feat: API regeneration: release-2024-10-14.01-03-27

DiscoveryJson/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": {
@@ -17813,7 +17846,7 @@
       }
     }
   },
-  "revision": "20240925",
+  "revision": "20241001",
   "rootUrl": "https://aiplatform.googleapis.com/",
   "schemas": {
     "CloudAiLargeModelsVisionGenerateVideoResponse": {
@@ -21435,6 +21468,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",
@@ -24836,7 +24893,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": {
@@ -24968,6 +25030,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 +26830,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"
         }
@@ -32288,6 +32355,18 @@
       },
       "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",

DiscoveryJson/aiplatform.v1beta1.json

@@ -17143,7 +17143,7 @@
                       "type": "string"
                     },
                     "updateMask": {
-                      "description": "Required. Mask specifying which fields to update.",
+                      "description": "Optional. Mask specifying which fields to update.",
                       "format": "google-fieldmask",
                       "location": "query",
                       "type": "string"
@@ -21202,7 +21202,7 @@
       }
     }
   },
-  "revision": "20240925",
+  "revision": "20241001",
   "rootUrl": "https://aiplatform.googleapis.com/",
   "schemas": {
     "CloudAiLargeModelsVisionGenerateVideoResponse": {
@@ -25624,6 +25624,30 @@
       },
       "type": "object"
     },
+    "GoogleCloudAiplatformV1beta1DynamicRetrievalConfig": {
+      "description": "Describes the options to customize dynamic retrieval.",
+      "id": "GoogleCloudAiplatformV1beta1DynamicRetrievalConfig",
+      "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"
+    },
     "GoogleCloudAiplatformV1beta1EncryptionSpec": {
       "description": "Represents a customer-managed encryption key spec that can be applied to a top-level resource.",
       "id": "GoogleCloudAiplatformV1beta1EncryptionSpec",
@@ -29499,7 +29523,12 @@
     "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval": {
       "description": "Tool to retrieve public web data for grounding, powered by Google.",
       "id": "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval",
-      "properties": {},
+      "properties": {
+        "dynamicRetrievalConfig": {
+          "$ref": "GoogleCloudAiplatformV1beta1DynamicRetrievalConfig",
+          "description": "Specifies the dynamic retrieval configuration for the given source."
+        }
+      },
       "type": "object"
     },
     "GoogleCloudAiplatformV1beta1GroundednessInput": {
@@ -29631,6 +29660,11 @@
           },
           "type": "array"
         },
+        "retrievalMetadata": {
+          "$ref": "GoogleCloudAiplatformV1beta1RetrievalMetadata",
+          "description": "Optional. Output only. Retrieval metadata.",
+          "readOnly": true
+        },
         "retrievalQueries": {
           "description": "Optional. Queries executed by the retrieval tools.",
           "items": {
@@ -31747,11 +31781,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"
         }
@@ -35709,6 +35743,28 @@
       },
       "type": "object"
     },
+    "GoogleCloudAiplatformV1beta1PartnerModelTuningSpec": {
+      "description": "Tuning spec for Partner models.",
+      "id": "GoogleCloudAiplatformV1beta1PartnerModelTuningSpec",
+      "properties": {
+        "hyperParameters": {
+          "additionalProperties": {
+            "type": "any"
+          },
+          "description": "Hyperparameters for tuning. The accepted hyper_parameters and their valid range of values will differ depending on the base model.",
+          "type": "object"
+        },
+        "trainingDatasetUri": {
+          "description": "Required. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file.",
+          "type": "string"
+        },
+        "validationDatasetUri": {
+          "description": "Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file.",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "GoogleCloudAiplatformV1beta1PauseModelDeploymentMonitoringJobRequest": {
       "description": "Request message for JobService.PauseModelDeploymentMonitoringJob.",
       "id": "GoogleCloudAiplatformV1beta1PauseModelDeploymentMonitoringJobRequest",
@@ -35901,9 +35957,8 @@
           "type": "string"
         },
         "originalPipelineJobId": {
-          "description": "Output only. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job.",
+          "description": "Optional. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job.",
           "format": "int64",
-          "readOnly": true,
           "type": "string"
         },
         "pipelineSpec": {
@@ -35915,11 +35970,10 @@
           "type": "object"
         },
         "pipelineTaskRerunConfigs": {
-          "description": "Output only. The rerun configs for each task in the pipeline job. By default, the rerun will: 1. Use the same input artifacts as the original run. 2. Use the same input parameters as the original run. 3. Skip all the tasks that are already succeeded in the original run. 4. Rerun all the tasks that are not succeeded in the original run. By providing this field, users can override the default behavior and specify the rerun config for each task.",
+          "description": "Optional. The rerun configs for each task in the pipeline job. By default, the rerun will: 1. Use the same input artifacts as the original run. 2. Use the same input parameters as the original run. 3. Skip all the tasks that are already succeeded in the original run. 4. Rerun all the tasks that are not succeeded in the original run. By providing this field, users can override the default behavior and specify the rerun config for each task.",
           "items": {
             "$ref": "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfig"
           },
-          "readOnly": true,
           "type": "array"
         },
         "preflightValidations": {
@@ -36338,28 +36392,23 @@
       "properties": {
         "inputs": {
           "$ref": "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigInputs",
-          "description": "Output only. The runtime input of the task overridden by the user.",
-          "readOnly": true
+          "description": "Optional. The runtime input of the task overridden by the user."
         },
         "skipDownstreamTasks": {
-          "description": "Output only. Whether to skip downstream tasks. Default value is False.",
-          "readOnly": true,
+          "description": "Optional. Whether to skip downstream tasks. Default value is False.",
           "type": "boolean"
         },
         "skipTask": {
-          "description": "Output only. Whether to skip this task. Default value is False.",
-          "readOnly": true,
+          "description": "Optional. Whether to skip this task. Default value is False.",
           "type": "boolean"
         },
         "taskId": {
-          "description": "Output only. The system generated ID of the task. Retrieved from original run.",
+          "description": "Optional. The system generated ID of the task. Retrieved from original run.",
           "format": "int64",
-          "readOnly": true,
           "type": "string"
         },
         "taskName": {
-          "description": "Output only. The name of the task.",
-          "readOnly": true,
+          "description": "Optional. The name of the task.",
           "type": "string"
         }
       },
@@ -36370,11 +36419,10 @@
       "id": "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigArtifactList",
       "properties": {
         "artifacts": {
-          "description": "Output only. A list of artifact metadata.",
+          "description": "Optional. A list of artifact metadata.",
           "items": {
             "$ref": "GoogleCloudAiplatformV1beta1RuntimeArtifact"
           },
-          "readOnly": true,
           "type": "array"
         }
       },
@@ -36388,16 +36436,14 @@
           "additionalProperties": {
             "$ref": "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigArtifactList"
           },
-          "description": "Output only. Input artifacts.",
-          "readOnly": true,
+          "description": "Optional. Input artifacts.",
           "type": "object"
         },
         "parameterValues": {
           "additionalProperties": {
             "type": "any"
           },
-          "description": "Output only. Input parameters.",
-          "readOnly": true,
+          "description": "Optional. Input parameters.",
           "type": "object"
         }
       },
@@ -38833,6 +38879,18 @@
       },
       "type": "object"
     },
+    "GoogleCloudAiplatformV1beta1RetrievalMetadata": {
+      "description": "Metadata related to retrieval in the grounding flow.",
+      "id": "GoogleCloudAiplatformV1beta1RetrievalMetadata",
+      "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"
+    },
     "GoogleCloudAiplatformV1beta1RetrieveContextsRequest": {
       "description": "Request message for VertexRagService.RetrieveContexts.",
       "id": "GoogleCloudAiplatformV1beta1RetrieveContextsRequest",
@@ -46551,6 +46609,10 @@
           "readOnly": true,
           "type": "string"
         },
+        "partnerModelTuningSpec": {
+          "$ref": "GoogleCloudAiplatformV1beta1PartnerModelTuningSpec",
+          "description": "Tuning Spec for open sourced and third party Partner models."
+        },
         "pipelineJob": {
           "description": "Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`.",
           "readOnly": true,