Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 5955fc9

Browse files
committedJan 23, 2024
feat(aiplatform): update the api
#### aiplatform:v1 The following keys were deleted: - schemas.LearningServingLlmLanguageFilterResult (Total Keys: 6) The following keys were added: - resources.projects.resources.locations.resources.endpoints.methods.streamRawPredict (Total Keys: 12) - resources.projects.resources.locations.resources.publishers.resources.models.methods.streamRawPredict (Total Keys: 12) - schemas.GoogleCloudAiplatformV1PipelineJobRuntimeConfig.properties.defaultRuntime.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1PipelineJobRuntimeConfigDefaultRuntime (Total Keys: 3) - schemas.GoogleCloudAiplatformV1PipelineJobRuntimeConfigPersistentResourceRuntimeDetail (Total Keys: 3) - schemas.GoogleCloudAiplatformV1StreamRawPredictRequest (Total Keys: 3) - schemas.LanguageLabsAidaTrustRecitationProtoDocAttribution.properties.biorxivId.type (Total Keys: 1) - schemas.LanguageLabsAidaTrustRecitationProtoDocAttribution.properties.youtubeVideoId.type (Total Keys: 1) - schemas.LearningGenaiRecitationDocAttribution.properties.biorxivId.type (Total Keys: 1) - schemas.LearningGenaiRecitationDocAttribution.properties.youtubeVideoId.type (Total Keys: 1) - schemas.LearningGenaiRootGroundingMetadata (Total Keys: 17) - schemas.LearningGenaiRootLanguageFilterResult (Total Keys: 6) - schemas.LearningServingLlmMessageMetadata.properties.groundingMetadata.$ref (Total Keys: 1) The following keys were changed: - schemas.CloudAiNlLlmProtoServiceRaiResult.properties.languageFilterResult.$ref (Total Keys: 1) - schemas.LearningGenaiRootFilterMetadataFilterDebugInfo.properties.languageFilterResult.$ref (Total Keys: 1) #### aiplatform:v1beta1 The following keys were deleted: - schemas.LearningServingLlmLanguageFilterResult (Total Keys: 6) The following keys were added: - schemas.GoogleCloudAiplatformV1beta1CreatePersistentResourceOperationMetadata.properties.progressMessage.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfig.properties.defaultRuntime.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigDefaultRuntime (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigPersistentResourceRuntimeDetail (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1UpdatePersistentResourceOperationMetadata.properties.progressMessage.type (Total Keys: 1) - schemas.LanguageLabsAidaTrustRecitationProtoDocAttribution.properties.biorxivId.type (Total Keys: 1) - schemas.LanguageLabsAidaTrustRecitationProtoDocAttribution.properties.youtubeVideoId.type (Total Keys: 1) - schemas.LearningGenaiRecitationDocAttribution.properties.biorxivId.type (Total Keys: 1) - schemas.LearningGenaiRecitationDocAttribution.properties.youtubeVideoId.type (Total Keys: 1) - schemas.LearningGenaiRootGroundingMetadata (Total Keys: 17) - schemas.LearningGenaiRootLanguageFilterResult (Total Keys: 6) - schemas.LearningServingLlmMessageMetadata.properties.groundingMetadata.$ref (Total Keys: 1) The following keys were changed: - schemas.CloudAiNlLlmProtoServiceRaiResult.properties.languageFilterResult.$ref (Total Keys: 1) - schemas.LearningGenaiRootFilterMetadataFilterDebugInfo.properties.languageFilterResult.$ref (Total Keys: 1)
1 parent d86d7a7 commit 5955fc9

15 files changed

+547
-82
lines changed
 

‎docs/dyn/aiplatform_v1.projects.locations.endpoints.html

+43
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,9 @@ <h2>Instance Methods</h2>
133133
<p class="toc_element">
134134
<code><a href="#streamGenerateContent">streamGenerateContent(model, body=None, x__xgafv=None)</a></code></p>
135135
<p class="firstline">Generate content with multimodal inputs with streaming support.</p>
136+
<p class="toc_element">
137+
<code><a href="#streamRawPredict">streamRawPredict(endpoint, body=None, x__xgafv=None)</a></code></p>
138+
<p class="firstline"></p>
136139
<p class="toc_element">
137140
<code><a href="#undeployModel">undeployModel(endpoint, body=None, x__xgafv=None)</a></code></p>
138141
<p class="firstline">Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.</p>
@@ -2444,6 +2447,46 @@ <h3>Method Details</h3>
24442447
}</pre>
24452448
</div>
24462449

2450+
<div class="method">
2451+
<code class="details" id="streamRawPredict">streamRawPredict(endpoint, body=None, x__xgafv=None)</code>
2452+
<pre>
2453+
2454+
Args:
2455+
endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
2456+
body: object, The request body.
2457+
The object takes the form of:
2458+
2459+
{ # Request message for PredictionService.StreamRawPredict.
2460+
&quot;httpBody&quot;: { # 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. # The prediction input. Supports HTTP headers and arbitrary data payload.
2461+
&quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
2462+
&quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
2463+
&quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response for streaming APIs.
2464+
{
2465+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2466+
},
2467+
],
2468+
},
2469+
}
2470+
2471+
x__xgafv: string, V1 error format.
2472+
Allowed values
2473+
1 - v1 error format
2474+
2 - v2 error format
2475+
2476+
Returns:
2477+
An object of the form:
2478+
2479+
{ # 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.
2480+
&quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
2481+
&quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
2482+
&quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response for streaming APIs.
2483+
{
2484+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
2485+
},
2486+
],
2487+
}</pre>
2488+
</div>
2489+
24472490
<div class="method">
24482491
<code class="details" id="undeployModel">undeployModel(endpoint, body=None, x__xgafv=None)</code>
24492492
<pre>Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it&#x27;s using.

‎docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ <h3>Method Details</h3>
116116
<pre>Creates a new FeatureOnlineStore in a given project and location.
117117

118118
Args:
119-
parent: string, Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}&#x27;` (required)
119+
parent: string, Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}` (required)
120120
body: object, The request body.
121121
The object takes the form of:
122122

‎docs/dyn/aiplatform_v1.projects.locations.models.html

+7-7
Original file line numberDiff line numberDiff line change
@@ -497,7 +497,7 @@ <h3>Method Details</h3>
497497
&quot;metadata&quot;: &quot;&quot;, # Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema. Unset if the Model does not have any additional information.
498498
&quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
499499
&quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
500-
&quot;modelSourceInfo&quot;: { # Detail description of the source information of the model. # Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or existing Vertex AI Model.
500+
&quot;modelSourceInfo&quot;: { # Detail description of the source information of the model. # Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or saved and tuned from Genie or Model Garden.
501501
&quot;copy&quot;: True or False, # If this Model is copy of another Model. If true then source_type pertains to the original.
502502
&quot;sourceType&quot;: &quot;A String&quot;, # Type of the model source.
503503
},
@@ -745,7 +745,7 @@ <h3>Method Details</h3>
745745
&quot;metadata&quot;: &quot;&quot;, # Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema. Unset if the Model does not have any additional information.
746746
&quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
747747
&quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
748-
&quot;modelSourceInfo&quot;: { # Detail description of the source information of the model. # Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or existing Vertex AI Model.
748+
&quot;modelSourceInfo&quot;: { # Detail description of the source information of the model. # Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or saved and tuned from Genie or Model Garden.
749749
&quot;copy&quot;: True or False, # If this Model is copy of another Model. If true then source_type pertains to the original.
750750
&quot;sourceType&quot;: &quot;A String&quot;, # Type of the model source.
751751
},
@@ -996,7 +996,7 @@ <h3>Method Details</h3>
996996
&quot;metadata&quot;: &quot;&quot;, # Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema. Unset if the Model does not have any additional information.
997997
&quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
998998
&quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
999-
&quot;modelSourceInfo&quot;: { # Detail description of the source information of the model. # Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or existing Vertex AI Model.
999+
&quot;modelSourceInfo&quot;: { # Detail description of the source information of the model. # Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or saved and tuned from Genie or Model Garden.
10001000
&quot;copy&quot;: True or False, # If this Model is copy of another Model. If true then source_type pertains to the original.
10011001
&quot;sourceType&quot;: &quot;A String&quot;, # Type of the model source.
10021002
},
@@ -1277,7 +1277,7 @@ <h3>Method Details</h3>
12771277
&quot;metadata&quot;: &quot;&quot;, # Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema. Unset if the Model does not have any additional information.
12781278
&quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
12791279
&quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
1280-
&quot;modelSourceInfo&quot;: { # Detail description of the source information of the model. # Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or existing Vertex AI Model.
1280+
&quot;modelSourceInfo&quot;: { # Detail description of the source information of the model. # Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or saved and tuned from Genie or Model Garden.
12811281
&quot;copy&quot;: True or False, # If this Model is copy of another Model. If true then source_type pertains to the original.
12821282
&quot;sourceType&quot;: &quot;A String&quot;, # Type of the model source.
12831283
},
@@ -1513,7 +1513,7 @@ <h3>Method Details</h3>
15131513
&quot;metadata&quot;: &quot;&quot;, # Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema. Unset if the Model does not have any additional information.
15141514
&quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
15151515
&quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
1516-
&quot;modelSourceInfo&quot;: { # Detail description of the source information of the model. # Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or existing Vertex AI Model.
1516+
&quot;modelSourceInfo&quot;: { # Detail description of the source information of the model. # Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or saved and tuned from Genie or Model Garden.
15171517
&quot;copy&quot;: True or False, # If this Model is copy of another Model. If true then source_type pertains to the original.
15181518
&quot;sourceType&quot;: &quot;A String&quot;, # Type of the model source.
15191519
},
@@ -1748,7 +1748,7 @@ <h3>Method Details</h3>
17481748
&quot;metadata&quot;: &quot;&quot;, # Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema. Unset if the Model does not have any additional information.
17491749
&quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
17501750
&quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
1751-
&quot;modelSourceInfo&quot;: { # Detail description of the source information of the model. # Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or existing Vertex AI Model.
1751+
&quot;modelSourceInfo&quot;: { # Detail description of the source information of the model. # Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or saved and tuned from Genie or Model Garden.
17521752
&quot;copy&quot;: True or False, # If this Model is copy of another Model. If true then source_type pertains to the original.
17531753
&quot;sourceType&quot;: &quot;A String&quot;, # Type of the model source.
17541754
},
@@ -2042,7 +2042,7 @@ <h3>Method Details</h3>
20422042
&quot;metadata&quot;: &quot;&quot;, # Immutable. An additional information about the Model; the schema of the metadata can be found in metadata_schema. Unset if the Model does not have any additional information.
20432043
&quot;metadataArtifact&quot;: &quot;A String&quot;, # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
20442044
&quot;metadataSchemaUri&quot;: &quot;A String&quot;, # Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
2045-
&quot;modelSourceInfo&quot;: { # Detail description of the source information of the model. # Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or existing Vertex AI Model.
2045+
&quot;modelSourceInfo&quot;: { # Detail description of the source information of the model. # Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or saved and tuned from Genie or Model Garden.
20462046
&quot;copy&quot;: True or False, # If this Model is copy of another Model. If true then source_type pertains to the original.
20472047
&quot;sourceType&quot;: &quot;A String&quot;, # Type of the model source.
20482048
},

0 commit comments

Comments
 (0)
Please sign in to comment.