google-api-python-client 2.123.0__py2.py3-none-any.whl → 2.124.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/aiplatform.v1.json

@@ -3242,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\"`. * `base_model_name` only supports = Some examples: * `endpoint=1` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`",
+"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"
 },
@@ -11797,6 +11797,187 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"reboot": {
+"description": "Reboots a PersistentResource.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.persistentResources.reboot",
+"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}:reboot",
+"request": {
+"$ref": "GoogleCloudAiplatformV1RebootPersistentResourceRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"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}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.persistentResources.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.persistentResources.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"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}/persistentResources/{persistentResourcesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.persistentResources.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.persistentResources.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.persistentResources.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
 }
 }
 },
@@ -15858,7 +16039,7 @@
 }
 }
 },
-"revision": "20240313",
+"revision": "20240320",
 "rootUrl": "https://aiplatform.googleapis.com/",
 "schemas": {
 "CloudAiLargeModelsVisionEmbedVideoResponse": {
@@ -19012,6 +19193,10 @@
 "description": "Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Job should be peered. 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 job is not peered with any network.",
 "type": "string"
 },
+"persistentResourceId": {
+"description": "Optional. The ID of the PersistentResource in the same Project and Location which to run If this is specified, the job will be run on existing machines held by the PersistentResource instead of on-demand short-live machines. The network and CMEK configs on the job should be consistent with those on the PersistentResource, otherwise, the job will be rejected.",
+"type": "string"
+},
 "protectedArtifactLocationId": {
 "description": "The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations",
 "type": "string"
@@ -22038,6 +22223,10 @@
 "description": "Response message for FeatureOnlineStoreService.FetchFeatureValues",
 "id": "GoogleCloudAiplatformV1FetchFeatureValuesResponse",
 "properties": {
+"dataKey": {
+"$ref": "GoogleCloudAiplatformV1FeatureViewDataKey",
+"description": "The data key associated with this response. Will only be populated for FeatureOnlineStoreService.StreamingFetchFeatureValues RPCs."
+},
 "keyValues": {
 "$ref": "GoogleCloudAiplatformV1FetchFeatureValuesResponseFeatureNameValuePairList",
 "description": "Feature values in KeyValue format."
@@ -22343,13 +22532,6 @@
 },
 "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": {
@@ -27789,6 +27971,10 @@
 "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke",
 "description": "Optional. Deploy PublisherModel to Google Kubernetes Engine."
 },
+"multiDeployVertex": {
+"$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex",
+"description": "Optional. Multiple setups to deploy the PublisherModel to Vertex Endpoint."
+},
 "openEvaluationPipeline": {
 "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences",
 "description": "Optional. Open evaluation pipeline of the PublisherModel."
@@ -27889,6 +28075,20 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex": {
+"description": "Multiple setups to deploy the PublisherModel.",
+"id": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex",
+"properties": {
+"multiDeployVertex": {
+"description": "Optional. One click deployment configurations.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeploy"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines": {
 "description": "Open fine tuning pipelines.",
 "id": "GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines",
@@ -28480,6 +28680,12 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1RebootPersistentResourceRequest": {
+"description": "Request message for PersistentResourceService.RebootPersistentResource.",
+"id": "GoogleCloudAiplatformV1RebootPersistentResourceRequest",
+"properties": {},
+"type": "object"
+},
 "GoogleCloudAiplatformV1RemoveContextChildrenRequest": {
 "description": "Request message for MetadataService.DeleteContextChildrenRequest.",
 "id": "GoogleCloudAiplatformV1RemoveContextChildrenRequest",
@@ -29082,6 +29288,10 @@
 "description": "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.",
 "id": "GoogleCloudAiplatformV1Schema",
 "properties": {
+"default": {
+"description": "Optional. Default value of the data.",
+"type": "any"
+},
 "description": {
 "description": "Optional. The description of the data.",
 "type": "string"
@@ -29098,22 +29308,66 @@
 "type": "any"
 },
 "format": {
-"description": "Optional. The format of the data. Supported formats: for NUMBER type: float, double for INTEGER type: int32, int64",
+"description": "Optional. The format of the data. Supported formats: for NUMBER type: \"float\", \"double\" for INTEGER type: \"int32\", \"int64\" for STRING type: \"email\", \"byte\", etc",
 "type": "string"
 },
 "items": {
 "$ref": "GoogleCloudAiplatformV1Schema",
-"description": "Optional. Schema of the elements of Type.ARRAY."
+"description": "Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY."
+},
+"maxItems": {
+"description": "Optional. Maximum number of the elements for Type.ARRAY.",
+"format": "int64",
+"type": "string"
+},
+"maxLength": {
+"description": "Optional. Maximum length of the Type.STRING",
+"format": "int64",
+"type": "string"
+},
+"maxProperties": {
+"description": "Optional. Maximum number of the properties for Type.OBJECT.",
+"format": "int64",
+"type": "string"
+},
+"maximum": {
+"description": "Optional. Maximum value of the Type.INTEGER and Type.NUMBER",
+"format": "double",
+"type": "number"
+},
+"minItems": {
+"description": "Optional. Minimum number of the elements for Type.ARRAY.",
+"format": "int64",
+"type": "string"
+},
+"minLength": {
+"description": "Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING",
+"format": "int64",
+"type": "string"
+},
+"minProperties": {
+"description": "Optional. Minimum number of the properties for Type.OBJECT.",
+"format": "int64",
+"type": "string"
+},
+"minimum": {
+"description": "Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER",
+"format": "double",
+"type": "number"
 },
 "nullable": {
 "description": "Optional. Indicates if the value may be null.",
 "type": "boolean"
 },
+"pattern": {
+"description": "Optional. Pattern of the Type.STRING to restrict a string to a regular expression.",
+"type": "string"
+},
 "properties": {
 "additionalProperties": {
 "$ref": "GoogleCloudAiplatformV1Schema"
 },
-"description": "Optional. Properties of Type.OBJECT.",
+"description": "Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.",
 "type": "object"
 },
 "required": {
@@ -29123,6 +29377,10 @@
 },
 "type": "array"
 },
+"title": {
+"description": "Optional. The title of the Schema.",
+"type": "string"
+},
 "type": {
 "description": "Optional. The type of the data.",
 "enum": [
@@ -35078,7 +35336,7 @@ false
 "id": "GoogleCloudAiplatformV1VertexAISearch",
 "properties": {
 "datastore": {
-"description": "Required. Fully-qualified Vertex AI Search's datastore resource ID. projects/<>/locations/<>/collections/<>/dataStores/<>",
+"description": "Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}",
 "type": "string"
 }
 },
@@ -35830,6 +36088,8 @@ false
 "DUET_GOOGLESQL_GENERATION",
 "DUET_CLOUD_IX_PROMPTS",
 "DUET_RAD",
+"DUET_STACKOVERFLOW_ISSUES",
+"DUET_STACKOVERFLOW_ANSWERS",
 "BARD_ARCADE_GITHUB",
 "MOBILE_ASSISTANT_MAGI_FILTERED_0825_373K",
 "MOBILE_ASSISTANT_PALM24B_FILTERED_400K",
@@ -36155,6 +36415,8 @@ false
 "",
 "",
 "",
+"",
+"",
 "Bard ARCADE finetune dataset.",
 "Mobile assistant finetune datasets.",
 "",
@@ -36594,6 +36856,8 @@ false
 "DUET_GOOGLESQL_GENERATION",
 "DUET_CLOUD_IX_PROMPTS",
 "DUET_RAD",
+"DUET_STACKOVERFLOW_ISSUES",
+"DUET_STACKOVERFLOW_ANSWERS",
 "BARD_ARCADE_GITHUB",
 "MOBILE_ASSISTANT_MAGI_FILTERED_0825_373K",
 "MOBILE_ASSISTANT_PALM24B_FILTERED_400K",
@@ -36919,6 +37183,8 @@ false
 "",
 "",
 "",
+"",
+"",
 "Bard ARCADE finetune dataset.",
 "Mobile assistant finetune datasets.",
 "",
@@ -37369,6 +37635,8 @@ false
 "DUET_GOOGLESQL_GENERATION",
 "DUET_CLOUD_IX_PROMPTS",
 "DUET_RAD",
+"DUET_STACKOVERFLOW_ISSUES",
+"DUET_STACKOVERFLOW_ANSWERS",
 "BARD_ARCADE_GITHUB",
 "MOBILE_ASSISTANT_MAGI_FILTERED_0825_373K",
 "MOBILE_ASSISTANT_PALM24B_FILTERED_400K",
@@ -37694,6 +37962,8 @@ false
 "",
 "",
 "",
+"",
+"",
 "Bard ARCADE finetune dataset",
 "Mobile assistant finetune datasets.",
 "",
@@ -38133,6 +38403,8 @@ false
 "DUET_GOOGLESQL_GENERATION",
 "DUET_CLOUD_IX_PROMPTS",
 "DUET_RAD",
+"DUET_STACKOVERFLOW_ISSUES",
+"DUET_STACKOVERFLOW_ANSWERS",
 "BARD_ARCADE_GITHUB",
 "MOBILE_ASSISTANT_MAGI_FILTERED_0825_373K",
 "MOBILE_ASSISTANT_PALM24B_FILTERED_400K",
@@ -38458,6 +38730,8 @@ false
 "",
 "",
 "",
+"",
+"",
 "Bard ARCADE finetune dataset",
 "Mobile assistant finetune datasets.",
 "",
@@ -39150,7 +39424,7 @@ false
 "id": "LearningGenaiRootGroundingMetadataCitation",
 "properties": {
 "endIndex": {
-"description": "Index in the prediction output where the citation ends (exclusive). Must be > start_index and < len(output).",
+"description": "Index in the prediction output where the citation ends (exclusive). Must be > start_index and <= len(output).",
 "format": "int32",
 "type": "integer"
 },
@@ -39940,14 +40214,16 @@ false
 "RETURN",
 "STOP",
 "MAX_TOKENS",
-"FILTER"
+"FILTER",
+"TOP_N_FILTERED"
 ],
 "enumDescriptions": [
 "",
 "Return all the tokens back. This typically implies no filtering or stop sequence was triggered.",
 "Finished due to provided stop sequence.",
 "Model has emitted the maximum number of tokens as specified by max_decoding_steps.",
-"Finished due to triggering some post-processing filter."
+"Finished due to triggering some post-processing filter.",
+"Filtered out due to Top_N < Response_Candidates.Size()"
 ],
 "type": "string"
 },