chore: Update discovery artifacts (#2499)

## Deleted keys were detected in the following stable discovery artifacts: backupdr v1 https://togithub.com/googleapis/google-api-python-client/commit/00ea603ab7db6a61bc46b3137b13317cd92794e9 beyondcorp v1 https://togithub.com/googleapis/google-api-python-client/commit/c5dc8155a6e45947ad1e814e4f5b7b565dff52d2 compute v1 https://togithub.com/googleapis/google-api-python-client/commit/a2da190b62fce111b85d64269e31ff99a96ac0ef datamigration v1 https://togithub.com/googleapis/google-api-python-client/commit/ce05f20c9b34285f61c3012458e094d0cafc6f12 sqladmin v1 https://togithub.com/googleapis/google-api-python-client/commit/e974cd42205b66a807017f06136e86c818b9bfbc ## Deleted keys were detected in the following pre-stable discovery artifacts: aiplatform v1beta1 https://togithub.com/googleapis/google-api-python-client/commit/bf8e9269aaa605ef1fefc19ab463616c7257c517 beyondcorp v1alpha https://togithub.com/googleapis/google-api-python-client/commit/c5dc8155a6e45947ad1e814e4f5b7b565dff52d2 compute alpha https://togithub.com/googleapis/google-api-python-client/commit/a2da190b62fce111b85d64269e31ff99a96ac0ef compute beta https://togithub.com/googleapis/google-api-python-client/commit/a2da190b62fce111b85d64269e31ff99a96ac0ef sqladmin v1beta4 https://togithub.com/googleapis/google-api-python-client/commit/e974cd42205b66a807017f06136e86c818b9bfbc ## Discovery Artifact Change Summary: feat(aiplatform): update the api https://togithub.com/googleapis/google-api-python-client/commit/bf8e9269aaa605ef1fefc19ab463616c7257c517 feat(alloydb): update the api https://togithub.com/googleapis/google-api-python-client/commit/c4eb92ce6c666b864707455516db0c84fdaae7c2 feat(appengine): update the api https://togithub.com/googleapis/google-api-python-client/commit/af5ad121035ef9c3f1dab63cc96c149d5e689936 feat(apphub): update the api https://togithub.com/googleapis/google-api-python-client/commit/9dc88cd5d815b074ae9dcb0ccf6b0855d1679089 feat(assuredworkloads): update the api https://togithub.com/googleapis/google-api-python-client/commit/5c39d8bc4a749a49616429c5c0e841dca3e5858c feat(backupdr): update the api https://togithub.com/googleapis/google-api-python-client/commit/00ea603ab7db6a61bc46b3137b13317cd92794e9 feat(beyondcorp): update the api https://togithub.com/googleapis/google-api-python-client/commit/c5dc8155a6e45947ad1e814e4f5b7b565dff52d2 fix(composer): update the api https://togithub.com/googleapis/google-api-python-client/commit/20db5f7a3b556930ea0befd26a124a60f9b4e24c feat(compute): update the api https://togithub.com/googleapis/google-api-python-client/commit/a2da190b62fce111b85d64269e31ff99a96ac0ef feat(container): update the api https://togithub.com/googleapis/google-api-python-client/commit/d8e8dbcef43f5bcf12f739034f601ca8d753de4e feat(datamigration): update the api https://togithub.com/googleapis/google-api-python-client/commit/ce05f20c9b34285f61c3012458e094d0cafc6f12 feat(drive): update the api https://togithub.com/googleapis/google-api-python-client/commit/c428cccc59c55c0cb88764bd8e06f539b124bd7b feat(firebaseml): update the api https://togithub.com/googleapis/google-api-python-client/commit/0613d82d828c3b28b505d59bb979c04f35cf6d10 feat(gkehub): update the api https://togithub.com/googleapis/google-api-python-client/commit/1c68621a39b8bfcb63081daec46bfbb6846ea5c6 feat(migrationcenter): update the api https://togithub.com/googleapis/google-api-python-client/commit/d10becb6f833c30fb39166910ac57e1a479acdcc feat(monitoring): update the api https://togithub.com/googleapis/google-api-python-client/commit/cfd92ec4e2c717b99aeb7e9c8133ef8ad3961b52 feat(playdeveloperreporting): update the api https://togithub.com/googleapis/google-api-python-client/commit/2f85d8c59aab4764b5d5cece5c739469a83e4ca3 feat(retail): update the api https://togithub.com/googleapis/google-api-python-client/commit/fdb5e8ae1c48ec8948ae1827b5cdd4af8c537722 feat(securitycenter): update the api https://togithub.com/googleapis/google-api-python-client/commit/87e6b171a58f1640abb3548f90e223ad91fbd130 fix(spanner): update the api https://togithub.com/googleapis/google-api-python-client/commit/2e0b806e16128b277d0eeab23a825ee120b22d5d feat(sqladmin): update the api https://togithub.com/googleapis/google-api-python-client/commit/e974cd42205b66a807017f06136e86c818b9bfbc feat(storage): update the api https://togithub.com/googleapis/google-api-python-client/commit/d8a6456c767c5c3fda2ce8ace3d656ca29da0286 feat(workloadmanager): update the api https://togithub.com/googleapis/google-api-python-client/commit/bb24af0704b3afffad4e3c183e375de0398e97da feat(youtube): update the api https://togithub.com/googleapis/google-api-python-client/commit/3bbf27b2f0acb2b7a28f81a787e2aff92f55efb0
googleapis · Oct 15, 2024 · 4c855d1 · 4c855d1
1 parent 2034e78
commit 4c855d1
Show file tree

Hide file tree

Showing 557 changed files with 36,899 additions and 12,198 deletions.
diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html
@@ -383,6 +383,10 @@ <h3>Method Details</h3>
         },
       ],
       &quot;googleSearchRetrieval&quot;: { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
+        &quot;dynamicRetrievalConfig&quot;: { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
+          &quot;dynamicThreshold&quot;: 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
+          &quot;mode&quot;: &quot;A String&quot;, # The mode of the predictor to be used in dynamic retrieval.
+        },
       },
       &quot;retrieval&quot;: { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
         &quot;disableAttribution&quot;: True or False, # Optional. Deprecated. This option is no longer supported.
@@ -652,6 +656,10 @@ <h3>Method Details</h3>
         },
       ],
       &quot;googleSearchRetrieval&quot;: { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
+        &quot;dynamicRetrievalConfig&quot;: { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
+          &quot;dynamicThreshold&quot;: 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
+          &quot;mode&quot;: &quot;A String&quot;, # The mode of the predictor to be used in dynamic retrieval.
+        },
       },
       &quot;retrieval&quot;: { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
         &quot;disableAttribution&quot;: True or False, # Optional. Deprecated. This option is no longer supported.
@@ -769,6 +777,9 @@ <h3>Method Details</h3>
             },
           },
         ],
+        &quot;retrievalMetadata&quot;: { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata.
+          &quot;googleSearchDynamicRetrievalScore&quot;: 3.14, # 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.
+        },
         &quot;searchEntryPoint&quot;: { # Google search entry point. # Optional. Google search entry for the following-up web searches.
           &quot;renderedContent&quot;: &quot;A String&quot;, # Optional. Web content snippet that can be embedded in a web page or an app webview.
           &quot;sdkBlob&quot;: &quot;A String&quot;, # Optional. Base64 encoded JSON representing array of tuple.
@@ -782,17 +793,17 @@ <h3>Method Details</h3>
         &quot;chosenCandidates&quot;: [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.
           { # Candidate for the logprobs token and score.
             &quot;logProbability&quot;: 3.14, # The candidate&#x27;s log probability.
-            &quot;token&quot;: &quot;A String&quot;, # The candidate’s token string value.
-            &quot;tokenId&quot;: 42, # The candidate’s token id value.
+            &quot;token&quot;: &quot;A String&quot;, # The candidate&#x27;s token string value.
+            &quot;tokenId&quot;: 42, # The candidate&#x27;s token id value.
           },
         ],
         &quot;topCandidates&quot;: [ # Length = total number of decoding steps.
           { # Candidates with top log probabilities at each decoding step.
             &quot;candidates&quot;: [ # Sorted by log probability in descending order.
               { # Candidate for the logprobs token and score.
                 &quot;logProbability&quot;: 3.14, # The candidate&#x27;s log probability.
-                &quot;token&quot;: &quot;A String&quot;, # The candidate’s token string value.
-                &quot;tokenId&quot;: 42, # The candidate’s token id value.
+                &quot;token&quot;: &quot;A String&quot;, # The candidate&#x27;s token string value.
+                &quot;tokenId&quot;: 42, # The candidate&#x27;s token id value.
               },
             ],
           },
@@ -1062,6 +1073,10 @@ <h3>Method Details</h3>
         },
       ],
       &quot;googleSearchRetrieval&quot;: { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
+        &quot;dynamicRetrievalConfig&quot;: { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
+          &quot;dynamicThreshold&quot;: 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
+          &quot;mode&quot;: &quot;A String&quot;, # The mode of the predictor to be used in dynamic retrieval.
+        },
       },
       &quot;retrieval&quot;: { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
         &quot;disableAttribution&quot;: True or False, # Optional. Deprecated. This option is no longer supported.
@@ -1179,6 +1194,9 @@ <h3>Method Details</h3>
             },
           },
         ],
+        &quot;retrievalMetadata&quot;: { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata.
+          &quot;googleSearchDynamicRetrievalScore&quot;: 3.14, # 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.
+        },
         &quot;searchEntryPoint&quot;: { # Google search entry point. # Optional. Google search entry for the following-up web searches.
           &quot;renderedContent&quot;: &quot;A String&quot;, # Optional. Web content snippet that can be embedded in a web page or an app webview.
           &quot;sdkBlob&quot;: &quot;A String&quot;, # Optional. Base64 encoded JSON representing array of tuple.
@@ -1192,17 +1210,17 @@ <h3>Method Details</h3>
         &quot;chosenCandidates&quot;: [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.
           { # Candidate for the logprobs token and score.
             &quot;logProbability&quot;: 3.14, # The candidate&#x27;s log probability.
-            &quot;token&quot;: &quot;A String&quot;, # The candidate’s token string value.
-            &quot;tokenId&quot;: 42, # The candidate’s token id value.
+            &quot;token&quot;: &quot;A String&quot;, # The candidate&#x27;s token string value.
+            &quot;tokenId&quot;: 42, # The candidate&#x27;s token id value.
           },
         ],
         &quot;topCandidates&quot;: [ # Length = total number of decoding steps.
           { # Candidates with top log probabilities at each decoding step.
             &quot;candidates&quot;: [ # Sorted by log probability in descending order.
               { # Candidate for the logprobs token and score.
                 &quot;logProbability&quot;: 3.14, # The candidate&#x27;s log probability.
-                &quot;token&quot;: &quot;A String&quot;, # The candidate’s token string value.
-                &quot;tokenId&quot;: 42, # The candidate’s token id value.
+                &quot;token&quot;: &quot;A String&quot;, # The candidate&#x27;s token string value.
+                &quot;tokenId&quot;: 42, # The candidate&#x27;s token id value.
               },
             ],
           },

diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.chat.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.chat.html
@@ -0,0 +1,127 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+  margin: 0;
+  padding: 0;
+  border: 0;
+  font-weight: inherit;
+  font-style: inherit;
+  font-size: 100%;
+  font-family: inherit;
+  vertical-align: baseline;
+}
+
+body {
+  font-size: 13px;
+  padding: 1em;
+}
+
+h1 {
+  font-size: 26px;
+  margin-bottom: 1em;
+}
+
+h2 {
+  font-size: 24px;
+  margin-bottom: 1em;
+}
+
+h3 {
+  font-size: 20px;
+  margin-bottom: 1em;
+  margin-top: 1em;
+}
+
+pre, code {
+  line-height: 1.5;
+  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+  margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+  font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+  border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+  margin-top: 0.5em;
+}
+
+.firstline {
+  margin-left: 2 em;
+}
+
+.method  {
+  margin-top: 1em;
+  border: solid 1px #CCC;
+  padding: 1em;
+  background: #EEE;
+}
+
+.details {
+  font-weight: bold;
+  font-size: 14px;
+}
+
+</style>
+
+<h1><a href="aiplatform_v1.html">Vertex AI API</a> . <a href="aiplatform_v1.projects.html">projects</a> . <a href="aiplatform_v1.projects.locations.html">locations</a> . <a href="aiplatform_v1.projects.locations.endpoints.html">endpoints</a> . <a href="aiplatform_v1.projects.locations.endpoints.chat.html">chat</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+  <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
+  <code><a href="#completions">completions(endpoint, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Exposes an OpenAI-compatible endpoint for chat completions.</p>
+<h3>Method Details</h3>
+<div class="method">
+    <code class="details" id="close">close()</code>
+  <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
+    <code class="details" id="completions">completions(endpoint, body=None, x__xgafv=None)</code>
+  <pre>Exposes an OpenAI-compatible endpoint for chat completions.
+
+Args:
+  endpoint: string, Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can&#x27;t be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  &quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
+  &quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
+  &quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can&#x27;t be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  &quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
+  &quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
+  &quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}</pre>
+</div>
+
+</body></html>