Skip to content

Commit e230538

Browse files
feat(aiplatform): update the api
#### aiplatform:v1 The following keys were deleted: - schemas.GoogleCloudAiplatformV1VertexRagStore.properties.ragCorpora (Total Keys: 3) The following keys were added: - resources.media.methods.upload (Total Keys: 16) - resources.projects.resources.locations.methods.augmentPrompt (Total Keys: 12) - resources.projects.resources.locations.methods.corroborateContent (Total Keys: 12) - resources.projects.resources.locations.methods.retrieveContexts (Total Keys: 12) - resources.projects.resources.locations.resources.cachedContents.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.cachedContents.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.cachedContents.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.cachedContents.methods.list (Total Keys: 16) - resources.projects.resources.locations.resources.cachedContents.methods.patch (Total Keys: 15) - resources.projects.resources.locations.resources.ragCorpora.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.ragCorpora.methods.delete (Total Keys: 13) - resources.projects.resources.locations.resources.ragCorpora.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.ragCorpora.methods.list (Total Keys: 16) - resources.projects.resources.locations.resources.ragCorpora.methods.patch (Total Keys: 12) - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.methods.import (Total Keys: 12) - resources.projects.resources.locations.resources.ragCorpora.resources.ragFiles.methods.list (Total Keys: 16) - resources.projects.resources.locations.resources.reasoningEngines.methods.query (Total Keys: 12) - schemas.GoogleCloudAiplatformV1ApiAuth (Total Keys: 6) - schemas.GoogleCloudAiplatformV1AugmentPromptRequest (Total Keys: 10) - schemas.GoogleCloudAiplatformV1AugmentPromptResponse (Total Keys: 6) - schemas.GoogleCloudAiplatformV1CachedContent (Total Keys: 35) - schemas.GoogleCloudAiplatformV1Claim (Total Keys: 11) - schemas.GoogleCloudAiplatformV1CorpusStatus (Total Keys: 6) - schemas.GoogleCloudAiplatformV1CorroborateContentRequest (Total Keys: 10) - schemas.GoogleCloudAiplatformV1CorroborateContentResponse (Total Keys: 6) - schemas.GoogleCloudAiplatformV1DedicatedResources.properties.requiredReplicaCount (Total Keys: 2) - schemas.GoogleCloudAiplatformV1DeployedModel.properties.status (Total Keys: 2) - schemas.GoogleCloudAiplatformV1DeployedModelStatus (Total Keys: 10) - schemas.GoogleCloudAiplatformV1DirectUploadSource (Total Keys: 2) - schemas.GoogleCloudAiplatformV1Fact (Total Keys: 10) - schemas.GoogleCloudAiplatformV1FileStatus (Total Keys: 6) - schemas.GoogleCloudAiplatformV1GenerateContentRequest.properties.cachedContent.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata.properties.cachedContentTokenCount (Total Keys: 3) - schemas.GoogleCloudAiplatformV1GoogleDriveSource (Total Keys: 8) - schemas.GoogleCloudAiplatformV1ImportRagFilesConfig (Total Keys: 13) - schemas.GoogleCloudAiplatformV1ImportRagFilesRequest (Total Keys: 3) - schemas.GoogleCloudAiplatformV1JiraSource (Total Keys: 13) - schemas.GoogleCloudAiplatformV1ListCachedContentsResponse (Total Keys: 5) - schemas.GoogleCloudAiplatformV1ListRagCorporaResponse (Total Keys: 5) - schemas.GoogleCloudAiplatformV1ListRagFilesResponse (Total Keys: 5) - schemas.GoogleCloudAiplatformV1QueryReasoningEngineRequest (Total Keys: 5) - schemas.GoogleCloudAiplatformV1QueryReasoningEngineResponse (Total Keys: 3) - schemas.GoogleCloudAiplatformV1RagContexts (Total Keys: 11) - schemas.GoogleCloudAiplatformV1RagCorpus (Total Keys: 14) - schemas.GoogleCloudAiplatformV1RagEmbeddingModelConfig (Total Keys: 10) - schemas.GoogleCloudAiplatformV1RagFile (Total Keys: 33) - schemas.GoogleCloudAiplatformV1RagQuery (Total Keys: 4) - schemas.GoogleCloudAiplatformV1RagRetrievalConfig (Total Keys: 12) - schemas.GoogleCloudAiplatformV1RagVectorDbConfig (Total Keys: 13) - schemas.GoogleCloudAiplatformV1RetrieveContextsRequest (Total Keys: 16) - schemas.GoogleCloudAiplatformV1RetrieveContextsResponse (Total Keys: 3) - schemas.GoogleCloudAiplatformV1SlackSource (Total Keys: 16) - schemas.GoogleCloudAiplatformV1TuningJob.properties.serviceAccount.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1UploadRagFileConfig (Total Keys: 3) - schemas.GoogleCloudAiplatformV1UploadRagFileRequest (Total Keys: 4) - schemas.GoogleCloudAiplatformV1UploadRagFileResponse (Total Keys: 4) - schemas.GoogleCloudAiplatformV1VertexRagStore.properties.ragRetrievalConfig.$ref (Total Keys: 1) #### aiplatform:v1beta1 The following keys were added: - schemas.GoogleCloudAiplatformV1beta1DedicatedResources.properties.requiredReplicaCount (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1DeployedModel.properties.status (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1DeployedModelStatus (Total Keys: 10) - schemas.GoogleCloudAiplatformV1beta1Extension.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1Extension.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1Fact.properties.score (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1ImportRagFilesConfig.properties.ragFileTransformationConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1RagContextsContext.properties.score (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1RagContextsContext.properties.sourceDisplayName.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1RagCorpus.properties.vectorDbConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1RagCorpus.properties.vertexAiSearchConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1RagFileChunkingConfig.properties.fixedLengthChunking.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1RagFileChunkingConfigFixedLengthChunking (Total Keys: 6) - schemas.GoogleCloudAiplatformV1beta1RagFileParsingConfig.properties.advancedParser.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1RagFileParsingConfig.properties.layoutParser.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1RagFileParsingConfigAdvancedParser (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1RagFileParsingConfigLayoutParser (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1RagFileTransformationConfig (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1RagQuery.properties.ragRetrievalConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1RagRetrievalConfig (Total Keys: 28) - schemas.GoogleCloudAiplatformV1beta1RagVectorDbConfig.properties.ragEmbeddingModelConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1TuningJob.properties.serviceAccount.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1UploadRagFileConfig.properties.ragFileTransformationConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1VertexAiSearchConfig (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1VertexRagStore.properties.ragRetrievalConfig.$ref (Total Keys: 1)
1 parent c1381b2 commit e230538

File tree

117 files changed

+5972
-312
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+5972
-312
lines changed

docs/dyn/aiplatform_v1.endpoints.html

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -395,9 +395,6 @@ <h3>Method Details</h3>
395395
&quot;datastore&quot;: &quot;A String&quot;, # Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
396396
},
397397
&quot;vertexRagStore&quot;: { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
398-
&quot;ragCorpora&quot;: [ # Optional. Deprecated. Please use rag_resources instead.
399-
&quot;A String&quot;,
400-
],
401398
&quot;ragResources&quot;: [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
402399
{ # The definition of the Rag resource.
403400
&quot;ragCorpus&quot;: &quot;A String&quot;, # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
@@ -406,6 +403,14 @@ <h3>Method Details</h3>
406403
],
407404
},
408405
],
406+
&quot;ragRetrievalConfig&quot;: { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
407+
&quot;filter&quot;: { # Config for filters. # Optional. Config for filters.
408+
&quot;metadataFilter&quot;: &quot;A String&quot;, # Optional. String for metadata filtering.
409+
&quot;vectorDistanceThreshold&quot;: 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
410+
&quot;vectorSimilarityThreshold&quot;: 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
411+
},
412+
&quot;topK&quot;: 42, # Optional. The number of contexts to retrieve.
413+
},
409414
&quot;similarityTopK&quot;: 42, # Optional. Number of top k results to return from the selected corpora.
410415
&quot;vectorDistanceThreshold&quot;: 3.14, # Optional. Only return results with vector distance smaller than the threshold.
411416
},
@@ -438,6 +443,7 @@ <h3>Method Details</h3>
438443
The object takes the form of:
439444

440445
{ # Request message for [PredictionService.GenerateContent].
446+
&quot;cachedContent&quot;: &quot;A String&quot;, # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
441447
&quot;contents&quot;: [ # Required. 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.
442448
{ # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
443449
&quot;parts&quot;: [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
@@ -669,9 +675,6 @@ <h3>Method Details</h3>
669675
&quot;datastore&quot;: &quot;A String&quot;, # Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
670676
},
671677
&quot;vertexRagStore&quot;: { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
672-
&quot;ragCorpora&quot;: [ # Optional. Deprecated. Please use rag_resources instead.
673-
&quot;A String&quot;,
674-
],
675678
&quot;ragResources&quot;: [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
676679
{ # The definition of the Rag resource.
677680
&quot;ragCorpus&quot;: &quot;A String&quot;, # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
@@ -680,6 +683,14 @@ <h3>Method Details</h3>
680683
],
681684
},
682685
],
686+
&quot;ragRetrievalConfig&quot;: { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
687+
&quot;filter&quot;: { # Config for filters. # Optional. Config for filters.
688+
&quot;metadataFilter&quot;: &quot;A String&quot;, # Optional. String for metadata filtering.
689+
&quot;vectorDistanceThreshold&quot;: 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
690+
&quot;vectorSimilarityThreshold&quot;: 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
691+
},
692+
&quot;topK&quot;: 42, # Optional. The number of contexts to retrieve.
693+
},
683694
&quot;similarityTopK&quot;: 42, # Optional. Number of top k results to return from the selected corpora.
684695
&quot;vectorDistanceThreshold&quot;: 3.14, # Optional. Only return results with vector distance smaller than the threshold.
685696
},
@@ -840,6 +851,7 @@ <h3>Method Details</h3>
840851
],
841852
},
842853
&quot;usageMetadata&quot;: { # Usage metadata about response(s). # Usage metadata about the response(s).
854+
&quot;cachedContentTokenCount&quot;: 42, # Output only. Number of tokens in the cached part in the input (the cached content).
843855
&quot;candidatesTokenCount&quot;: 42, # Number of tokens in the response(s).
844856
&quot;promptTokenCount&quot;: 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.
845857
&quot;totalTokenCount&quot;: 42, # Total token count for prompt and response candidates.
@@ -857,6 +869,7 @@ <h3>Method Details</h3>
857869
The object takes the form of:
858870

859871
{ # Request message for [PredictionService.GenerateContent].
872+
&quot;cachedContent&quot;: &quot;A String&quot;, # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
860873
&quot;contents&quot;: [ # Required. 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.
861874
{ # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
862875
&quot;parts&quot;: [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
@@ -1088,9 +1101,6 @@ <h3>Method Details</h3>
10881101
&quot;datastore&quot;: &quot;A String&quot;, # Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
10891102
},
10901103
&quot;vertexRagStore&quot;: { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
1091-
&quot;ragCorpora&quot;: [ # Optional. Deprecated. Please use rag_resources instead.
1092-
&quot;A String&quot;,
1093-
],
10941104
&quot;ragResources&quot;: [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
10951105
{ # The definition of the Rag resource.
10961106
&quot;ragCorpus&quot;: &quot;A String&quot;, # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
@@ -1099,6 +1109,14 @@ <h3>Method Details</h3>
10991109
],
11001110
},
11011111
],
1112+
&quot;ragRetrievalConfig&quot;: { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
1113+
&quot;filter&quot;: { # Config for filters. # Optional. Config for filters.
1114+
&quot;metadataFilter&quot;: &quot;A String&quot;, # Optional. String for metadata filtering.
1115+
&quot;vectorDistanceThreshold&quot;: 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
1116+
&quot;vectorSimilarityThreshold&quot;: 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
1117+
},
1118+
&quot;topK&quot;: 42, # Optional. The number of contexts to retrieve.
1119+
},
11021120
&quot;similarityTopK&quot;: 42, # Optional. Number of top k results to return from the selected corpora.
11031121
&quot;vectorDistanceThreshold&quot;: 3.14, # Optional. Only return results with vector distance smaller than the threshold.
11041122
},
@@ -1259,6 +1277,7 @@ <h3>Method Details</h3>
12591277
],
12601278
},
12611279
&quot;usageMetadata&quot;: { # Usage metadata about response(s). # Usage metadata about the response(s).
1280+
&quot;cachedContentTokenCount&quot;: 42, # Output only. Number of tokens in the cached part in the input (the cached content).
12621281
&quot;candidatesTokenCount&quot;: 42, # Number of tokens in the response(s).
12631282
&quot;promptTokenCount&quot;: 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.
12641283
&quot;totalTokenCount&quot;: 42, # Total token count for prompt and response candidates.

docs/dyn/aiplatform_v1.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,11 @@ <h2>Instance Methods</h2>
8484
</p>
8585
<p class="firstline">Returns the endpoints Resource.</p>
8686

87+
<p class="toc_element">
88+
<code><a href="aiplatform_v1.media.html">media()</a></code>
89+
</p>
90+
<p class="firstline">Returns the media Resource.</p>
91+
8792
<p class="toc_element">
8893
<code><a href="aiplatform_v1.projects.html">projects()</a></code>
8994
</p>

0 commit comments

Comments
 (0)