google-api-python-client 2.145.0__py2.py3-none-any.whl → 2.147.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/aiplatform.v1.json

@@ -4271,7 +4271,7 @@
 ],
 "parameters": {
 "featureGroupId": {
-"description": "Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.",
+"description": "Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.",
 "location": "query",
 "type": "string"
 },
@@ -17476,6 +17476,34 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"rebaseTunedModel": {
+"description": "Rebase a TunedModel.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.tuningJobs.rebaseTunedModel",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/tuningJobs:rebaseTunedModel",
+"request": {
+"$ref": "GoogleCloudAiplatformV1RebaseTunedModelRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
 },
 "resources": {
@@ -17506,6 +17534,31 @@
 "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}/tuningJobs/{tuningJobsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.tuningJobs.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/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}/tuningJobs/{tuningJobsId}/operations/{operationsId}",
@@ -17760,7 +17813,7 @@
 }
 }
 },
-"revision": "20240828",
+"revision": "20240916",
 "rootUrl": "https://aiplatform.googleapis.com/",
 "schemas": {
 "CloudAiLargeModelsVisionGenerateVideoResponse": {
@@ -17899,8 +17952,16 @@
 "type": "object"
 },
 "CloudAiLargeModelsVisionRaiInfo": {
+"description": "Next ID: 6",
 "id": "CloudAiLargeModelsVisionRaiInfo",
 "properties": {
+"blockedEntities": {
+"description": "List of blocked entities from the blocklist if it is detected.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
 "detectedLabels": {
 "description": "The list of detected labels for different rai categories.",
 "items": {
@@ -19404,6 +19465,11 @@
 "readOnly": true,
 "type": "integer"
 },
+"logprobsResult": {
+"$ref": "GoogleCloudAiplatformV1LogprobsResult",
+"description": "Output only. Log-likelihood scores for the response tokens and top tokens",
+"readOnly": true
+},
 "safetyRatings": {
 "description": "Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.",
 "items": {
@@ -19844,6 +19910,10 @@
 },
 "type": "array"
 },
+"generationConfig": {
+"$ref": "GoogleCloudAiplatformV1GenerationConfig",
+"description": "Optional. Generation config that the model will use to generate the response."
+},
 "instances": {
 "description": "Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.",
 "items": {
@@ -20082,6 +20152,25 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest": {
+"description": "Request message for [NotebookService.CreateNotebookExecutionJob]",
+"id": "GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest",
+"properties": {
+"notebookExecutionJob": {
+"$ref": "GoogleCloudAiplatformV1NotebookExecutionJob",
+"description": "Required. The NotebookExecutionJob to create."
+},
+"notebookExecutionJobId": {
+"description": "Optional. User specified ID for the NotebookExecutionJob.",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata": {
 "description": "Metadata information for NotebookService.CreateNotebookRuntimeTemplate.",
 "id": "GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata",
@@ -21043,6 +21132,13 @@
 "description": "Output only. Provides paths for users to send requests directly to the deployed index services running on Cloud via private services access. This field is populated if network is configured.",
 "readOnly": true
 },
+"pscAutomationConfigs": {
+"description": "Optional. If set for PSC deployed index, PSC connection will be automatically created after deployment is done and the endpoint information is populated in private_endpoints.psc_automated_endpoints.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1PSCAutomationConfig"
+},
+"type": "array"
+},
 "reservedIpRanges": {
 "description": "Optional. A list of reserved ip ranges under the VPC network that can be used for this DeployedIndex. If set, we will deploy the index within the provided ip ranges. Otherwise, the index might be deployed to any ip ranges under the provided VPC network. The value should be the name of the address (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) Example: ['vertex-ai-ip-range']. For more information about subnets and network IP ranges, please see https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges.",
 "items": {
@@ -23053,7 +23149,7 @@
 "description": "Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View."
 },
 "dense": {
-"description": "Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema (entity_id, feature_timestamp, f0, f1) and values (e1, 2020-01-01T10:00:00.123Z, 10, 15) (e1, 2020-02-01T10:00:00.123Z, 20, null) If dense is set, (e1, 20, null) is synced to online stores. If dense is not set, (e1, 20, 15) is synced to online stores.",
+"description": "Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema `(entity_id, feature_timestamp, f0, f1)` and the following rows: `(e1, 2020-01-01T10:00:00.123Z, 10, 15)` `(e1, 2020-02-01T10:00:00.123Z, 20, null)` If dense is set, `(e1, 20, null)` is synced to online stores. If dense is not set, `(e1, 20, 15)` is synced to online stores.",
 "type": "boolean"
 },
 "entityIdColumns": {
@@ -23727,7 +23823,7 @@
 "type": "string"
 },
 "uri": {
-"description": "Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns at least: Field name Type Mode corpus_id STRING REQUIRED/NULLABLE file_id STRING REQUIRED/NULLABLE chunk_id STRING REQUIRED/NULLABLE chunk_data_type STRING REQUIRED/NULLABLE chunk_data STRING REQUIRED/NULLABLE embeddings FLOAT REPEATED file_original_uri STRING REQUIRED/NULLABLE",
+"description": "Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns and types at least: - `corpus_id` (STRING, NULLABLE/REQUIRED) - `file_id` (STRING, NULLABLE/REQUIRED) - `chunk_id` (STRING, NULLABLE/REQUIRED) - `chunk_data_type` (STRING, NULLABLE/REQUIRED) - `chunk_data` (STRING, NULLABLE/REQUIRED) - `embeddings` (FLOAT, REPEATED) - `file_original_uri` (STRING, NULLABLE/REQUIRED)",
 "type": "string"
 }
 },
@@ -24453,6 +24549,13 @@
 "$ref": "GoogleCloudAiplatformV1GenerationConfig",
 "description": "Optional. Generation config."
 },
+"labels": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.",
+"type": "object"
+},
 "safetySettings": {
 "description": "Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.",
 "items": {
@@ -24490,6 +24593,11 @@
 "readOnly": true,
 "type": "array"
 },
+"modelVersion": {
+"description": "Output only. The model version used to generate the response.",
+"readOnly": true,
+"type": "string"
+},
 "promptFeedback": {
 "$ref": "GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback",
 "description": "Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations.",
@@ -24577,6 +24685,11 @@
 "format": "float",
 "type": "number"
 },
+"logprobs": {
+"description": "Optional. Logit probabilities.",
+"format": "int32",
+"type": "integer"
+},
 "maxOutputTokens": {
 "description": "Optional. The maximum number of output tokens to generate per message.",
 "format": "int32",
@@ -24587,6 +24700,10 @@
 "format": "float",
 "type": "number"
 },
+"responseLogprobs": {
+"description": "Optional. If true, export the logprobs results in response.",
+"type": "boolean"
+},
 "responseMimeType": {
 "description": "Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.",
 "type": "string"
@@ -26615,6 +26732,62 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1LogprobsResult": {
+"description": "Logprobs Result",
+"id": "GoogleCloudAiplatformV1LogprobsResult",
+"properties": {
+"chosenCandidates": {
+"description": "Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1LogprobsResultCandidate"
+},
+"type": "array"
+},
+"topCandidates": {
+"description": "Length = total number of decoding steps.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1LogprobsResultTopCandidates"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1LogprobsResultCandidate": {
+"description": "Candidate for the logprobs token and score.",
+"id": "GoogleCloudAiplatformV1LogprobsResultCandidate",
+"properties": {
+"logProbability": {
+"description": "The candidate's log probability.",
+"format": "float",
+"type": "number"
+},
+"token": {
+"description": "The candidate\u2019s token string value.",
+"type": "string"
+},
+"tokenId": {
+"description": "The candidate\u2019s token id value.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1LogprobsResultTopCandidates": {
+"description": "Candidates with top log probabilities at each decoding step.",
+"id": "GoogleCloudAiplatformV1LogprobsResultTopCandidates",
+"properties": {
+"candidates": {
+"description": "Sorted by log probability in descending order.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1LogprobsResultCandidate"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1LookupStudyRequest": {
 "description": "Request message for VizierService.LookupStudy.",
 "id": "GoogleCloudAiplatformV1LookupStudyRequest",
@@ -29487,6 +29660,21 @@ false
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1PSCAutomationConfig": {
+"description": "PSC config that is used to automatically create forwarding rule via ServiceConnectionMap.",
+"id": "GoogleCloudAiplatformV1PSCAutomationConfig",
+"properties": {
+"network": {
+"description": "Required. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in '12345', and {network} is network name.",
+"type": "string"
+},
+"projectId": {
+"description": "Required. Project id used to create forwarding rule.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1PairwiseMetricInput": {
 "description": "Input for pairwise metric.",
 "id": "GoogleCloudAiplatformV1PairwiseMetricInput",
@@ -31840,6 +32028,29 @@ false
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1RebaseTunedModelRequest": {
+"description": "Request message for GenAiTuningService.RebaseTunedModel.",
+"id": "GoogleCloudAiplatformV1RebaseTunedModelRequest",
+"properties": {
+"artifactDestination": {
+"$ref": "GoogleCloudAiplatformV1GcsDestination",
+"description": "Optional. The Google Cloud Storage location to write the artifacts."
+},
+"deployToSameEndpoint": {
+"description": "Optional. By default, bison to gemini migration will always create new model/endpoint, but for gemini-1.0 to gemini-1.5 migration, we default deploy to the same endpoint. See details in this Section.",
+"type": "boolean"
+},
+"tunedModelRef": {
+"$ref": "GoogleCloudAiplatformV1TunedModelRef",
+"description": "Required. TunedModel reference to retrieve the legacy model information."
+},
+"tuningJob": {
+"$ref": "GoogleCloudAiplatformV1TuningJob",
+"description": "Optional. The TuningJob to be updated. Users can use this TuningJob field to overwrite tuning configs."
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata": {
 "description": "Details of operations that perform reboot PersistentResource.",
 "id": "GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata",
@@ -32199,14 +32410,16 @@ false
 "HARM_CATEGORY_HATE_SPEECH",
 "HARM_CATEGORY_DANGEROUS_CONTENT",
 "HARM_CATEGORY_HARASSMENT",
-"HARM_CATEGORY_SEXUALLY_EXPLICIT"
+"HARM_CATEGORY_SEXUALLY_EXPLICIT",
+"HARM_CATEGORY_CIVIC_INTEGRITY"
 ],
 "enumDescriptions": [
 "The harm category is unspecified.",
 "The harm category is hate speech.",
 "The harm category is dangerous content.",
 "The harm category is harassment.",
-"The harm category is sexually explicit content."
+"The harm category is sexually explicit content.",
+"The harm category is civic integrity."
 ],
 "readOnly": true,
 "type": "string"
@@ -32299,14 +32512,16 @@ false
 "HARM_CATEGORY_HATE_SPEECH",
 "HARM_CATEGORY_DANGEROUS_CONTENT",
 "HARM_CATEGORY_HARASSMENT",
-"HARM_CATEGORY_SEXUALLY_EXPLICIT"
+"HARM_CATEGORY_SEXUALLY_EXPLICIT",
+"HARM_CATEGORY_CIVIC_INTEGRITY"
 ],
 "enumDescriptions": [
 "The harm category is unspecified.",
 "The harm category is hate speech.",
 "The harm category is dangerous content.",
 "The harm category is harassment.",
-"The harm category is sexually explicit content."
+"The harm category is sexually explicit content.",
+"The harm category is civic integrity."
 ],
 "type": "string"
 },
@@ -32331,14 +32546,16 @@ false
 "BLOCK_LOW_AND_ABOVE",
 "BLOCK_MEDIUM_AND_ABOVE",
 "BLOCK_ONLY_HIGH",
-"BLOCK_NONE"
+"BLOCK_NONE",
+"OFF"
 ],
 "enumDescriptions": [
 "Unspecified harm block threshold.",
 "Block low threshold and above (i.e. block more).",
 "Block medium threshold and above.",
 "Block only high threshold (i.e. block less).",
-"Block none."
+"Block none.",
+"Turn off the safety filter."
 ],
 "type": "string"
 }
@@ -32502,6 +32719,10 @@ false
 "readOnly": true,
 "type": "boolean"
 },
+"createNotebookExecutionJobRequest": {
+"$ref": "GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest",
+"description": "Request for NotebookService.CreateNotebookExecutionJob."
+},
 "createPipelineJobRequest": {
 "$ref": "GoogleCloudAiplatformV1CreatePipelineJobRequest",
 "description": "Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location})."
@@ -32672,6 +32893,13 @@ false
 "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-object). More fields may be added in the future as needed.",
 "id": "GoogleCloudAiplatformV1Schema",
 "properties": {
+"anyOf": {
+"description": "Optional. The value should be validated against any (one or more) of the subschemas in the list.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1Schema"
+},
+"type": "array"
+},
 "default": {
 "description": "Optional. Default value of the data.",
 "type": "any"
@@ -32754,6 +32982,13 @@ false
 "description": "Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.",
 "type": "object"
 },
+"propertyOrdering": {
+"description": "Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
 "required": {
 "description": "Optional. Required properties of Type.OBJECT.",
 "items": {
@@ -38047,7 +38282,7 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1SupervisedTuningSpec": {
-"description": "Tuning Spec for Supervised Tuning.",
+"description": "Tuning Spec for Supervised Tuning for first party models.",
 "id": "GoogleCloudAiplatformV1SupervisedTuningSpec",
 "properties": {
 "hyperParameters": {
@@ -38665,7 +38900,7 @@ false
 "id": "GoogleCloudAiplatformV1Tool",
 "properties": {
 "functionDeclarations": {
-"description": "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.",
+"description": "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 128 function declarations can be provided.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1FunctionDeclaration"
 },
@@ -39235,6 +39470,25 @@ false
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1TunedModelRef": {
+"description": "TunedModel Reference for legacy model migration.",
+"id": "GoogleCloudAiplatformV1TunedModelRef",
+"properties": {
+"pipelineJob": {
+"description": "Support migration from tuning job list page, from bison model to gemini model.",
+"type": "string"
+},
+"tunedModel": {
+"description": "Support migration from model registry.",
+"type": "string"
+},
+"tuningJob": {
+"description": "Support migration from tuning job list page, from gemini-1.0-pro-002 to 1.5 and above.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1TuningDataStats": {
 "description": "The tuning data statistic values for TuningJob.",
 "id": "GoogleCloudAiplatformV1TuningDataStats",