Skip to content

Commit 2d498c2

Browse files
committedApr 30, 2025
update docs
1 parent f0fbe8b commit 2d498c2

File tree

4 files changed

+6
-10
lines changed

4 files changed

+6
-10
lines changed
 

‎common/api-review/vertexai.api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ export { Date_2 as Date }
124124
export interface EnhancedGenerateContentResponse extends GenerateContentResponse {
125125
// (undocumented)
126126
functionCalls: () => FunctionCall[] | undefined;
127-
inlineData: () => GenerativeContentBlob[] | undefined;
127+
inlineDataParts: () => InlineDataPart[] | undefined;
128128
text: () => string;
129129
}
130130

‎docs-devsite/vertexai.enhancedgeneratecontentresponse.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export interface EnhancedGenerateContentResponse extends GenerateContentResponse
2424
| Property | Type | Description |
2525
| --- | --- | --- |
2626
| [functionCalls](./vertexai.enhancedgeneratecontentresponse.md#enhancedgeneratecontentresponsefunctioncalls) | () =&gt; [FunctionCall](./vertexai.functioncall.md#functioncall_interface)<!-- -->\[\] \| undefined | |
27-
| [inlineData](./vertexai.enhancedgeneratecontentresponse.md#enhancedgeneratecontentresponseinlinedata) | () =&gt; [GenerativeContentBlob](./vertexai.generativecontentblob.md#generativecontentblob_interface)<!-- -->\[\] \| undefined | Aggregates and returns all [InlineDataPart](./vertexai.inlinedatapart.md#inlinedatapart_interface) from the [GenerateContentResponse](./vertexai.generatecontentresponse.md#generatecontentresponse_interface)<!-- -->'s first candidate. |
27+
| [inlineDataParts](./vertexai.enhancedgeneratecontentresponse.md#enhancedgeneratecontentresponseinlinedataparts) | () =&gt; [InlineDataPart](./vertexai.inlinedatapart.md#inlinedatapart_interface)<!-- -->\[\] \| undefined | Aggregates and returns all [InlineDataPart](./vertexai.inlinedatapart.md#inlinedatapart_interface) from the [GenerateContentResponse](./vertexai.generatecontentresponse.md#generatecontentresponse_interface)<!-- -->'s first candidate. |
2828
| [text](./vertexai.enhancedgeneratecontentresponse.md#enhancedgeneratecontentresponsetext) | () =&gt; string | Returns the text string from the response, if available. Throws if the prompt or candidate was blocked. |
2929
3030
## EnhancedGenerateContentResponse.functionCalls
@@ -35,14 +35,14 @@ export interface EnhancedGenerateContentResponse extends GenerateContentResponse
3535
functionCalls: () => FunctionCall[] | undefined;
3636
```
3737
38-
## EnhancedGenerateContentResponse.inlineData
38+
## EnhancedGenerateContentResponse.inlineDataParts
3939
4040
Aggregates and returns all [InlineDataPart](./vertexai.inlinedatapart.md#inlinedatapart_interface) from the [GenerateContentResponse](./vertexai.generatecontentresponse.md#generatecontentresponse_interface)<!-- -->'s first candidate.
4141
4242
<b>Signature:</b>
4343
4444
```typescript
45-
inlineData: () => GenerativeContentBlob[] | undefined;
45+
inlineDataParts: () => InlineDataPart[] | undefined;
4646
```
4747
4848
## EnhancedGenerateContentResponse.text

‎docs-devsite/vertexai.generationconfig.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,8 @@ export interface GenerationConfig
2727
| [maxOutputTokens](./vertexai.generationconfig.md#generationconfigmaxoutputtokens) | number | |
2828
| [presencePenalty](./vertexai.generationconfig.md#generationconfigpresencepenalty) | number | |
2929
| [responseMimeType](./vertexai.generationconfig.md#generationconfigresponsemimetype) | string | Output response MIME type of the generated candidate text. Supported MIME types are <code>text/plain</code> (default, text output), <code>application/json</code> (JSON response in the candidates), and <code>text/x.enum</code>. |
30-
<<<<<<< HEAD
31-
| [responseSchema](./vertexai.generationconfig.md#generationconfigresponseschema) | [TypedSchema](./vertexai.md#typedschema) \| [SchemaRequest](./vertexai.schemarequest.md#schemarequest_interface) | Output response schema of the generated candidate text. This value can be a class generated with a [Schema](./vertexai.schema.md#schema_class) static method like <code>Schema.string()</code> or <code>Schema.object()</code> or it can be a plain JS object matching the [SchemaRequest](./vertexai.schemarequest.md#schemarequest_interface) interface. <br/>Note: This only applies when the specified <code>responseMIMEType</code> supports a schema; currently this is limited to <code>application/json</code> and <code>text/x.enum</code>. |
32-
=======
3330
| [responseModalities](./vertexai.generationconfig.md#generationconfigresponsemodalities) | [ResponseModality](./vertexai.md#responsemodality)<!-- -->\[\] | <b><i>(Public Preview)</i></b> Generation modalities to be returned in generation responses. |
34-
| [responseSchema](./vertexai.generationconfig.md#generationconfigresponseschema) | [TypedSchema](./vertexai.md#typedschema) \| [SchemaRequest](./vertexai.schemarequest.md#schemarequest_interface) | Output response schema of the generated candidate text. This value can be a class generated with a <code>[Schema](./vertexai.schema.md#schema_class)</code> static method like <code>Schema.string()</code> or <code>Schema.object()</code> or it can be a plain JS object matching the <code>[SchemaRequest](./vertexai.schemarequest.md#schemarequest_interface)</code> interface. <br/>Note: This only applies when the specified <code>responseMIMEType</code> supports a schema; currently this is limited to <code>application/json</code> and <code>text/x.enum</code>. |
35-
>>>>>>> 4f7f1ecb1 (feat(vertexai): Gemini multimodal output)
31+
| [responseSchema](./vertexai.generationconfig.md#generationconfigresponseschema) | [TypedSchema](./vertexai.md#typedschema) \| [SchemaRequest](./vertexai.schemarequest.md#schemarequest_interface) | Output response schema of the generated candidate text. This value can be a class generated with a [Schema](./vertexai.schema.md#schema_class) static method like <code>Schema.string()</code> or <code>Schema.object()</code> or it can be a plain JS object matching the [SchemaRequest](./vertexai.schemarequest.md#schemarequest_interface) interface. <br/>Note: This only applies when the specified <code>responseMIMEType</code> supports a schema; currently this is limited to <code>application/json</code> and <code>text/x.enum</code>. |
3632
| [stopSequences](./vertexai.generationconfig.md#generationconfigstopsequences) | string\[\] | |
3733
| [temperature](./vertexai.generationconfig.md#generationconfigtemperature) | number | |
3834
| [topK](./vertexai.generationconfig.md#generationconfigtopk) | number | |

‎packages/vertexai/src/types/responses.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ export interface EnhancedGenerateContentResponse
6363
* Aggregates and returns all {@link InlineDataPart} from the {@link GenerateContentResponse}'s
6464
* first candidate.
6565
*
66-
* @returns An array of {@link InlineDataPart} containing data from the response, if available.
66+
* @returns An array of {@link InlineDataPart}s containing data from the response, if available.
6767
*
6868
* @throws If the prompt or candidate was blocked.
6969
*/

0 commit comments

Comments
 (0)