-
Notifications
You must be signed in to change notification settings - Fork 154
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add additional properties to FileMetadataResponse
- Loading branch information
Showing
14 changed files
with
209 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
"@google/generative-ai": patch | ||
--- | ||
|
||
Add additional properties `videoMetadata` and `error` to `FileMetadataResponse` type. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ErrorDetail](./generative-ai.errordetail.md) > ["@type"](./generative-ai.errordetail.__type_.md) | ||
|
||
## ErrorDetail."@type" property | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
"@type"?: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [ErrorDetail](./generative-ai.errordetail.md) | ||
|
||
## ErrorDetail interface | ||
|
||
Optional additional error details. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export interface ErrorDetail | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Modifiers | Type | Description | | ||
| --- | --- | --- | --- | | ||
| ["@type"?](./generative-ai.errordetail.__type_.md) | | string | _(Optional)_ | | ||
|
13 changes: 13 additions & 0 deletions
13
docs/reference/files/generative-ai.filemetadataresponse.error.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [error](./generative-ai.filemetadataresponse.error.md) | ||
|
||
## FileMetadataResponse.error property | ||
|
||
Error populated if file processing has failed. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
error?: RpcStatus; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13
docs/reference/files/generative-ai.filemetadataresponse.videometadata.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [FileMetadataResponse](./generative-ai.filemetadataresponse.md) > [videoMetadata](./generative-ai.filemetadataresponse.videometadata.md) | ||
|
||
## FileMetadataResponse.videoMetadata property | ||
|
||
Video metadata populated after processing is complete. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
videoMetadata?: VideoMetadata; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RpcStatus](./generative-ai.rpcstatus.md) > [code](./generative-ai.rpcstatus.code.md) | ||
|
||
## RpcStatus.code property | ||
|
||
Error status code | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
code: number; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RpcStatus](./generative-ai.rpcstatus.md) > [details](./generative-ai.rpcstatus.details.md) | ||
|
||
## RpcStatus.details property | ||
|
||
A list of messages that carry the error details. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
details?: ErrorDetail[]; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [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) | | [ErrorDetail](./generative-ai.errordetail.md)<!-- -->\[\] | _(Optional)_ A list of messages that carry the error details. | | ||
| [message](./generative-ai.rpcstatus.message.md) | | string | A developer-facing error message. | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [RpcStatus](./generative-ai.rpcstatus.md) > [message](./generative-ai.rpcstatus.message.md) | ||
|
||
## RpcStatus.message property | ||
|
||
A developer-facing error message. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
message: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [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. | | ||
|
13 changes: 13 additions & 0 deletions
13
docs/reference/files/generative-ai.videometadata.videoduration.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@google/generative-ai](./generative-ai.md) > [VideoMetadata](./generative-ai.videometadata.md) > [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; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters