feat(aiplatform): update the api

#### aiplatform:v1 The following keys were deleted: - schemas.GoogleCloudAiplatformV1NotebookExecutionJob.properties.scheduleResourceName.readOnly (Total Keys: 1) The following keys were added: - schemas.GoogleCloudAiplatformV1RetrievalConfig (Total Keys: 4) - schemas.GoogleCloudAiplatformV1SupervisedTuningDataStats.properties.droppedExampleReasons (Total Keys: 3) - schemas.GoogleCloudAiplatformV1SupervisedTuningDataStats.properties.totalTruncatedExampleCount.readOnly (Total Keys: 1) - schemas.GoogleCloudAiplatformV1SupervisedTuningDataStats.properties.truncatedExampleIndices.readOnly (Total Keys: 1) - schemas.GoogleCloudAiplatformV1ToolConfig.properties.retrievalConfig.$ref (Total Keys: 1) - schemas.GoogleTypeLatLng (Total Keys: 6) #### aiplatform:v1beta1 The following keys were deleted: - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJob.properties.scheduleResourceName.readOnly (Total Keys: 1) The following keys were added: - schemas.GoogleCloudAiplatformV1beta1ExportPublisherModelOperationMetadata (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1ExportPublisherModelResponse (Total Keys: 4) - schemas.GoogleCloudAiplatformV1beta1Part.properties.thought.readOnly (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1RetrievalConfig (Total Keys: 4) - schemas.GoogleCloudAiplatformV1beta1SupervisedTuningDataStats.properties.droppedExampleReasons (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1SupervisedTuningDataStats.properties.totalTruncatedExampleCount.readOnly (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1SupervisedTuningDataStats.properties.truncatedExampleIndices.readOnly (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ToolConfig.properties.retrievalConfig.$ref (Total Keys: 1) - schemas.GoogleTypeLatLng (Total Keys: 6)
googleapis · Jan 21, 2025 · 24228d4 · 24228d4
1 parent 04355c7
commit 24228d4
Show file tree

Hide file tree

Showing 26 changed files with 507 additions and 164 deletions.
diff --git a/docs/dyn/aiplatform_v1.datasets.datasetVersions.html b/docs/dyn/aiplatform_v1.datasets.datasetVersions.html
@@ -120,7 +120,7 @@ <h3>Method Details</h3>
   &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
   &quot;metadata&quot;: &quot;&quot;, # Required. Output only. Additional information about the DatasetVersion.
   &quot;modelReference&quot;: &quot;A String&quot;, # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
-  &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the DatasetVersion.
+  &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
   &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
   &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
   &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this DatasetVersion was last updated.
@@ -212,7 +212,7 @@ <h3>Method Details</h3>
   &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
   &quot;metadata&quot;: &quot;&quot;, # Required. Output only. Additional information about the DatasetVersion.
   &quot;modelReference&quot;: &quot;A String&quot;, # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
-  &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the DatasetVersion.
+  &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
   &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
   &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
   &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this DatasetVersion was last updated.
@@ -247,7 +247,7 @@ <h3>Method Details</h3>
       &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
       &quot;metadata&quot;: &quot;&quot;, # Required. Output only. Additional information about the DatasetVersion.
       &quot;modelReference&quot;: &quot;A String&quot;, # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
-      &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the DatasetVersion.
+      &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
       &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
       &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
       &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this DatasetVersion was last updated.
@@ -276,7 +276,7 @@ <h3>Method Details</h3>
   <pre>Updates a DatasetVersion.
 
 Args:
-  name: string, Output only. Identifier. The resource name of the DatasetVersion. (required)
+  name: string, Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -287,7 +287,7 @@ <h3>Method Details</h3>
   &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
   &quot;metadata&quot;: &quot;&quot;, # Required. Output only. Additional information about the DatasetVersion.
   &quot;modelReference&quot;: &quot;A String&quot;, # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
-  &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the DatasetVersion.
+  &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
   &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
   &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
   &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this DatasetVersion was last updated.
@@ -309,7 +309,7 @@ <h3>Method Details</h3>
   &quot;etag&quot;: &quot;A String&quot;, # Used to perform consistent read-modify-write updates. If not set, a blind &quot;overwrite&quot; update happens.
   &quot;metadata&quot;: &quot;&quot;, # Required. Output only. Additional information about the DatasetVersion.
   &quot;modelReference&quot;: &quot;A String&quot;, # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
-  &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the DatasetVersion.
+  &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`
   &quot;satisfiesPzi&quot;: True or False, # Output only. Reserved for future use.
   &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
   &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this DatasetVersion was last updated.

diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html
@@ -610,6 +610,13 @@ <h3>Method Details</h3>
       ],
       &quot;mode&quot;: &quot;A String&quot;, # Optional. Function calling mode.
     },
+    &quot;retrievalConfig&quot;: { # Retrieval config. # Optional. Retrieval config.
+      &quot;languageCode&quot;: &quot;A String&quot;, # The language code of the user.
+      &quot;latLng&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+        &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+        &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+      },
+    },
   },
   &quot;tools&quot;: [ # Optional. 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.
     { # Tool details that the model may use to generate 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. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -1049,6 +1056,13 @@ <h3>Method Details</h3>
       ],
       &quot;mode&quot;: &quot;A String&quot;, # Optional. Function calling mode.
     },
+    &quot;retrievalConfig&quot;: { # Retrieval config. # Optional. Retrieval config.
+      &quot;languageCode&quot;: &quot;A String&quot;, # The language code of the user.
+      &quot;latLng&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+        &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+        &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+      },
+    },
   },
   &quot;tools&quot;: [ # Optional. 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.
     { # Tool details that the model may use to generate 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. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).

diff --git a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html
@@ -189,6 +189,13 @@ <h3>Method Details</h3>
       ],
       &quot;mode&quot;: &quot;A String&quot;, # Optional. Function calling mode.
     },
+    &quot;retrievalConfig&quot;: { # Retrieval config. # Optional. Retrieval config.
+      &quot;languageCode&quot;: &quot;A String&quot;, # The language code of the user.
+      &quot;latLng&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+        &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+        &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+      },
+    },
   },
   &quot;tools&quot;: [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response
     { # Tool details that the model may use to generate 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. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -400,6 +407,13 @@ <h3>Method Details</h3>
       ],
       &quot;mode&quot;: &quot;A String&quot;, # Optional. Function calling mode.
     },
+    &quot;retrievalConfig&quot;: { # Retrieval config. # Optional. Retrieval config.
+      &quot;languageCode&quot;: &quot;A String&quot;, # The language code of the user.
+      &quot;latLng&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+        &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+        &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+      },
+    },
   },
   &quot;tools&quot;: [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response
     { # Tool details that the model may use to generate 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. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -636,6 +650,13 @@ <h3>Method Details</h3>
       ],
       &quot;mode&quot;: &quot;A String&quot;, # Optional. Function calling mode.
     },
+    &quot;retrievalConfig&quot;: { # Retrieval config. # Optional. Retrieval config.
+      &quot;languageCode&quot;: &quot;A String&quot;, # The language code of the user.
+      &quot;latLng&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+        &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+        &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+      },
+    },
   },
   &quot;tools&quot;: [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response
     { # Tool details that the model may use to generate 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. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -858,6 +879,13 @@ <h3>Method Details</h3>
           ],
           &quot;mode&quot;: &quot;A String&quot;, # Optional. Function calling mode.
         },
+        &quot;retrievalConfig&quot;: { # Retrieval config. # Optional. Retrieval config.
+          &quot;languageCode&quot;: &quot;A String&quot;, # The language code of the user.
+          &quot;latLng&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+            &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+            &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+          },
+        },
       },
       &quot;tools&quot;: [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response
         { # Tool details that the model may use to generate 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. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -1088,6 +1116,13 @@ <h3>Method Details</h3>
       ],
       &quot;mode&quot;: &quot;A String&quot;, # Optional. Function calling mode.
     },
+    &quot;retrievalConfig&quot;: { # Retrieval config. # Optional. Retrieval config.
+      &quot;languageCode&quot;: &quot;A String&quot;, # The language code of the user.
+      &quot;latLng&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+        &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+        &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+      },
+    },
   },
   &quot;tools&quot;: [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response
     { # Tool details that the model may use to generate 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. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
@@ -1300,6 +1335,13 @@ <h3>Method Details</h3>
       ],
       &quot;mode&quot;: &quot;A String&quot;, # Optional. Function calling mode.
     },
+    &quot;retrievalConfig&quot;: { # Retrieval config. # Optional. Retrieval config.
+      &quot;languageCode&quot;: &quot;A String&quot;, # The language code of the user.
+      &quot;latLng&quot;: { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user.
+        &quot;latitude&quot;: 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+        &quot;longitude&quot;: 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+      },
+    },
   },
   &quot;tools&quot;: [ # Optional. Input only. Immutable. A list of `Tools` the model may use to generate the next response
     { # Tool details that the model may use to generate 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. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).