Skip to content

Commit 50938ea

Browse files
feat(aiplatform): update the api
#### aiplatform:v1 The following keys were deleted: - schemas.GoogleCloudAiplatformV1PublisherModelCallToAction.properties.fineTune.$ref (Total Keys: 1) #### aiplatform:v1beta1 The following keys were deleted: - schemas.GoogleCloudAiplatformV1beta1ModelMonitoringGenAiStats (Total Keys: 6) - schemas.GoogleCloudAiplatformV1beta1ModelMonitoringStats.properties.genAiStats.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1PublisherModelCallToAction.properties.fineTune.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsFilter.properties.genAiStatsFilter.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsFilterGenAiStatsFilter (Total Keys: 7) 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.GoogleCloudAiplatformV1beta1ImportRagFilesConfig.properties.maxEmbeddingRequestsPerMin (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1RagCorpus.properties.ragEmbeddingModelConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1RagEmbeddingModelConfig (Total Keys: 10) - schemas.GoogleCloudAiplatformV1beta1StreamRawPredictRequest (Total Keys: 3) The following keys were changed: - resources.projects.resources.locations.resources.cachedContents.methods.delete.response.$ref (Total Keys: 1)
1 parent ed68923 commit 50938ea

10 files changed

+224
-165
lines changed

docs/dyn/aiplatform_v1.publishers.models.html

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -218,20 +218,6 @@ <h3>Method Details</h3>
218218
&quot;A String&quot;,
219219
],
220220
},
221-
&quot;fineTune&quot;: { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Fine tune the PublisherModel with the third-party model tuning UI.
222-
&quot;references&quot;: { # Required.
223-
&quot;a_key&quot;: { # Reference to a resource.
224-
&quot;description&quot;: &quot;A String&quot;, # Description of the resource.
225-
&quot;resourceName&quot;: &quot;A String&quot;, # The resource name of the Google Cloud resource.
226-
&quot;uri&quot;: &quot;A String&quot;, # The URI of the resource.
227-
&quot;useCase&quot;: &quot;A String&quot;, # Use case (CUJ) of the resource.
228-
},
229-
},
230-
&quot;resourceDescription&quot;: &quot;A String&quot;, # Optional. Description of the resource.
231-
&quot;resourceTitle&quot;: &quot;A String&quot;, # Optional. Title of the resource.
232-
&quot;resourceUseCase&quot;: &quot;A String&quot;, # Optional. Use case (CUJ) of the resource.
233-
&quot;title&quot;: &quot;A String&quot;, # Required.
234-
},
235221
&quot;openEvaluationPipeline&quot;: { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open evaluation pipeline of the PublisherModel.
236222
&quot;references&quot;: { # Required.
237223
&quot;a_key&quot;: { # Reference to a resource.

docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -477,24 +477,7 @@ <h3>Method Details</h3>
477477
Returns:
478478
An object of the form:
479479

480-
{ # This resource represents a long-running operation that is the result of a network API call.
481-
&quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
482-
&quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
483-
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
484-
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
485-
{
486-
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
487-
},
488-
],
489-
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
490-
},
491-
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
492-
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
493-
},
494-
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
495-
&quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
496-
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
497-
},
480+
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
498481
}</pre>
499482
</div>
500483

docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,9 @@ <h2>Instance Methods</h2>
147147
<p class="toc_element">
148148
<code><a href="#streamGenerateContent">streamGenerateContent(model, body=None, x__xgafv=None)</a></code></p>
149149
<p class="firstline">Generate content with multimodal inputs with streaming support.</p>
150+
<p class="toc_element">
151+
<code><a href="#streamRawPredict">streamRawPredict(endpoint, body=None, x__xgafv=None)</a></code></p>
152+
<p class="firstline">Perform a streaming online prediction with an arbitrary HTTP payload.</p>
150153
<p class="toc_element">
151154
<code><a href="#testIamPermissions">testIamPermissions(resource, permissions=None, x__xgafv=None)</a></code></p>
152155
<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
@@ -3238,6 +3241,46 @@ <h3>Method Details</h3>
32383241
}</pre>
32393242
</div>
32403243

3244+
<div class="method">
3245+
<code class="details" id="streamRawPredict">streamRawPredict(endpoint, body=None, x__xgafv=None)</code>
3246+
<pre>Perform a streaming online prediction with an arbitrary HTTP payload.
3247+
3248+
Args:
3249+
endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
3250+
body: object, The request body.
3251+
The object takes the form of:
3252+
3253+
{ # Request message for PredictionService.StreamRawPredict.
3254+
&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.
3255+
&quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
3256+
&quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
3257+
&quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response for streaming APIs.
3258+
{
3259+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3260+
},
3261+
],
3262+
},
3263+
}
3264+
3265+
x__xgafv: string, V1 error format.
3266+
Allowed values
3267+
1 - v1 error format
3268+
2 - v2 error format
3269+
3270+
Returns:
3271+
An object of the form:
3272+
3273+
{ # 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.
3274+
&quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
3275+
&quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
3276+
&quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response for streaming APIs.
3277+
{
3278+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
3279+
},
3280+
],
3281+
}</pre>
3282+
</div>
3283+
32413284
<div class="method">
32423285
<code class="details" id="testIamPermissions">testIamPermissions(resource, permissions=None, x__xgafv=None)</code>
32433286
<pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may &quot;fail open&quot; without warning.

docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.html

Lines changed: 0 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1404,13 +1404,6 @@ <h3>Method Details</h3>
14041404
&quot;pageSize&quot;: 42, # The standard list page size.
14051405
&quot;pageToken&quot;: &quot;A String&quot;, # A page token received from a previous ModelMonitoringService.SearchModelMonitoringStats call.
14061406
&quot;statsFilter&quot;: { # Filter for searching ModelMonitoringStats. # Filter for search different stats.
1407-
&quot;genAiStatsFilter&quot;: { # GenAi statistics filter. # GenAi statistics filter.
1408-
&quot;clusterId&quot;: &quot;A String&quot;, # From a particular cluster of monitoring results.
1409-
&quot;modelMonitoringJob&quot;: &quot;A String&quot;, # From a particular monitoring job.
1410-
&quot;modelMonitoringSchedule&quot;: &quot;A String&quot;, # From a particular monitoring schedule.
1411-
&quot;objectiveType&quot;: &quot;A String&quot;, # One of the supported monitoring objectives: `gen-ai-general` `gen-ai-evaluation` `gen-ai-safety`
1412-
&quot;statsName&quot;: &quot;A String&quot;, # If not specified, will return all the stats_names.
1413-
},
14141407
&quot;tabularStatsFilter&quot;: { # Tabular statistics filter. # Tabular statistics filter.
14151408
&quot;algorithm&quot;: &quot;A String&quot;, # Specify the algorithm type used for distance calculation, eg: jensen_shannon_divergence, l_infinity.
14161409
&quot;modelMonitoringJob&quot;: &quot;A String&quot;, # From a particular monitoring job.
@@ -1436,34 +1429,6 @@ <h3>Method Details</h3>
14361429
{ # Response message for ModelMonitoringService.SearchModelMonitoringStats.
14371430
&quot;monitoringStats&quot;: [ # Stats retrieved for requested objectives.
14381431
{ # Represents the collection of statistics for a metric.
1439-
&quot;genAiStats&quot;: { # A collection of data points that describes the time-varying values of a gen ai metric. # Generated gen ai statistics.
1440-
&quot;dataPoints&quot;: [ # The data points of this time series. When listing time series, points are returned in reverse time order.
1441-
{ # Represents a single statistics data point.
1442-
&quot;algorithm&quot;: &quot;A String&quot;, # Algorithm used to calculated the metrics, eg: jensen_shannon_divergence, l_infinity.
1443-
&quot;baselineStats&quot;: { # Typed value of the statistics. # Statistics from baseline dataset.
1444-
&quot;distributionValue&quot;: { # Summary statistics for a population of values. # Distribution.
1445-
&quot;distribution&quot;: &quot;&quot;, # Predictive monitoring drift distribution in `tensorflow.metadata.v0.DatasetFeatureStatistics` format.
1446-
&quot;distributionDeviation&quot;: 3.14, # Distribution distance deviation from the current dataset&#x27;s statistics to baseline dataset&#x27;s statistics. * For categorical feature, the distribution distance is calculated by L-inifinity norm or Jensen–Shannon divergence. * For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence.
1447-
},
1448-
&quot;doubleValue&quot;: 3.14, # Double.
1449-
},
1450-
&quot;createTime&quot;: &quot;A String&quot;, # Statistics create time.
1451-
&quot;currentStats&quot;: { # Typed value of the statistics. # Statistics from current dataset.
1452-
&quot;distributionValue&quot;: { # Summary statistics for a population of values. # Distribution.
1453-
&quot;distribution&quot;: &quot;&quot;, # Predictive monitoring drift distribution in `tensorflow.metadata.v0.DatasetFeatureStatistics` format.
1454-
&quot;distributionDeviation&quot;: 3.14, # Distribution distance deviation from the current dataset&#x27;s statistics to baseline dataset&#x27;s statistics. * For categorical feature, the distribution distance is calculated by L-inifinity norm or Jensen–Shannon divergence. * For numerical feature, the distribution distance is calculated by Jensen–Shannon divergence.
1455-
},
1456-
&quot;doubleValue&quot;: 3.14, # Double.
1457-
},
1458-
&quot;hasAnomaly&quot;: True or False, # Indicate if the statistics has anomaly.
1459-
&quot;modelMonitoringJob&quot;: &quot;A String&quot;, # Model monitoring job resource name.
1460-
&quot;schedule&quot;: &quot;A String&quot;, # Schedule resource name.
1461-
&quot;thresholdValue&quot;: 3.14, # Threshold value.
1462-
},
1463-
],
1464-
&quot;objectiveType&quot;: &quot;A String&quot;, # One of the supported monitoring objectives: `gen-ai-general` `gen-ai-evaluation` `gen-ai-safety`
1465-
&quot;statsName&quot;: &quot;A String&quot;, # The stats name.
1466-
},
14671432
&quot;tabularStats&quot;: { # A collection of data points that describes the time-varying values of a tabular metric. # Generated tabular statistics.
14681433
&quot;dataPoints&quot;: [ # The data points of this time series. When listing time series, points are returned in reverse time order.
14691434
{ # Represents a single statistics data point.

docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,9 @@ <h2>Instance Methods</h2>
101101
<p class="toc_element">
102102
<code><a href="#streamGenerateContent">streamGenerateContent(model, body=None, x__xgafv=None)</a></code></p>
103103
<p class="firstline">Generate content with multimodal inputs with streaming support.</p>
104+
<p class="toc_element">
105+
<code><a href="#streamRawPredict">streamRawPredict(endpoint, body=None, x__xgafv=None)</a></code></p>
106+
<p class="firstline">Perform a streaming online prediction with an arbitrary HTTP payload.</p>
104107
<h3>Method Details</h3>
105108
<div class="method">
106109
<code class="details" id="close">close()</code>
@@ -1171,4 +1174,44 @@ <h3>Method Details</h3>
11711174
}</pre>
11721175
</div>
11731176

1177+
<div class="method">
1178+
<code class="details" id="streamRawPredict">streamRawPredict(endpoint, body=None, x__xgafv=None)</code>
1179+
<pre>Perform a streaming online prediction with an arbitrary HTTP payload.
1180+
1181+
Args:
1182+
endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
1183+
body: object, The request body.
1184+
The object takes the form of:
1185+
1186+
{ # Request message for PredictionService.StreamRawPredict.
1187+
&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.
1188+
&quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
1189+
&quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
1190+
&quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response for streaming APIs.
1191+
{
1192+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1193+
},
1194+
],
1195+
},
1196+
}
1197+
1198+
x__xgafv: string, V1 error format.
1199+
Allowed values
1200+
1 - v1 error format
1201+
2 - v2 error format
1202+
1203+
Returns:
1204+
An object of the form:
1205+
1206+
{ # 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.
1207+
&quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
1208+
&quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
1209+
&quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response for streaming APIs.
1210+
{
1211+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1212+
},
1213+
],
1214+
}</pre>
1215+
</div>
1216+
11741217
</body></html>

0 commit comments

Comments
 (0)