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

googleapiclient/discovery_cache/documents/aiplatform.v1.json

@@ -4106,6 +4106,39 @@
 }
 },
 "resources": {
+"chat": {
+"methods": {
+"completions": {
+"description": "Exposes an OpenAI-compatible endpoint for chat completions.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/chat/completions",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.chat.completions",
+"parameterOrder": [
+"endpoint"
+],
+"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"
+}
+},
+"path": "v1/{+endpoint}/chat/completions",
+"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": {
@@ -4433,6 +4466,34 @@
 "resources": {
 "features": {
 "methods": {
+"batchCreate": {
+"description": "Creates a batch of Features in a given FeatureGroup.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features:batchCreate",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureGroups.features.batchCreate",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/features:batchCreate",
+"request": {
+"$ref": "GoogleCloudAiplatformV1BatchCreateFeaturesRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "create": {
 "description": "Creates a new Feature in a given FeatureGroup.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features",
@@ -5340,7 +5401,7 @@
 "type": "string"
 },
 "updateMask": {
-"description": "Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron`",
+"description": "Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources`",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -12735,6 +12796,34 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"stop": {
+"description": "Stops a NotebookRuntime.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:stop",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookRuntimes.stop",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:stop",
+"request": {
+"$ref": "GoogleCloudAiplatformV1StopNotebookRuntimeRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "upgrade": {
 "description": "Upgrades a NotebookRuntime.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade",
@@ -17813,7 +17902,7 @@
 }
 }
 },
-"revision": "20240925",
+"revision": "20241025",
 "rootUrl": "https://aiplatform.googleapis.com/",
 "schemas": {
 "CloudAiLargeModelsVisionGenerateVideoResponse": {
@@ -17864,6 +17953,10 @@
 "$ref": "CloudAiLargeModelsVisionImageRAIScores",
 "description": "RAI scores for generated image."
 },
+"imageSize": {
+"$ref": "CloudAiLargeModelsVisionImageImageSize",
+"description": "Image size. The size of the image. Can be self reported, or computed from the image bytes."
+},
 "raiInfo": {
 "$ref": "CloudAiLargeModelsVisionRaiInfo",
 "description": "RAI info for image."
@@ -17883,6 +17976,25 @@
 },
 "type": "object"
 },
+"CloudAiLargeModelsVisionImageImageSize": {
+"description": "Image size.",
+"id": "CloudAiLargeModelsVisionImageImageSize",
+"properties": {
+"channels": {
+"format": "int32",
+"type": "integer"
+},
+"height": {
+"format": "int32",
+"type": "integer"
+},
+"width": {
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
 "CloudAiLargeModelsVisionImageRAIScores": {
 "description": "RAI scores for generated image returned.",
 "id": "CloudAiLargeModelsVisionImageRAIScores",
@@ -19571,6 +19683,18 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1ClientConnectionConfig": {
+"description": "Configurations (e.g. inference timeout) that are applied on your endpoints.",
+"id": "GoogleCloudAiplatformV1ClientConnectionConfig",
+"properties": {
+"inferenceTimeout": {
+"description": "Customizable online prediction request timeout.",
+"format": "google-duration",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1CoherenceInput": {
 "description": "Input for coherence metric.",
 "id": "GoogleCloudAiplatformV1CoherenceInput",
@@ -21264,6 +21388,13 @@
 "sharedResources": {
 "description": "The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`",
 "type": "string"
+},
+"systemLabels": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "System labels to apply to Model Garden deployments. System labels are managed by Google for internal use only.",
+"type": "object"
 }
 },
 "type": "object"
@@ -21435,6 +21566,30 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1DynamicRetrievalConfig": {
+"description": "Describes the options to customize dynamic retrieval.",
+"id": "GoogleCloudAiplatformV1DynamicRetrievalConfig",
+"properties": {
+"dynamicThreshold": {
+"description": "Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.",
+"format": "float",
+"type": "number"
+},
+"mode": {
+"description": "The mode of the predictor to be used in dynamic retrieval.",
+"enum": [
+"MODE_UNSPECIFIED",
+"MODE_DYNAMIC"
+],
+"enumDescriptions": [
+"Always trigger retrieval.",
+"Run retrieval only when system decides it is necessary."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1EncryptionSpec": {
 "description": "Represents a customer-managed encryption key spec that can be applied to a top-level resource.",
 "id": "GoogleCloudAiplatformV1EncryptionSpec",
@@ -21450,6 +21605,10 @@
 "description": "Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.",
 "id": "GoogleCloudAiplatformV1Endpoint",
 "properties": {
+"clientConnectionConfig": {
+"$ref": "GoogleCloudAiplatformV1ClientConnectionConfig",
+"description": "Configurations that are applied to the endpoint for online prediction."
+},
 "createTime": {
 "description": "Output only. Timestamp when this Endpoint was created.",
 "format": "google-datetime",
@@ -23557,6 +23716,10 @@
 "description": "Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
 "type": "string"
 },
+"optimizedConfig": {
+"$ref": "GoogleCloudAiplatformV1FeatureViewOptimizedConfig",
+"description": "Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore."
+},
 "satisfiesPzi": {
 "description": "Output only. Reserved for future use.",
 "readOnly": true,
@@ -23736,6 +23899,17 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1FeatureViewOptimizedConfig": {
+"description": "Configuration for FeatureViews created in Optimized FeatureOnlineStore.",
+"id": "GoogleCloudAiplatformV1FeatureViewOptimizedConfig",
+"properties": {
+"automaticResources": {
+"$ref": "GoogleCloudAiplatformV1AutomaticResources",
+"description": "Optional. A description of resources that the FeatureView uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2. If max_replica_count is not set, the default value is 6. The max allowed replica count is 1000."
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1FeatureViewSync": {
 "description": "FeatureViewSync is a representation of sync operation which copies data from data source to Feature View in Online Store.",
 "id": "GoogleCloudAiplatformV1FeatureViewSync",
@@ -23782,6 +23956,10 @@
 "description": "Configuration for Sync. Only one option is set.",
 "id": "GoogleCloudAiplatformV1FeatureViewSyncConfig",
 "properties": {
+"continuous": {
+"description": "Optional. If true, syncs the FeatureView in a continuous manner to Online Store.",
+"type": "boolean"
+},
 "cron": {
 "description": "Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: \"CRON_TZ=${IANA_TIME_ZONE}\" or \"TZ=${IANA_TIME_ZONE}\". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, \"CRON_TZ=America/New_York 1 * * * *\", or \"TZ=America/New_York 1 * * * *\".",
 "type": "string"
@@ -24675,6 +24853,10 @@
 "description": "Generation config.",
 "id": "GoogleCloudAiplatformV1GenerationConfig",
 "properties": {
+"audioTimestamp": {
+"description": "Optional. If enabled, audio timestamp will be included in the request to the model.",
+"type": "boolean"
+},
 "candidateCount": {
 "description": "Optional. Number of candidates to generate.",
 "format": "int32",
@@ -24836,7 +25018,12 @@
 "GoogleCloudAiplatformV1GoogleSearchRetrieval": {
 "description": "Tool to retrieve public web data for grounding, powered by Google.",
 "id": "GoogleCloudAiplatformV1GoogleSearchRetrieval",
-"properties": {},
+"properties": {
+"dynamicRetrievalConfig": {
+"$ref": "GoogleCloudAiplatformV1DynamicRetrievalConfig",
+"description": "Specifies the dynamic retrieval configuration for the given source."
+}
+},
 "type": "object"
 },
 "GoogleCloudAiplatformV1GroundednessInput": {
@@ -24924,6 +25111,10 @@
 "description": "Chunk from context retrieved by the retrieval tools.",
 "id": "GoogleCloudAiplatformV1GroundingChunkRetrievedContext",
 "properties": {
+"text": {
+"description": "Text of the attribution.",
+"type": "string"
+},
 "title": {
 "description": "Title of the attribution.",
 "type": "string"
@@ -24968,6 +25159,11 @@
 },
 "type": "array"
 },
+"retrievalMetadata": {
+"$ref": "GoogleCloudAiplatformV1RetrievalMetadata",
+"description": "Optional. Output only. Retrieval metadata.",
+"readOnly": true
+},
 "searchEntryPoint": {
 "$ref": "GoogleCloudAiplatformV1SearchEntryPoint",
 "description": "Optional. Google search entry for the following-up web searches."
@@ -26763,11 +26959,11 @@
 "type": "number"
 },
 "token": {
-"description": "The candidate\u2019s token string value.",
+"description": "The candidate's token string value.",
 "type": "string"
 },
 "tokenId": {
-"description": "The candidate\u2019s token id value.",
+"description": "The candidate's token id value.",
 "format": "int32",
 "type": "integer"
 }
@@ -31087,7 +31283,7 @@ false
 "additionalProperties": {
 "type": "string"
 },
-"description": "Optional. Labels for the deployment. For managing deployment config like verifying, source of deployment config, etc.",
+"description": "Optional. Labels for the deployment config. For managing deployment config like verifying, source of deployment config, etc.",
 "type": "object"
 },
 "sampleRequest": {
@@ -32288,6 +32484,18 @@ false
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1RetrievalMetadata": {
+"description": "Metadata related to retrieval in the grounding flow.",
+"id": "GoogleCloudAiplatformV1RetrievalMetadata",
+"properties": {
+"googleSearchDynamicRetrievalScore": {
+"description": "Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.",
+"format": "float",
+"type": "number"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1RougeInput": {
 "description": "Input for rouge metric.",
 "id": "GoogleCloudAiplatformV1RougeInput",
@@ -32909,7 +33117,7 @@ false
 "type": "string"
 },
 "enum": {
-"description": "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\"]}",
+"description": "Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[\"EAST\", NORTH\", \"SOUTH\", \"WEST\"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[\"101\", \"201\", \"301\"]}",
 "items": {
 "type": "string"
 },
@@ -34819,6 +35027,177 @@ false
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1SchemaPromptApiSchema": {
+"description": "The A2 schema of a prompt.",
+"id": "GoogleCloudAiplatformV1SchemaPromptApiSchema",
+"properties": {
+"apiSchemaVersion": {
+"description": "The Schema version that represents changes to the API behavior.",
+"type": "string"
+},
+"executions": {
+"description": "A list of execution instances for constructing a ready-to-use prompt.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1SchemaPromptInstancePromptExecution"
+},
+"type": "array"
+},
+"multimodalPrompt": {
+"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecMultimodalPrompt",
+"description": "Multimodal prompt which embeds preambles to prompt string."
+},
+"structuredPrompt": {
+"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt",
+"description": "The prompt variation that stores preambles in separate fields."
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1SchemaPromptInstancePromptExecution": {
+"description": "A prompt instance's parameters set that contains a set of variable values.",
+"id": "GoogleCloudAiplatformV1SchemaPromptInstancePromptExecution",
+"properties": {
+"arguments": {
+"additionalProperties": {
+"$ref": "GoogleCloudAiplatformV1SchemaPromptInstanceVariableValue"
+},
+"description": "Maps variable names to their value.",
+"type": "object"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1SchemaPromptInstanceVariableValue": {
+"description": "The value of a variable in prompt.",
+"id": "GoogleCloudAiplatformV1SchemaPromptInstanceVariableValue",
+"properties": {
+"partList": {
+"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPartList",
+"description": "The parts of the variable value."
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1SchemaPromptSpecMultimodalPrompt": {
+"description": "Prompt variation that embeds preambles to prompt string.",
+"id": "GoogleCloudAiplatformV1SchemaPromptSpecMultimodalPrompt",
+"properties": {
+"promptMessage": {
+"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage",
+"description": "The prompt message."
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1SchemaPromptSpecPartList": {
+"description": "A list of elements and information that make up a portion of prompt.",
+"id": "GoogleCloudAiplatformV1SchemaPromptSpecPartList",
+"properties": {
+"parts": {
+"description": "A list of elements that can be part of a prompt.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1Part"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage": {
+"description": "The prompt message that aligns with the prompt message in google.cloud.aiplatform.master.GenerateContentRequest.",
+"id": "GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage",
+"properties": {
+"contents": {
+"description": "The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1Content"
+},
+"type": "array"
+},
+"generationConfig": {
+"$ref": "GoogleCloudAiplatformV1GenerationConfig",
+"description": "Generation config."
+},
+"model": {
+"description": "The model name.",
+"type": "string"
+},
+"safetySettings": {
+"description": "Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1SafetySetting"
+},
+"type": "array"
+},
+"systemInstruction": {
+"$ref": "GoogleCloudAiplatformV1Content",
+"description": "The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph."
+},
+"toolConfig": {
+"$ref": "GoogleCloudAiplatformV1ToolConfig",
+"description": "Tool config. This config is shared for all tools provided in the request."
+},
+"tools": {
+"description": "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": {
+"$ref": "GoogleCloudAiplatformV1Tool"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt": {
+"description": "Prompt variation that stores preambles in separate fields.",
+"id": "GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt",
+"properties": {
+"context": {
+"$ref": "GoogleCloudAiplatformV1Content",
+"description": "Preamble: The context of the prompt."
+},
+"examples": {
+"description": "Preamble: A set of examples for expected model response.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPartList"
+},
+"type": "array"
+},
+"infillPrefix": {
+"description": "Preamble: For infill prompt, the prefix before expected model response.",
+"type": "string"
+},
+"infillSuffix": {
+"description": "Preamble: For infill prompt, the suffix after expected model response.",
+"type": "string"
+},
+"inputPrefixes": {
+"description": "Preamble: The input prefixes before each example input.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"outputPrefixes": {
+"description": "Preamble: The output prefixes before each example output.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"predictionInputs": {
+"description": "Preamble: The input test data for prediction. Each PartList in this field represents one text-only input set for a single model request.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPartList"
+},
+"type": "array"
+},
+"promptMessage": {
+"$ref": "GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage",
+"description": "The prompt message."
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1SchemaTablesDatasetMetadata": {
 "description": "The metadata of Datasets that contain tables data.",
 "id": "GoogleCloudAiplatformV1SchemaTablesDatasetMetadata",
@@ -34960,6 +35339,10 @@ false
 "description": "User-created prompt note. Note size limit is 2KB.",
 "type": "string"
 },
+"promptApiSchema": {
+"$ref": "GoogleCloudAiplatformV1SchemaPromptApiSchema",
+"description": "The API schema of the prompt to support both UI and SDK usages."
+},
 "promptType": {
 "description": "Type of the prompt dataset.",
 "type": "string"
@@ -37159,6 +37542,12 @@ false
 "properties": {},
 "type": "object"
 },
+"GoogleCloudAiplatformV1StopNotebookRuntimeRequest": {
+"description": "Request message for NotebookService.StopNotebookRuntime.",
+"id": "GoogleCloudAiplatformV1StopNotebookRuntimeRequest",
+"properties": {},
+"type": "object"
+},
 "GoogleCloudAiplatformV1StopTrialRequest": {
 "description": "Request message for VizierService.StopTrial.",
 "id": "GoogleCloudAiplatformV1StopTrialRequest",
@@ -39141,7 +39530,7 @@ false
 "id": "GoogleCloudAiplatformV1ToolParameterKVMatchSpec",
 "properties": {
 "useStrictStringMatch": {
-"description": "Optional. Whether to use STRCIT string match on parameter values.",
+"description": "Optional. Whether to use STRICT string match on parameter values.",
 "type": "boolean"
 }
 },
@@ -40041,6 +40430,7 @@ false
 "type": "array"
 },
 "similarityTopK": {
+"deprecated": true,
 "description": "Optional. Number of top k results to return from the selected corpora.",
 "format": "int32",
 "type": "integer"