From 840e463c58748a5ccf596d56cb8e27222e672737 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 19 Mar 2024 07:08:17 +0000 Subject: [PATCH] feat(aiplatform): update the api #### aiplatform:v1 The following keys were deleted: - schemas.GoogleCloudAiplatformV1Endpoint.properties.privateServiceConnectConfig.$ref (Total Keys: 1) The following keys were added: - resources.projects.resources.locations.resources.persistentResources.methods.create (Total Keys: 14) - resources.projects.resources.locations.resources.persistentResources.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.persistentResources.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.persistentResources.methods.list (Total Keys: 16) - resources.projects.resources.locations.resources.persistentResources.methods.patch (Total Keys: 15) - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel (Total Keys: 11) - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get (Total Keys: 11) - schemas.CloudAiNlLlmProtoServicePart.properties.documentMetadata.$ref (Total Keys: 1) - schemas.CloudAiNlLlmProtoServicePartDocumentMetadata (Total Keys: 3) - schemas.CloudAiNlLlmProtoServiceRaiSignal.properties.influentialTerms (Total Keys: 2) - schemas.CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm (Total Keys: 8) - schemas.GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata (Total Keys: 4) - schemas.GoogleCloudAiplatformV1GenerateContentRequest.properties.systemInstructions (Total Keys: 2) - schemas.GoogleCloudAiplatformV1GoogleSearchRetrieval (Total Keys: 3) - schemas.GoogleCloudAiplatformV1ListPersistentResourcesResponse (Total Keys: 5) - schemas.GoogleCloudAiplatformV1PersistentResource (Total Keys: 28) - schemas.GoogleCloudAiplatformV1RayMetricSpec (Total Keys: 3) - schemas.GoogleCloudAiplatformV1RaySpec (Total Keys: 7) - schemas.GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata (Total Keys: 4) - schemas.GoogleCloudAiplatformV1ResourcePool (Total Keys: 17) - schemas.GoogleCloudAiplatformV1ResourceRuntime (Total Keys: 11) - schemas.GoogleCloudAiplatformV1Retrieval (Total Keys: 4) - schemas.GoogleCloudAiplatformV1SafetySetting.properties.method.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1ServiceAccountSpec (Total Keys: 4) - schemas.GoogleCloudAiplatformV1Tool.properties.googleSearchRetrieval.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1Tool.properties.retrieval.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata (Total Keys: 4) - schemas.GoogleCloudAiplatformV1VertexAISearch (Total Keys: 3) The following keys were changed: - endpoints (Total Keys: 1) #### aiplatform:v1beta1 The following keys were deleted: - schemas.GoogleCloudAiplatformV1beta1Endpoint.properties.privateServiceConnectConfig.$ref (Total Keys: 1) The following keys were added: - resources.projects.resources.locations.resources.extensions.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.extensions.methods.execute (Total Keys: 12) - resources.projects.resources.locations.resources.extensions.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.extensions.methods.import (Total Keys: 12) - resources.projects.resources.locations.resources.extensions.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.extensions.methods.patch (Total Keys: 15) - schemas.GoogleCloudAiplatformV1beta1AuthConfig (Total Keys: 30) - schemas.GoogleCloudAiplatformV1beta1ExecuteExtensionRequest (Total Keys: 6) - schemas.GoogleCloudAiplatformV1beta1ExecuteExtensionResponse (Total Keys: 6) - schemas.GoogleCloudAiplatformV1beta1Extension (Total Keys: 30) - schemas.GoogleCloudAiplatformV1beta1GenerateContentRequest.properties.systemInstructions (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1ListExtensionsResponse (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1RebootPersistentResourceOperationMetadata (Total Keys: 4) - schemas.GoogleCloudAiplatformV1beta1SafetySetting.properties.method.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ToolUseExample (Total Keys: 15) The following keys were changed: - endpoints (Total Keys: 1) --- ...tform_v1.projects.locations.endpoints.html | 128 +++- .../dyn/aiplatform_v1.projects.locations.html | 10 + ..._v1.projects.locations.indexEndpoints.html | 2 +- ...platform_v1.projects.locations.models.html | 2 +- ...1.projects.locations.notebookRuntimes.html | 2 +- ...rojects.locations.persistentResources.html | 552 ++++++++++++++ ....projects.locations.publishers.models.html | 96 ++- ...form_v1.projects.locations.tuningJobs.html | 91 +++ ...jects.locations.tuningJobs.operations.html | 145 ++++ ..._v1beta1.projects.locations.endpoints.html | 108 ++- ...v1beta1.projects.locations.extensions.html | 641 ++++++++++++++++ ...ions.featureOnlineStores.featureViews.html | 8 +- ...1.projects.locations.notebookRuntimes.html | 2 +- ....projects.locations.publishers.models.html | 78 +- .../documents/aiplatform.v1.json | 713 +++++++++++++++++- .../documents/aiplatform.v1beta1.json | 641 +++++++++++++++- 16 files changed, 3104 insertions(+), 115 deletions(-) create mode 100644 docs/dyn/aiplatform_v1.projects.locations.persistentResources.html create mode 100644 docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html create mode 100644 docs/dyn/aiplatform_v1.projects.locations.tuningJobs.operations.html diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index 4403629b425..a35e488eed8 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -427,12 +427,6 @@

Method Details

"enabled": True or False, # If logging is enabled or not. "samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1]. }, - "privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive. - "enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect. - "projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment. - "A String", - ], - }, "trafficSplit": { # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. "a_key": 42, }, @@ -1110,16 +1104,51 @@

Method Details

"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. }, ], + "systemInstructions": [ # Optional. The user provided system instructions for the model. + { # 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. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # Raw media bytes. Text should not be sent as raw bytes, use the 'text' field. # Optional. Inlined bytes data. + "data": "A String", # Required. Raw bytes for media formats. + "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 64 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 and parameters. 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 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). 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. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "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). 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 "description": "A String", # Optional. The description of the data. "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} "A String", @@ -1138,6 +1167,15 @@

Method Details

}, }, ], + "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. + "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + }, + "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. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. + "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. projects/<>/locations/<>/collections/<>/dataStores/<> + }, + }, }, ], } @@ -1440,12 +1478,6 @@

Method Details

"enabled": True or False, # If logging is enabled or not. "samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1]. }, - "privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive. - "enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect. - "projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment. - "A String", - ], - }, "trafficSplit": { # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. "a_key": 42, }, @@ -1459,7 +1491,7 @@

Method Details

Args: parent: string, Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project}/locations/{location}` (required) - filter: string, Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports = and, != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` + filter: string, Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports = and, != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports = Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. pageSize: integer, Optional. The standard list page size. pageToken: string, Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call. @@ -1643,12 +1675,6 @@

Method Details

"enabled": True or False, # If logging is enabled or not. "samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1]. }, - "privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive. - "enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect. - "projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment. - "A String", - ], - }, "trafficSplit": { # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. "a_key": 42, }, @@ -2038,12 +2064,6 @@

Method Details

"enabled": True or False, # If logging is enabled or not. "samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1]. }, - "privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive. - "enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect. - "projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment. - "A String", - ], - }, "trafficSplit": { # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. "a_key": 42, }, @@ -2228,12 +2248,6 @@

Method Details

"enabled": True or False, # If logging is enabled or not. "samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1]. }, - "privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive. - "enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect. - "projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment. - "A String", - ], - }, "trafficSplit": { # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. "a_key": 42, }, @@ -2562,16 +2576,51 @@

Method Details

"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. }, ], + "systemInstructions": [ # Optional. The user provided system instructions for the model. + { # 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. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # Raw media bytes. Text should not be sent as raw bytes, use the 'text' field. # Optional. Inlined bytes data. + "data": "A String", # Required. Raw bytes for media formats. + "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 64 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 and parameters. 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 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). 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. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "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). 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 "description": "A String", # Optional. The description of the data. "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} "A String", @@ -2590,6 +2639,15 @@

Method Details

}, }, ], + "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. + "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + }, + "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. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. + "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. projects/<>/locations/<>/collections/<>/dataStores/<> + }, + }, }, ], } diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html index cb9c1ae83f6..ea145746d2e 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -174,6 +174,11 @@

Instance Methods

Returns the operations Resource.

+

+ persistentResources() +

+

Returns the persistentResources Resource.

+

pipelineJobs()

@@ -209,6 +214,11 @@

Instance Methods

Returns the trainingPipelines Resource.

+

+ tuningJobs() +

+

Returns the tuningJobs Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html b/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html index 9c9df7d2c88..44d2d5368b8 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html @@ -377,7 +377,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # The request message for MatchService.FindNeighbors. +{ # LINT.IfChange The request message for MatchService.FindNeighbors. "deployedIndexId": "A String", # The ID of the DeployedIndex that will serve the request. This request is sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index has a DeployedIndex.id field. The value of the field below must equal one of the DeployedIndex.id fields of the IndexEndpoint that is being called for this request. "queries": [ # The list of queries. { # A query to find a number of the nearest neighbors (most similar vectors) of a vector. diff --git a/docs/dyn/aiplatform_v1.projects.locations.models.html b/docs/dyn/aiplatform_v1.projects.locations.models.html index fe519a8f93f..69a718b2c4a 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.models.html @@ -598,7 +598,7 @@

Method Details

Args: parent: string, Required. The resource name of the Location to list the Models from. Format: `projects/{project}/locations/{location}` (required) - filter: string, An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `model=1234` * `displayName="myDisplayName"` * `labels.myKey="myValue"` + filter: string, An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. pageSize: integer, The standard list page size. pageToken: string, The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call. diff --git a/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimes.html b/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimes.html index f65386037b3..91e49376c98 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimes.html +++ b/docs/dyn/aiplatform_v1.projects.locations.notebookRuntimes.html @@ -268,7 +268,7 @@

Method Details

Args: parent: string, Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project}/locations/{location}` (required) - filter: string, Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` + filter: string, Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. pageSize: integer, Optional. The standard list page size. pageToken: string, Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call. diff --git a/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html b/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html new file mode 100644 index 00000000000..a04edd83759 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html @@ -0,0 +1,552 @@ + + + +

Vertex AI API . projects . locations . persistentResources

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, persistentResourceId=None, x__xgafv=None)

+

Creates a PersistentResource.

+

+ delete(name, x__xgafv=None)

+

Deletes a PersistentResource.

+

+ get(name, x__xgafv=None)

+

Gets a PersistentResource.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists PersistentResources in a Location.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a PersistentResource.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, persistentResourceId=None, x__xgafv=None) + 
Creates a PersistentResource.
+
+Args:
+  parent: string, Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents long-lasting resources that are dedicated to users to runs custom workloads. A PersistentResource can have multiple node pools and each node pool can have its own machine spec.
+  "createTime": "A String", # Output only. Time when the PersistentResource was created.
+  "displayName": "A String", # Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+  "encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Optional. Customer-managed encryption key spec for a PersistentResource. If set, this PersistentResource and all sub-resources of this PersistentResource will be secured by this key.
+    "kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
+  },
+  "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). # Output only. Only populated when persistent resource's state is `STOPPING` or `ERROR`.
+    "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.
+  },
+  "labels": { # Optional. The labels with user-defined metadata to organize PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Immutable. Resource name of a PersistentResource.
+  "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.
+  "reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
+    "A String",
+  ],
+  "resourcePools": [ # Required. The spec of the pools of different resources.
+    { # Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource.
+      "autoscalingSpec": { # The min/max number of replicas allowed if enabling autoscaling # Optional. Optional spec to configure GKE autoscaling
+        "maxReplicaCount": "A String", # Optional. max replicas in the node pool, must be ≥ replica_count and > min_replica_count or will throw error
+        "minReplicaCount": "A String", # Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error
+      },
+      "diskSpec": { # Represents the spec of disk options. # Optional. Disk spec for the machine in this node pool.
+        "bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB).
+        "bootDiskType": "A String", # Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
+      },
+      "id": "A String", # Immutable. The unique ID in a PersistentResource for referring to this resource pool. User can specify it if necessary. Otherwise, it's generated automatically.
+      "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine.
+        "acceleratorCount": 42, # The number of accelerators to attach to the machine.
+        "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
+        "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
+        "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
+      },
+      "replicaCount": "A String", # Optional. The total number of machines to use for this resource pool.
+      "usedReplicaCount": "A String", # Output only. The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count.
+    },
+  ],
+  "resourceRuntime": { # Persistent Cluster runtime information as output # Output only. Runtime information of the Persistent Resource.
+    "accessUris": { # Output only. URIs for user to connect to the Cluster. Example: { "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" }
+      "a_key": "A String",
+    },
+    "notebookRuntimeTemplate": "A String", # Output only. The resource name of NotebookRuntimeTemplate for the RoV Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if set), and with the same Ray and Python version as the Persistent Cluster. Example: "projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123"
+  },
+  "resourceRuntimeSpec": { # Configuration for the runtime on a PersistentResource instance, including but not limited to: * Service accounts used to run the workloads. * Whether to make it a dedicated Ray Cluster. # Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration.
+    "raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource.
+      "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set.
+      "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.
+      "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations.
+        "disabled": True or False, # Optional. Flag to disable the Ray metrics collection.
+      },
+      "resourcePoolImages": { # Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" }
+        "a_key": "A String",
+      },
+    },
+    "serviceAccountSpec": { # Configuration for the use of custom service account to run the workloads. # Optional. Configure the use of workload identity on the PersistentResource
+      "enableCustomServiceAccount": True or False, # Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
+      "serviceAccount": "A String", # Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers are specified in `ResourceRuntimeSpec`.
+    },
+  },
+  "startTime": "A String", # Output only. Time when the PersistentResource for the first time entered the `RUNNING` state.
+  "state": "A String", # Output only. The detailed state of a Study.
+  "updateTime": "A String", # Output only. Time when the PersistentResource was most recently updated.
+}
+
+  persistentResourceId: string, Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.
+  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.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) + 
Deletes a PersistentResource.
+
+Args:
+  name: string, Required. The name of the PersistentResource to be deleted. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}` (required)
+  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.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) + 
Gets a PersistentResource.
+
+Args:
+  name: string, Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents long-lasting resources that are dedicated to users to runs custom workloads. A PersistentResource can have multiple node pools and each node pool can have its own machine spec.
+  "createTime": "A String", # Output only. Time when the PersistentResource was created.
+  "displayName": "A String", # Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+  "encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Optional. Customer-managed encryption key spec for a PersistentResource. If set, this PersistentResource and all sub-resources of this PersistentResource will be secured by this key.
+    "kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
+  },
+  "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). # Output only. Only populated when persistent resource's state is `STOPPING` or `ERROR`.
+    "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.
+  },
+  "labels": { # Optional. The labels with user-defined metadata to organize PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Immutable. Resource name of a PersistentResource.
+  "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.
+  "reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
+    "A String",
+  ],
+  "resourcePools": [ # Required. The spec of the pools of different resources.
+    { # Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource.
+      "autoscalingSpec": { # The min/max number of replicas allowed if enabling autoscaling # Optional. Optional spec to configure GKE autoscaling
+        "maxReplicaCount": "A String", # Optional. max replicas in the node pool, must be ≥ replica_count and > min_replica_count or will throw error
+        "minReplicaCount": "A String", # Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error
+      },
+      "diskSpec": { # Represents the spec of disk options. # Optional. Disk spec for the machine in this node pool.
+        "bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB).
+        "bootDiskType": "A String", # Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
+      },
+      "id": "A String", # Immutable. The unique ID in a PersistentResource for referring to this resource pool. User can specify it if necessary. Otherwise, it's generated automatically.
+      "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine.
+        "acceleratorCount": 42, # The number of accelerators to attach to the machine.
+        "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
+        "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
+        "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
+      },
+      "replicaCount": "A String", # Optional. The total number of machines to use for this resource pool.
+      "usedReplicaCount": "A String", # Output only. The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count.
+    },
+  ],
+  "resourceRuntime": { # Persistent Cluster runtime information as output # Output only. Runtime information of the Persistent Resource.
+    "accessUris": { # Output only. URIs for user to connect to the Cluster. Example: { "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" }
+      "a_key": "A String",
+    },
+    "notebookRuntimeTemplate": "A String", # Output only. The resource name of NotebookRuntimeTemplate for the RoV Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if set), and with the same Ray and Python version as the Persistent Cluster. Example: "projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123"
+  },
+  "resourceRuntimeSpec": { # Configuration for the runtime on a PersistentResource instance, including but not limited to: * Service accounts used to run the workloads. * Whether to make it a dedicated Ray Cluster. # Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration.
+    "raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource.
+      "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set.
+      "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.
+      "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations.
+        "disabled": True or False, # Optional. Flag to disable the Ray metrics collection.
+      },
+      "resourcePoolImages": { # Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" }
+        "a_key": "A String",
+      },
+    },
+    "serviceAccountSpec": { # Configuration for the use of custom service account to run the workloads. # Optional. Configure the use of workload identity on the PersistentResource
+      "enableCustomServiceAccount": True or False, # Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
+      "serviceAccount": "A String", # Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers are specified in `ResourceRuntimeSpec`.
+    },
+  },
+  "startTime": "A String", # Output only. Time when the PersistentResource for the first time entered the `RUNNING` state.
+  "state": "A String", # Output only. The detailed state of a Study.
+  "updateTime": "A String", # Output only. Time when the PersistentResource was most recently updated.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists PersistentResources in a Location.
+
+Args:
+  parent: string, Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project}/locations/{location}` (required)
+  pageSize: integer, Optional. The standard list page size.
+  pageToken: string, Optional. The standard list page token. Typically obtained via ListPersistentResourceResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call.
+  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 PersistentResourceService.ListPersistentResources
+  "nextPageToken": "A String", # A token to retrieve next page of results. Pass to ListPersistentResourcesRequest.page_token to obtain that page.
+  "persistentResources": [
+    { # Represents long-lasting resources that are dedicated to users to runs custom workloads. A PersistentResource can have multiple node pools and each node pool can have its own machine spec.
+      "createTime": "A String", # Output only. Time when the PersistentResource was created.
+      "displayName": "A String", # Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+      "encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Optional. Customer-managed encryption key spec for a PersistentResource. If set, this PersistentResource and all sub-resources of this PersistentResource will be secured by this key.
+        "kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
+      },
+      "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). # Output only. Only populated when persistent resource's state is `STOPPING` or `ERROR`.
+        "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.
+      },
+      "labels": { # Optional. The labels with user-defined metadata to organize PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
+        "a_key": "A String",
+      },
+      "name": "A String", # Immutable. Resource name of a PersistentResource.
+      "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.
+      "reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
+        "A String",
+      ],
+      "resourcePools": [ # Required. The spec of the pools of different resources.
+        { # Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource.
+          "autoscalingSpec": { # The min/max number of replicas allowed if enabling autoscaling # Optional. Optional spec to configure GKE autoscaling
+            "maxReplicaCount": "A String", # Optional. max replicas in the node pool, must be ≥ replica_count and > min_replica_count or will throw error
+            "minReplicaCount": "A String", # Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error
+          },
+          "diskSpec": { # Represents the spec of disk options. # Optional. Disk spec for the machine in this node pool.
+            "bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB).
+            "bootDiskType": "A String", # Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
+          },
+          "id": "A String", # Immutable. The unique ID in a PersistentResource for referring to this resource pool. User can specify it if necessary. Otherwise, it's generated automatically.
+          "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine.
+            "acceleratorCount": 42, # The number of accelerators to attach to the machine.
+            "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
+            "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
+            "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
+          },
+          "replicaCount": "A String", # Optional. The total number of machines to use for this resource pool.
+          "usedReplicaCount": "A String", # Output only. The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count.
+        },
+      ],
+      "resourceRuntime": { # Persistent Cluster runtime information as output # Output only. Runtime information of the Persistent Resource.
+        "accessUris": { # Output only. URIs for user to connect to the Cluster. Example: { "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" }
+          "a_key": "A String",
+        },
+        "notebookRuntimeTemplate": "A String", # Output only. The resource name of NotebookRuntimeTemplate for the RoV Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if set), and with the same Ray and Python version as the Persistent Cluster. Example: "projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123"
+      },
+      "resourceRuntimeSpec": { # Configuration for the runtime on a PersistentResource instance, including but not limited to: * Service accounts used to run the workloads. * Whether to make it a dedicated Ray Cluster. # Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration.
+        "raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource.
+          "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set.
+          "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.
+          "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations.
+            "disabled": True or False, # Optional. Flag to disable the Ray metrics collection.
+          },
+          "resourcePoolImages": { # Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" }
+            "a_key": "A String",
+          },
+        },
+        "serviceAccountSpec": { # Configuration for the use of custom service account to run the workloads. # Optional. Configure the use of workload identity on the PersistentResource
+          "enableCustomServiceAccount": True or False, # Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
+          "serviceAccount": "A String", # Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers are specified in `ResourceRuntimeSpec`.
+        },
+      },
+      "startTime": "A String", # Output only. Time when the PersistentResource for the first time entered the `RUNNING` state.
+      "state": "A String", # Output only. The detailed state of a Study.
+      "updateTime": "A String", # Output only. Time when the PersistentResource was most recently updated.
+    },
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates a PersistentResource.
+
+Args:
+  name: string, Immutable. Resource name of a PersistentResource. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents long-lasting resources that are dedicated to users to runs custom workloads. A PersistentResource can have multiple node pools and each node pool can have its own machine spec.
+  "createTime": "A String", # Output only. Time when the PersistentResource was created.
+  "displayName": "A String", # Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+  "encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Optional. Customer-managed encryption key spec for a PersistentResource. If set, this PersistentResource and all sub-resources of this PersistentResource will be secured by this key.
+    "kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
+  },
+  "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). # Output only. Only populated when persistent resource's state is `STOPPING` or `ERROR`.
+    "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.
+  },
+  "labels": { # Optional. The labels with user-defined metadata to organize PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Immutable. Resource name of a PersistentResource.
+  "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.
+  "reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
+    "A String",
+  ],
+  "resourcePools": [ # Required. The spec of the pools of different resources.
+    { # Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource.
+      "autoscalingSpec": { # The min/max number of replicas allowed if enabling autoscaling # Optional. Optional spec to configure GKE autoscaling
+        "maxReplicaCount": "A String", # Optional. max replicas in the node pool, must be ≥ replica_count and > min_replica_count or will throw error
+        "minReplicaCount": "A String", # Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error
+      },
+      "diskSpec": { # Represents the spec of disk options. # Optional. Disk spec for the machine in this node pool.
+        "bootDiskSizeGb": 42, # Size in GB of the boot disk (default is 100GB).
+        "bootDiskType": "A String", # Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
+      },
+      "id": "A String", # Immutable. The unique ID in a PersistentResource for referring to this resource pool. User can specify it if necessary. Otherwise, it's generated automatically.
+      "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine.
+        "acceleratorCount": 42, # The number of accelerators to attach to the machine.
+        "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
+        "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
+        "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
+      },
+      "replicaCount": "A String", # Optional. The total number of machines to use for this resource pool.
+      "usedReplicaCount": "A String", # Output only. The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count.
+    },
+  ],
+  "resourceRuntime": { # Persistent Cluster runtime information as output # Output only. Runtime information of the Persistent Resource.
+    "accessUris": { # Output only. URIs for user to connect to the Cluster. Example: { "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" }
+      "a_key": "A String",
+    },
+    "notebookRuntimeTemplate": "A String", # Output only. The resource name of NotebookRuntimeTemplate for the RoV Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if set), and with the same Ray and Python version as the Persistent Cluster. Example: "projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123"
+  },
+  "resourceRuntimeSpec": { # Configuration for the runtime on a PersistentResource instance, including but not limited to: * Service accounts used to run the workloads. * Whether to make it a dedicated Ray Cluster. # Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration.
+    "raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource.
+      "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set.
+      "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.
+      "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations.
+        "disabled": True or False, # Optional. Flag to disable the Ray metrics collection.
+      },
+      "resourcePoolImages": { # Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" }
+        "a_key": "A String",
+      },
+    },
+    "serviceAccountSpec": { # Configuration for the use of custom service account to run the workloads. # Optional. Configure the use of workload identity on the PersistentResource
+      "enableCustomServiceAccount": True or False, # Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
+      "serviceAccount": "A String", # Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers are specified in `ResourceRuntimeSpec`.
+    },
+  },
+  "startTime": "A String", # Output only. Time when the PersistentResource for the first time entered the `RUNNING` state.
+  "state": "A String", # Output only. The detailed state of a Study.
+  "updateTime": "A String", # Output only. Time when the PersistentResource was most recently updated.
+}
+
+  updateMask: string, Required. Specify the fields to be overwritten in the PersistentResource by the update method.
+  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.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index 15c220dd018..1e2a359dcc1 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -265,16 +265,51 @@

Method Details

"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. }, ], + "systemInstructions": [ # Optional. The user provided system instructions for the model. + { # 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. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # Raw media bytes. Text should not be sent as raw bytes, use the 'text' field. # Optional. Inlined bytes data. + "data": "A String", # Required. Raw bytes for media formats. + "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 64 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 and parameters. 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 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). 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. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "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). 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 "description": "A String", # Optional. The description of the data. "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} "A String", @@ -293,6 +328,15 @@

Method Details

}, }, ], + "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. + "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + }, + "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. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. + "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. projects/<>/locations/<>/collections/<>/dataStores/<> + }, + }, }, ], } @@ -733,16 +777,51 @@

Method Details

"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. }, ], + "systemInstructions": [ # Optional. The user provided system instructions for the model. + { # 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. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # Raw media bytes. Text should not be sent as raw bytes, use the 'text' field. # Optional. Inlined bytes data. + "data": "A String", # Required. Raw bytes for media formats. + "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 64 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 and parameters. 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 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). 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. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "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). 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 "description": "A String", # Optional. The description of the data. "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} "A String", @@ -761,6 +840,15 @@

Method Details

}, }, ], + "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. + "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + }, + "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. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. + "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. projects/<>/locations/<>/collections/<>/dataStores/<> + }, + }, }, ], } diff --git a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html new file mode 100644 index 00000000000..481ce416f99 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . projects . locations . tuningJobs

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.operations.html b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.operations.html new file mode 100644 index 00000000000..ee80de85d19 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.operations.html @@ -0,0 +1,145 @@ + + + +

Vertex AI API . projects . locations . tuningJobs . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) + 
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  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.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index e54e2d4f65c..a209ceabceb 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -439,12 +439,6 @@

Method Details

"enabled": True or False, # If logging is enabled or not. "samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1]. }, - "privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive. - "enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect. - "projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment. - "A String", - ], - }, "trafficSplit": { # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. "a_key": 42, }, @@ -1256,16 +1250,51 @@

Method Details

"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. }, ], + "systemInstructions": [ # Optional. The user provided system instructions for the model. + { # 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. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # Raw media bytes. Text should not be sent as raw bytes, use the 'text' field. # Optional. Inlined bytes data. + "data": "A String", # Required. Raw bytes for media formats. + "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 64 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 and parameters. 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 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). 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. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "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). 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 "description": "A String", # Optional. The description of the data. "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} "A String", @@ -1601,12 +1630,6 @@

Method Details

"enabled": True or False, # If logging is enabled or not. "samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1]. }, - "privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive. - "enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect. - "projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment. - "A String", - ], - }, "trafficSplit": { # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. "a_key": 42, }, @@ -1844,12 +1867,6 @@

Method Details

"enabled": True or False, # If logging is enabled or not. "samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1]. }, - "privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive. - "enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect. - "projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment. - "A String", - ], - }, "trafficSplit": { # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. "a_key": 42, }, @@ -2251,12 +2268,6 @@

Method Details

"enabled": True or False, # If logging is enabled or not. "samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1]. }, - "privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive. - "enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect. - "projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment. - "A String", - ], - }, "trafficSplit": { # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. "a_key": 42, }, @@ -2447,12 +2458,6 @@

Method Details

"enabled": True or False, # If logging is enabled or not. "samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1]. }, - "privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive. - "enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect. - "projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment. - "A String", - ], - }, "trafficSplit": { # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. "a_key": 42, }, @@ -2839,16 +2844,51 @@

Method Details

"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. }, ], + "systemInstructions": [ # Optional. The user provided system instructions for the model. + { # 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. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # Raw media bytes. Text should not be sent as raw bytes, use the 'text' field. # Optional. Inlined bytes data. + "data": "A String", # Required. Raw bytes for media formats. + "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 64 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 and parameters. 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 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). 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. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "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). 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 "description": "A String", # Optional. The description of the data. "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} "A String", diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html index 9f25bf1a7bb..e6c65f92b86 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html @@ -87,10 +87,651 @@

Instance Methods

close()

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes an Extension.

+

+ execute(name, body=None, x__xgafv=None)

+

Executes the request against a given extension.

+

+ get(name, x__xgafv=None)

+

Gets an Extension.

+

+ import_(parent, body=None, x__xgafv=None)

+

Imports an Extension.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists Extensions in a location.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates an Extension.

Method Details

close() 
Close httplib2 connections.
+
+ delete(name, x__xgafv=None) + 
Deletes an Extension.
+
+Args:
+  name: string, Required. The name of the Extension resource to be deleted. Format: `projects/{project}/locations/{location}/extensions/{extension}` (required)
+  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.
+  },
+}
+
+ +
+ execute(name, body=None, x__xgafv=None) + 
Executes the request against a given extension.
+
+Args:
+  name: string, Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ExtensionExecutionService.ExecuteExtension.
+  "operationId": "A String", # Required. The operation to be executed in this extension as defined in ExtensionOperation.operation_id.
+  "operationParams": { # Optional. Request parameters that will be used for executing this operation. The struct should be in a form of map with param name as the key and actual param value as the value. E.g. If this operation requires a param "name" to be set to "abc". you can set this to something like {"name": "abc"}.
+    "a_key": "", # Properties of the object.
+  },
+  "runtimeAuthConfig": { # Auth configuration to run the extension. # Optional. Auth config provided at runtime to override the default value in Extension.manifest.auth_config. The AuthConfig.auth_type should match the value in Extension.manifest.auth_config.
+    "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+      "apiKeySecret": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}`
+      "httpElementLocation": "A String", # Required. The location of the API key.
+      "name": "A String", # Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
+    },
+    "authType": "A String", # Type of auth scheme.
+    "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
+      "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If it is not specified, the Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) will be used. - If the service account is provided, the service account should grant Vertex AI Extension Service Agent `iam.serviceAccounts.getAccessToken` permission.
+    },
+    "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
+      "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}`
+    },
+    "noAuth": { # Empty message, used to indicate no authentication for an endpoint. # Config for no auth.
+    },
+    "oauthConfig": { # Config for user oauth. # Config for user oauth.
+      "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from ExecuteExtensionRequest.runtime_auth_config at request time.
+      "serviceAccount": "A String", # The service account that the extension execution service will use to query extension. Used for generating OAuth token on behalf of provided service account. - If the service account is provided, the service account should grant Vertex AI Service Agent `iam.serviceAccounts.getAccessToken` permission.
+    },
+    "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth.
+      "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from ExecuteExtensionRequest.runtime_auth_config at request time.
+    },
+  },
+}
+
+  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 ExtensionExecutionService.ExecuteExtension.
+  "content": "A String", # Response content from the extension. The content should be conformant to the response.content schema in the extension's manifest/OpenAPI spec.
+  "output": { # Output from the extension. The output should be conformant to the extension's manifest/OpenAPI spec. The output can contain values for keys like "content", "headers", etc. This field is deprecated, please use content field below for the extension execution result.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) + 
Gets an Extension.
+
+Args:
+  name: string, Required. The name of the Extension resource. Format: `projects/{project}/locations/{location}/extensions/{extension}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Extensions are tools for large language models to access external data, run computations, etc.
+  "createTime": "A String", # Output only. Timestamp when this Extension was created.
+  "description": "A String", # Optional. The description of the Extension.
+  "displayName": "A String", # Required. The display name of the Extension. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+  "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
+  "extensionOperations": [ # Output only. Supported operations.
+    { # Operation of an extension.
+      "functionDeclaration": { # 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 and parameters. 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. # Output only. Structured representation of a function declaration as defined by the OpenAPI Spec.
+        "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). 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
+          "description": "A String", # Optional. The description of the data.
+          "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
+            "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
+          "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. Schema of the elements of Type.ARRAY.
+          "nullable": True or False, # Optional. Indicates if the value may be null.
+          "properties": { # Optional. Properties of Type.OBJECT.
+            "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+          },
+          "required": [ # Optional. Required properties of Type.OBJECT.
+            "A String",
+          ],
+          "type": "A String", # Optional. The type of the data.
+        },
+      },
+      "operationId": "A String", # Operation ID that uniquely identifies the operations among the extension. See: "Operation Object" in https://swagger.io/specification/. This field is parsed from the OpenAPI spec. For HTTP extensions, if it does not exist in the spec, we will generate one from the HTTP method and path.
+    },
+  ],
+  "manifest": { # Manifest spec of an Extension needed for runtime execution. # Required. Manifest of the Extension.
+    "apiSpec": { # The API specification shown to the LLM. # Required. Immutable. The API specification shown to the LLM.
+      "openApiGcsUri": "A String", # Cloud Storage URI pointing to the OpenAPI spec.
+      "openApiYaml": "A String", # The API spec in Open API standard and YAML format.
+    },
+    "authConfig": { # Auth configuration to run the extension. # Required. Immutable. Type of auth supported by this extension.
+      "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+        "apiKeySecret": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}`
+        "httpElementLocation": "A String", # Required. The location of the API key.
+        "name": "A String", # Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
+      },
+      "authType": "A String", # Type of auth scheme.
+      "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
+        "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If it is not specified, the Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) will be used. - If the service account is provided, the service account should grant Vertex AI Extension Service Agent `iam.serviceAccounts.getAccessToken` permission.
+      },
+      "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
+        "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}`
+      },
+      "noAuth": { # Empty message, used to indicate no authentication for an endpoint. # Config for no auth.
+      },
+      "oauthConfig": { # Config for user oauth. # Config for user oauth.
+        "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from ExecuteExtensionRequest.runtime_auth_config at request time.
+        "serviceAccount": "A String", # The service account that the extension execution service will use to query extension. Used for generating OAuth token on behalf of provided service account. - If the service account is provided, the service account should grant Vertex AI Service Agent `iam.serviceAccounts.getAccessToken` permission.
+      },
+      "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth.
+        "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from ExecuteExtensionRequest.runtime_auth_config at request time.
+      },
+    },
+    "description": "A String", # Required. The natural language description shown to the LLM. It should describe the usage of the extension, and is essential for the LLM to perform reasoning.
+    "name": "A String", # Required. Extension name shown to the LLM. The name can be up to 128 characters long.
+  },
+  "name": "A String", # Identifier. The resource name of the Extension.
+  "toolUseExamples": [ # Optional. Examples to illustrate the usage of the extension as a tool.
+    { # A single example of the tool usage.
+      "displayName": "A String", # Required. The display name for example.
+      "extensionOperation": { # Identifies one operation of the extension. # Extension operation to call.
+        "extension": "A String", # Resource name of the extension.
+        "operationId": "A String", # Required. Operation ID of the extension.
+      },
+      "functionName": "A String", # Function name to call.
+      "query": "A String", # Required. Query that should be routed to this tool.
+      "requestParams": { # Request parameters used for executing this tool.
+        "a_key": "", # Properties of the object.
+      },
+      "responseParams": { # Response parameters generated by this tool.
+        "a_key": "", # Properties of the object.
+      },
+      "responseSummary": "A String", # Summary of the tool response to the user query.
+    },
+  ],
+  "updateTime": "A String", # Output only. Timestamp when this Extension was most recently updated.
+}
+
+ +
+ import_(parent, body=None, x__xgafv=None) + 
Imports an Extension.
+
+Args:
+  parent: string, Required. The resource name of the Location to import the Extension in. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Extensions are tools for large language models to access external data, run computations, etc.
+  "createTime": "A String", # Output only. Timestamp when this Extension was created.
+  "description": "A String", # Optional. The description of the Extension.
+  "displayName": "A String", # Required. The display name of the Extension. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+  "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
+  "extensionOperations": [ # Output only. Supported operations.
+    { # Operation of an extension.
+      "functionDeclaration": { # 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 and parameters. 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. # Output only. Structured representation of a function declaration as defined by the OpenAPI Spec.
+        "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). 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
+          "description": "A String", # Optional. The description of the data.
+          "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
+            "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
+          "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. Schema of the elements of Type.ARRAY.
+          "nullable": True or False, # Optional. Indicates if the value may be null.
+          "properties": { # Optional. Properties of Type.OBJECT.
+            "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+          },
+          "required": [ # Optional. Required properties of Type.OBJECT.
+            "A String",
+          ],
+          "type": "A String", # Optional. The type of the data.
+        },
+      },
+      "operationId": "A String", # Operation ID that uniquely identifies the operations among the extension. See: "Operation Object" in https://swagger.io/specification/. This field is parsed from the OpenAPI spec. For HTTP extensions, if it does not exist in the spec, we will generate one from the HTTP method and path.
+    },
+  ],
+  "manifest": { # Manifest spec of an Extension needed for runtime execution. # Required. Manifest of the Extension.
+    "apiSpec": { # The API specification shown to the LLM. # Required. Immutable. The API specification shown to the LLM.
+      "openApiGcsUri": "A String", # Cloud Storage URI pointing to the OpenAPI spec.
+      "openApiYaml": "A String", # The API spec in Open API standard and YAML format.
+    },
+    "authConfig": { # Auth configuration to run the extension. # Required. Immutable. Type of auth supported by this extension.
+      "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+        "apiKeySecret": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}`
+        "httpElementLocation": "A String", # Required. The location of the API key.
+        "name": "A String", # Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
+      },
+      "authType": "A String", # Type of auth scheme.
+      "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
+        "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If it is not specified, the Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) will be used. - If the service account is provided, the service account should grant Vertex AI Extension Service Agent `iam.serviceAccounts.getAccessToken` permission.
+      },
+      "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
+        "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}`
+      },
+      "noAuth": { # Empty message, used to indicate no authentication for an endpoint. # Config for no auth.
+      },
+      "oauthConfig": { # Config for user oauth. # Config for user oauth.
+        "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from ExecuteExtensionRequest.runtime_auth_config at request time.
+        "serviceAccount": "A String", # The service account that the extension execution service will use to query extension. Used for generating OAuth token on behalf of provided service account. - If the service account is provided, the service account should grant Vertex AI Service Agent `iam.serviceAccounts.getAccessToken` permission.
+      },
+      "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth.
+        "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from ExecuteExtensionRequest.runtime_auth_config at request time.
+      },
+    },
+    "description": "A String", # Required. The natural language description shown to the LLM. It should describe the usage of the extension, and is essential for the LLM to perform reasoning.
+    "name": "A String", # Required. Extension name shown to the LLM. The name can be up to 128 characters long.
+  },
+  "name": "A String", # Identifier. The resource name of the Extension.
+  "toolUseExamples": [ # Optional. Examples to illustrate the usage of the extension as a tool.
+    { # A single example of the tool usage.
+      "displayName": "A String", # Required. The display name for example.
+      "extensionOperation": { # Identifies one operation of the extension. # Extension operation to call.
+        "extension": "A String", # Resource name of the extension.
+        "operationId": "A String", # Required. Operation ID of the extension.
+      },
+      "functionName": "A String", # Function name to call.
+      "query": "A String", # Required. Query that should be routed to this tool.
+      "requestParams": { # Request parameters used for executing this tool.
+        "a_key": "", # Properties of the object.
+      },
+      "responseParams": { # Response parameters generated by this tool.
+        "a_key": "", # Properties of the object.
+      },
+      "responseSummary": "A String", # Summary of the tool response to the user query.
+    },
+  ],
+  "updateTime": "A String", # Output only. Timestamp when this Extension was most recently updated.
+}
+
+  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.
+  },
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists Extensions in a location.
+
+Args:
+  parent: string, Required. The resource name of the Location to list the Extensions from. Format: `projects/{project}/locations/{location}` (required)
+  filter: string, Optional. The standard list filter. Supported fields: * `display_name` * `create_time` * `update_time` More detail in [AIP-160](https://google.aip.dev/160).
+  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.
+  pageSize: integer, Optional. The standard list page size.
+  pageToken: string, Optional. The standard list page token.
+  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 ExtensionRegistryService.ListExtensions
+  "extensions": [ # List of Extension in the requested page.
+    { # Extensions are tools for large language models to access external data, run computations, etc.
+      "createTime": "A String", # Output only. Timestamp when this Extension was created.
+      "description": "A String", # Optional. The description of the Extension.
+      "displayName": "A String", # Required. The display name of the Extension. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+      "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
+      "extensionOperations": [ # Output only. Supported operations.
+        { # Operation of an extension.
+          "functionDeclaration": { # 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 and parameters. 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. # Output only. Structured representation of a function declaration as defined by the OpenAPI Spec.
+            "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). 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
+              "description": "A String", # Optional. The description of the data.
+              "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
+                "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
+              "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. Schema of the elements of Type.ARRAY.
+              "nullable": True or False, # Optional. Indicates if the value may be null.
+              "properties": { # Optional. Properties of Type.OBJECT.
+                "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+              },
+              "required": [ # Optional. Required properties of Type.OBJECT.
+                "A String",
+              ],
+              "type": "A String", # Optional. The type of the data.
+            },
+          },
+          "operationId": "A String", # Operation ID that uniquely identifies the operations among the extension. See: "Operation Object" in https://swagger.io/specification/. This field is parsed from the OpenAPI spec. For HTTP extensions, if it does not exist in the spec, we will generate one from the HTTP method and path.
+        },
+      ],
+      "manifest": { # Manifest spec of an Extension needed for runtime execution. # Required. Manifest of the Extension.
+        "apiSpec": { # The API specification shown to the LLM. # Required. Immutable. The API specification shown to the LLM.
+          "openApiGcsUri": "A String", # Cloud Storage URI pointing to the OpenAPI spec.
+          "openApiYaml": "A String", # The API spec in Open API standard and YAML format.
+        },
+        "authConfig": { # Auth configuration to run the extension. # Required. Immutable. Type of auth supported by this extension.
+          "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+            "apiKeySecret": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}`
+            "httpElementLocation": "A String", # Required. The location of the API key.
+            "name": "A String", # Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
+          },
+          "authType": "A String", # Type of auth scheme.
+          "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
+            "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If it is not specified, the Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) will be used. - If the service account is provided, the service account should grant Vertex AI Extension Service Agent `iam.serviceAccounts.getAccessToken` permission.
+          },
+          "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
+            "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}`
+          },
+          "noAuth": { # Empty message, used to indicate no authentication for an endpoint. # Config for no auth.
+          },
+          "oauthConfig": { # Config for user oauth. # Config for user oauth.
+            "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from ExecuteExtensionRequest.runtime_auth_config at request time.
+            "serviceAccount": "A String", # The service account that the extension execution service will use to query extension. Used for generating OAuth token on behalf of provided service account. - If the service account is provided, the service account should grant Vertex AI Service Agent `iam.serviceAccounts.getAccessToken` permission.
+          },
+          "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth.
+            "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from ExecuteExtensionRequest.runtime_auth_config at request time.
+          },
+        },
+        "description": "A String", # Required. The natural language description shown to the LLM. It should describe the usage of the extension, and is essential for the LLM to perform reasoning.
+        "name": "A String", # Required. Extension name shown to the LLM. The name can be up to 128 characters long.
+      },
+      "name": "A String", # Identifier. The resource name of the Extension.
+      "toolUseExamples": [ # Optional. Examples to illustrate the usage of the extension as a tool.
+        { # A single example of the tool usage.
+          "displayName": "A String", # Required. The display name for example.
+          "extensionOperation": { # Identifies one operation of the extension. # Extension operation to call.
+            "extension": "A String", # Resource name of the extension.
+            "operationId": "A String", # Required. Operation ID of the extension.
+          },
+          "functionName": "A String", # Function name to call.
+          "query": "A String", # Required. Query that should be routed to this tool.
+          "requestParams": { # Request parameters used for executing this tool.
+            "a_key": "", # Properties of the object.
+          },
+          "responseParams": { # Response parameters generated by this tool.
+            "a_key": "", # Properties of the object.
+          },
+          "responseSummary": "A String", # Summary of the tool response to the user query.
+        },
+      ],
+      "updateTime": "A String", # Output only. Timestamp when this Extension was most recently updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListExtensionsRequest.page_token to obtain that page.
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates an Extension.
+
+Args:
+  name: string, Identifier. The resource name of the Extension. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Extensions are tools for large language models to access external data, run computations, etc.
+  "createTime": "A String", # Output only. Timestamp when this Extension was created.
+  "description": "A String", # Optional. The description of the Extension.
+  "displayName": "A String", # Required. The display name of the Extension. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+  "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
+  "extensionOperations": [ # Output only. Supported operations.
+    { # Operation of an extension.
+      "functionDeclaration": { # 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 and parameters. 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. # Output only. Structured representation of a function declaration as defined by the OpenAPI Spec.
+        "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). 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
+          "description": "A String", # Optional. The description of the data.
+          "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
+            "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
+          "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. Schema of the elements of Type.ARRAY.
+          "nullable": True or False, # Optional. Indicates if the value may be null.
+          "properties": { # Optional. Properties of Type.OBJECT.
+            "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+          },
+          "required": [ # Optional. Required properties of Type.OBJECT.
+            "A String",
+          ],
+          "type": "A String", # Optional. The type of the data.
+        },
+      },
+      "operationId": "A String", # Operation ID that uniquely identifies the operations among the extension. See: "Operation Object" in https://swagger.io/specification/. This field is parsed from the OpenAPI spec. For HTTP extensions, if it does not exist in the spec, we will generate one from the HTTP method and path.
+    },
+  ],
+  "manifest": { # Manifest spec of an Extension needed for runtime execution. # Required. Manifest of the Extension.
+    "apiSpec": { # The API specification shown to the LLM. # Required. Immutable. The API specification shown to the LLM.
+      "openApiGcsUri": "A String", # Cloud Storage URI pointing to the OpenAPI spec.
+      "openApiYaml": "A String", # The API spec in Open API standard and YAML format.
+    },
+    "authConfig": { # Auth configuration to run the extension. # Required. Immutable. Type of auth supported by this extension.
+      "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+        "apiKeySecret": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}`
+        "httpElementLocation": "A String", # Required. The location of the API key.
+        "name": "A String", # Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
+      },
+      "authType": "A String", # Type of auth scheme.
+      "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
+        "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If it is not specified, the Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) will be used. - If the service account is provided, the service account should grant Vertex AI Extension Service Agent `iam.serviceAccounts.getAccessToken` permission.
+      },
+      "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
+        "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}`
+      },
+      "noAuth": { # Empty message, used to indicate no authentication for an endpoint. # Config for no auth.
+      },
+      "oauthConfig": { # Config for user oauth. # Config for user oauth.
+        "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from ExecuteExtensionRequest.runtime_auth_config at request time.
+        "serviceAccount": "A String", # The service account that the extension execution service will use to query extension. Used for generating OAuth token on behalf of provided service account. - If the service account is provided, the service account should grant Vertex AI Service Agent `iam.serviceAccounts.getAccessToken` permission.
+      },
+      "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth.
+        "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from ExecuteExtensionRequest.runtime_auth_config at request time.
+      },
+    },
+    "description": "A String", # Required. The natural language description shown to the LLM. It should describe the usage of the extension, and is essential for the LLM to perform reasoning.
+    "name": "A String", # Required. Extension name shown to the LLM. The name can be up to 128 characters long.
+  },
+  "name": "A String", # Identifier. The resource name of the Extension.
+  "toolUseExamples": [ # Optional. Examples to illustrate the usage of the extension as a tool.
+    { # A single example of the tool usage.
+      "displayName": "A String", # Required. The display name for example.
+      "extensionOperation": { # Identifies one operation of the extension. # Extension operation to call.
+        "extension": "A String", # Resource name of the extension.
+        "operationId": "A String", # Required. Operation ID of the extension.
+      },
+      "functionName": "A String", # Function name to call.
+      "query": "A String", # Required. Query that should be routed to this tool.
+      "requestParams": { # Request parameters used for executing this tool.
+        "a_key": "", # Properties of the object.
+      },
+      "responseParams": { # Response parameters generated by this tool.
+        "a_key": "", # Properties of the object.
+      },
+      "responseSummary": "A String", # Summary of the tool response to the user query.
+    },
+  ],
+  "updateTime": "A String", # Output only. Timestamp when this Extension was most recently updated.
+}
+
+  updateMask: string, Required. Mask specifying which fields to update. Supported fields: * `display_name` * `description`
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Extensions are tools for large language models to access external data, run computations, etc.
+  "createTime": "A String", # Output only. Timestamp when this Extension was created.
+  "description": "A String", # Optional. The description of the Extension.
+  "displayName": "A String", # Required. The display name of the Extension. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+  "etag": "A String", # Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
+  "extensionOperations": [ # Output only. Supported operations.
+    { # Operation of an extension.
+      "functionDeclaration": { # 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 and parameters. 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. # Output only. Structured representation of a function declaration as defined by the OpenAPI Spec.
+        "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). 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
+          "description": "A String", # Optional. The description of the data.
+          "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
+            "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
+          "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. Schema of the elements of Type.ARRAY.
+          "nullable": True or False, # Optional. Indicates if the value may be null.
+          "properties": { # Optional. Properties of Type.OBJECT.
+            "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
+          },
+          "required": [ # Optional. Required properties of Type.OBJECT.
+            "A String",
+          ],
+          "type": "A String", # Optional. The type of the data.
+        },
+      },
+      "operationId": "A String", # Operation ID that uniquely identifies the operations among the extension. See: "Operation Object" in https://swagger.io/specification/. This field is parsed from the OpenAPI spec. For HTTP extensions, if it does not exist in the spec, we will generate one from the HTTP method and path.
+    },
+  ],
+  "manifest": { # Manifest spec of an Extension needed for runtime execution. # Required. Manifest of the Extension.
+    "apiSpec": { # The API specification shown to the LLM. # Required. Immutable. The API specification shown to the LLM.
+      "openApiGcsUri": "A String", # Cloud Storage URI pointing to the OpenAPI spec.
+      "openApiYaml": "A String", # The API spec in Open API standard and YAML format.
+    },
+    "authConfig": { # Auth configuration to run the extension. # Required. Immutable. Type of auth supported by this extension.
+      "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+        "apiKeySecret": "A String", # Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}`
+        "httpElementLocation": "A String", # Required. The location of the API key.
+        "name": "A String", # Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
+      },
+      "authType": "A String", # Type of auth scheme.
+      "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
+        "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If it is not specified, the Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) will be used. - If the service account is provided, the service account should grant Vertex AI Extension Service Agent `iam.serviceAccounts.getAccessToken` permission.
+      },
+      "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
+        "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}`
+      },
+      "noAuth": { # Empty message, used to indicate no authentication for an endpoint. # Config for no auth.
+      },
+      "oauthConfig": { # Config for user oauth. # Config for user oauth.
+        "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from ExecuteExtensionRequest.runtime_auth_config at request time.
+        "serviceAccount": "A String", # The service account that the extension execution service will use to query extension. Used for generating OAuth token on behalf of provided service account. - If the service account is provided, the service account should grant Vertex AI Service Agent `iam.serviceAccounts.getAccessToken` permission.
+      },
+      "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth.
+        "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from ExecuteExtensionRequest.runtime_auth_config at request time.
+      },
+    },
+    "description": "A String", # Required. The natural language description shown to the LLM. It should describe the usage of the extension, and is essential for the LLM to perform reasoning.
+    "name": "A String", # Required. Extension name shown to the LLM. The name can be up to 128 characters long.
+  },
+  "name": "A String", # Identifier. The resource name of the Extension.
+  "toolUseExamples": [ # Optional. Examples to illustrate the usage of the extension as a tool.
+    { # A single example of the tool usage.
+      "displayName": "A String", # Required. The display name for example.
+      "extensionOperation": { # Identifies one operation of the extension. # Extension operation to call.
+        "extension": "A String", # Resource name of the extension.
+        "operationId": "A String", # Required. Operation ID of the extension.
+      },
+      "functionName": "A String", # Function name to call.
+      "query": "A String", # Required. Query that should be routed to this tool.
+      "requestParams": { # Request parameters used for executing this tool.
+        "a_key": "", # Properties of the object.
+      },
+      "responseParams": { # Response parameters generated by this tool.
+        "a_key": "", # Properties of the object.
+      },
+      "responseSummary": "A String", # Summary of the tool response to the user query.
+    },
+  ],
+  "updateTime": "A String", # Output only. Timestamp when this Extension was most recently updated.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html index b56a9113b1f..4ecfdf2fda8 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html @@ -171,7 +171,7 @@

Method Details

"vectorSearchConfig": { # Deprecated. Use IndexConfig instead. # Optional. Deprecated: please use FeatureView.index_config instead. "bruteForceConfig": { # Optional. Configuration options for using brute force search, which simply implements the standard linear search in the database for each query. It is primarily meant for benchmarking and to generate the ground truth for approximate search. }, - "crowdingColumn": "A String", # Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute. + "crowdingColumn": "A String", # Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by FeatureOnlineStoreService.SearchNearestEntities to diversify search results. If NearestNeighborQuery.per_crowding_attribute_neighbor_count is set to K in SearchNearestEntitiesRequest, it's guaranteed that no more than K entities of the same crowding attribute are returned in the response. "distanceMeasureType": "A String", # Optional. The distance measure used in nearest neighbor search. "embeddingColumn": "A String", # Optional. Column of embedding. This column contains the source data to create index for vector search. embedding_column must be set when using vector search. "embeddingDimension": 42, # Optional. The number of dimensions of the input embedding. @@ -372,7 +372,7 @@

Method Details

"vectorSearchConfig": { # Deprecated. Use IndexConfig instead. # Optional. Deprecated: please use FeatureView.index_config instead. "bruteForceConfig": { # Optional. Configuration options for using brute force search, which simply implements the standard linear search in the database for each query. It is primarily meant for benchmarking and to generate the ground truth for approximate search. }, - "crowdingColumn": "A String", # Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute. + "crowdingColumn": "A String", # Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by FeatureOnlineStoreService.SearchNearestEntities to diversify search results. If NearestNeighborQuery.per_crowding_attribute_neighbor_count is set to K in SearchNearestEntitiesRequest, it's guaranteed that no more than K entities of the same crowding attribute are returned in the response. "distanceMeasureType": "A String", # Optional. The distance measure used in nearest neighbor search. "embeddingColumn": "A String", # Optional. Column of embedding. This column contains the source data to create index for vector search. embedding_column must be set when using vector search. "embeddingDimension": 42, # Optional. The number of dimensions of the input embedding. @@ -474,7 +474,7 @@

Method Details

"vectorSearchConfig": { # Deprecated. Use IndexConfig instead. # Optional. Deprecated: please use FeatureView.index_config instead. "bruteForceConfig": { # Optional. Configuration options for using brute force search, which simply implements the standard linear search in the database for each query. It is primarily meant for benchmarking and to generate the ground truth for approximate search. }, - "crowdingColumn": "A String", # Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute. + "crowdingColumn": "A String", # Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by FeatureOnlineStoreService.SearchNearestEntities to diversify search results. If NearestNeighborQuery.per_crowding_attribute_neighbor_count is set to K in SearchNearestEntitiesRequest, it's guaranteed that no more than K entities of the same crowding attribute are returned in the response. "distanceMeasureType": "A String", # Optional. The distance measure used in nearest neighbor search. "embeddingColumn": "A String", # Optional. Column of embedding. This column contains the source data to create index for vector search. embedding_column must be set when using vector search. "embeddingDimension": 42, # Optional. The number of dimensions of the input embedding. @@ -547,7 +547,7 @@

Method Details

"vectorSearchConfig": { # Deprecated. Use IndexConfig instead. # Optional. Deprecated: please use FeatureView.index_config instead. "bruteForceConfig": { # Optional. Configuration options for using brute force search, which simply implements the standard linear search in the database for each query. It is primarily meant for benchmarking and to generate the ground truth for approximate search. }, - "crowdingColumn": "A String", # Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute. + "crowdingColumn": "A String", # Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by FeatureOnlineStoreService.SearchNearestEntities to diversify search results. If NearestNeighborQuery.per_crowding_attribute_neighbor_count is set to K in SearchNearestEntitiesRequest, it's guaranteed that no more than K entities of the same crowding attribute are returned in the response. "distanceMeasureType": "A String", # Optional. The distance measure used in nearest neighbor search. "embeddingColumn": "A String", # Optional. Column of embedding. This column contains the source data to create index for vector search. embedding_column must be set when using vector search. "embeddingDimension": 42, # Optional. The number of dimensions of the input embedding. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimes.html b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimes.html index 85702dac510..72b81702728 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimes.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.notebookRuntimes.html @@ -303,7 +303,7 @@

Method Details

Args: parent: string, Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project}/locations/{location}` (required) - filter: string, Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` + filter: string, Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. pageSize: integer, Optional. The standard list page size. pageToken: string, Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index 6b1a98a3242..d923bb8e7bf 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -265,16 +265,51 @@

Method Details

"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. }, ], + "systemInstructions": [ # Optional. The user provided system instructions for the model. + { # 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. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # Raw media bytes. Text should not be sent as raw bytes, use the 'text' field. # Optional. Inlined bytes data. + "data": "A String", # Required. Raw bytes for media formats. + "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 64 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 and parameters. 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 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). 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. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "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). 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 "description": "A String", # Optional. The description of the data. "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} "A String", @@ -777,16 +812,51 @@

Method Details

"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. }, ], + "systemInstructions": [ # Optional. The user provided system instructions for the model. + { # 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. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # Raw media bytes. Text should not be sent as raw bytes, use the 'text' field. # Optional. Inlined bytes data. + "data": "A String", # Required. Raw bytes for media formats. + "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 64 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 and parameters. 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 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). 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. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "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). 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 "description": "A String", # Optional. The description of the data. "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} "A String", diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index 296dccb1d5d..91e3eece34f 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -21,6 +21,11 @@ "endpoints": [ { "description": "Locational Endpoint", +"endpointUrl": "https://africa-south1-aiplatform.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Locational Endpoint", "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", "location": "asia-east1" }, @@ -121,6 +126,21 @@ }, { "description": "Locational Endpoint", +"endpointUrl": "https://europe-west12-aiplatform.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Locational Endpoint", +"endpointUrl": "https://me-central1-aiplatform.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Locational Endpoint", +"endpointUrl": "https://me-central2-aiplatform.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Locational Endpoint", "endpointUrl": "https://me-west1-aiplatform.googleapis.com/", "location": "me-west1" }, @@ -188,6 +208,11 @@ "description": "Locational Endpoint", "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", "location": "us-west4" +}, +{ +"description": "Locational Endpoint", +"endpointUrl": "https://us-east5-aiplatform.googleapis.com/", +"location": "us-east5" } ], "fullyEncodeReservedExpansion": true, @@ -3217,7 +3242,7 @@ ], "parameters": { "filter": { -"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports = and, != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `endpoint=1` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`", +"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports = and !=. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports = and, != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports = Some examples: * `endpoint=1` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`", "location": "query", "type": "string" }, @@ -10036,7 +10061,7 @@ ], "parameters": { "filter": { -"description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `model=1234` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`", +"description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`", "location": "query", "type": "string" }, @@ -11367,7 +11392,7 @@ ], "parameters": { "filter": { -"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime=\"notebookRuntime123\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"` * `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser=\"test@google.com\"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED`", +"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime=\"notebookRuntime123\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"` * `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser=\"test@google.com\"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED`", "location": "query", "type": "string" }, @@ -11618,6 +11643,163 @@ } } }, +"persistentResources": { +"methods": { +"create": { +"description": "Creates a PersistentResource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.persistentResources.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"persistentResourceId": { +"description": "Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/persistentResources", +"request": { +"$ref": "GoogleCloudAiplatformV1PersistentResource" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a PersistentResource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.persistentResources.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the PersistentResource to be deleted. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a PersistentResource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.persistentResources.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1PersistentResource" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists PersistentResources in a Location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.persistentResources.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The standard list page token. Typically obtained via ListPersistentResourceResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/persistentResources", +"response": { +"$ref": "GoogleCloudAiplatformV1ListPersistentResourcesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a PersistentResource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.persistentResources.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. Resource name of a PersistentResource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Specify the fields to be overwritten in the PersistentResource by the update method.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1PersistentResource" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "pipelineJobs": { "methods": { "batchCancel": { @@ -15557,6 +15739,64 @@ } } } +}, +"tuningJobs": { +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tuningJobs.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tuningJobs.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} } } } @@ -15618,7 +15858,7 @@ } } }, -"revision": "20240229", +"revision": "20240313", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionEmbedVideoResponse": { @@ -16237,6 +16477,10 @@ "description": "A single part of a message.", "id": "CloudAiNlLlmProtoServicePart", "properties": { +"documentMetadata": { +"$ref": "CloudAiNlLlmProtoServicePartDocumentMetadata", +"description": "Document metadata. The metadata should only be used by the Cloud LLM when supporting document mime types. It will only be populated when this image input part is converted from a document input part." +}, "fileData": { "$ref": "CloudAiNlLlmProtoServicePartFileData", "description": "URI-based data." @@ -16284,6 +16528,22 @@ }, "type": "object" }, +"CloudAiNlLlmProtoServicePartDocumentMetadata": { +"description": "Metadata describes the original input document content.", +"id": "CloudAiNlLlmProtoServicePartDocumentMetadata", +"properties": { +"originalDocumentBlob": { +"$ref": "CloudAiNlLlmProtoServicePartBlob", +"description": "The original document blob." +}, +"pageNumber": { +"description": "The (1-indexed) page number of the image in the original document. The first page carries the original document content and mime type.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "CloudAiNlLlmProtoServicePartFileData": { "description": "Represents file data.", "id": "CloudAiNlLlmProtoServicePartFileData", @@ -16429,6 +16689,13 @@ "description": "Whether the category is flagged as being present. Currently, this is set to true if score >= 0.5.", "type": "boolean" }, +"influentialTerms": { +"description": "The influential terms that could potentially block the response.", +"items": { +"$ref": "CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm" +}, +"type": "array" +}, "raiCategory": { "description": "The RAI category.", "enum": [ @@ -16517,6 +16784,41 @@ }, "type": "object" }, +"CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm": { +"description": "The influential term that could potentially block the response.", +"id": "CloudAiNlLlmProtoServiceRaiSignalInfluentialTerm", +"properties": { +"beginOffset": { +"description": "The beginning offset of the influential term.", +"format": "int32", +"type": "integer" +}, +"confidence": { +"description": "The confidence score of the influential term.", +"format": "float", +"type": "number" +}, +"source": { +"description": "The source of the influential term, prompt or response.", +"enum": [ +"SOURCE_UNSPECIFIED", +"PROMPT", +"RESPONSE" +], +"enumDescriptions": [ +"Unspecified source.", +"The influential term comes from the prompt.", +"The influential term comes from the response." +], +"type": "string" +}, +"term": { +"description": "The influential term.", +"type": "string" +} +}, +"type": "object" +}, "CloudAiNlLlmProtoServiceSafetyRating": { "description": "Safety rating corresponding to the generated content.", "id": "CloudAiNlLlmProtoServiceSafetyRating", @@ -17827,7 +18129,10 @@ "MAX_TOKENS", "SAFETY", "RECITATION", -"OTHER" +"OTHER", +"BLOCKLIST", +"PROHIBITED_CONTENT", +"SPII" ], "enumDescriptions": [ "The finish reason is unspecified.", @@ -17835,7 +18140,10 @@ "The maximum number of tokens as specified in the request was reached.", "The token generation was stopped as the response was flagged for safety reasons. NOTE: When streaming the Candidate.content will be empty if content filters blocked the output.", "The token generation was stopped as the response was flagged for unauthorized citations.", -"All other reasons that stopped the token generation" +"All other reasons that stopped the token generation", +"The token generation was stopped as the response was flagged for the terms which are included from the terminology blocklist.", +"The token generation was stopped as the response was flagged for the prohibited contents.", +"The token generation was stopped as the response was flagged for Sensitive Personally Identifiable Information (SPII) contents." ], "readOnly": true, "type": "string" @@ -18441,6 +18749,21 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata": { +"description": "Details of operations that perform create PersistentResource.", +"id": "GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata", +"properties": { +"genericMetadata": { +"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", +"description": "Operation metadata for PersistentResource." +}, +"progressMessage": { +"description": "Progress Message for Create LRO", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1CreatePipelineJobRequest": { "description": "Request message for PipelineService.CreatePipelineJob.", "id": "GoogleCloudAiplatformV1CreatePipelineJobRequest", @@ -19664,10 +19987,6 @@ "$ref": "GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig", "description": "Configures the request-response logging for online prediction." }, -"privateServiceConnectConfig": { -"$ref": "GoogleCloudAiplatformV1PrivateServiceConnectConfig", -"description": "Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive." -}, "trafficSplit": { "additionalProperties": { "format": "int32", @@ -21798,7 +22117,7 @@ "type": "object" }, "GoogleCloudAiplatformV1FindNeighborsRequest": { -"description": "The request message for MatchService.FindNeighbors.", +"description": "LINT.IfChange The request message for MatchService.FindNeighbors.", "id": "GoogleCloudAiplatformV1FindNeighborsRequest", "properties": { "deployedIndexId": { @@ -21948,12 +22267,12 @@ "type": "string" }, "name": { -"description": "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 and dashes, with a maximum length of 64.", +"description": "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.", "type": "string" }, "parameters": { "$ref": "GoogleCloudAiplatformV1Schema", -"description": "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. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1" +"description": "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" } }, "type": "object" @@ -22024,6 +22343,13 @@ }, "type": "array" }, +"systemInstructions": { +"description": "Optional. The user provided system instructions for the model.", +"items": { +"$ref": "GoogleCloudAiplatformV1Content" +}, +"type": "array" +}, "tools": { "description": "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.", "items": { @@ -22067,12 +22393,16 @@ "enum": [ "BLOCKED_REASON_UNSPECIFIED", "SAFETY", -"OTHER" +"OTHER", +"BLOCKLIST", +"PROHIBITED_CONTENT" ], "enumDescriptions": [ "Unspecified blocked reason.", "Candidates blocked due to safety.", -"Candidates blocked due to other reason." +"Candidates blocked due to other reason.", +"Candidates blocked due to the terms which are included from the terminology blocklist.", +"Candidates blocked due to prohibited content." ], "readOnly": true, "type": "string" @@ -22191,6 +22521,17 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1GoogleSearchRetrieval": { +"description": "Tool to retrieve public web data for grounding, powered by Google.", +"id": "GoogleCloudAiplatformV1GoogleSearchRetrieval", +"properties": { +"disableAttribution": { +"description": "Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1GroundingAttribution": { "description": "Grounding attribution.", "id": "GoogleCloudAiplatformV1GroundingAttribution", @@ -23660,6 +24001,23 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1ListPersistentResourcesResponse": { +"description": "Response message for PersistentResourceService.ListPersistentResources", +"id": "GoogleCloudAiplatformV1ListPersistentResourcesResponse", +"properties": { +"nextPageToken": { +"description": "A token to retrieve next page of results. Pass to ListPersistentResourcesRequest.page_token to obtain that page.", +"type": "string" +}, +"persistentResources": { +"items": { +"$ref": "GoogleCloudAiplatformV1PersistentResource" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1ListPipelineJobsResponse": { "description": "Response message for PipelineService.ListPipelineJobs", "id": "GoogleCloudAiplatformV1ListPipelineJobsResponse", @@ -26301,7 +26659,9 @@ "BEING_STARTED", "BEING_STOPPED", "STOPPED", -"BEING_UPGRADED" +"BEING_UPGRADED", +"ERROR", +"INVALID" ], "enumDescriptions": [ "Unspecified runtime state.", @@ -26309,7 +26669,9 @@ "NotebookRuntime is in starting state.", "NotebookRuntime is in stopping state.", "NotebookRuntime is in stopped state.", -"NotebookRuntime is in upgrading state. It is in the middle of upgrading process." +"NotebookRuntime is in upgrading state. It is in the middle of upgrading process.", +"NotebookRuntime was unable to start/stop properly.", +"NotebookRuntime is in invalid state. Cannot be recovered." ], "readOnly": true, "type": "string" @@ -26508,6 +26870,103 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1PersistentResource": { +"description": "Represents long-lasting resources that are dedicated to users to runs custom workloads. A PersistentResource can have multiple node pools and each node pool can have its own machine spec.", +"id": "GoogleCloudAiplatformV1PersistentResource", +"properties": { +"createTime": { +"description": "Output only. Time when the PersistentResource was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters.", +"type": "string" +}, +"encryptionSpec": { +"$ref": "GoogleCloudAiplatformV1EncryptionSpec", +"description": "Optional. Customer-managed encryption key spec for a PersistentResource. If set, this PersistentResource and all sub-resources of this PersistentResource will be secured by this key." +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. Only populated when persistent resource's state is `STOPPING` or `ERROR`.", +"readOnly": true +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The labels with user-defined metadata to organize PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.", +"type": "object" +}, +"name": { +"description": "Immutable. Resource name of a PersistentResource.", +"type": "string" +}, +"network": { +"description": "Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.", +"type": "string" +}, +"reservedIpRanges": { +"description": "Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].", +"items": { +"type": "string" +}, +"type": "array" +}, +"resourcePools": { +"description": "Required. The spec of the pools of different resources.", +"items": { +"$ref": "GoogleCloudAiplatformV1ResourcePool" +}, +"type": "array" +}, +"resourceRuntime": { +"$ref": "GoogleCloudAiplatformV1ResourceRuntime", +"description": "Output only. Runtime information of the Persistent Resource.", +"readOnly": true +}, +"resourceRuntimeSpec": { +"$ref": "GoogleCloudAiplatformV1ResourceRuntimeSpec", +"description": "Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration." +}, +"startTime": { +"description": "Output only. Time when the PersistentResource for the first time entered the `RUNNING` state.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The detailed state of a Study.", +"enum": [ +"STATE_UNSPECIFIED", +"PROVISIONING", +"RUNNING", +"STOPPING", +"ERROR", +"UPDATING" +], +"enumDescriptions": [ +"Not set.", +"The PROVISIONING state indicates the persistent resources is being created.", +"The RUNNING state indicates the persistent resource is healthy and fully usable.", +"The STOPPING state indicates the persistent resource is being deleted.", +"The ERROR state indicates the persistent resource may be unusable. Details can be found in the `error` field.", +"The UPDATING state indicates the persistent resource is being updated." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. Time when the PersistentResource was most recently updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1PipelineJob": { "description": "An instance of a machine learning PipelineJob.", "id": "GoogleCloudAiplatformV1PipelineJob", @@ -27240,7 +27699,6 @@ "description": "Optional. Indicates the launch stage of the model.", "enum": [ "LAUNCH_STAGE_UNSPECIFIED", -"DOGFOOD", "EXPERIMENTAL", "PRIVATE_PREVIEW", "PUBLIC_PREVIEW", @@ -27248,7 +27706,6 @@ ], "enumDescriptions": [ "The model launch stage is unspecified.", -"Used to indicate the PublisherModel is at Google internal testing launch stage.", "Used to indicate the PublisherModel is at Experimental launch stage, available to a small set of customers.", "Used to indicate the PublisherModel is at Private Preview launch stage, only available to a small set of customers, although a larger set of customers than an Experimental launch. Previews are the first launch stage used to get feedback from customers.", "Used to indicate the PublisherModel is at Public Preview launch stage, available to all customers, although not supported for production workloads.", @@ -27766,6 +28223,43 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1RayMetricSpec": { +"description": "Configuration for the Ray metrics.", +"id": "GoogleCloudAiplatformV1RayMetricSpec", +"properties": { +"disabled": { +"description": "Optional. Flag to disable the Ray metrics collection.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1RaySpec": { +"description": "Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes.", +"id": "GoogleCloudAiplatformV1RaySpec", +"properties": { +"headNodeResourcePoolId": { +"description": "Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set.", +"type": "string" +}, +"imageUri": { +"description": "Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.", +"type": "string" +}, +"rayMetricSpec": { +"$ref": "GoogleCloudAiplatformV1RayMetricSpec", +"description": "Optional. Ray metrics configurations." +}, +"resourcePoolImages": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { \"ray_head_node_pool\": \"head image\" \"ray_worker_node_pool1\": \"worker image\" \"ray_worker_node_pool2\": \"another worker image\" }", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1ReadFeatureValuesRequest": { "description": "Request message for FeaturestoreOnlineServingService.ReadFeatureValues.", "id": "GoogleCloudAiplatformV1ReadFeatureValuesRequest", @@ -27971,6 +28465,21 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata": { +"description": "Details of operations that perform reboot PersistentResource.", +"id": "GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata", +"properties": { +"genericMetadata": { +"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", +"description": "Operation metadata for PersistentResource." +}, +"progressMessage": { +"description": "Progress Message for Reboot LRO", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1RemoveContextChildrenRequest": { "description": "Request message for MetadataService.DeleteContextChildrenRequest.", "id": "GoogleCloudAiplatformV1RemoveContextChildrenRequest", @@ -28011,6 +28520,92 @@ "properties": {}, "type": "object" }, +"GoogleCloudAiplatformV1ResourcePool": { +"description": "Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource.", +"id": "GoogleCloudAiplatformV1ResourcePool", +"properties": { +"autoscalingSpec": { +"$ref": "GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec", +"description": "Optional. Optional spec to configure GKE autoscaling" +}, +"diskSpec": { +"$ref": "GoogleCloudAiplatformV1DiskSpec", +"description": "Optional. Disk spec for the machine in this node pool." +}, +"id": { +"description": "Immutable. The unique ID in a PersistentResource for referring to this resource pool. User can specify it if necessary. Otherwise, it's generated automatically.", +"type": "string" +}, +"machineSpec": { +"$ref": "GoogleCloudAiplatformV1MachineSpec", +"description": "Required. Immutable. The specification of a single machine." +}, +"replicaCount": { +"description": "Optional. The total number of machines to use for this resource pool.", +"format": "int64", +"type": "string" +}, +"usedReplicaCount": { +"description": "Output only. The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec": { +"description": "The min/max number of replicas allowed if enabling autoscaling", +"id": "GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec", +"properties": { +"maxReplicaCount": { +"description": "Optional. max replicas in the node pool, must be \u2265 replica_count and > min_replica_count or will throw error", +"format": "int64", +"type": "string" +}, +"minReplicaCount": { +"description": "Optional. min replicas in the node pool, must be \u2264 replica_count and < max_replica_count or will throw error", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1ResourceRuntime": { +"description": "Persistent Cluster runtime information as output", +"id": "GoogleCloudAiplatformV1ResourceRuntime", +"properties": { +"accessUris": { +"additionalProperties": { +"type": "string" +}, +"description": "Output only. URIs for user to connect to the Cluster. Example: { \"RAY_HEAD_NODE_INTERNAL_IP\": \"head-node-IP:10001\" \"RAY_DASHBOARD_URI\": \"ray-dashboard-address:8888\" }", +"readOnly": true, +"type": "object" +}, +"notebookRuntimeTemplate": { +"description": "Output only. The resource name of NotebookRuntimeTemplate for the RoV Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if set), and with the same Ray and Python version as the Persistent Cluster. Example: \"projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123\"", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1ResourceRuntimeSpec": { +"description": "Configuration for the runtime on a PersistentResource instance, including but not limited to: * Service accounts used to run the workloads. * Whether to make it a dedicated Ray Cluster.", +"id": "GoogleCloudAiplatformV1ResourceRuntimeSpec", +"properties": { +"raySpec": { +"$ref": "GoogleCloudAiplatformV1RaySpec", +"description": "Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource." +}, +"serviceAccountSpec": { +"$ref": "GoogleCloudAiplatformV1ServiceAccountSpec", +"description": "Optional. Configure the use of workload identity on the PersistentResource" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1ResourcesConsumed": { "description": "Statistics information about resource consumption.", "id": "GoogleCloudAiplatformV1ResourcesConsumed", @@ -28052,6 +28647,21 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1Retrieval": { +"description": "Defines a retrieval tool that model can call to access external knowledge.", +"id": "GoogleCloudAiplatformV1Retrieval", +"properties": { +"disableAttribution": { +"description": "Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.", +"type": "boolean" +}, +"vertexAiSearch": { +"$ref": "GoogleCloudAiplatformV1VertexAISearch", +"description": "Set to use data source powered by Vertex AI Search." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1SafetyRating": { "description": "Safety rating corresponding to the generated content.", "id": "GoogleCloudAiplatformV1SafetyRating", @@ -28155,6 +28765,20 @@ ], "type": "string" }, +"method": { +"description": "Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.", +"enum": [ +"HARM_BLOCK_METHOD_UNSPECIFIED", +"SEVERITY", +"PROBABILITY" +], +"enumDescriptions": [ +"The harm block method is unspecified.", +"The harm block method uses both probability and severity scores.", +"The harm block method uses the probability score." +], +"type": "string" +}, "threshold": { "description": "Required. The harm block threshold.", "enum": [ @@ -32428,6 +33052,21 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1ServiceAccountSpec": { +"description": "Configuration for the use of custom service account to run the workloads.", +"id": "GoogleCloudAiplatformV1ServiceAccountSpec", +"properties": { +"enableCustomServiceAccount": { +"description": "Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).", +"type": "boolean" +}, +"serviceAccount": { +"description": "Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers are specified in `ResourceRuntimeSpec`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1ShieldedVmConfig": { "description": "A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).", "id": "GoogleCloudAiplatformV1ShieldedVmConfig", @@ -33788,6 +34427,14 @@ false "$ref": "GoogleCloudAiplatformV1FunctionDeclaration" }, "type": "array" +}, +"googleSearchRetrieval": { +"$ref": "GoogleCloudAiplatformV1GoogleSearchRetrieval", +"description": "Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search." +}, +"retrieval": { +"$ref": "GoogleCloudAiplatformV1Retrieval", +"description": "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." } }, "type": "object" @@ -34248,6 +34895,21 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata": { +"description": "Details of operations that perform update PersistentResource.", +"id": "GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata", +"properties": { +"genericMetadata": { +"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", +"description": "Operation metadata for PersistentResource." +}, +"progressMessage": { +"description": "Progress Message for Update LRO", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata": { "description": "Runtime operation metadata for SpecialistPoolService.UpdateSpecialistPool.", "id": "GoogleCloudAiplatformV1UpdateSpecialistPoolOperationMetadata", @@ -34411,6 +35073,17 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1VertexAISearch": { +"description": "Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation", +"id": "GoogleCloudAiplatformV1VertexAISearch", +"properties": { +"datastore": { +"description": "Required. Fully-qualified Vertex AI Search's datastore resource ID. projects/<>/locations/<>/collections/<>/dataStores/<>", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1VideoMetadata": { "description": "Metadata describes the input video content.", "id": "GoogleCloudAiplatformV1VideoMetadata", @@ -38113,6 +38786,7 @@ false "C", "DART", "GRADLE", +"GROOVY", "JAVADOC", "JSON", "MAKEFILE", @@ -38140,6 +38814,7 @@ false "C code.", "Dart code.", "Gradle code.", +"Groovy code.", "API documentation.", "JSON code.", "Makefile code.", diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index c712374406d..1722305cb22 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -21,6 +21,11 @@ "endpoints": [ { "description": "Locational Endpoint", +"endpointUrl": "https://africa-south1-aiplatform.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Locational Endpoint", "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", "location": "asia-east1" }, @@ -121,6 +126,21 @@ }, { "description": "Locational Endpoint", +"endpointUrl": "https://europe-west12-aiplatform.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Locational Endpoint", +"endpointUrl": "https://me-central1-aiplatform.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Locational Endpoint", +"endpointUrl": "https://me-central2-aiplatform.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Locational Endpoint", "endpointUrl": "https://me-west1-aiplatform.googleapis.com/", "location": "me-west1" }, @@ -188,6 +208,11 @@ "description": "Locational Endpoint", "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", "location": "us-west4" +}, +{ +"description": "Locational Endpoint", +"endpointUrl": "https://us-east5-aiplatform.googleapis.com/", +"location": "us-east5" } ], "fullyEncodeReservedExpansion": true, @@ -4297,6 +4322,194 @@ } }, "extensions": { +"methods": { +"delete": { +"description": "Deletes an Extension.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.extensions.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Extension resource to be deleted. Format: `projects/{project}/locations/{location}/extensions/{extension}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"execute": { +"description": "Executes the request against a given extension.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}:execute", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.extensions.execute", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:execute", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1ExecuteExtensionRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ExecuteExtensionResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets an Extension.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.extensions.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Extension resource. Format: `projects/{project}/locations/{location}/extensions/{extension}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1Extension" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"import": { +"description": "Imports an Extension.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions:import", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.extensions.import", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the Location to import the Extension in. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/extensions:import", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1Extension" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Extensions in a location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.extensions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The standard list filter. Supported fields: * `display_name` * `create_time` * `update_time` More detail in [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The standard list page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Location to list the Extensions from. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/extensions", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ListExtensionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates an Extension.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.extensions.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the Extension.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Mask specifying which fields to update. Supported fields: * `display_name` * `description`", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1Extension" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1Extension" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "deployments": { "resources": { @@ -12741,7 +12954,7 @@ ], "parameters": { "filter": { -"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime=\"notebookRuntime123\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"` * `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser=\"test@google.com\"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED`", +"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime=\"notebookRuntime123\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"` * `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser=\"test@google.com\"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED`", "location": "query", "type": "string" }, @@ -17955,7 +18168,7 @@ } } }, -"revision": "20240301", +"revision": "20240313", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionEmbedVideoResponse": { @@ -19424,6 +19637,149 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1AuthConfig": { +"description": "Auth configuration to run the extension.", +"id": "GoogleCloudAiplatformV1beta1AuthConfig", +"properties": { +"apiKeyConfig": { +"$ref": "GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig", +"description": "Config for API key auth." +}, +"authType": { +"description": "Type of auth scheme.", +"enum": [ +"AUTH_TYPE_UNSPECIFIED", +"NO_AUTH", +"API_KEY_AUTH", +"HTTP_BASIC_AUTH", +"GOOGLE_SERVICE_ACCOUNT_AUTH", +"OAUTH", +"OIDC_AUTH" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"" +], +"type": "string" +}, +"googleServiceAccountConfig": { +"$ref": "GoogleCloudAiplatformV1beta1AuthConfigGoogleServiceAccountConfig", +"description": "Config for Google Service Account auth." +}, +"httpBasicAuthConfig": { +"$ref": "GoogleCloudAiplatformV1beta1AuthConfigHttpBasicAuthConfig", +"description": "Config for HTTP Basic auth." +}, +"noAuth": { +"$ref": "GoogleCloudAiplatformV1beta1AuthConfigNoAuth", +"deprecated": true, +"description": "Config for no auth." +}, +"oauthConfig": { +"$ref": "GoogleCloudAiplatformV1beta1AuthConfigOauthConfig", +"description": "Config for user oauth." +}, +"oidcConfig": { +"$ref": "GoogleCloudAiplatformV1beta1AuthConfigOidcConfig", +"description": "Config for user OIDC auth." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig": { +"description": "Config for authentication with API key.", +"id": "GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig", +"properties": { +"apiKeySecret": { +"description": "Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}`", +"type": "string" +}, +"httpElementLocation": { +"description": "Required. The location of the API key.", +"enum": [ +"HTTP_IN_UNSPECIFIED", +"HTTP_IN_QUERY", +"HTTP_IN_HEADER", +"HTTP_IN_PATH", +"HTTP_IN_BODY", +"HTTP_IN_COOKIE" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"" +], +"type": "string" +}, +"name": { +"description": "Required. The parameter name of the API key. E.g. If the API request is \"https://example.com/act?api_key=\", \"api_key\" would be the parameter name.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1AuthConfigGoogleServiceAccountConfig": { +"description": "Config for Google Service Account Authentication.", +"id": "GoogleCloudAiplatformV1beta1AuthConfigGoogleServiceAccountConfig", +"properties": { +"serviceAccount": { +"description": "Optional. The service account that the extension execution service runs as. - If it is not specified, the Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) will be used. - If the service account is provided, the service account should grant Vertex AI Extension Service Agent `iam.serviceAccounts.getAccessToken` permission.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1AuthConfigHttpBasicAuthConfig": { +"description": "Config for HTTP Basic Authentication.", +"id": "GoogleCloudAiplatformV1beta1AuthConfigHttpBasicAuthConfig", +"properties": { +"credentialSecret": { +"description": "Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1AuthConfigNoAuth": { +"description": "Empty message, used to indicate no authentication for an endpoint.", +"id": "GoogleCloudAiplatformV1beta1AuthConfigNoAuth", +"properties": {}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1AuthConfigOauthConfig": { +"description": "Config for user oauth.", +"id": "GoogleCloudAiplatformV1beta1AuthConfigOauthConfig", +"properties": { +"accessToken": { +"description": "Access token for extension endpoint. Only used to propagate token from ExecuteExtensionRequest.runtime_auth_config at request time.", +"type": "string" +}, +"serviceAccount": { +"description": "The service account that the extension execution service will use to query extension. Used for generating OAuth token on behalf of provided service account. - If the service account is provided, the service account should grant Vertex AI Service Agent `iam.serviceAccounts.getAccessToken` permission.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1AuthConfigOidcConfig": { +"description": "Config for user OIDC auth.", +"id": "GoogleCloudAiplatformV1beta1AuthConfigOidcConfig", +"properties": { +"idToken": { +"description": "OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from ExecuteExtensionRequest.runtime_auth_config at request time.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1AutomaticResources": { "description": "A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines.", "id": "GoogleCloudAiplatformV1beta1AutomaticResources", @@ -22169,10 +22525,6 @@ "$ref": "GoogleCloudAiplatformV1beta1PredictRequestResponseLoggingConfig", "description": "Configures the request-response logging for online prediction." }, -"privateServiceConnectConfig": { -"$ref": "GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig", -"description": "Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive." -}, "trafficSplit": { "additionalProperties": { "format": "int32", @@ -22563,6 +22915,49 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ExecuteExtensionRequest": { +"description": "Request message for ExtensionExecutionService.ExecuteExtension.", +"id": "GoogleCloudAiplatformV1beta1ExecuteExtensionRequest", +"properties": { +"operationId": { +"description": "Required. The operation to be executed in this extension as defined in ExtensionOperation.operation_id.", +"type": "string" +}, +"operationParams": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Request parameters that will be used for executing this operation. The struct should be in a form of map with param name as the key and actual param value as the value. E.g. If this operation requires a param \"name\" to be set to \"abc\". you can set this to something like {\"name\": \"abc\"}.", +"type": "object" +}, +"runtimeAuthConfig": { +"$ref": "GoogleCloudAiplatformV1beta1AuthConfig", +"description": "Optional. Auth config provided at runtime to override the default value in Extension.manifest.auth_config. The AuthConfig.auth_type should match the value in Extension.manifest.auth_config." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1ExecuteExtensionResponse": { +"description": "Response message for ExtensionExecutionService.ExecuteExtension.", +"id": "GoogleCloudAiplatformV1beta1ExecuteExtensionResponse", +"properties": { +"content": { +"description": "Response content from the extension. The content should be conformant to the response.content schema in the extension's manifest/OpenAPI spec.", +"type": "string" +}, +"output": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"deprecated": true, +"description": "Output from the extension. The output should be conformant to the extension's manifest/OpenAPI spec. The output can contain values for keys like \"content\", \"headers\", etc. This field is deprecated, please use content field below for the extension execution result.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1Execution": { "description": "Instance of a general execution.", "id": "GoogleCloudAiplatformV1beta1Execution", @@ -23360,6 +23755,114 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1Extension": { +"description": "Extensions are tools for large language models to access external data, run computations, etc.", +"id": "GoogleCloudAiplatformV1beta1Extension", +"properties": { +"createTime": { +"description": "Output only. Timestamp when this Extension was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. The description of the Extension.", +"type": "string" +}, +"displayName": { +"description": "Required. The display name of the Extension. The name can be up to 128 characters long and can consist of any UTF-8 characters.", +"type": "string" +}, +"etag": { +"description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", +"type": "string" +}, +"extensionOperations": { +"description": "Output only. Supported operations.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1ExtensionOperation" +}, +"readOnly": true, +"type": "array" +}, +"manifest": { +"$ref": "GoogleCloudAiplatformV1beta1ExtensionManifest", +"description": "Required. Manifest of the Extension." +}, +"name": { +"description": "Identifier. The resource name of the Extension.", +"type": "string" +}, +"toolUseExamples": { +"description": "Optional. Examples to illustrate the usage of the extension as a tool.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1ToolUseExample" +}, +"type": "array" +}, +"updateTime": { +"description": "Output only. Timestamp when this Extension was most recently updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1ExtensionManifest": { +"description": "Manifest spec of an Extension needed for runtime execution.", +"id": "GoogleCloudAiplatformV1beta1ExtensionManifest", +"properties": { +"apiSpec": { +"$ref": "GoogleCloudAiplatformV1beta1ExtensionManifestApiSpec", +"description": "Required. Immutable. The API specification shown to the LLM." +}, +"authConfig": { +"$ref": "GoogleCloudAiplatformV1beta1AuthConfig", +"description": "Required. Immutable. Type of auth supported by this extension." +}, +"description": { +"description": "Required. The natural language description shown to the LLM. It should describe the usage of the extension, and is essential for the LLM to perform reasoning.", +"type": "string" +}, +"name": { +"description": "Required. Extension name shown to the LLM. The name can be up to 128 characters long.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1ExtensionManifestApiSpec": { +"description": "The API specification shown to the LLM.", +"id": "GoogleCloudAiplatformV1beta1ExtensionManifestApiSpec", +"properties": { +"openApiGcsUri": { +"description": "Cloud Storage URI pointing to the OpenAPI spec.", +"type": "string" +}, +"openApiYaml": { +"description": "The API spec in Open API standard and YAML format.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1ExtensionOperation": { +"description": "Operation of an extension.", +"id": "GoogleCloudAiplatformV1beta1ExtensionOperation", +"properties": { +"functionDeclaration": { +"$ref": "GoogleCloudAiplatformV1beta1FunctionDeclaration", +"description": "Output only. Structured representation of a function declaration as defined by the OpenAPI Spec.", +"readOnly": true +}, +"operationId": { +"description": "Operation ID that uniquely identifies the operations among the extension. See: \"Operation Object\" in https://swagger.io/specification/. This field is parsed from the OpenAPI spec. For HTTP extensions, if it does not exist in the spec, we will generate one from the HTTP method and path.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1Feature": { "description": "Feature Metadata information. For example, color is a feature that describes an apple.", "id": "GoogleCloudAiplatformV1beta1Feature", @@ -24081,7 +24584,7 @@ "description": "Optional. Configuration options for using brute force search, which simply implements the standard linear search in the database for each query. It is primarily meant for benchmarking and to generate the ground truth for approximate search." }, "crowdingColumn": { -"description": "Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute.", +"description": "Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by FeatureOnlineStoreService.SearchNearestEntities to diversify search results. If NearestNeighborQuery.per_crowding_attribute_neighbor_count is set to K in SearchNearestEntitiesRequest, it's guaranteed that no more than K entities of the same crowding attribute are returned in the response.", "type": "string" }, "distanceMeasureType": { @@ -24619,12 +25122,12 @@ "type": "string" }, "name": { -"description": "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 and dashes, with a maximum length of 64.", +"description": "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.", "type": "string" }, "parameters": { "$ref": "GoogleCloudAiplatformV1beta1Schema", -"description": "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. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1" +"description": "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" } }, "type": "object" @@ -24730,6 +25233,13 @@ }, "type": "array" }, +"systemInstructions": { +"description": "Optional. The user provided system instructions for the model.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1Content" +}, +"type": "array" +}, "tools": { "description": "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.", "items": { @@ -26061,6 +26571,24 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ListExtensionsResponse": { +"description": "Response message for ExtensionRegistryService.ListExtensions", +"id": "GoogleCloudAiplatformV1beta1ListExtensionsResponse", +"properties": { +"extensions": { +"description": "List of Extension in the requested page.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1Extension" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass to ListExtensionsRequest.page_token to obtain that page.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ListFeatureGroupsResponse": { "description": "Response message for FeatureRegistryService.ListFeatureGroups.", "id": "GoogleCloudAiplatformV1beta1ListFeatureGroupsResponse", @@ -29114,7 +29642,9 @@ "BEING_STARTED", "BEING_STOPPED", "STOPPED", -"BEING_UPGRADED" +"BEING_UPGRADED", +"ERROR", +"INVALID" ], "enumDescriptions": [ "Unspecified runtime state.", @@ -29122,7 +29652,9 @@ "NotebookRuntime is in starting state.", "NotebookRuntime is in stopping state.", "NotebookRuntime is in stopped state.", -"NotebookRuntime is in upgrading state. It is in the middle of upgrading process." +"NotebookRuntime is in upgrading state. It is in the middle of upgrading process.", +"NotebookRuntime was unable to start/stop properly.", +"NotebookRuntime is in invalid state. Cannot be recovered." ], "readOnly": true, "type": "string" @@ -30939,6 +31471,21 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1RebootPersistentResourceOperationMetadata": { +"description": "Details of operations that perform reboot PersistentResource.", +"id": "GoogleCloudAiplatformV1beta1RebootPersistentResourceOperationMetadata", +"properties": { +"genericMetadata": { +"$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", +"description": "Operation metadata for PersistentResource." +}, +"progressMessage": { +"description": "Progress Message for Reboot LRO", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest": { "description": "Request message for MetadataService.DeleteContextChildrenRequest.", "id": "GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest", @@ -31319,6 +31866,20 @@ ], "type": "string" }, +"method": { +"description": "Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.", +"enum": [ +"HARM_BLOCK_METHOD_UNSPECIFIED", +"SEVERITY", +"PROBABILITY" +], +"enumDescriptions": [ +"The harm block method is unspecified.", +"The harm block method uses both probability and severity scores.", +"The harm block method uses the probability score." +], +"type": "string" +}, "threshold": { "description": "Required. The harm block threshold.", "enum": [ @@ -36905,6 +37466,64 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ToolUseExample": { +"description": "A single example of the tool usage.", +"id": "GoogleCloudAiplatformV1beta1ToolUseExample", +"properties": { +"displayName": { +"description": "Required. The display name for example.", +"type": "string" +}, +"extensionOperation": { +"$ref": "GoogleCloudAiplatformV1beta1ToolUseExampleExtensionOperation", +"description": "Extension operation to call." +}, +"functionName": { +"description": "Function name to call.", +"type": "string" +}, +"query": { +"description": "Required. Query that should be routed to this tool.", +"type": "string" +}, +"requestParams": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Request parameters used for executing this tool.", +"type": "object" +}, +"responseParams": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Response parameters generated by this tool.", +"type": "object" +}, +"responseSummary": { +"description": "Summary of the tool response to the user query.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1ToolUseExampleExtensionOperation": { +"description": "Identifies one operation of the extension.", +"id": "GoogleCloudAiplatformV1beta1ToolUseExampleExtensionOperation", +"properties": { +"extension": { +"description": "Resource name of the extension.", +"type": "string" +}, +"operationId": { +"description": "Required. Operation ID of the extension.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1TrainingConfig": { "description": "CMLE training config. For every active learning labeling iteration, system will train a machine learning model on CMLE. The trained model will be used by data sampling algorithm to select DataItems.", "id": "GoogleCloudAiplatformV1beta1TrainingConfig",