GET
/v1/schemas/google-vertex/chat/v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent?kind=output
Accept:
| field | recorded source |
|---|---|
| schema | Source linked above. upstream-spec Source tracee69620665421ad8d22f2876f8fc6e5cd76ca04ce1a4add0c27f46952bc942963{
"fetchedAt": 1793424646,
"extractorVersion": "1",
"verifiedAt": null
} |
Response body
6 properties · 0 required · 46 $defs| property | type | description | constraints |
|---|---|---|---|
| modelVersion | string | Output only. The model version used to generate the response. | |
| usageMetadata | GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata | Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. | |
| promptFeedback | GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback | Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. | |
| responseId | string | Output only. response_id is used to identify each response. It is the encoding of the event_id. | |
| candidates | GoogleCloudAiplatformV1Candidate[] | Output only. Generated candidates. | |
| createTime | string | Output only. Timestamp when the request is made to the server. | format: google-datetime |
Types
46 $defsGoogleCloudAiplatformV1AudioTranscriptionobject
The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate `Part` with its own `AudioTranscription` carrying the `speaker_label`.
| speakerLabel | string | Optional. A label identifying the speaker of this audio segment (e.g. `spk_1`, `spk_2`). Present when `diarization` is set. | |
| text | string | Required. The transcription text of this audio segment. | |
| words | GoogleCloudAiplatformV1AudioTranscriptionWordInfo[] | Optional. Detailed word-level transcriptions and timing details. Present when `word_timestamp` is set. |
GoogleCloudAiplatformV1AudioTranscriptionWordInfoobject
Information about a single recognized word.
| word | string | Required. Transcript of the word. | |
| endOffset | string | Optional. End offset in time of the word relative to the start of the audio. | format: google-duration |
| startOffset | string | Optional. Start offset in time of the word relative to the start of the audio. | format: google-duration |
GoogleCloudAiplatformV1Blobobject
A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video.
| data | string | Required. The raw bytes of the data. | format: byte |
| mimeType | string | Required. The IANA standard MIME type of the source data. | |
| displayName | string | Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search… |
GoogleCloudAiplatformV1Candidateobject
A response candidate generated from the model.
| groundingMetadata | GoogleCloudAiplatformV1GroundingMetadata | Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. | |
| content | GoogleCloudAiplatformV1Content | The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. | |
| safetyRatings | GoogleCloudAiplatformV1SafetyRating[] | Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. | |
| logprobsResult | GoogleCloudAiplatformV1LogprobsResult | The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident predictio… | |
| finishReason | enum | Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating. | FINISH_REASON_UNSPECIFIED | STOP | MAX_TOKENS | SAFETY | RECITATION | OTHER · +14 more |
| index | integer | Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1. | format: int32 |
| finishMessage | string | Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set. | |
| urlContextMetadata | GoogleCloudAiplatformV1UrlContextMetadata | Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. | |
| avgLogprobs | number | Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent resp… | format: double |
| continuationToken | string | Output only. An optional opaque continuation token returned when `finish_reason` is `CONTINUATION`. Clients can pass this token in a subsequent `GenerateContentRequest` to continue generation. | format: byte |
| citationMetadata | GoogleCloudAiplatformV1CitationMetadata | A collection of citations that apply to a piece of generated content. |
GoogleCloudAiplatformV1Citationobject
A citation for a piece of generatedcontent.
| license | string | Output only. The license of the source of the citation. | |
| title | string | Output only. The title of the source of the citation. | |
| endIndex | integer | Output only. The end index of the citation in the content. | format: int32 |
| uri | string | Output only. The URI of the source of the citation. | |
| startIndex | integer | Output only. The start index of the citation in the content. | format: int32 |
| publicationDate | GoogleTypeDate | Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non… |
GoogleCloudAiplatformV1CitationMetadataobject
A collection of citations that apply to a piece of generated content.
| citations | GoogleCloudAiplatformV1Citation[] | Output only. A list of citations for the content. |
GoogleCloudAiplatformV1CodeExecutionResultobject
Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used.
| id | string | Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. | |
| outcome | enum | Required. Outcome of the code execution. | OUTCOME_UNSPECIFIED | OUTCOME_OK | OUTCOME_FAILED | OUTCOME_DEADLINE_EXCEEDED |
| output | string | Optional. Contains stdout when code execution is successful, stderr or other description otherwise. |
GoogleCloudAiplatformV1Contentobject
The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
| parts | GoogleCloudAiplatformV1Part[] | Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. | |
| role | string | Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. |
GoogleCloudAiplatformV1ExecutableCodeobject
Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated.
| id | string | Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. | |
| language | enum | Required. Programming language of the `code`. | LANGUAGE_UNSPECIFIED | PYTHON |
| code | string | Required. The code to be executed. |
GoogleCloudAiplatformV1FileDataobject
URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage.
| mimeType | string | Required. The IANA standard MIME type of the source data. | |
| displayName | string | Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search… | |
| fileUri | string | Required. The URI of the file in Google Cloud Storage. |
GoogleCloudAiplatformV1FunctionCallobject
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.
| partialArgs | GoogleCloudAiplatformV1PartialArg[] | Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. | |
| id | string | Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. | |
| args | object | Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. | |
| name | string | Optional. The name of the function to call. Matches FunctionDeclaration.name. | |
| willContinue | boolean | Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. |
GoogleCloudAiplatformV1FunctionResponseobject
The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made…
| parts | GoogleCloudAiplatformV1FunctionResponsePart[] | Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. | |
| id | string | Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. | |
| scheduling | enum | Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. | SCHEDULING_UNSPECIFIED | SILENT | WHEN_IDLE | INTERRUPT |
| response | object | Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. | |
| name | string | Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. |
GoogleCloudAiplatformV1FunctionResponseBlobobject
Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field.
| displayName | string | Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_executi… | |
| mimeType | string | Required. The IANA standard MIME type of the source data. | |
| data | string | Required. Raw bytes. | format: byte |
GoogleCloudAiplatformV1FunctionResponseFileDataobject
URI based data for function response.
| fileUri | string | Required. URI. | |
| mimeType | string | Required. The IANA standard MIME type of the source data. | |
| displayName | string | Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (co… |
GoogleCloudAiplatformV1FunctionResponsePartobject
A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `Functio…
| fileData | GoogleCloudAiplatformV1FunctionResponseFileData | URI based data for function response. | |
| inlineData | GoogleCloudAiplatformV1FunctionResponseBlob | Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. |
GoogleCloudAiplatformV1GenerateContentResponsePromptFeedbackobject
Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations.
| blockReason | enum | Output only. The reason why the prompt was blocked. | BLOCKED_REASON_UNSPECIFIED | SAFETY | OTHER | BLOCKLIST | PROHIBITED_CONTENT | MODEL_ARMOR · +2 more |
| safetyRatings | GoogleCloudAiplatformV1SafetyRating[] | Output only. A list of safety ratings for the prompt. There is one rating per category. | |
| blockReasonMessage | string | Output only. A readable message that explains the reason why the prompt was blocked. |
GoogleCloudAiplatformV1GenerateContentResponseUsageMetadataobject
Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.
| trafficType | enum | Output only. The traffic type for this request. | TRAFFIC_TYPE_UNSPECIFIED | ON_DEMAND | ON_DEMAND_PRIORITY | ON_DEMAND_FLEX | ON_DEMAND_OFFPEAK | PROVISIONED_THROUGHPUT |
| cachedContentTokenCount | integer | Output only. The number of tokens in the cached content that was used for this request. | format: int32 |
| toolUsePromptTokensDetails | GoogleCloudAiplatformV1ModalityTokenCount[] | Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. | |
| toolUsePromptTokenCount | integer | Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. | format: int32 |
| cacheTokensDetails | GoogleCloudAiplatformV1ModalityTokenCount[] | Output only. A detailed breakdown of the token count for each modality in the cached content. | |
| promptTokenCount | integer | The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. | format: int32 |
| totalTokenCount | integer | The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. | format: int32 |
| candidatesTokensDetails | GoogleCloudAiplatformV1ModalityTokenCount[] | Output only. A detailed breakdown of the token count for each modality in the generated candidates. | |
| promptTokensDetails | GoogleCloudAiplatformV1ModalityTokenCount[] | Output only. A detailed breakdown of the token count for each modality in the prompt. | |
| candidatesTokenCount | integer | The total number of tokens in the generated candidates. | format: int32 |
| thoughtsTokenCount | integer | Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. | format: int32 |
GoogleCloudAiplatformV1GroundingChunkobject
A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.
| image | GoogleCloudAiplatformV1GroundingChunkImage | An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. | |
| maps | GoogleCloudAiplatformV1GroundingChunkMaps | A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. | |
| web | GoogleCloudAiplatformV1GroundingChunkWeb | A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. | |
| retrievedContext | GoogleCloudAiplatformV1GroundingChunkRetrievedContext | Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. |
GoogleCloudAiplatformV1GroundingChunkImageobject
An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information.
| imageUri | string | The URI of the image. | |
| sourceUri | string | The URI of the image search result page. | |
| title | string | The title of the image search result page. | |
| domain | string | The domain of the image search result page. |
GoogleCloudAiplatformV1GroundingChunkMapsobject
A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information.
| uri | string | The URI of the place. | |
| route | GoogleCloudAiplatformV1GroundingChunkMapsRoute | Route information from Google Maps. | |
| text | string | The text of the place answer. | |
| title | string | The title of the place. | |
| placeId | string | This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. | |
| placeAnswerSources | GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources | The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. |
GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesobject
The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.
| reviewSnippets | GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet[] | Snippets of reviews that were used to generate the answer. |
GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippetobject
A review snippet that is used to generate the answer.
| title | string | The title of the review. | |
| reviewId | string | The ID of the review that is being referenced. | |
| googleMapsUri | string | A link to show the review on Google Maps. |
GoogleCloudAiplatformV1GroundingChunkMapsRouteobject
Route information from Google Maps.
| duration | string | The total duration of the route. | format: google-duration |
| encodedPolyline | string | An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm | |
| distanceMeters | integer | The total distance of the route, in meters. | format: int32 |
GoogleCloudAiplatformV1GroundingChunkRetrievedContextobject
Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset.
| title | string | The title of the retrieved data source. | |
| text | string | The content of the retrieved data source. | |
| uri | string | The URI of the retrieved data source. | |
| ragChunk | GoogleCloudAiplatformV1RagChunk | A RagChunk includes the content of a chunk of a RagFile, and associated metadata. | |
| documentName | string | Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches… |
GoogleCloudAiplatformV1GroundingChunkWebobject
A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information.
| domain | string | The domain of the web page that contains the evidence. This can be used to filter out low-quality sources. | |
| title | string | The title of the web page that contains the evidence. | |
| uri | string | The URI of the web page that contains the evidence. |
GoogleCloudAiplatformV1GroundingMetadataobject
Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources.
| retrievalMetadata | GoogleCloudAiplatformV1RetrievalMetadata | Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. | |
| retrievalQueries | string[] | Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. | |
| webSearchQueries | string[] | Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search. | |
| groundingChunks | GoogleCloudAiplatformV1GroundingChunk[] | A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. | |
| imageSearchQueries | string[] | Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled. | |
| googleMapsWidgetContextToken | string | Optional. Output only. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and will no longer be populated once removed. A token that can be used to render a Google Maps wi… | |
| searchEntryPoint | GoogleCloudAiplatformV1SearchEntryPoint | An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. | |
| sourceFlaggingUris | GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri[] | Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. | |
| groundingSupports | GoogleCloudAiplatformV1GroundingSupport[] | Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. |
GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUriobject
A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.
| sourceId | string | The ID of the place or review. | |
| flagContentUri | string | The URI that can be used to flag the content. |
GoogleCloudAiplatformV1GroundingSupportobject
A collection of supporting references for a segment or part of the model's response.
| segment | GoogleCloudAiplatformV1Segment | A segment of the content. | |
| confidenceScores | number[] | The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and … | |
| renderedParts | integer[] | Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message. | |
| groundingChunkIndices | integer[] | A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chu… |
GoogleCloudAiplatformV1LogprobsResultobject
The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident predictio…
| topCandidates | GoogleCloudAiplatformV1LogprobsResultTopCandidates[] | A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. | |
| chosenCandidates | GoogleCloudAiplatformV1LogprobsResultCandidate[] | A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`. |
GoogleCloudAiplatformV1LogprobsResultCandidateobject
A single token and its associated log probability.
| token | string | The token's string representation. | |
| tokenId | integer | The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the mode… | format: int32 |
| logProbability | number | The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. | format: float |
GoogleCloudAiplatformV1LogprobsResultTopCandidatesobject
A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered.
| candidates | GoogleCloudAiplatformV1LogprobsResultCandidate[] | The list of candidate tokens, sorted by log probability in descending order. |
GoogleCloudAiplatformV1ModalityTokenCountobject
Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is pa…
| tokenCount | integer | The number of tokens counted for this modality. | format: int32 |
| modality | enum | The modality that this token count applies to. | MODALITY_UNSPECIFIED | TEXT | IMAGE | VIDEO | AUDIO | DOCUMENT |
GoogleCloudAiplatformV1Partobject
A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` must contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IA…
| fileData | GoogleCloudAiplatformV1FileData | URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. | |
| functionCall | GoogleCloudAiplatformV1FunctionCall | 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. | |
| executableCode | GoogleCloudAiplatformV1ExecutableCode | Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. | |
| mediaResolution | GoogleCloudAiplatformV1PartMediaResolution | per part media resolution. Media resolution for the input media. | |
| videoMetadata | GoogleCloudAiplatformV1VideoMetadata | Provides metadata for a video, including the start and end offsets for clipping and the frame rate. | |
| thought | boolean | Optional. Indicates whether the `part` represents the model's thought process or reasoning. | |
| inlineData | GoogleCloudAiplatformV1Blob | A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. | |
| functionResponse | GoogleCloudAiplatformV1FunctionResponse | The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made… | |
| speechMetadata | GoogleCloudAiplatformV1SpeechMetadata | Structured Metadata Sub-Message for Part | |
| audioTranscription | GoogleCloudAiplatformV1AudioTranscription | The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate `Part` with its own `AudioTranscription` carrying the `speaker_label`. | |
| thoughtSignature | string | Optional. An opaque signature for the thought so it can be reused in subsequent requests. | format: byte |
| codeExecutionResult | GoogleCloudAiplatformV1CodeExecutionResult | Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. | |
| text | string | Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. |
GoogleCloudAiplatformV1PartialArgobject
Partial argument value of the function call.
| numberValue | number | Optional. Represents a double value. | format: double |
| willContinue | boolean | Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. | |
| stringValue | string | Optional. Represents a string value. | |
| boolValue | boolean | Optional. Represents a boolean value. | |
| nullValue | enum | Optional. Represents a null value. | NULL_VALUE |
| jsonPath | string | Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". |
GoogleCloudAiplatformV1PartMediaResolutionobject
per part media resolution. Media resolution for the input media.
| level | enum | The tokenization quality used for given media. | MEDIA_RESOLUTION_UNSPECIFIED | MEDIA_RESOLUTION_LOW | MEDIA_RESOLUTION_MEDIUM | MEDIA_RESOLUTION_HIGH | MEDIA_RESOLUTION_ULTRA_HIGH |
GoogleCloudAiplatformV1RagChunkobject
A RagChunk includes the content of a chunk of a RagFile, and associated metadata.
| pageSpan | GoogleCloudAiplatformV1RagChunkPageSpan | Represents where the chunk starts and ends in the document. | |
| text | string | The content of the chunk. | |
| fileId | string | The ID of the file that the chunk belongs to. | |
| chunkId | string | The ID of the chunk. |
GoogleCloudAiplatformV1RagChunkPageSpanobject
Represents where the chunk starts and ends in the document.
| firstPage | integer | Page where chunk starts in the document. Inclusive. 1-indexed. | format: int32 |
| lastPage | integer | Page where chunk ends in the document. Inclusive. 1-indexed. | format: int32 |
GoogleCloudAiplatformV1RetrievalMetadataobject
Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled.
| googleSearchDynamicRetrievalScore | number | Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populate… | format: float |
GoogleCloudAiplatformV1SafetyRatingobject
A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.
| severity | enum | Output only. The severity of harm for this category. | HARM_SEVERITY_UNSPECIFIED | HARM_SEVERITY_NEGLIGIBLE | HARM_SEVERITY_LOW | HARM_SEVERITY_MEDIUM | HARM_SEVERITY_HIGH |
| severityScore | number | Output only. The severity score of harm for this category. | format: float |
| category | enum | Output only. The harm category of this rating. | HARM_CATEGORY_UNSPECIFIED | HARM_CATEGORY_HATE_SPEECH | HARM_CATEGORY_DANGEROUS_CONTENT… | HARM_CATEGORY_HARASSMENT | HARM_CATEGORY_SEXUALLY_EXPLICIT… | HARM_CATEGORY_CIVIC_INTEGRITY · +5 more |
| overwrittenThreshold | enum | Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. | HARM_BLOCK_THRESHOLD_UNSPECIFIE… | BLOCK_LOW_AND_ABOVE | BLOCK_MEDIUM_AND_ABOVE | BLOCK_ONLY_HIGH | BLOCK_NONE | OFF |
| probability | enum | Output only. The probability of harm for this category. | HARM_PROBABILITY_UNSPECIFIED | NEGLIGIBLE | LOW | MEDIUM | HIGH |
| blocked | boolean | Output only. Indicates whether the content was blocked because of this rating. | |
| probabilityScore | number | Output only. The probability score of harm for this category. | format: float |
GoogleCloudAiplatformV1SearchEntryPointobject
An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application.
| renderedContent | string | Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. | |
| sdkBlob | string | Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. | format: byte |
GoogleCloudAiplatformV1Segmentobject
A segment of the content.
| endIndex | integer | Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. | format: int32 |
| startIndex | integer | Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment. | format: int32 |
| partIndex | integer | Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. | format: int32 |
| text | string | Output only. The text of the segment. |
GoogleCloudAiplatformV1SpeechMetadataobject
Structured Metadata Sub-Message for Part
| style | string | Optional. Natural language description of the vocal style (e.g., "cheerful"). | |
| speaker | string | Optional. Identifies which speaker is speaking this turn. |
GoogleCloudAiplatformV1UrlContextMetadataobject
Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.
| urlMetadata | GoogleCloudAiplatformV1UrlMetadata[] | Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. |
GoogleCloudAiplatformV1UrlMetadataobject
The metadata for a single URL retrieval.
| retrievedUrl | string | The URL retrieved by the tool. | |
| urlRetrievalStatus | enum | The status of the URL retrieval. | URL_RETRIEVAL_STATUS_UNSPECIFIE… | URL_RETRIEVAL_STATUS_SUCCESS | URL_RETRIEVAL_STATUS_ERROR |
GoogleCloudAiplatformV1VideoMetadataobject
Provides metadata for a video, including the start and end offsets for clipping and the frame rate.
| fps | number | Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. | format: double |
| endOffset | string | Optional. The end offset of the video. | format: google-duration |
| startOffset | string | Optional. The start offset of the video. | format: google-duration |
GoogleTypeDateobject
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non…
| month | integer | Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. | format: int32 |
| day | integer | Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. | format: int32 |
| year | integer | Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. | format: int32 |
Validate a payload
before you spend tokensshell
$ curl -X POST https://modelschemas.com/v1/validate \
-d '{"provider":"google-vertex","endpointId":"v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}