Close httplib2 connections.
computeTokens(endpoint, body=None, x__xgafv=None)
Return a list of tokens based on the input text.
countTokens(endpoint, body=None, x__xgafv=None)
Perform a token counting.
fetchPredictOperation(endpoint, body=None, x__xgafv=None)
Fetch an asynchronous online prediction operation.
generateContent(model, body=None, x__xgafv=None)
Generate content with multimodal inputs.
predict(endpoint, body=None, x__xgafv=None)
Perform an online prediction.
predictLongRunning(endpoint, body=None, x__xgafv=None)
rawPredict(endpoint, body=None, x__xgafv=None)
Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.
serverStreamingPredict(endpoint, body=None, x__xgafv=None)
Perform a server-side streaming online prediction request for Vertex LLM streaming.
streamGenerateContent(model, body=None, x__xgafv=None)
Generate content with multimodal inputs with streaming support.
streamRawPredict(endpoint, body=None, x__xgafv=None)
Perform a streaming online prediction with an arbitrary HTTP payload.
close()
Close httplib2 connections.
computeTokens(endpoint, body=None, x__xgafv=None)
Return a list of tokens based on the input text.
Args:
endpoint: string, Required. The name of the Endpoint requested to get lists of tokens and token ids. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for ComputeTokens RPC call.
"contents": [ # Optional. Input content.
{ # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
"parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
{ # 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` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
"fileData": { # URI based data. # Optional. URI based data.
"fileUri": "A String", # Required. URI.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data.
},
"functionCall": { # 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. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
"args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
"a_key": "", # Properties of the object.
},
"name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
},
"functionResponse": { # 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 based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
"name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
"response": { # 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.
"a_key": "", # Properties of the object.
},
},
"inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data.
"data": "A String", # Required. Raw bytes.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data.
},
"text": "A String", # Optional. Text part (can be code).
"videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
"endOffset": "A String", # Optional. The end offset of the video.
"startOffset": "A String", # Optional. The start offset of the video.
},
},
],
"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
},
],
"instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.
"",
],
"model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ComputeTokens RPC call.
"tokensInfo": [ # Lists of tokens info from the input. A ComputeTokensRequest could have multiple instances with a prompt in each instance. We also need to return lists of tokens info for the request with multiple instances.
{ # Tokens info with a list of tokens and the corresponding list of token ids.
"role": "A String", # Optional. Optional fields for the role from the corresponding Content.
"tokenIds": [ # A list of token ids from the input.
"A String",
],
"tokens": [ # A list of tokens from the input.
"A String",
],
},
],
}
countTokens(endpoint, body=None, x__xgafv=None)
Perform a token counting.
Args:
endpoint: string, Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for PredictionService.CountTokens.
"contents": [ # Optional. Input content.
{ # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
"parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
{ # 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` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
"fileData": { # URI based data. # Optional. URI based data.
"fileUri": "A String", # Required. URI.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data.
},
"functionCall": { # 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. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
"args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
"a_key": "", # Properties of the object.
},
"name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
},
"functionResponse": { # 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 based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
"name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
"response": { # 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.
"a_key": "", # Properties of the object.
},
},
"inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data.
"data": "A String", # Required. Raw bytes.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data.
},
"text": "A String", # Optional. Text part (can be code).
"videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
"endOffset": "A String", # Optional. The end offset of the video.
"startOffset": "A String", # Optional. The start offset of the video.
},
},
],
"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
},
],
"generationConfig": { # Generation config. # Optional. Generation config that the model will use to generate the response.
"audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
"candidateCount": 42, # Optional. Number of candidates to generate.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. 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.
"responseModalities": [ # Optional. The modalities of the response.
"A String",
],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1Schema
],
"default": "", # Optional. Default value of the data.
"description": "A String", # Optional. The description of the data.
"enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
"A String",
],
"example": "", # Optional. Example of the object. Will only populated when the object is the root.
"format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
"items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
"maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
"maxLength": "A String", # Optional. Maximum length of the Type.STRING
"maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
"maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
"minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
"minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
"minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
"minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
"nullable": True or False, # Optional. Indicates if the value may be null.
"pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
"properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
"a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
},
"propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
"A String",
],
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
"title": "A String", # Optional. The title of the Schema.
"type": "A String", # Optional. The type of the data.
},
"routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
"autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
"modelRoutingPreference": "A String", # The model routing preference.
},
"manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
"modelName": "A String", # The model name to use. Only the public LLM models are accepted. e.g. 'gemini-1.5-pro-001'.
},
},
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
"prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
"voiceName": "A String", # The name of the preset voice to use.
},
},
},
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
"instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.
"",
],
"model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`
"systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.
"parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
{ # 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` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
"fileData": { # URI based data. # Optional. URI based data.
"fileUri": "A String", # Required. URI.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data.
},
"functionCall": { # 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. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
"args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
"a_key": "", # Properties of the object.
},
"name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
},
"functionResponse": { # 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 based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
"name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
"response": { # 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.
"a_key": "", # Properties of the object.
},
},
"inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data.
"data": "A String", # Required. Raw bytes.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data.
},
"text": "A String", # Optional. Text part (can be code).
"videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
"endOffset": "A String", # Optional. The end offset of the video.
"startOffset": "A String", # Optional. The start offset of the video.
},
},
],
"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
},
"tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided.
{ # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
"description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
"name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64.
"parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1Schema
],
"default": "", # Optional. Default value of the data.
"description": "A String", # Optional. The description of the data.
"enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
"A String",
],
"example": "", # Optional. Example of the object. Will only populated when the object is the root.
"format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
"items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
"maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
"maxLength": "A String", # Optional. Maximum length of the Type.STRING
"maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
"maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
"minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
"minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
"minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
"minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
"nullable": True or False, # Optional. Indicates if the value may be null.
"pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
"properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
"a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
},
"propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
"A String",
],
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
"title": "A String", # Optional. The title of the Schema.
"type": "A String", # Optional. The type of the data.
},
"response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1Schema
],
"default": "", # Optional. Default value of the data.
"description": "A String", # Optional. The description of the data.
"enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
"A String",
],
"example": "", # Optional. Example of the object. Will only populated when the object is the root.
"format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
"items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
"maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
"maxLength": "A String", # Optional. Maximum length of the Type.STRING
"maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
"maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
"minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
"minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
"minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
"minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
"nullable": True or False, # Optional. Indicates if the value may be null.
"pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
"properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
"a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
},
"propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
"A String",
],
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
"title": "A String", # Optional. The title of the Schema.
"type": "A String", # Optional. The type of the data.
},
},
],
"googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
},
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
"mode": "A String", # The mode of the predictor to be used in dynamic retrieval.
},
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
{ # The definition of the Rag resource.
"ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
"ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
"A String",
],
},
],
"ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
"filter": { # Config for filters. # Optional. Config for filters.
"metadataFilter": "A String", # Optional. String for metadata filtering.
"vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
"vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
},
"topK": 42, # Optional. The number of contexts to retrieve.
},
"similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
},
},
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for PredictionService.CountTokens.
"totalBillableCharacters": 42, # The total number of billable characters counted across all instances from the request.
"totalTokens": 42, # The total number of tokens counted across all instances from the request.
}
fetchPredictOperation(endpoint, body=None, x__xgafv=None)
Fetch an asynchronous online prediction operation.
Args:
endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for PredictionService.FetchPredictOperation.
"operationName": "A String", # Required. The server-assigned name for the operation.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
generateContent(model, body=None, x__xgafv=None)
Generate content with multimodal inputs.
Args:
model: string, Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for [PredictionService.GenerateContent].
"cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
"contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
{ # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
"parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
{ # 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` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
"fileData": { # URI based data. # Optional. URI based data.
"fileUri": "A String", # Required. URI.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data.
},
"functionCall": { # 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. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
"args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
"a_key": "", # Properties of the object.
},
"name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
},
"functionResponse": { # 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 based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
"name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
"response": { # 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.
"a_key": "", # Properties of the object.
},
},
"inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data.
"data": "A String", # Required. Raw bytes.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data.
},
"text": "A String", # Optional. Text part (can be code).
"videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
"endOffset": "A String", # Optional. The end offset of the video.
"startOffset": "A String", # Optional. The start offset of the video.
},
},
],
"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
},
],
"generationConfig": { # Generation config. # Optional. Generation config.
"audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
"candidateCount": 42, # Optional. Number of candidates to generate.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. 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.
"responseModalities": [ # Optional. The modalities of the response.
"A String",
],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1Schema
],
"default": "", # Optional. Default value of the data.
"description": "A String", # Optional. The description of the data.
"enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
"A String",
],
"example": "", # Optional. Example of the object. Will only populated when the object is the root.
"format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
"items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
"maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
"maxLength": "A String", # Optional. Maximum length of the Type.STRING
"maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
"maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
"minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
"minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
"minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
"minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
"nullable": True or False, # Optional. Indicates if the value may be null.
"pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
"properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
"a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
},
"propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
"A String",
],
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
"title": "A String", # Optional. The title of the Schema.
"type": "A String", # Optional. The type of the data.
},
"routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
"autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
"modelRoutingPreference": "A String", # The model routing preference.
},
"manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
"modelName": "A String", # The model name to use. Only the public LLM models are accepted. e.g. 'gemini-1.5-pro-001'.
},
},
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
"prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
"voiceName": "A String", # The name of the preset voice to use.
},
},
},
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
"labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
"a_key": "A String",
},
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
{ # Safety settings.
"category": "A String", # Required. Harm category.
"method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.
"threshold": "A String", # Required. The harm block threshold.
},
],
"systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.
"parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
{ # 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` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
"fileData": { # URI based data. # Optional. URI based data.
"fileUri": "A String", # Required. URI.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data.
},
"functionCall": { # 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. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
"args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
"a_key": "", # Properties of the object.
},
"name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
},
"functionResponse": { # 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 based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
"name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
"response": { # 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.
"a_key": "", # Properties of the object.
},
},
"inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data.
"data": "A String", # Required. Raw bytes.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data.
},
"text": "A String", # Optional. Text part (can be code).
"videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
"endOffset": "A String", # Optional. The end offset of the video.
"startOffset": "A String", # Optional. The start offset of the video.
},
},
],
"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
},
"toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request.
"functionCallingConfig": { # Function calling config. # Optional. Function calling config.
"allowedFunctionNames": [ # Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided.
"A String",
],
"mode": "A String", # Optional. Function calling mode.
},
},
"tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided.
{ # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
"description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
"name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64.
"parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1Schema
],
"default": "", # Optional. Default value of the data.
"description": "A String", # Optional. The description of the data.
"enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
"A String",
],
"example": "", # Optional. Example of the object. Will only populated when the object is the root.
"format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
"items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
"maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
"maxLength": "A String", # Optional. Maximum length of the Type.STRING
"maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
"maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
"minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
"minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
"minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
"minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
"nullable": True or False, # Optional. Indicates if the value may be null.
"pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
"properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
"a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
},
"propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
"A String",
],
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
"title": "A String", # Optional. The title of the Schema.
"type": "A String", # Optional. The type of the data.
},
"response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1Schema
],
"default": "", # Optional. Default value of the data.
"description": "A String", # Optional. The description of the data.
"enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
"A String",
],
"example": "", # Optional. Example of the object. Will only populated when the object is the root.
"format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
"items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
"maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
"maxLength": "A String", # Optional. Maximum length of the Type.STRING
"maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
"maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
"minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
"minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
"minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
"minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
"nullable": True or False, # Optional. Indicates if the value may be null.
"pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
"properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
"a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
},
"propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
"A String",
],
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
"title": "A String", # Optional. The title of the Schema.
"type": "A String", # Optional. The type of the data.
},
},
],
"googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
},
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
"mode": "A String", # The mode of the predictor to be used in dynamic retrieval.
},
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
{ # The definition of the Rag resource.
"ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
"ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
"A String",
],
},
],
"ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
"filter": { # Config for filters. # Optional. Config for filters.
"metadataFilter": "A String", # Optional. String for metadata filtering.
"vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
"vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
},
"topK": 42, # Optional. The number of contexts to retrieve.
},
"similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
},
},
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for [PredictionService.GenerateContent].
"candidates": [ # Output only. Generated candidates.
{ # A response candidate generated from the model.
"avgLogprobs": 3.14, # Output only. Average log probability score of the candidate.
"citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content.
"citations": [ # Output only. List of citations.
{ # Source attributions for content.
"endIndex": 42, # Output only. End index into the content.
"license": "A String", # Output only. License of the attribution.
"publicationDate": { # 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-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution.
"day": 42, # 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.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"startIndex": 42, # Output only. Start index into the content.
"title": "A String", # Output only. Title of the attribution.
"uri": "A String", # Output only. Url reference of the attribution.
},
],
},
"content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate.
"parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
{ # 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` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
"fileData": { # URI based data. # Optional. URI based data.
"fileUri": "A String", # Required. URI.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data.
},
"functionCall": { # 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. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
"args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
"a_key": "", # Properties of the object.
},
"name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
},
"functionResponse": { # 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 based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
"name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
"response": { # 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.
"a_key": "", # Properties of the object.
},
},
"inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data.
"data": "A String", # Required. Raw bytes.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data.
},
"text": "A String", # Optional. Text part (can be code).
"videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
"endOffset": "A String", # Optional. The end offset of the video.
"startOffset": "A String", # Optional. The start offset of the video.
},
},
],
"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
},
"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.
"finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
"groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content.
"groundingChunks": [ # List of supporting references retrieved from specified grounding source.
{ # Grounding chunk.
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
"text": "A String", # Text of the attribution.
"title": "A String", # Title of the attribution.
"uri": "A String", # URI reference of the attribution.
},
"web": { # Chunk from the web. # Grounding chunk from the web.
"title": "A String", # Title of the chunk.
"uri": "A String", # URI reference of the chunk.
},
},
],
"groundingSupports": [ # Optional. List of grounding support.
{ # Grounding support.
"confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. This list must have the same size as the grounding_chunk_indices.
3.14,
],
"groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.
42,
],
"segment": { # Segment of the content. # Segment of the content this support belongs to.
"endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.
"partIndex": 42, # Output only. The index of a Part object within its parent Content object.
"startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.
"text": "A String", # Output only. The text corresponding to the segment from the response.
},
},
],
"retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata.
"googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.
},
"searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches.
"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview.
"sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple.
},
"webSearchQueries": [ # Optional. Web search queries for the following-up web search.
"A String",
],
},
"index": 42, # Output only. Index of the candidate.
"logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens
"chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.
{ # Candidate for the logprobs token and score.
"logProbability": 3.14, # The candidate's log probability.
"token": "A String", # The candidate's token string value.
"tokenId": 42, # The candidate's token id value.
},
],
"topCandidates": [ # Length = total number of decoding steps.
{ # Candidates with top log probabilities at each decoding step.
"candidates": [ # Sorted by log probability in descending order.
{ # Candidate for the logprobs token and score.
"logProbability": 3.14, # The candidate's log probability.
"token": "A String", # The candidate's token string value.
"tokenId": 42, # The candidate's token id value.
},
],
},
],
},
"safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.
{ # Safety rating corresponding to the generated content.
"blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating.
"category": "A String", # Output only. Harm category.
"probability": "A String", # Output only. Harm probability levels in the content.
"probabilityScore": 3.14, # Output only. Harm probability score.
"severity": "A String", # Output only. Harm severity levels in the content.
"severityScore": 3.14, # Output only. Harm severity score.
},
],
},
],
"modelVersion": "A String", # Output only. The model version used to generate the response.
"promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations.
"blockReason": "A String", # Output only. Blocked reason.
"blockReasonMessage": "A String", # Output only. A readable block reason message.
"safetyRatings": [ # Output only. Safety ratings.
{ # Safety rating corresponding to the generated content.
"blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating.
"category": "A String", # Output only. Harm category.
"probability": "A String", # Output only. Harm probability levels in the content.
"probabilityScore": 3.14, # Output only. Harm probability score.
"severity": "A String", # Output only. Harm severity levels in the content.
"severityScore": 3.14, # Output only. Harm severity score.
},
],
},
"usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s).
"cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content).
"candidatesTokenCount": 42, # Number of tokens in the response(s).
"promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.
"totalTokenCount": 42, # Total token count for prompt and response candidates.
},
}
predict(endpoint, body=None, x__xgafv=None)
Perform an online prediction.
Args:
endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for PredictionService.Predict.
"instances": [ # Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.
"",
],
"parameters": "", # The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for PredictionService.Predict.
"deployedModelId": "A String", # ID of the Endpoint's DeployedModel that served this prediction.
"metadata": "", # Output only. Request-level metadata returned by the model. The metadata type will be dependent upon the model implementation.
"model": "A String", # Output only. The resource name of the Model which is deployed as the DeployedModel that this prediction hits.
"modelDisplayName": "A String", # Output only. The display name of the Model which is deployed as the DeployedModel that this prediction hits.
"modelVersionId": "A String", # Output only. The version ID of the Model which is deployed as the DeployedModel that this prediction hits.
"predictions": [ # The predictions that are the output of the predictions call. The schema of any single prediction may be specified via Endpoint's DeployedModels' Model's PredictSchemata's prediction_schema_uri.
"",
],
}
predictLongRunning(endpoint, body=None, x__xgafv=None)
Args:
endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for PredictionService.PredictLongRunning.
"instances": [ # Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.
"",
],
"parameters": "", # Optional. The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
rawPredict(endpoint, body=None, x__xgafv=None)
Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.
Args:
endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for PredictionService.RawPredict.
"httpBody": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # The prediction input. Supports HTTP headers and arbitrary data payload. A DeployedModel may have an upper limit on the number of instances it supports per request. When this limit it is exceeded for an AutoML model, the RawPredict method returns an error. When this limit is exceeded for a custom-trained model, the behavior varies depending on the model. You can specify the schema for each instance in the predict_schemata.instance_schema_uri field when you create a Model. This schema applies when you deploy the `Model` as a `DeployedModel` to an Endpoint and use the `RawPredict` method.
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
"data": "A String", # The HTTP request/response body as raw binary.
"extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
"data": "A String", # The HTTP request/response body as raw binary.
"extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
}
serverStreamingPredict(endpoint, body=None, x__xgafv=None)
Perform a server-side streaming online prediction request for Vertex LLM streaming.
Args:
endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for PredictionService.StreamingPredict. The first message must contain endpoint field and optionally input. The subsequent messages must contain input.
"inputs": [ # The prediction input.
{ # A tensor value type.
"boolVal": [ # Type specific representations that make it easy to create tensor protos in all languages. Only the representation corresponding to "dtype" can be set. The values hold the flattened representation of the tensor in row major order. BOOL
True or False,
],
"bytesVal": [ # STRING
"A String",
],
"doubleVal": [ # DOUBLE
3.14,
],
"dtype": "A String", # The data type of tensor.
"floatVal": [ # FLOAT
3.14,
],
"int64Val": [ # INT64
"A String",
],
"intVal": [ # INT_8 INT_16 INT_32
42,
],
"listVal": [ # A list of tensor values.
# Object with schema name: GoogleCloudAiplatformV1Tensor
],
"shape": [ # Shape of the tensor.
"A String",
],
"stringVal": [ # STRING
"A String",
],
"structVal": { # A map of string to tensor.
"a_key": # Object with schema name: GoogleCloudAiplatformV1Tensor
},
"tensorVal": "A String", # Serialized raw tensor content.
"uint64Val": [ # UINT64
"A String",
],
"uintVal": [ # UINT8 UINT16 UINT32
42,
],
},
],
"parameters": { # A tensor value type. # The parameters that govern the prediction.
"boolVal": [ # Type specific representations that make it easy to create tensor protos in all languages. Only the representation corresponding to "dtype" can be set. The values hold the flattened representation of the tensor in row major order. BOOL
True or False,
],
"bytesVal": [ # STRING
"A String",
],
"doubleVal": [ # DOUBLE
3.14,
],
"dtype": "A String", # The data type of tensor.
"floatVal": [ # FLOAT
3.14,
],
"int64Val": [ # INT64
"A String",
],
"intVal": [ # INT_8 INT_16 INT_32
42,
],
"listVal": [ # A list of tensor values.
# Object with schema name: GoogleCloudAiplatformV1Tensor
],
"shape": [ # Shape of the tensor.
"A String",
],
"stringVal": [ # STRING
"A String",
],
"structVal": { # A map of string to tensor.
"a_key": # Object with schema name: GoogleCloudAiplatformV1Tensor
},
"tensorVal": "A String", # Serialized raw tensor content.
"uint64Val": [ # UINT64
"A String",
],
"uintVal": [ # UINT8 UINT16 UINT32
42,
],
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for PredictionService.StreamingPredict.
"outputs": [ # The prediction output.
{ # A tensor value type.
"boolVal": [ # Type specific representations that make it easy to create tensor protos in all languages. Only the representation corresponding to "dtype" can be set. The values hold the flattened representation of the tensor in row major order. BOOL
True or False,
],
"bytesVal": [ # STRING
"A String",
],
"doubleVal": [ # DOUBLE
3.14,
],
"dtype": "A String", # The data type of tensor.
"floatVal": [ # FLOAT
3.14,
],
"int64Val": [ # INT64
"A String",
],
"intVal": [ # INT_8 INT_16 INT_32
42,
],
"listVal": [ # A list of tensor values.
# Object with schema name: GoogleCloudAiplatformV1Tensor
],
"shape": [ # Shape of the tensor.
"A String",
],
"stringVal": [ # STRING
"A String",
],
"structVal": { # A map of string to tensor.
"a_key": # Object with schema name: GoogleCloudAiplatformV1Tensor
},
"tensorVal": "A String", # Serialized raw tensor content.
"uint64Val": [ # UINT64
"A String",
],
"uintVal": [ # UINT8 UINT16 UINT32
42,
],
},
],
"parameters": { # A tensor value type. # The parameters that govern the prediction.
"boolVal": [ # Type specific representations that make it easy to create tensor protos in all languages. Only the representation corresponding to "dtype" can be set. The values hold the flattened representation of the tensor in row major order. BOOL
True or False,
],
"bytesVal": [ # STRING
"A String",
],
"doubleVal": [ # DOUBLE
3.14,
],
"dtype": "A String", # The data type of tensor.
"floatVal": [ # FLOAT
3.14,
],
"int64Val": [ # INT64
"A String",
],
"intVal": [ # INT_8 INT_16 INT_32
42,
],
"listVal": [ # A list of tensor values.
# Object with schema name: GoogleCloudAiplatformV1Tensor
],
"shape": [ # Shape of the tensor.
"A String",
],
"stringVal": [ # STRING
"A String",
],
"structVal": { # A map of string to tensor.
"a_key": # Object with schema name: GoogleCloudAiplatformV1Tensor
},
"tensorVal": "A String", # Serialized raw tensor content.
"uint64Val": [ # UINT64
"A String",
],
"uintVal": [ # UINT8 UINT16 UINT32
42,
],
},
}
streamGenerateContent(model, body=None, x__xgafv=None)
Generate content with multimodal inputs with streaming support.
Args:
model: string, Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for [PredictionService.GenerateContent].
"cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
"contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
{ # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
"parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
{ # 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` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
"fileData": { # URI based data. # Optional. URI based data.
"fileUri": "A String", # Required. URI.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data.
},
"functionCall": { # 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. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
"args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
"a_key": "", # Properties of the object.
},
"name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
},
"functionResponse": { # 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 based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
"name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
"response": { # 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.
"a_key": "", # Properties of the object.
},
},
"inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data.
"data": "A String", # Required. Raw bytes.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data.
},
"text": "A String", # Optional. Text part (can be code).
"videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
"endOffset": "A String", # Optional. The end offset of the video.
"startOffset": "A String", # Optional. The start offset of the video.
},
},
],
"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
},
],
"generationConfig": { # Generation config. # Optional. Generation config.
"audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
"candidateCount": 42, # Optional. Number of candidates to generate.
"frequencyPenalty": 3.14, # Optional. Frequency penalties.
"logprobs": 42, # Optional. Logit probabilities.
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
"presencePenalty": 3.14, # Optional. Positive penalties.
"responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
"responseMimeType": "A String", # Optional. 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.
"responseModalities": [ # Optional. The modalities of the response.
"A String",
],
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1Schema
],
"default": "", # Optional. Default value of the data.
"description": "A String", # Optional. The description of the data.
"enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
"A String",
],
"example": "", # Optional. Example of the object. Will only populated when the object is the root.
"format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
"items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
"maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
"maxLength": "A String", # Optional. Maximum length of the Type.STRING
"maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
"maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
"minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
"minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
"minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
"minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
"nullable": True or False, # Optional. Indicates if the value may be null.
"pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
"properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
"a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
},
"propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
"A String",
],
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
"title": "A String", # Optional. The title of the Schema.
"type": "A String", # Optional. The type of the data.
},
"routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
"autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
"modelRoutingPreference": "A String", # The model routing preference.
},
"manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
"modelName": "A String", # The model name to use. Only the public LLM models are accepted. e.g. 'gemini-1.5-pro-001'.
},
},
"seed": 42, # Optional. Seed.
"speechConfig": { # The speech generation config. # Optional. The speech generation config.
"voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
"prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
"voiceName": "A String", # The name of the preset voice to use.
},
},
},
"stopSequences": [ # Optional. Stop sequences.
"A String",
],
"temperature": 3.14, # Optional. Controls the randomness of predictions.
"topK": 3.14, # Optional. If specified, top-k sampling will be used.
"topP": 3.14, # Optional. If specified, nucleus sampling will be used.
},
"labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
"a_key": "A String",
},
"safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
{ # Safety settings.
"category": "A String", # Required. Harm category.
"method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.
"threshold": "A String", # Required. The harm block threshold.
},
],
"systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.
"parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
{ # 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` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
"fileData": { # URI based data. # Optional. URI based data.
"fileUri": "A String", # Required. URI.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data.
},
"functionCall": { # 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. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
"args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
"a_key": "", # Properties of the object.
},
"name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
},
"functionResponse": { # 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 based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
"name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
"response": { # 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.
"a_key": "", # Properties of the object.
},
},
"inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data.
"data": "A String", # Required. Raw bytes.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data.
},
"text": "A String", # Optional. Text part (can be code).
"videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
"endOffset": "A String", # Optional. The end offset of the video.
"startOffset": "A String", # Optional. The start offset of the video.
},
},
],
"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
},
"toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request.
"functionCallingConfig": { # Function calling config. # Optional. Function calling config.
"allowedFunctionNames": [ # Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided.
"A String",
],
"mode": "A String", # Optional. Function calling mode.
},
},
"tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
"functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided.
{ # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
"description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
"name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64.
"parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1Schema
],
"default": "", # Optional. Default value of the data.
"description": "A String", # Optional. The description of the data.
"enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
"A String",
],
"example": "", # Optional. Example of the object. Will only populated when the object is the root.
"format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
"items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
"maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
"maxLength": "A String", # Optional. Maximum length of the Type.STRING
"maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
"maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
"minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
"minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
"minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
"minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
"nullable": True or False, # Optional. Indicates if the value may be null.
"pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
"properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
"a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
},
"propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
"A String",
],
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
"title": "A String", # Optional. The title of the Schema.
"type": "A String", # Optional. The type of the data.
},
"response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: GoogleCloudAiplatformV1Schema
],
"default": "", # Optional. Default value of the data.
"description": "A String", # Optional. The description of the data.
"enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
"A String",
],
"example": "", # Optional. Example of the object. Will only populated when the object is the root.
"format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
"items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
"maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
"maxLength": "A String", # Optional. Maximum length of the Type.STRING
"maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
"maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
"minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
"minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
"minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
"minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
"nullable": True or False, # Optional. Indicates if the value may be null.
"pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
"properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
"a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
},
"propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
"A String",
],
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
"title": "A String", # Optional. The title of the Schema.
"type": "A String", # Optional. The type of the data.
},
},
],
"googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
},
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
"dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
"mode": "A String", # The mode of the predictor to be used in dynamic retrieval.
},
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
"disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
"vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
"ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
{ # The definition of the Rag resource.
"ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
"ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
"A String",
],
},
],
"ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
"filter": { # Config for filters. # Optional. Config for filters.
"metadataFilter": "A String", # Optional. String for metadata filtering.
"vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
"vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
},
"topK": 42, # Optional. The number of contexts to retrieve.
},
"similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
"vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
},
},
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for [PredictionService.GenerateContent].
"candidates": [ # Output only. Generated candidates.
{ # A response candidate generated from the model.
"avgLogprobs": 3.14, # Output only. Average log probability score of the candidate.
"citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content.
"citations": [ # Output only. List of citations.
{ # Source attributions for content.
"endIndex": 42, # Output only. End index into the content.
"license": "A String", # Output only. License of the attribution.
"publicationDate": { # 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-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Publication date of the attribution.
"day": 42, # 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.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"startIndex": 42, # Output only. Start index into the content.
"title": "A String", # Output only. Title of the attribution.
"uri": "A String", # Output only. Url reference of the attribution.
},
],
},
"content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate.
"parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
{ # 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` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
"fileData": { # URI based data. # Optional. URI based data.
"fileUri": "A String", # Required. URI.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data.
},
"functionCall": { # 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. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
"args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
"a_key": "", # Properties of the object.
},
"name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
},
"functionResponse": { # 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 based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
"name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
"response": { # 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.
"a_key": "", # Properties of the object.
},
},
"inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data.
"data": "A String", # Required. Raw bytes.
"mimeType": "A String", # Required. The IANA standard MIME type of the source data.
},
"text": "A String", # Optional. Text part (can be code).
"videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
"endOffset": "A String", # Optional. The end offset of the video.
"startOffset": "A String", # Optional. The start offset of the video.
},
},
],
"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
},
"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.
"finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
"groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content.
"groundingChunks": [ # List of supporting references retrieved from specified grounding source.
{ # Grounding chunk.
"retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
"text": "A String", # Text of the attribution.
"title": "A String", # Title of the attribution.
"uri": "A String", # URI reference of the attribution.
},
"web": { # Chunk from the web. # Grounding chunk from the web.
"title": "A String", # Title of the chunk.
"uri": "A String", # URI reference of the chunk.
},
},
],
"groundingSupports": [ # Optional. List of grounding support.
{ # Grounding support.
"confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. This list must have the same size as the grounding_chunk_indices.
3.14,
],
"groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.
42,
],
"segment": { # Segment of the content. # Segment of the content this support belongs to.
"endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.
"partIndex": 42, # Output only. The index of a Part object within its parent Content object.
"startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.
"text": "A String", # Output only. The text corresponding to the segment from the response.
},
},
],
"retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata.
"googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.
},
"searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches.
"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview.
"sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple.
},
"webSearchQueries": [ # Optional. Web search queries for the following-up web search.
"A String",
],
},
"index": 42, # Output only. Index of the candidate.
"logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens
"chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.
{ # Candidate for the logprobs token and score.
"logProbability": 3.14, # The candidate's log probability.
"token": "A String", # The candidate's token string value.
"tokenId": 42, # The candidate's token id value.
},
],
"topCandidates": [ # Length = total number of decoding steps.
{ # Candidates with top log probabilities at each decoding step.
"candidates": [ # Sorted by log probability in descending order.
{ # Candidate for the logprobs token and score.
"logProbability": 3.14, # The candidate's log probability.
"token": "A String", # The candidate's token string value.
"tokenId": 42, # The candidate's token id value.
},
],
},
],
},
"safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.
{ # Safety rating corresponding to the generated content.
"blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating.
"category": "A String", # Output only. Harm category.
"probability": "A String", # Output only. Harm probability levels in the content.
"probabilityScore": 3.14, # Output only. Harm probability score.
"severity": "A String", # Output only. Harm severity levels in the content.
"severityScore": 3.14, # Output only. Harm severity score.
},
],
},
],
"modelVersion": "A String", # Output only. The model version used to generate the response.
"promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations.
"blockReason": "A String", # Output only. Blocked reason.
"blockReasonMessage": "A String", # Output only. A readable block reason message.
"safetyRatings": [ # Output only. Safety ratings.
{ # Safety rating corresponding to the generated content.
"blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating.
"category": "A String", # Output only. Harm category.
"probability": "A String", # Output only. Harm probability levels in the content.
"probabilityScore": 3.14, # Output only. Harm probability score.
"severity": "A String", # Output only. Harm severity levels in the content.
"severityScore": 3.14, # Output only. Harm severity score.
},
],
},
"usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s).
"cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content).
"candidatesTokenCount": 42, # Number of tokens in the response(s).
"promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.
"totalTokenCount": 42, # Total token count for prompt and response candidates.
},
}
streamRawPredict(endpoint, body=None, x__xgafv=None)
Perform a streaming online prediction with an arbitrary HTTP payload.
Args:
endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for PredictionService.StreamRawPredict.
"httpBody": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # The prediction input. Supports HTTP headers and arbitrary data payload.
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
"data": "A String", # The HTTP request/response body as raw binary.
"extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
"contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
"data": "A String", # The HTTP request/response body as raw binary.
"extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
}