Add additional properties to FileMetadataResponse (#147)

Author: hsubox76

.changeset/few-pants-thank.md

@@ -0,0 +1,5 @@
+---
+"@google/generative-ai": patch
+---
+
+Add additional properties `videoMetadata` and `error` to `FileMetadataResponse` type.

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.md

@@ -20,10 +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(). |
+|  [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.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;
+```

docs/reference/main/generative-ai.googlegenerativeaifetcherror._constructor_.md

@@ -19,5 +19,5 @@ constructor(message: string, status?: number, statusText?: string, errorDetails?
 |  message | string |  |
 |  status | number | _(Optional)_ |
 |  statusText | string | _(Optional)_ |
-|  errorDetails | ErrorDetails\[\] | _(Optional)_ |
+|  errorDetails | [ErrorDetails](./generative-ai.errordetails.md)<!-- -->\[\] | _(Optional)_ |
 

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

@@ -23,7 +23,7 @@ export declare class GoogleGenerativeAIFetchError extends GoogleGenerativeAIErro
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [errorDetails?](./generative-ai.googlegenerativeaifetcherror.errordetails.md) |  | ErrorDetails\[\] | _(Optional)_ |
+|  [errorDetails?](./generative-ai.googlegenerativeaifetcherror.errordetails.md) |  | [ErrorDetails](./generative-ai.errordetails.md)<!-- -->\[\] | _(Optional)_ |
 |  [status?](./generative-ai.googlegenerativeaifetcherror.status.md) |  | number | _(Optional)_ |
 |  [statusText?](./generative-ai.googlegenerativeaifetcherror.statustext.md) |  | string | _(Optional)_ |
 

docs/reference/main/generative-ai.md

@@ -45,6 +45,7 @@
 |  [EmbedContentRequest](./generative-ai.embedcontentrequest.md) | Params for calling [GenerativeModel.embedContent()](./generative-ai.generativemodel.embedcontent.md) |
 |  [EmbedContentResponse](./generative-ai.embedcontentresponse.md) | Response from calling [GenerativeModel.embedContent()](./generative-ai.generativemodel.embedcontent.md)<!-- -->. |
 |  [EnhancedGenerateContentResponse](./generative-ai.enhancedgeneratecontentresponse.md) | Response object wrapped with helper methods. |
+|  [ErrorDetails](./generative-ai.errordetails.md) | Details object that may be included in an error response. |
 |  [FileData](./generative-ai.filedata.md) | Data pointing to a file uploaded with the Files API. |
 |  [FileDataPart](./generative-ai.filedatapart.md) | Content part interface if the part represents FunctionResponse. |
 |  [FunctionCall](./generative-ai.functioncall.md) | A predicted \[FunctionCall\] returned from the model that contains a string representing the \[FunctionDeclaration.name\] and a structured JSON object containing the parameters and their values. |

packages/main/src/errors.ts

@@ -15,6 +15,8 @@
  * limitations under the License.
  */
 
+import { ErrorDetails } from "../types";
+
 /**
  * Basic error type for this SDK.
  * @public
@@ -62,15 +64,3 @@ export class GoogleGenerativeAIFetchError extends GoogleGenerativeAIError {
  * @public
  */
 export class GoogleGenerativeAIRequestInputError extends GoogleGenerativeAIError {}
-
-/**
- * Details object that may be included in an error response.
- * @public
- */
-interface ErrorDetails {
-  "@type"?: string;
-  reason?: string;
-  domain?: string;
-  metadata?: Record<string, unknown>;
-  [key: string]: unknown;
-}

packages/main/src/files/types.ts

@@ -15,6 +15,10 @@
  * limitations under the License.
  */
 
+import { ErrorDetails } from "../../types";
+
+export { ErrorDetails };
+
 /**
  * Params to pass to {@link GoogleAIFileManager.listFiles}
  * @public
@@ -49,6 +53,14 @@ export interface FileMetadataResponse {
   sha256Hash: string;
   uri: string;
   state: FileState;
+  /**
+   * Error populated if file processing has failed.
+   */
+  error?: RpcStatus;
+  /**
+   * Video metadata populated after processing is complete.
+   */
+  videoMetadata?: VideoMetadata;
 }
 
 /**
@@ -82,3 +94,34 @@ export enum FileState {
   // File failed processing.
   FAILED = "FAILED",
 }
+
+/**
+ * Standard RPC error status object.
+ * @public
+ */
+export interface RpcStatus {
+  /**
+   * Error status code
+   */
+  code: number;
+  /**
+   * A developer-facing error message.
+   */
+  message: string;
+  /**
+   * A list of messages that carry the error details.
+   */
+  details?: ErrorDetails[];
+}
+
+/**
+ * Metadata populated when video has been processed.
+ * @public
+ */
+export interface VideoMetadata {
+  /**
+   * The video duration in
+   * protobuf {@link https://cloud.google.com/ruby/docs/reference/google-cloud-workflows-v1/latest/Google-Protobuf-Duration#json-mapping | Duration} format.
+   */
+  videoDuration: string;
+}

packages/main/types/responses.ts

@@ -183,3 +183,15 @@ export interface BatchEmbedContentsResponse {
 export interface ContentEmbedding {
   values: number[];
 }
+
+/**
+ * Details object that may be included in an error response.
+ * @public
+ */
+export interface ErrorDetails {
+  "@type"?: string;
+  reason?: string;
+  domain?: string;
+  metadata?: Record<string, unknown>;
+  [key: string]: unknown;
+}