merge main

.changeset/dirty-wolves-sin.md

@@ -0,0 +1,5 @@
+---
+"@google/generative-ai": minor
+---
+
+Expand the model's `countTokens` method to alternatively accept a `GenerateContentRequest`.

.changeset/fifty-masks-leave.md

@@ -0,0 +1,5 @@
+---
+"@google/generative-ai": patch
+---
+
+Removed the `model` field from the internally formatted payload of `countToken` requests as it was unnecessary.

README.md

@@ -20,7 +20,7 @@ For example, with just a few lines of code, you can access Gemini's multimodal c
 
 For Node.js:
 ```js
-const model = genAI.getGenerativeModel({ model: "gemini-pro-vision" });
+const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash-latest" });
 
 const prompt = "Does this look store-bought or homemade?";
 const image = {
@@ -36,7 +36,7 @@ console.log(result.response.text());
 
 For web:
 ```js
-const model = genAI.getGenerativeModel({ model: "gemini-pro-vision" });
+const model = genAI.getGenerativeModel({ model: "gemini-1.5-flash-latest" });
 
 const prompt = "Does this look store-bought or homemade?";
 const image = {

docs/contributing.md

@@ -37,6 +37,7 @@ Steps to build locally:
 1. Run `yarn test` to run unit tests.
 1. Run `yarn docs` to generate any changes to reference docs (destination dir is docs/reference).
 1. Run `yarn format` to fix formatting and add license headers as needed.
+1. Run `yarn changeset` to generate the changeset summary.
 
 This repo has a monorepo structure to allow for easily adding additional packages. The `@google/generative-ai` package code is in `packages/main`.
 

docs/reference/files/generative-ai.errordetails.__type_.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ErrorDetails](./generative-ai.errordetails.md) &gt; ["@type"](./generative-ai.errordetails.__type_.md)
+
+## ErrorDetails."@type" property
+
+**Signature:**
+
+```typescript
+"@type"?: string;
+```

docs/reference/files/generative-ai.errordetails.domain.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ErrorDetails](./generative-ai.errordetails.md) &gt; [domain](./generative-ai.errordetails.domain.md)
+
+## ErrorDetails.domain property
+
+**Signature:**
+
+```typescript
+domain?: string;
+```

docs/reference/files/generative-ai.errordetails.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ErrorDetails](./generative-ai.errordetails.md)
+
+## ErrorDetails interface
+
+Details object that may be included in an error response.
+
+**Signature:**
+
+```typescript
+export interface ErrorDetails 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  ["@type"?](./generative-ai.errordetails.__type_.md) |  | string | _(Optional)_ |
+|  [domain?](./generative-ai.errordetails.domain.md) |  | string | _(Optional)_ |
+|  [metadata?](./generative-ai.errordetails.metadata.md) |  | Record&lt;string, unknown&gt; | _(Optional)_ |
+|  [reason?](./generative-ai.errordetails.reason.md) |  | string | _(Optional)_ |
+

docs/reference/files/generative-ai.errordetails.metadata.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ErrorDetails](./generative-ai.errordetails.md) &gt; [metadata](./generative-ai.errordetails.metadata.md)
+
+## ErrorDetails.metadata property
+
+**Signature:**
+
+```typescript
+metadata?: Record<string, unknown>;
+```

docs/reference/files/generative-ai.errordetails.reason.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ErrorDetails](./generative-ai.errordetails.md) &gt; [reason](./generative-ai.errordetails.reason.md)
+
+## ErrorDetails.reason property
+
+**Signature:**
+
+```typescript
+reason?: string;
+```

docs/reference/files/generative-ai.filemetadataresponse.error.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [FileMetadataResponse](./generative-ai.filemetadataresponse.md) &gt; [error](./generative-ai.filemetadataresponse.error.md)
+
+## FileMetadataResponse.error property
+
+Error populated if file processing has failed.
+
+**Signature:**
+
+```typescript
+error?: RpcStatus;
+```

docs/reference/files/generative-ai.filemetadataresponse.md

@@ -18,6 +18,7 @@ export interface FileMetadataResponse
 |  --- | --- | --- | --- |
 |  [createTime](./generative-ai.filemetadataresponse.createtime.md) |  | string |  |
 |  [displayName?](./generative-ai.filemetadataresponse.displayname.md) |  | string | _(Optional)_ |
+|  [error?](./generative-ai.filemetadataresponse.error.md) |  | [RpcStatus](./generative-ai.rpcstatus.md) | _(Optional)_ Error populated if file processing has failed. |
 |  [expirationTime](./generative-ai.filemetadataresponse.expirationtime.md) |  | string |  |
 |  [mimeType](./generative-ai.filemetadataresponse.mimetype.md) |  | string |  |
 |  [name](./generative-ai.filemetadataresponse.name.md) |  | string |  |
@@ -26,4 +27,5 @@ export interface FileMetadataResponse
 |  [state](./generative-ai.filemetadataresponse.state.md) |  | [FileState](./generative-ai.filestate.md) |  |
 |  [updateTime](./generative-ai.filemetadataresponse.updatetime.md) |  | string |  |
 |  [uri](./generative-ai.filemetadataresponse.uri.md) |  | string |  |
+|  [videoMetadata?](./generative-ai.filemetadataresponse.videometadata.md) |  | [VideoMetadata](./generative-ai.videometadata.md) | _(Optional)_ Video metadata populated after processing is complete. |
 

docs/reference/files/generative-ai.filemetadataresponse.videometadata.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [FileMetadataResponse](./generative-ai.filemetadataresponse.md) &gt; [videoMetadata](./generative-ai.filemetadataresponse.videometadata.md)
+
+## FileMetadataResponse.videoMetadata property
+
+Video metadata populated after processing is complete.
+
+**Signature:**
+
+```typescript
+videoMetadata?: VideoMetadata;
+```

docs/reference/files/generative-ai.filestate.md

@@ -16,8 +16,8 @@ export declare enum FileState
 
 |  Member | Value | Description |
 |  --- | --- | --- |
-|  ACTIVE | <code>2</code> |  |
-|  FAILED | <code>10</code> |  |
-|  PROCESSING | <code>1</code> |  |
-|  STATE\_UNSPECIFIED | <code>0</code> |  |
+|  ACTIVE | <code>&quot;ACTIVE&quot;</code> |  |
+|  FAILED | <code>&quot;FAILED&quot;</code> |  |
+|  PROCESSING | <code>&quot;PROCESSING&quot;</code> |  |
+|  STATE\_UNSPECIFIED | <code>&quot;STATE_UNSPECIFIED&quot;</code> |  |
 

docs/reference/files/generative-ai.md

@@ -20,11 +20,13 @@
 
 |  Interface | Description |
 |  --- | --- |
+|  [ErrorDetails](./generative-ai.errordetails.md) | Details object that may be included in an error response. |
 |  [FileMetadata](./generative-ai.filemetadata.md) | Metadata to provide alongside a file upload |
 |  [FileMetadataResponse](./generative-ai.filemetadataresponse.md) | File metadata response from server. |
 |  [ListFilesResponse](./generative-ai.listfilesresponse.md) | Response from calling [GoogleAIFileManager.listFiles()](./generative-ai.googleaifilemanager.listfiles.md) |
 |  [ListParams](./generative-ai.listparams.md) | Params to pass to [GoogleAIFileManager.listFiles()](./generative-ai.googleaifilemanager.listfiles.md) |
 |  [RequestOptions](./generative-ai.requestoptions.md) | Params passed to getGenerativeModel() or GoogleAIFileManager(). |
-|  [SingleRequestOptions](./generative-ai.singlerequestoptions.md) | Params passed to atomic asynchronous operations. |
+|  [RpcStatus](./generative-ai.rpcstatus.md) | Standard RPC error status object. |
 |  [UploadFileResponse](./generative-ai.uploadfileresponse.md) | Response from calling [GoogleAIFileManager.uploadFile()](./generative-ai.googleaifilemanager.uploadfile.md) |
+|  [VideoMetadata](./generative-ai.videometadata.md) | Metadata populated when video has been processed. |
 

docs/reference/files/generative-ai.rpcstatus.code.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [RpcStatus](./generative-ai.rpcstatus.md) &gt; [code](./generative-ai.rpcstatus.code.md)
+
+## RpcStatus.code property
+
+Error status code
+
+**Signature:**
+
+```typescript
+code: number;
+```

docs/reference/files/generative-ai.rpcstatus.details.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [RpcStatus](./generative-ai.rpcstatus.md) &gt; [details](./generative-ai.rpcstatus.details.md)
+
+## RpcStatus.details property
+
+A list of messages that carry the error details.
+
+**Signature:**
+
+```typescript
+details?: ErrorDetails[];
+```

docs/reference/files/generative-ai.rpcstatus.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [RpcStatus](./generative-ai.rpcstatus.md)
+
+## RpcStatus interface
+
+Standard RPC error status object.
+
+**Signature:**
+
+```typescript
+export interface RpcStatus 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [code](./generative-ai.rpcstatus.code.md) |  | number | Error status code |
+|  [details?](./generative-ai.rpcstatus.details.md) |  | [ErrorDetails](./generative-ai.errordetails.md)<!-- -->\[\] | _(Optional)_ A list of messages that carry the error details. |
+|  [message](./generative-ai.rpcstatus.message.md) |  | string | A developer-facing error message. |
+

docs/reference/files/generative-ai.rpcstatus.message.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [RpcStatus](./generative-ai.rpcstatus.md) &gt; [message](./generative-ai.rpcstatus.message.md)
+
+## RpcStatus.message property
+
+A developer-facing error message.
+
+**Signature:**
+
+```typescript
+message: string;
+```

docs/reference/files/generative-ai.videometadata.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [VideoMetadata](./generative-ai.videometadata.md)
+
+## VideoMetadata interface
+
+Metadata populated when video has been processed.
+
+**Signature:**
+
+```typescript
+export interface VideoMetadata 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [videoDuration](./generative-ai.videometadata.videoduration.md) |  | string | The video duration in protobuf [Duration](https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-v1/latest/Google-Protobuf-Duration#json-mapping) format. |
+

docs/reference/files/generative-ai.videometadata.videoduration.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [VideoMetadata](./generative-ai.videometadata.md) &gt; [videoDuration](./generative-ai.videometadata.videoduration.md)
+
+## VideoMetadata.videoDuration property
+
+The video duration in protobuf [Duration](https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-v1/latest/Google-Protobuf-Duration#json-mapping) format.
+
+**Signature:**
+
+```typescript
+videoDuration: string;
+```

docs/reference/main/generative-ai.counttokensrequest.contents.md

@@ -7,5 +7,5 @@
 **Signature:**
 
 ```typescript
-contents: Content[];
+contents?: Content[];
 ```

docs/reference/main/generative-ai.counttokensrequest.generatecontentrequest.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [CountTokensRequest](./generative-ai.counttokensrequest.md) &gt; [generateContentRequest](./generative-ai.counttokensrequest.generatecontentrequest.md)
+
+## CountTokensRequest.generateContentRequest property
+
+**Signature:**
+
+```typescript
+generateContentRequest?: GenerateContentRequest;
+```

docs/reference/main/generative-ai.counttokensrequest.md

@@ -4,7 +4,9 @@
 
 ## CountTokensRequest interface
 
-Params for calling [GenerativeModel.countTokens()](./generative-ai.generativemodel.counttokens.md)
+Params for calling [GenerativeModel.countTokens()](./generative-ai.generativemodel.counttokens.md)<!-- -->.
+
+The request must contain either a [Content](./generative-ai.content.md) array or a [GenerateContentRequest](./generative-ai.generatecontentrequest.md)<!-- -->, but not both. If both are provided then a [GoogleGenerativeAIRequestInputError](./generative-ai.googlegenerativeairequestinputerror.md) is thrown.
 
 **Signature:**
 
@@ -16,5 +18,6 @@ export interface CountTokensRequest
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [contents](./generative-ai.counttokensrequest.contents.md) |  | [Content](./generative-ai.content.md)<!-- -->\[\] |  |
+|  [contents?](./generative-ai.counttokensrequest.contents.md) |  | [Content](./generative-ai.content.md)<!-- -->\[\] | _(Optional)_ |
+|  [generateContentRequest?](./generative-ai.counttokensrequest.generatecontentrequest.md) |  | [GenerateContentRequest](./generative-ai.generatecontentrequest.md) | _(Optional)_ |
 

docs/reference/main/generative-ai.errordetails.__type_.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ErrorDetails](./generative-ai.errordetails.md) &gt; ["@type"](./generative-ai.errordetails.__type_.md)
+
+## ErrorDetails."@type" property
+
+**Signature:**
+
+```typescript
+"@type"?: string;
+```

docs/reference/main/generative-ai.errordetails.domain.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ErrorDetails](./generative-ai.errordetails.md) &gt; [domain](./generative-ai.errordetails.domain.md)
+
+## ErrorDetails.domain property
+
+**Signature:**
+
+```typescript
+domain?: string;
+```

docs/reference/main/generative-ai.errordetails.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ErrorDetails](./generative-ai.errordetails.md)
+
+## ErrorDetails interface
+
+Details object that may be included in an error response.
+
+**Signature:**
+
+```typescript
+export interface ErrorDetails 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  ["@type"?](./generative-ai.errordetails.__type_.md) |  | string | _(Optional)_ |
+|  [domain?](./generative-ai.errordetails.domain.md) |  | string | _(Optional)_ |
+|  [metadata?](./generative-ai.errordetails.metadata.md) |  | Record&lt;string, unknown&gt; | _(Optional)_ |
+|  [reason?](./generative-ai.errordetails.reason.md) |  | string | _(Optional)_ |
+

docs/reference/main/generative-ai.errordetails.metadata.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ErrorDetails](./generative-ai.errordetails.md) &gt; [metadata](./generative-ai.errordetails.metadata.md)
+
+## ErrorDetails.metadata property
+
+**Signature:**
+
+```typescript
+metadata?: Record<string, unknown>;
+```

docs/reference/main/generative-ai.errordetails.reason.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@google/generative-ai](./generative-ai.md) &gt; [ErrorDetails](./generative-ai.errordetails.md) &gt; [reason](./generative-ai.errordetails.reason.md)
+
+## ErrorDetails.reason property
+
+**Signature:**
+
+```typescript
+reason?: string;
+```