google-api-python-client 2.182.0__py3-none-any.whl → 2.183.0__py3-none-any.whl

googleapiclient/discovery_cache/documents/aiplatform.v1.json

@@ -228,6 +228,16 @@
 "description": "Locational Endpoint",
 "endpointUrl": "https://us-east5-aiplatform.googleapis.com/",
 "location": "us-east5"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://aiplatform.us.rep.googleapis.com/",
+"location": "us"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://aiplatform.eu.rep.googleapis.com/",
+"location": "eu"
 }
 ],
 "fullyEncodeReservedExpansion": true,
@@ -1382,7 +1392,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -4969,6 +4979,133 @@
 }
 }
 },
+"deployedModels": {
+"resources": {
+"invoke": {
+"methods": {
+"invoke": {
+"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/deployedModels/{deployedModelId}/invoke/{invokeId}",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke",
+"parameterOrder": [
+"endpoint",
+"deployedModelId",
+"invokeId"
+],
+"parameters": {
+"deployedModelId": {
+"description": "ID of the DeployedModel that serves the invoke request.",
+"location": "path",
+"required": true,
+"type": "string"
+},
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+},
+"invokeId": {
+"location": "path",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1InvokeRequest"
+},
+"response": {
+"$ref": "GoogleApiHttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+}
+}
+}
+}
+},
+"invoke": {
+"methods": {
+"invoke": {
+"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/invoke/{invokeId}",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.invoke.invoke",
+"parameterOrder": [
+"endpoint",
+"invokeId"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+},
+"invokeId": {
+"location": "path",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}/invoke/{+invokeId}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1InvokeRequest"
+},
+"response": {
+"$ref": "GoogleApiHttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+}
+}
+},
+"openapi": {
+"methods": {
+"embeddings": {
+"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/embeddings",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.openapi.embeddings",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"deployedModelId": {
+"description": "ID of the DeployedModel that serves the invoke request.",
+"location": "query",
+"type": "string"
+},
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}/embeddings",
+"request": {
+"$ref": "GoogleApiHttpBody"
+},
+"response": {
+"$ref": "GoogleApiHttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+}
+}
+},
 "operations": {
 "methods": {
 "cancel": {
@@ -20793,7 +20930,7 @@
 }
 }
 },
-"revision": "20250902",
+"revision": "20250916",
 "rootUrl": "https://aiplatform.googleapis.com/",
 "schemas": {
 "CloudAiLargeModelsVisionGenerateVideoResponse": {
@@ -25092,7 +25229,7 @@
 "id": "GoogleCloudAiplatformV1DeployRequestEndpointConfig",
 "properties": {
 "dedicatedEndpointDisabled": {
-"description": "Optional. By default, if dedicated endpoint is enabled, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com.",
+"description": "Optional. By default, if dedicated endpoint is enabled and private service connect config is not set, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. If private service connect config is set, the endpoint will be exposed through private service connect. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com.",
 "type": "boolean"
 },
 "dedicatedEndpointEnabled": {
@@ -25107,6 +25244,10 @@
 "endpointUserId": {
 "description": "Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.",
 "type": "string"
+},
+"privateServiceConnectConfig": {
+"$ref": "GoogleCloudAiplatformV1PrivateServiceConnectConfig",
+"description": "Optional. Configuration for private service connect. If set, the endpoint will be exposed through private service connect."
 }
 },
 "type": "object"
@@ -26814,10 +26955,6 @@
 "description": "The metric used for evaluation runs.",
 "id": "GoogleCloudAiplatformV1EvaluationRunMetric",
 "properties": {
-"computationBasedMetricSpec": {
-"$ref": "GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec",
-"description": "Spec for a computation based metric."
-},
 "llmBasedMetricSpec": {
 "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec",
 "description": "Spec for an LLM based metric."
@@ -26837,37 +26974,6 @@
 },
 "type": "object"
 },
-"GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec": {
-"description": "Specification for a computation based metric.",
-"id": "GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec",
-"properties": {
-"parameters": {
-"additionalProperties": {
-"description": "Properties of the object.",
-"type": "any"
-},
-"description": "Optional. A map of parameters for the metric, e.g. {\"rouge_type\": \"rougeL\"}.",
-"type": "object"
-},
-"type": {
-"description": "Required. The type of the computation based metric.",
-"enum": [
-"COMPUTATION_BASED_METRIC_TYPE_UNSPECIFIED",
-"EXACT_MATCH",
-"BLEU",
-"ROUGE"
-],
-"enumDescriptions": [
-"Unspecified computation based metric type.",
-"Exact match metric.",
-"BLEU metric.",
-"ROUGE metric."
-],
-"type": "string"
-}
-},
-"type": "object"
-},
 "GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec": {
 "description": "Specification for an LLM based metric.",
 "id": "GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec",
@@ -30064,11 +30170,11 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback": {
-"description": "Content filter results for a prompt sent in the request.",
+"description": "Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations.",
 "id": "GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback",
 "properties": {
 "blockReason": {
-"description": "Output only. Blocked reason.",
+"description": "Output only. The reason why the prompt was blocked.",
 "enum": [
 "BLOCKED_REASON_UNSPECIFIED",
 "SAFETY",
@@ -30079,24 +30185,24 @@
 "IMAGE_SAFETY"
 ],
 "enumDescriptions": [
-"Unspecified blocked reason.",
-"Candidates blocked due to safety.",
-"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.",
-"The user prompt was blocked by Model Armor.",
-"Candidates blocked due to unsafe image generation content."
+"The blocked reason is unspecified.",
+"The prompt was blocked for safety reasons.",
+"The prompt was blocked for other reasons. For example, it may be due to the prompt's language, or because it contains other harmful content.",
+"The prompt was blocked because it contains a term from the terminology blocklist.",
+"The prompt was blocked because it contains prohibited content.",
+"The prompt was blocked by Model Armor.",
+"The prompt was blocked because it contains content that is unsafe for image generation."
 ],
 "readOnly": true,
 "type": "string"
 },
 "blockReasonMessage": {
-"description": "Output only. A readable block reason message.",
+"description": "Output only. A readable message that explains the reason why the prompt was blocked.",
 "readOnly": true,
 "type": "string"
 },
 "safetyRatings": {
-"description": "Output only. Safety ratings.",
+"description": "Output only. A list of safety ratings for the prompt. There is one rating per category.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1SafetyRating"
 },
@@ -30107,11 +30213,11 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata": {
-"description": "Usage metadata about response(s).",
+"description": "Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.",
 "id": "GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata",
 "properties": {
 "cacheTokensDetails": {
-"description": "Output only. List of modalities of the cached content in the request input.",
+"description": "Output only. A detailed breakdown of the token count for each modality in the cached content.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1ModalityTokenCount"
 },
@@ -30119,18 +30225,18 @@
 "type": "array"
 },
 "cachedContentTokenCount": {
-"description": "Output only. Number of tokens in the cached part in the input (the cached content).",
+"description": "Output only. The number of tokens in the cached content that was used for this request.",
 "format": "int32",
 "readOnly": true,
 "type": "integer"
 },
 "candidatesTokenCount": {
-"description": "Number of tokens in the response(s).",
+"description": "The total number of tokens in the generated candidates.",
 "format": "int32",
 "type": "integer"
 },
 "candidatesTokensDetails": {
-"description": "Output only. List of modalities that were returned in the response.",
+"description": "Output only. A detailed breakdown of the token count for each modality in the generated candidates.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1ModalityTokenCount"
 },
@@ -30138,12 +30244,12 @@
 "type": "array"
 },
 "promptTokenCount": {
-"description": "Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.",
+"description": "The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.",
 "format": "int32",
 "type": "integer"
 },
 "promptTokensDetails": {
-"description": "Output only. List of modalities that were processed in the request input.",
+"description": "Output only. A detailed breakdown of the token count for each modality in the prompt.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1ModalityTokenCount"
 },
@@ -30151,19 +30257,19 @@
 "type": "array"
 },
 "thoughtsTokenCount": {
-"description": "Output only. Number of tokens present in thoughts output.",
+"description": "Output only. The number of tokens that were part of the model's generated \"thoughts\" output, if applicable.",
 "format": "int32",
 "readOnly": true,
 "type": "integer"
 },
 "toolUsePromptTokenCount": {
-"description": "Output only. Number of tokens present in tool-use prompt(s).",
+"description": "Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.",
 "format": "int32",
 "readOnly": true,
 "type": "integer"
 },
 "toolUsePromptTokensDetails": {
-"description": "Output only. List of modalities that were processed for tool-use request inputs.",
+"description": "Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1ModalityTokenCount"
 },
@@ -30171,12 +30277,12 @@
 "type": "array"
 },
 "totalTokenCount": {
-"description": "Total token count for prompt, response candidates, and tool-use prompts (if present).",
+"description": "The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.",
 "format": "int32",
 "type": "integer"
 },
 "trafficType": {
-"description": "Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota.",
+"description": "Output only. The traffic type for this request.",
 "enum": [
 "TRAFFIC_TYPE_UNSPECIFIED",
 "ON_DEMAND",
@@ -30184,7 +30290,7 @@
 ],
 "enumDescriptions": [
 "Unspecified request traffic type.",
-"Type for Pay-As-You-Go traffic.",
+"The request was processed using Pay-As-You-Go quota.",
 "Type for Provisioned Throughput traffic."
 ],
 "readOnly": true,
@@ -30602,7 +30708,12 @@
 "GoogleCloudAiplatformV1GoogleMaps": {
 "description": "Tool to retrieve public maps data for grounding, powered by Google.",
 "id": "GoogleCloudAiplatformV1GoogleMaps",
-"properties": {},
+"properties": {
+"enableWidget": {
+"description": "Optional. If true, include the widget context token in the response.",
+"type": "boolean"
+}
+},
 "type": "object"
 },
 "GoogleCloudAiplatformV1GoogleSearchRetrieval": {
@@ -30714,15 +30825,15 @@
 "type": "string"
 },
 "text": {
-"description": "Text of the chunk.",
+"description": "Text of the place answer.",
 "type": "string"
 },
 "title": {
-"description": "Title of the chunk.",
+"description": "Title of the place.",
 "type": "string"
 },
 "uri": {
-"description": "URI reference of the chunk.",
+"description": "URI reference of the place.",
 "type": "string"
 }
 },
@@ -30732,10 +30843,6 @@
 "description": "Sources used to generate the place answer.",
 "id": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources",
 "properties": {
-"flagContentUri": {
-"description": "A link where users can flag a problem with the generated answer.",
-"type": "string"
-},
 "reviewSnippets": {
 "description": "Snippets of reviews that are used to generate the answer.",
 "items": {
@@ -30746,47 +30853,20 @@
 },
 "type": "object"
 },
-"GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution": {
-"description": "Author attribution for a photo or review.",
-"id": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution",
-"properties": {
-"displayName": {
-"description": "Name of the author of the Photo or Review.",
-"type": "string"
-},
-"photoUri": {
-"description": "Profile photo URI of the author of the Photo or Review.",
-"type": "string"
-},
-"uri": {
-"description": "URI of the author of the Photo or Review.",
-"type": "string"
-}
-},
-"type": "object"
-},
 "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet": {
 "description": "Encapsulates a review snippet.",
 "id": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet",
 "properties": {
-"authorAttribution": {
-"$ref": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution",
-"description": "This review's author."
-},
-"flagContentUri": {
-"description": "A link where users can flag a problem with the review.",
-"type": "string"
-},
 "googleMapsUri": {
 "description": "A link to show the review on Google Maps.",
 "type": "string"
 },
-"relativePublishTimeDescription": {
-"description": "A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country.",
+"reviewId": {
+"description": "Id of the review referencing the place.",
 "type": "string"
 },
-"review": {
-"description": "A reference representing this place review which may be used to look up this place review again.",
+"title": {
+"description": "Title of the review.",
 "type": "string"
 }
 },
@@ -30871,6 +30951,14 @@
 "$ref": "GoogleCloudAiplatformV1SearchEntryPoint",
 "description": "Optional. Google search entry for the following-up web searches."
 },
+"sourceFlaggingUris": {
+"description": "Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri"
+},
+"readOnly": true,
+"type": "array"
+},
 "webSearchQueries": {
 "description": "Optional. Web search queries for the following-up web search.",
 "items": {
@@ -30881,6 +30969,21 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri": {
+"description": "Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.",
+"id": "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri",
+"properties": {
+"flagContentUri": {
+"description": "A link where users can flag a problem with the source (place or review).",
+"type": "string"
+},
+"sourceId": {
+"description": "Id of the place or review.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1GroundingSupport": {
 "description": "Grounding support.",
 "id": "GoogleCloudAiplatformV1GroundingSupport",
@@ -31808,6 +31911,21 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1InvokeRequest": {
+"description": "Request message for PredictionService.Invoke.",
+"id": "GoogleCloudAiplatformV1InvokeRequest",
+"properties": {
+"deployedModelId": {
+"description": "ID of the DeployedModel that serves the invoke request.",
+"type": "string"
+},
+"httpBody": {
+"$ref": "GoogleApiHttpBody",
+"description": "The invoke method input. Supports HTTP headers and arbitrary data payload."
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1JiraSource": {
 "description": "The Jira source for the ImportRagFilesRequest.",
 "id": "GoogleCloudAiplatformV1JiraSource",
@@ -31855,6 +31973,45 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1LLMBasedMetricSpec": {
+"description": "Specification for an LLM based metric.",
+"id": "GoogleCloudAiplatformV1LLMBasedMetricSpec",
+"properties": {
+"additionalConfig": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. Optional additional configuration for the metric.",
+"type": "object"
+},
+"judgeAutoraterConfig": {
+"$ref": "GoogleCloudAiplatformV1AutoraterConfig",
+"description": "Optional. Optional configuration for the judge LLM (Autorater)."
+},
+"metricPromptTemplate": {
+"description": "Required. Template for the prompt sent to the judge model.",
+"type": "string"
+},
+"predefinedRubricGenerationSpec": {
+"$ref": "GoogleCloudAiplatformV1PredefinedMetricSpec",
+"description": "Dynamically generate rubrics using a predefined spec."
+},
+"rubricGenerationSpec": {
+"$ref": "GoogleCloudAiplatformV1RubricGenerationSpec",
+"description": "Dynamically generate rubrics using this specification."
+},
+"rubricGroupKey": {
+"description": "Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.",
+"type": "string"
+},
+"systemInstruction": {
+"description": "Optional. System instructions for the judge model.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1LargeModelReference": {
 "description": "Contains information about the Large Model.",
 "id": "GoogleCloudAiplatformV1LargeModelReference",
@@ -33284,6 +33441,10 @@ false
 "$ref": "GoogleCloudAiplatformV1ExactMatchSpec",
 "description": "Spec for exact match metric."
 },
+"llmBasedMetricSpec": {
+"$ref": "GoogleCloudAiplatformV1LLMBasedMetricSpec",
+"description": "Spec for an LLM based metric."
+},
 "pairwiseMetricSpec": {
 "$ref": "GoogleCloudAiplatformV1PairwiseMetricSpec",
 "description": "Spec for pairwise metric."
@@ -47636,7 +47797,8 @@ false
 },
 "googleSearchRetrieval": {
 "$ref": "GoogleCloudAiplatformV1GoogleSearchRetrieval",
-"description": "Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search."
+"deprecated": true,
+"description": "Optional. Specialized retrieval tool that is powered by Google Search."
 },
 "retrieval": {
 "$ref": "GoogleCloudAiplatformV1Retrieval",