google-api-python-client 2.151.0__py2.py3-none-any.whl → 2.152.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/aiplatform.v1.json

@@ -791,6 +791,61 @@
 }
 },
 "projects": {
+"methods": {
+"getCacheConfig": {
+"description": "Gets a GenAI cache config.",
+"flatPath": "v1/projects/{projectsId}/cacheConfig",
+"httpMethod": "GET",
+"id": "aiplatform.projects.getCacheConfig",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Name of the cache config. Format: - `projects/{project}/cacheConfig`.",
+"location": "path",
+"pattern": "^projects/[^/]+/cacheConfig$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1CacheConfig"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"updateCacheConfig": {
+"description": "Updates a cache config.",
+"flatPath": "v1/projects/{projectsId}/cacheConfig",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.updateCacheConfig",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.",
+"location": "path",
+"pattern": "^projects/[^/]+/cacheConfig$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1CacheConfig"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
 "resources": {
 "locations": {
 "methods": {
@@ -3763,6 +3818,35 @@
 "https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
+"fetchPredictOperation": {
+"description": "Fetch an asynchronous online prediction operation.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:fetchPredictOperation",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.fetchPredictOperation",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}:fetchPredictOperation",
+"request": {
+"$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
 "generateContent": {
 "description": "Generate content with multimodal inputs.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent",
@@ -3960,6 +4044,35 @@
 "https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
+"predictLongRunning": {
+"description": "",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predictLongRunning",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.predictLongRunning",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}:predictLongRunning",
+"request": {
+"$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
 "rawPredict": {
 "description": "Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict",
@@ -13932,6 +14045,35 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"fetchPredictOperation": {
+"description": "Fetch an asynchronous online prediction operation.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.fetchPredictOperation",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}:fetchPredictOperation",
+"request": {
+"$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
 "generateContent": {
 "description": "Generate content with multimodal inputs.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent",
@@ -13990,6 +14132,35 @@
 "https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
+"predictLongRunning": {
+"description": "",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predictLongRunning",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.predictLongRunning",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}:predictLongRunning",
+"request": {
+"$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
 "rawPredict": {
 "description": "Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:rawPredict",
@@ -17902,7 +18073,7 @@
 }
 }
 },
-"revision": "20241025",
+"revision": "20241026",
 "rootUrl": "https://aiplatform.googleapis.com/",
 "schemas": {
 "CloudAiLargeModelsVisionGenerateVideoResponse": {
@@ -18198,6 +18369,15 @@
 "description": "Video",
 "id": "CloudAiLargeModelsVisionVideo",
 "properties": {
+"encodedVideo": {
+"description": "Base 64 encoded video bytes.",
+"format": "byte",
+"type": "string"
+},
+"encoding": {
+"description": "Video encoding, for example \"video/mp4\".",
+"type": "string"
+},
 "uri": {
 "description": "Path to another storage (typically Google Cloud Storage).",
 "type": "string"
@@ -19464,6 +19644,21 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1CacheConfig": {
+"description": "Config of GenAI caching features. This is a singleton resource.",
+"id": "GoogleCloudAiplatformV1CacheConfig",
+"properties": {
+"disableCache": {
+"description": "If set to true, disables GenAI caching. Otherwise caching is enabled.",
+"type": "boolean"
+},
+"name": {
+"description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1CancelBatchPredictionJobRequest": {
 "description": "Request message for JobService.CancelBatchPredictionJob.",
 "id": "GoogleCloudAiplatformV1CancelBatchPredictionJobRequest",
@@ -19556,7 +19751,7 @@
 "Token generation reached a natural stopping point or a configured stop sequence.",
 "Token generation reached the configured maximum output tokens.",
 "Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, content is empty if content filters blocks the output.",
-"Token generation stopped because the content potentially contains copyright violations.",
+"The token generation stopped because of potential recitation.",
 "All other reasons that stopped the token generation.",
 "Token generation stopped because the content contains forbidden terms.",
 "Token generation stopped for potentially containing prohibited content.",
@@ -24290,6 +24485,17 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1FetchPredictOperationRequest": {
+"description": "Request message for PredictionService.FetchPredictOperation.",
+"id": "GoogleCloudAiplatformV1FetchPredictOperationRequest",
+"properties": {
+"operationName": {
+"description": "Required. The server-assigned name for the operation.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1FileData": {
 "description": "URI based data.",
 "id": "GoogleCloudAiplatformV1FileData",
@@ -24646,7 +24852,7 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1FunctionDeclaration": {
-"description": "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": "Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.",
 "id": "GoogleCloudAiplatformV1FunctionDeclaration",
 "properties": {
 "description": {
@@ -29426,6 +29632,10 @@ false
 "readOnly": true,
 "type": "string"
 },
+"customEnvironmentSpec": {
+"$ref": "GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec",
+"description": "The custom compute configuration for an execution job."
+},
 "dataformRepositorySource": {
 "$ref": "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource",
 "description": "The Dataform Repository pointing to a single file notebook repository."
@@ -29531,6 +29741,25 @@ false
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec": {
+"description": "Compute configuration to use for an execution job.",
+"id": "GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec",
+"properties": {
+"machineSpec": {
+"$ref": "GoogleCloudAiplatformV1MachineSpec",
+"description": "The specification of a single machine for the execution job."
+},
+"networkSpec": {
+"$ref": "GoogleCloudAiplatformV1NetworkSpec",
+"description": "The network configuration to use for the execution job."
+},
+"persistentDiskSpec": {
+"$ref": "GoogleCloudAiplatformV1PersistentDiskSpec",
+"description": "The specification of a persistent disk to attach for the execution job."
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource": {
 "description": "The Dataform Repository containing the input notebook.",
 "id": "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource",
@@ -30838,6 +31067,24 @@ false
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1PredictLongRunningRequest": {
+"description": "Request message for PredictionService.PredictLongRunning.",
+"id": "GoogleCloudAiplatformV1PredictLongRunningRequest",
+"properties": {
+"instances": {
+"description": "Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.",
+"items": {
+"type": "any"
+},
+"type": "array"
+},
+"parameters": {
+"description": "Optional. The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.",
+"type": "any"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1PredictRequest": {
 "description": "Request message for PredictionService.Predict.",
 "id": "GoogleCloudAiplatformV1PredictRequest",
@@ -35049,6 +35296,10 @@ false
 "structuredPrompt": {
 "$ref": "GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt",
 "description": "The prompt variation that stores preambles in separate fields."
+},
+"translationPrompt": {
+"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationPrompt",
+"description": "The prompt variation for Translation use case."
 }
 },
 "type": "object"
@@ -35147,6 +35398,35 @@ false
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePair": {
+"description": "A pair of sentences used as reference in source and target languages.",
+"id": "GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePair",
+"properties": {
+"sourceSentence": {
+"description": "Source sentence in the sentence pair.",
+"type": "string"
+},
+"targetSentence": {
+"description": "Target sentence in the sentence pair.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePairList": {
+"description": "A list of reference sentence pairs.",
+"id": "GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePairList",
+"properties": {
+"referenceSentencePairs": {
+"description": "Reference sentence pairs.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePair"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt": {
 "description": "Prompt variation that stores preambles in separate fields.",
 "id": "GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt",
@@ -35198,6 +35478,108 @@ false
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1SchemaPromptSpecTranslationExample": {
+"description": "The translation example that contains reference sentences from various sources.",
+"id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationExample",
+"properties": {
+"referenceSentencePairLists": {
+"description": "The reference sentences from inline text.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecReferenceSentencePairList"
+},
+"type": "array"
+},
+"referenceSentencesFileInputs": {
+"description": "The reference sentences from file.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationSentenceFileInput"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1SchemaPromptSpecTranslationFileInputSource": {
+"id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationFileInputSource",
+"properties": {
+"content": {
+"description": "The file's contents.",
+"type": "string"
+},
+"displayName": {
+"description": "The file's display name.",
+"type": "string"
+},
+"mimeType": {
+"description": "The file's mime type.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1SchemaPromptSpecTranslationGcsInputSource": {
+"id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationGcsInputSource",
+"properties": {
+"inputUri": {
+"description": "Source data URI. For example, `gs://my_bucket/my_object`.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1SchemaPromptSpecTranslationOption": {
+"description": "Optional settings for translation prompt.",
+"id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationOption",
+"properties": {
+"numberOfShots": {
+"description": "How many shots to use.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1SchemaPromptSpecTranslationPrompt": {
+"description": "Prompt variation for Translation use case.",
+"id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationPrompt",
+"properties": {
+"example": {
+"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationExample",
+"description": "The translation example."
+},
+"option": {
+"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationOption",
+"description": "The translation option."
+},
+"promptMessage": {
+"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage",
+"description": "The prompt message."
+},
+"sourceLanguageCode": {
+"description": "The source language code.",
+"type": "string"
+},
+"targetLanguageCode": {
+"description": "The target language code.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1SchemaPromptSpecTranslationSentenceFileInput": {
+"id": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationSentenceFileInput",
+"properties": {
+"fileInputSource": {
+"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationFileInputSource",
+"description": "Inlined file source."
+},
+"gcsInputSource": {
+"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecTranslationGcsInputSource",
+"description": "Cloud Storage file source."
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1SchemaTablesDatasetMetadata": {
 "description": "The metadata of Datasets that contain tables data.",
 "id": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadata",
@@ -39907,7 +40289,7 @@ false
 "id": "GoogleCloudAiplatformV1TuningJob",
 "properties": {
 "baseModel": {
-"description": "The base model that is being tuned, e.g., \"gemini-1.0-pro-002\".",
+"description": "The base model that is being tuned, e.g., \"gemini-1.0-pro-002\". .",
 "type": "string"
 },
 "createTime": {