# -*- coding: utf-8 -*- # Copyright 2025 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # from __future__ import annotations from typing import MutableMapping, MutableSequence import proto # type: ignore from cloudsdk.google.protobuf import struct_pb2 # type: ignore from google.type import latlng_pb2 # type: ignore from googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types import api_auth as gca_api_auth from googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types import auth from googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types import openapi __protobuf__ = proto.module( package='google.cloud.aiplatform.v1beta1', manifest={ 'Tool', 'UrlContext', 'ToolUseExample', 'FunctionDeclaration', 'FunctionCall', 'PartialArg', 'FunctionResponsePart', 'FunctionResponseBlob', 'FunctionResponseFileData', 'FunctionResponse', 'ExecutableCode', 'CodeExecutionResult', 'Retrieval', 'VertexRagStore', 'VertexAISearch', 'ExternalApi', 'GoogleSearchRetrieval', 'GoogleMaps', 'EnterpriseWebSearch', 'DynamicRetrievalConfig', 'ToolConfig', 'FunctionCallingConfig', 'RetrievalConfig', 'RagRetrievalConfig', }, ) class Tool(proto.Message): r"""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). Attributes: function_declarations (MutableSequence[googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.FunctionDeclaration]): 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][google.cloud.aiplatform.v1beta1.Part.function_call] in the response. User should provide a [FunctionResponse][google.cloud.aiplatform.v1beta1.Part.function_response] for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. retrieval (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.Retrieval): 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. google_search (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.Tool.GoogleSearch): Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. google_search_retrieval (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.GoogleSearchRetrieval): Optional. Specialized retrieval tool that is powered by Google Search. google_maps (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.GoogleMaps): Optional. GoogleMaps tool type. Tool to support Google Maps in Model. enterprise_web_search (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.EnterpriseWebSearch): Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. parallel_ai_search (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.Tool.ParallelAiSearch): Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation code_execution (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.Tool.CodeExecution): Optional. CodeExecution tool type. Enables the model to execute code as part of generation. url_context (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.UrlContext): Optional. Tool to support URL context retrieval. computer_use (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.Tool.ComputerUse): Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. """ class PhishBlockThreshold(proto.Enum): r"""These are available confidence level user can set to block malicious urls with chosen confidence and above. For understanding different confidence of webrisk, please refer to https://cloud.google.com/web-risk/docs/reference/rpc/google.cloud.webrisk.v1eap1#confidencelevel Values: PHISH_BLOCK_THRESHOLD_UNSPECIFIED (0): Defaults to unspecified. BLOCK_LOW_AND_ABOVE (30): Blocks Low and above confidence URL that is risky. BLOCK_MEDIUM_AND_ABOVE (40): Blocks Medium and above confidence URL that is risky. BLOCK_HIGH_AND_ABOVE (50): Blocks High and above confidence URL that is risky. BLOCK_HIGHER_AND_ABOVE (55): Blocks Higher and above confidence URL that is risky. BLOCK_VERY_HIGH_AND_ABOVE (60): Blocks Very high and above confidence URL that is risky. BLOCK_ONLY_EXTREMELY_HIGH (100): Blocks Extremely high confidence URL that is risky. """ PHISH_BLOCK_THRESHOLD_UNSPECIFIED = 0 BLOCK_LOW_AND_ABOVE = 30 BLOCK_MEDIUM_AND_ABOVE = 40 BLOCK_HIGH_AND_ABOVE = 50 BLOCK_HIGHER_AND_ABOVE = 55 BLOCK_VERY_HIGH_AND_ABOVE = 60 BLOCK_ONLY_EXTREMELY_HIGH = 100 class GoogleSearch(proto.Message): r"""GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields Attributes: exclude_domains (MutableSequence[str]): Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. blocking_confidence (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.Tool.PhishBlockThreshold): Optional. Sites with confidence level chosen & above this value will be blocked from the search results. This field is a member of `oneof`_ ``_blocking_confidence``. """ exclude_domains: MutableSequence[str] = proto.RepeatedField( proto.STRING, number=3, ) blocking_confidence: 'Tool.PhishBlockThreshold' = proto.Field( proto.ENUM, number=4, optional=True, enum='Tool.PhishBlockThreshold', ) class ParallelAiSearch(proto.Message): r"""ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. Attributes: api_key (str): Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more details. custom_configs (google.protobuf.struct_pb2.Struct): Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only ``source_policy``, ``excerpts``, ``max_results``, ``mode``, ``fetch_policy`` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] }, "fetch_policy": { "max_age_seconds": 3600 } } """ api_key: str = proto.Field( proto.STRING, number=1, ) custom_configs: struct_pb2.Struct = proto.Field( proto.MESSAGE, number=3, message=struct_pb2.Struct, ) class CodeExecution(proto.Message): r"""Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. """ class ComputerUse(proto.Message): r"""Tool to support computer use. Attributes: environment (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.Tool.ComputerUse.Environment): Required. The environment being operated. excluded_predefined_functions (MutableSequence[str]): Optional. By default, `predefined functions `__ are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. """ class Environment(proto.Enum): r"""Represents the environment being operated, such as a web browser. Values: ENVIRONMENT_UNSPECIFIED (0): Defaults to browser. ENVIRONMENT_BROWSER (1): Operates in a web browser. """ ENVIRONMENT_UNSPECIFIED = 0 ENVIRONMENT_BROWSER = 1 environment: 'Tool.ComputerUse.Environment' = proto.Field( proto.ENUM, number=1, enum='Tool.ComputerUse.Environment', ) excluded_predefined_functions: MutableSequence[str] = proto.RepeatedField( proto.STRING, number=2, ) function_declarations: MutableSequence['FunctionDeclaration'] = proto.RepeatedField( proto.MESSAGE, number=1, message='FunctionDeclaration', ) retrieval: 'Retrieval' = proto.Field( proto.MESSAGE, number=2, message='Retrieval', ) google_search: GoogleSearch = proto.Field( proto.MESSAGE, number=7, message=GoogleSearch, ) google_search_retrieval: 'GoogleSearchRetrieval' = proto.Field( proto.MESSAGE, number=3, message='GoogleSearchRetrieval', ) google_maps: 'GoogleMaps' = proto.Field( proto.MESSAGE, number=5, message='GoogleMaps', ) enterprise_web_search: 'EnterpriseWebSearch' = proto.Field( proto.MESSAGE, number=6, message='EnterpriseWebSearch', ) parallel_ai_search: ParallelAiSearch = proto.Field( proto.MESSAGE, number=13, message=ParallelAiSearch, ) code_execution: CodeExecution = proto.Field( proto.MESSAGE, number=4, message=CodeExecution, ) url_context: 'UrlContext' = proto.Field( proto.MESSAGE, number=10, message='UrlContext', ) computer_use: ComputerUse = proto.Field( proto.MESSAGE, number=11, message=ComputerUse, ) class UrlContext(proto.Message): r"""Tool to support URL context. """ class ToolUseExample(proto.Message): r"""A single example of the tool usage. This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members. .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields Attributes: extension_operation (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.ToolUseExample.ExtensionOperation): Extension operation to call. This field is a member of `oneof`_ ``Target``. function_name (str): Function name to call. This field is a member of `oneof`_ ``Target``. display_name (str): Required. The display name for example. query (str): Required. Query that should be routed to this tool. request_params (google.protobuf.struct_pb2.Struct): Request parameters used for executing this tool. response_params (google.protobuf.struct_pb2.Struct): Response parameters generated by this tool. response_summary (str): Summary of the tool response to the user query. """ class ExtensionOperation(proto.Message): r"""Identifies one operation of the extension. Attributes: extension (str): Resource name of the extension. operation_id (str): Required. Operation ID of the extension. """ extension: str = proto.Field( proto.STRING, number=1, ) operation_id: str = proto.Field( proto.STRING, number=2, ) extension_operation: ExtensionOperation = proto.Field( proto.MESSAGE, number=10, oneof='Target', message=ExtensionOperation, ) function_name: str = proto.Field( proto.STRING, number=11, oneof='Target', ) display_name: str = proto.Field( proto.STRING, number=1, ) query: str = proto.Field( proto.STRING, number=2, ) request_params: struct_pb2.Struct = proto.Field( proto.MESSAGE, number=3, message=struct_pb2.Struct, ) response_params: struct_pb2.Struct = proto.Field( proto.MESSAGE, number=4, message=struct_pb2.Struct, ) response_summary: str = proto.Field( proto.STRING, number=5, ) class FunctionDeclaration(proto.Message): r"""Structured representation of a function declaration as defined by the `OpenAPI 3.0 specification `__. 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. Attributes: name (str): 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, colons and dashes, with a maximum length of 64. description (str): Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. parameters (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.Schema): 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 parameters_json_schema (google.protobuf.struct_pb2.Value): Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: :: { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } This field is mutually exclusive with ``parameters``. response (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.Schema): 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. response_json_schema (google.protobuf.struct_pb2.Value): Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with ``response``. """ name: str = proto.Field( proto.STRING, number=1, ) description: str = proto.Field( proto.STRING, number=2, ) parameters: openapi.Schema = proto.Field( proto.MESSAGE, number=3, message=openapi.Schema, ) parameters_json_schema: struct_pb2.Value = proto.Field( proto.MESSAGE, number=5, message=struct_pb2.Value, ) response: openapi.Schema = proto.Field( proto.MESSAGE, number=4, message=openapi.Schema, ) response_json_schema: struct_pb2.Value = proto.Field( proto.MESSAGE, number=6, message=struct_pb2.Value, ) class FunctionCall(proto.Message): r"""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. Attributes: id (str): Optional. The unique id of the function call. If populated, the client to execute the ``function_call`` and return the response with the matching ``id``. name (str): Optional. The name of the function to call. Matches [FunctionDeclaration.name]. args (google.protobuf.struct_pb2.Struct): Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. partial_args (MutableSequence[googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.PartialArg]): Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. will_continue (bool): Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. """ id: str = proto.Field( proto.STRING, number=3, ) name: str = proto.Field( proto.STRING, number=1, ) args: struct_pb2.Struct = proto.Field( proto.MESSAGE, number=2, message=struct_pb2.Struct, ) partial_args: MutableSequence['PartialArg'] = proto.RepeatedField( proto.MESSAGE, number=4, message='PartialArg', ) will_continue: bool = proto.Field( proto.BOOL, number=5, ) class PartialArg(proto.Message): r"""Partial argument value of the function call. This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members. .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields Attributes: null_value (google.protobuf.struct_pb2.NullValue): Optional. Represents a null value. This field is a member of `oneof`_ ``delta``. number_value (float): Optional. Represents a double value. This field is a member of `oneof`_ ``delta``. string_value (str): Optional. Represents a string value. This field is a member of `oneof`_ ``delta``. bool_value (bool): Optional. Represents a boolean value. This field is a member of `oneof`_ ``delta``. json_path (str): Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". will_continue (bool): Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. """ null_value: struct_pb2.NullValue = proto.Field( proto.ENUM, number=2, oneof='delta', enum=struct_pb2.NullValue, ) number_value: float = proto.Field( proto.DOUBLE, number=3, oneof='delta', ) string_value: str = proto.Field( proto.STRING, number=4, oneof='delta', ) bool_value: bool = proto.Field( proto.BOOL, number=5, oneof='delta', ) json_path: str = proto.Field( proto.STRING, number=1, ) will_continue: bool = proto.Field( proto.BOOL, number=6, ) class FunctionResponsePart(proto.Message): r"""A datatype containing media that is part of a ``FunctionResponse`` message. A ``FunctionResponsePart`` consists of data which has an associated datatype. A ``FunctionResponsePart`` can only contain one of the accepted types in ``FunctionResponsePart.data``. A ``FunctionResponsePart`` must have a fixed IANA MIME type identifying the type and subtype of the media if the ``inline_data`` field is filled with raw bytes. This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members. .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields Attributes: inline_data (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.FunctionResponseBlob): Inline media bytes. This field is a member of `oneof`_ ``data``. file_data (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.FunctionResponseFileData): URI based data. This field is a member of `oneof`_ ``data``. """ inline_data: 'FunctionResponseBlob' = proto.Field( proto.MESSAGE, number=1, oneof='data', message='FunctionResponseBlob', ) file_data: 'FunctionResponseFileData' = proto.Field( proto.MESSAGE, number=2, oneof='data', message='FunctionResponseFileData', ) class FunctionResponseBlob(proto.Message): r"""Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. Attributes: mime_type (str): Required. The IANA standard MIME type of the source data. data (bytes): Required. Raw bytes. display_name (str): Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. """ mime_type: str = proto.Field( proto.STRING, number=1, ) data: bytes = proto.Field( proto.BYTES, number=2, ) display_name: str = proto.Field( proto.STRING, number=4, ) class FunctionResponseFileData(proto.Message): r"""URI based data for function response. Attributes: mime_type (str): Required. The IANA standard MIME type of the source data. file_uri (str): Required. URI. display_name (str): Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. """ mime_type: str = proto.Field( proto.STRING, number=1, ) file_uri: str = proto.Field( proto.STRING, number=2, ) display_name: str = proto.Field( proto.STRING, number=3, ) class FunctionResponse(proto.Message): r"""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. Attributes: id (str): Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call ``id``. name (str): Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. response (google.protobuf.struct_pb2.Struct): 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. parts (MutableSequence[googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.FunctionResponsePart]): Optional. Ordered ``Parts`` that constitute a function response. Parts may have different IANA MIME types. """ id: str = proto.Field( proto.STRING, number=3, ) name: str = proto.Field( proto.STRING, number=1, ) response: struct_pb2.Struct = proto.Field( proto.MESSAGE, number=2, message=struct_pb2.Struct, ) parts: MutableSequence['FunctionResponsePart'] = proto.RepeatedField( proto.MESSAGE, number=4, message='FunctionResponsePart', ) class ExecutableCode(proto.Message): r"""Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. Attributes: language (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.ExecutableCode.Language): Required. Programming language of the ``code``. code (str): Required. The code to be executed. """ class Language(proto.Enum): r"""Supported programming languages for the generated code. Values: LANGUAGE_UNSPECIFIED (0): Unspecified language. This value should not be used. PYTHON (1): Python >= 3.10, with numpy and simpy available. """ LANGUAGE_UNSPECIFIED = 0 PYTHON = 1 language: Language = proto.Field( proto.ENUM, number=1, enum=Language, ) code: str = proto.Field( proto.STRING, number=2, ) class CodeExecutionResult(proto.Message): r"""Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a ``part`` containing the [ExecutableCode]. Attributes: outcome (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.CodeExecutionResult.Outcome): Required. Outcome of the code execution. output (str): Optional. Contains stdout when code execution is successful, stderr or other description otherwise. """ class Outcome(proto.Enum): r"""Enumeration of possible outcomes of the code execution. Values: OUTCOME_UNSPECIFIED (0): Unspecified status. This value should not be used. OUTCOME_OK (1): Code execution completed successfully. OUTCOME_FAILED (2): Code execution finished but with a failure. ``stderr`` should contain the reason. OUTCOME_DEADLINE_EXCEEDED (3): Code execution ran for too long, and was cancelled. There may or may not be a partial output present. """ OUTCOME_UNSPECIFIED = 0 OUTCOME_OK = 1 OUTCOME_FAILED = 2 OUTCOME_DEADLINE_EXCEEDED = 3 outcome: Outcome = proto.Field( proto.ENUM, number=1, enum=Outcome, ) output: str = proto.Field( proto.STRING, number=2, ) class Retrieval(proto.Message): r"""Defines a retrieval tool that model can call to access external knowledge. This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members. .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields Attributes: vertex_ai_search (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.VertexAISearch): Set to use data source powered by Vertex AI Search. This field is a member of `oneof`_ ``source``. vertex_rag_store (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.VertexRagStore): Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. This field is a member of `oneof`_ ``source``. external_api (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.ExternalApi): Use data source powered by external API for grounding. This field is a member of `oneof`_ ``source``. disable_attribution (bool): Optional. Deprecated. This option is no longer supported. """ vertex_ai_search: 'VertexAISearch' = proto.Field( proto.MESSAGE, number=2, oneof='source', message='VertexAISearch', ) vertex_rag_store: 'VertexRagStore' = proto.Field( proto.MESSAGE, number=4, oneof='source', message='VertexRagStore', ) external_api: 'ExternalApi' = proto.Field( proto.MESSAGE, number=5, oneof='source', message='ExternalApi', ) disable_attribution: bool = proto.Field( proto.BOOL, number=3, ) class VertexRagStore(proto.Message): r"""Retrieve from Vertex RAG Store for grounding. .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields Attributes: rag_corpora (MutableSequence[str]): Optional. Deprecated. Please use rag_resources instead. rag_resources (MutableSequence[googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.VertexRagStore.RagResource]): 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. similarity_top_k (int): Optional. Number of top k results to return from the selected corpora. This field is a member of `oneof`_ ``_similarity_top_k``. vector_distance_threshold (float): Optional. Only return results with vector distance smaller than the threshold. This field is a member of `oneof`_ ``_vector_distance_threshold``. rag_retrieval_config (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.RagRetrievalConfig): Optional. The retrieval config for the Rag query. store_context (bool): Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if ``store_context`` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. """ class RagResource(proto.Message): r"""The definition of the Rag resource. Attributes: rag_corpus (str): Optional. RagCorpora resource name. Format: ``projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`` rag_file_ids (MutableSequence[str]): Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. """ rag_corpus: str = proto.Field( proto.STRING, number=1, ) rag_file_ids: MutableSequence[str] = proto.RepeatedField( proto.STRING, number=2, ) rag_corpora: MutableSequence[str] = proto.RepeatedField( proto.STRING, number=1, ) rag_resources: MutableSequence[RagResource] = proto.RepeatedField( proto.MESSAGE, number=4, message=RagResource, ) similarity_top_k: int = proto.Field( proto.INT32, number=2, optional=True, ) vector_distance_threshold: float = proto.Field( proto.DOUBLE, number=3, optional=True, ) rag_retrieval_config: 'RagRetrievalConfig' = proto.Field( proto.MESSAGE, number=6, message='RagRetrievalConfig', ) store_context: bool = proto.Field( proto.BOOL, number=7, ) class VertexAISearch(proto.Message): r"""Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder Attributes: datastore (str): Optional. Fully-qualified Vertex AI Search data store resource ID. Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`` engine (str): Optional. Fully-qualified Vertex AI Search engine resource ID. Format: ``projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`` max_results (int): Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. filter (str): Optional. Filter strings to be passed to the search API. data_store_specs (MutableSequence[googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.VertexAISearch.DataStoreSpec]): Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. """ class DataStoreSpec(proto.Message): r"""Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec Attributes: data_store (str): Full resource name of DataStore, such as Format: ``projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`` filter (str): Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see `Filtering `__ """ data_store: str = proto.Field( proto.STRING, number=1, ) filter: str = proto.Field( proto.STRING, number=2, ) datastore: str = proto.Field( proto.STRING, number=1, ) engine: str = proto.Field( proto.STRING, number=2, ) max_results: int = proto.Field( proto.INT32, number=3, ) filter: str = proto.Field( proto.STRING, number=4, ) data_store_specs: MutableSequence[DataStoreSpec] = proto.RepeatedField( proto.MESSAGE, number=5, message=DataStoreSpec, ) class ExternalApi(proto.Message): r"""Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members. .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields Attributes: simple_search_params (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.ExternalApi.SimpleSearchParams): Parameters for the simple search API. This field is a member of `oneof`_ ``params``. elastic_search_params (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.ExternalApi.ElasticSearchParams): Parameters for the elastic search API. This field is a member of `oneof`_ ``params``. api_spec (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.ExternalApi.ApiSpec): The API spec that the external API implements. endpoint (str): The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search api_auth (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.ApiAuth): The authentication config to access the API. Deprecated. Please use auth_config instead. auth_config (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.AuthConfig): The authentication config to access the API. """ class ApiSpec(proto.Enum): r"""The API spec that the external API implements. Values: API_SPEC_UNSPECIFIED (0): Unspecified API spec. This value should not be used. SIMPLE_SEARCH (1): Simple search API spec. ELASTIC_SEARCH (2): Elastic search API spec. """ API_SPEC_UNSPECIFIED = 0 SIMPLE_SEARCH = 1 ELASTIC_SEARCH = 2 class SimpleSearchParams(proto.Message): r"""The search parameters to use for SIMPLE_SEARCH spec. """ class ElasticSearchParams(proto.Message): r"""The search parameters to use for the ELASTIC_SEARCH spec. Attributes: index (str): The ElasticSearch index to use. search_template (str): The ElasticSearch search template to use. num_hits (int): Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the ``num_hits`` param. """ index: str = proto.Field( proto.STRING, number=1, ) search_template: str = proto.Field( proto.STRING, number=2, ) num_hits: int = proto.Field( proto.INT32, number=6, ) simple_search_params: SimpleSearchParams = proto.Field( proto.MESSAGE, number=4, oneof='params', message=SimpleSearchParams, ) elastic_search_params: ElasticSearchParams = proto.Field( proto.MESSAGE, number=5, oneof='params', message=ElasticSearchParams, ) api_spec: ApiSpec = proto.Field( proto.ENUM, number=1, enum=ApiSpec, ) endpoint: str = proto.Field( proto.STRING, number=2, ) api_auth: gca_api_auth.ApiAuth = proto.Field( proto.MESSAGE, number=3, message=gca_api_auth.ApiAuth, ) auth_config: auth.AuthConfig = proto.Field( proto.MESSAGE, number=7, message=auth.AuthConfig, ) class GoogleSearchRetrieval(proto.Message): r"""Tool to retrieve public web data for grounding, powered by Google. Attributes: dynamic_retrieval_config (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.DynamicRetrievalConfig): Specifies the dynamic retrieval configuration for the given source. """ dynamic_retrieval_config: 'DynamicRetrievalConfig' = proto.Field( proto.MESSAGE, number=2, message='DynamicRetrievalConfig', ) class GoogleMaps(proto.Message): r"""Tool to retrieve public maps data for grounding, powered by Google. Attributes: enable_widget (bool): Optional. If true, include the widget context token in the response. """ enable_widget: bool = proto.Field( proto.BOOL, number=3, ) class EnterpriseWebSearch(proto.Message): r"""Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields Attributes: exclude_domains (MutableSequence[str]): Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. blocking_confidence (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.Tool.PhishBlockThreshold): Optional. Sites with confidence level chosen & above this value will be blocked from the search results. This field is a member of `oneof`_ ``_blocking_confidence``. """ exclude_domains: MutableSequence[str] = proto.RepeatedField( proto.STRING, number=1, ) blocking_confidence: 'Tool.PhishBlockThreshold' = proto.Field( proto.ENUM, number=4, optional=True, enum='Tool.PhishBlockThreshold', ) class DynamicRetrievalConfig(proto.Message): r"""Describes the options to customize dynamic retrieval. .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields Attributes: mode (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.DynamicRetrievalConfig.Mode): The mode of the predictor to be used in dynamic retrieval. dynamic_threshold (float): Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. This field is a member of `oneof`_ ``_dynamic_threshold``. """ class Mode(proto.Enum): r"""The mode of the predictor to be used in dynamic retrieval. Values: MODE_UNSPECIFIED (0): Always trigger retrieval. MODE_DYNAMIC (1): Run retrieval only when system decides it is necessary. """ MODE_UNSPECIFIED = 0 MODE_DYNAMIC = 1 mode: Mode = proto.Field( proto.ENUM, number=1, enum=Mode, ) dynamic_threshold: float = proto.Field( proto.FLOAT, number=2, optional=True, ) class ToolConfig(proto.Message): r"""Tool config. This config is shared for all tools provided in the request. Attributes: function_calling_config (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.FunctionCallingConfig): Optional. Function calling config. retrieval_config (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.RetrievalConfig): Optional. Retrieval config. """ function_calling_config: 'FunctionCallingConfig' = proto.Field( proto.MESSAGE, number=1, message='FunctionCallingConfig', ) retrieval_config: 'RetrievalConfig' = proto.Field( proto.MESSAGE, number=2, message='RetrievalConfig', ) class FunctionCallingConfig(proto.Message): r"""Function calling config. Attributes: mode (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.FunctionCallingConfig.Mode): Optional. Function calling mode. allowed_function_names (MutableSequence[str]): 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. stream_function_call_arguments (bool): Optional. When set to true, arguments of a single function call will be streamed out in multiple parts/contents/responses. Partial parameter results will be returned in the [FunctionCall.partial_args] field. """ class Mode(proto.Enum): r"""Function calling mode. Values: MODE_UNSPECIFIED (0): Unspecified function calling mode. This value should not be used. AUTO (1): Default model behavior, model decides to predict either function calls or natural language response. ANY (2): Model is constrained to always predicting function calls only. If "allowed_function_names" are set, the predicted function calls will be limited to any one of "allowed_function_names", else the predicted function calls will be any one of the provided "function_declarations". NONE (3): Model will not predict any function calls. Model behavior is same as when not passing any function declarations. VALIDATED (5): Model is constrained to predict either function calls or natural language response. If "allowed_function_names" are set, the predicted function calls will be limited to any one of "allowed_function_names", else the predicted function calls will be any one of the provided "function_declarations". """ MODE_UNSPECIFIED = 0 AUTO = 1 ANY = 2 NONE = 3 VALIDATED = 5 mode: Mode = proto.Field( proto.ENUM, number=1, enum=Mode, ) allowed_function_names: MutableSequence[str] = proto.RepeatedField( proto.STRING, number=2, ) stream_function_call_arguments: bool = proto.Field( proto.BOOL, number=4, ) class RetrievalConfig(proto.Message): r"""Retrieval config. .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields Attributes: lat_lng (google.type.latlng_pb2.LatLng): The location of the user. This field is a member of `oneof`_ ``_lat_lng``. language_code (str): The language code of the user. This field is a member of `oneof`_ ``_language_code``. """ lat_lng: latlng_pb2.LatLng = proto.Field( proto.MESSAGE, number=1, optional=True, message=latlng_pb2.LatLng, ) language_code: str = proto.Field( proto.STRING, number=2, optional=True, ) class RagRetrievalConfig(proto.Message): r"""Specifies the context retrieval config. Attributes: top_k (int): Optional. The number of contexts to retrieve. hybrid_search (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.RagRetrievalConfig.HybridSearch): Optional. Config for Hybrid Search. filter (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.RagRetrievalConfig.Filter): Optional. Config for filters. ranking (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.RagRetrievalConfig.Ranking): Optional. Config for ranking and reranking. """ class HybridSearch(proto.Message): r"""Config for Hybrid Search. .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields Attributes: alpha (float): Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. This field is a member of `oneof`_ ``_alpha``. """ alpha: float = proto.Field( proto.FLOAT, number=1, optional=True, ) class Filter(proto.Message): r"""Config for filters. This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members. .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields Attributes: vector_distance_threshold (float): Optional. Only returns contexts with vector distance smaller than the threshold. This field is a member of `oneof`_ ``vector_db_threshold``. vector_similarity_threshold (float): Optional. Only returns contexts with vector similarity larger than the threshold. This field is a member of `oneof`_ ``vector_db_threshold``. metadata_filter (str): Optional. String for metadata filtering. """ vector_distance_threshold: float = proto.Field( proto.DOUBLE, number=3, oneof='vector_db_threshold', ) vector_similarity_threshold: float = proto.Field( proto.DOUBLE, number=4, oneof='vector_db_threshold', ) metadata_filter: str = proto.Field( proto.STRING, number=2, ) class Ranking(proto.Message): r"""Config for ranking and reranking. This message has `oneof`_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members. .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields Attributes: rank_service (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.RagRetrievalConfig.Ranking.RankService): Optional. Config for Rank Service. This field is a member of `oneof`_ ``ranking_config``. llm_ranker (googlecloudsdk.generated_clients.gapic_clients.aiplatform_v1beta1.types.RagRetrievalConfig.Ranking.LlmRanker): Optional. Config for LlmRanker. This field is a member of `oneof`_ ``ranking_config``. """ class RankService(proto.Message): r"""Config for Rank Service. .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields Attributes: model_name (str): Optional. The model name of the rank service. Format: ``semantic-ranker-512@latest`` This field is a member of `oneof`_ ``_model_name``. """ model_name: str = proto.Field( proto.STRING, number=1, optional=True, ) class LlmRanker(proto.Message): r"""Config for LlmRanker. .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields Attributes: model_name (str): Optional. The model name used for ranking. See `Supported models `__. This field is a member of `oneof`_ ``_model_name``. """ model_name: str = proto.Field( proto.STRING, number=1, optional=True, ) rank_service: 'RagRetrievalConfig.Ranking.RankService' = proto.Field( proto.MESSAGE, number=1, oneof='ranking_config', message='RagRetrievalConfig.Ranking.RankService', ) llm_ranker: 'RagRetrievalConfig.Ranking.LlmRanker' = proto.Field( proto.MESSAGE, number=3, oneof='ranking_config', message='RagRetrievalConfig.Ranking.LlmRanker', ) top_k: int = proto.Field( proto.INT32, number=1, ) hybrid_search: HybridSearch = proto.Field( proto.MESSAGE, number=2, message=HybridSearch, ) filter: Filter = proto.Field( proto.MESSAGE, number=3, message=Filter, ) ranking: Ranking = proto.Field( proto.MESSAGE, number=4, message=Ranking, ) __all__ = tuple(sorted(__protobuf__.manifest))