Skip to content

Convert supported mimetypes to be bullet points #8270

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 30, 2024
Merged

Convert supported mimetypes to be bullet points #8270

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
251c641
Bullet supported mimetypes
dlarocque May 29, 2024
d122b76
Add empty changeset
dlarocque May 29, 2024
21c0084
Convert bullets to a single sentence for easier rendering
dlarocque May 29, 2024
5fd5527
remove changeset
dlarocque May 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/unlucky-radios-invent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think you need a changeset for documentation changes.

---
4 changes: 2 additions & 2 deletions docs-devsite/vertexai-preview.generationconfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export interface GenerationConfig
| [frequencyPenalty](./vertexai-preview.generationconfig.md#generationconfigfrequencypenalty) | number | |
| [maxOutputTokens](./vertexai-preview.generationconfig.md#generationconfigmaxoutputtokens) | number | |
| [presencePenalty](./vertexai-preview.generationconfig.md#generationconfigpresencepenalty) | number | |
| [responseMimeType](./vertexai-preview.generationconfig.md#generationconfigresponsemimetype) | string | Output response mimetype of the generated candidate text. Supported mimetype: <code>text/plain</code>: (default) Text output. <code>application/json</code>: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. |
| [responseMimeType](./vertexai-preview.generationconfig.md#generationconfigresponsemimetype) | string | Output response mimetype of the generated candidate text. Supported mimetypes: - <code>text/plain</code>: (default) Text output. - <code>application/json</code>: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. |
| [stopSequences](./vertexai-preview.generationconfig.md#generationconfigstopsequences) | string\[\] | |
| [temperature](./vertexai-preview.generationconfig.md#generationconfigtemperature) | number | |
| [topK](./vertexai-preview.generationconfig.md#generationconfigtopk) | number | |
Expand Down Expand Up @@ -66,7 +66,7 @@ presencePenalty?: number;

## GenerationConfig.responseMimeType

Output response mimetype of the generated candidate text. Supported mimetype: `text/plain`<!-- -->: (default) Text output. `application/json`<!-- -->: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
Output response mimetype of the generated candidate text. Supported mimetypes: - `text/plain`<!-- -->: (default) Text output. - `application/json`<!-- -->: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.

<b>Signature:</b>

Expand Down
6 changes: 3 additions & 3 deletions packages/vertexai/src/types/requests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,9 @@ export interface GenerationConfig {
frequencyPenalty?: number;
/**
* Output response mimetype of the generated candidate text.
* Supported mimetype:
* `text/plain`: (default) Text output.
* `application/json`: JSON response in the candidates.
* Supported mimetypes:
* - `text/plain`: (default) Text output.
* - `application/json`: JSON response in the candidates.
* The model needs to be prompted to output the appropriate response type,
* otherwise the behavior is undefined.
* This is a preview feature.
Expand Down
Loading