@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20241207 → 0.0.20241214
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +110 -8
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://aiplatform.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20241214
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -1152,7 +1152,7 @@ declare namespace gapi.client {
|
|
|
1152
1152
|
metadataSchemaUri?: string;
|
|
1153
1153
|
/** Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. */
|
|
1154
1154
|
modelReference?: string;
|
|
1155
|
-
/** Output only. Identifier. The resource name of the Dataset. */
|
|
1155
|
+
/** Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}` */
|
|
1156
1156
|
name?: string;
|
|
1157
1157
|
/** Output only. Reserved for future use. */
|
|
1158
1158
|
satisfiesPzi?: boolean;
|
|
@@ -2646,6 +2646,8 @@ declare namespace gapi.client {
|
|
|
2646
2646
|
logprobs?: number;
|
|
2647
2647
|
/** Optional. The maximum number of output tokens to generate per message. */
|
|
2648
2648
|
maxOutputTokens?: number;
|
|
2649
|
+
/** Optional. If specified, the media resolution specified will be used. */
|
|
2650
|
+
mediaResolution?: string;
|
|
2649
2651
|
/** Optional. Positive penalties. */
|
|
2650
2652
|
presencePenalty?: number;
|
|
2651
2653
|
/** Optional. If true, export the logprobs results in response. */
|
|
@@ -2666,8 +2668,6 @@ declare namespace gapi.client {
|
|
|
2666
2668
|
stopSequences?: string[];
|
|
2667
2669
|
/** Optional. Controls the randomness of predictions. */
|
|
2668
2670
|
temperature?: number;
|
|
2669
|
-
/** Optional. If specified, the token resolution specified will be used. */
|
|
2670
|
-
tokenResolution?: string;
|
|
2671
2671
|
/** Optional. If specified, top-k sampling will be used. */
|
|
2672
2672
|
topK?: number;
|
|
2673
2673
|
/** Optional. If specified, nucleus sampling will be used. */
|
|
@@ -3726,6 +3726,8 @@ declare namespace gapi.client {
|
|
|
3726
3726
|
healthRoute?: string;
|
|
3727
3727
|
/** Required. Immutable. URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry or Container Registry. Learn more about the [container publishing requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), including permissions requirements for the Vertex AI Service Agent. The container image is ingested upon ModelService.UploadModel, stored internally, and this original path is afterwards not used. To learn about the requirements for the Docker image itself, see [Custom container requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). You can use the URI to one of Vertex AI's [pre-built container images for prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) in this field. */
|
|
3728
3728
|
imageUri?: string;
|
|
3729
|
+
/** Immutable. Specification for Kubernetes liveness probe. */
|
|
3730
|
+
livenessProbe?: GoogleCloudAiplatformV1Probe;
|
|
3729
3731
|
/** Immutable. List of ports to expose from the container. Vertex AI sends any prediction requests that it receives to the first port on this list. Vertex AI also sends [liveness and health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) to this port. If you do not specify this field, it defaults to following value: ```json [ { "containerPort": 8080 } ] ``` Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). */
|
|
3730
3732
|
ports?: GoogleCloudAiplatformV1Port[];
|
|
3731
3733
|
/** Immutable. HTTP path on the container to send prediction requests to. Vertex AI forwards requests sent using projects.locations.endpoints.predict to this path on the container's IP address and port. Vertex AI then returns the container's response in the API response. For example, if you set this field to `/foo`, then when Vertex AI receives a prediction request, it forwards the request body in a POST request to the `/foo` path on the port of your container specified by the first value of this `ModelContainerSpec`'s ports field. If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) */
|
|
@@ -4817,8 +4819,14 @@ declare namespace gapi.client {
|
|
|
4817
4819
|
interface GoogleCloudAiplatformV1Probe {
|
|
4818
4820
|
/** ExecAction probes the health of a container by executing a command. */
|
|
4819
4821
|
exec?: GoogleCloudAiplatformV1ProbeExecAction;
|
|
4822
|
+
/** GrpcAction probes the health of a container by sending a gRPC request. */
|
|
4823
|
+
grpc?: GoogleCloudAiplatformV1ProbeGrpcAction;
|
|
4824
|
+
/** HttpGetAction probes the health of a container by sending an HTTP GET request. */
|
|
4825
|
+
httpGet?: GoogleCloudAiplatformV1ProbeHttpGetAction;
|
|
4820
4826
|
/** How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'. */
|
|
4821
4827
|
periodSeconds?: number;
|
|
4828
|
+
/** TcpSocketAction probes the health of a container by opening a TCP socket connection. */
|
|
4829
|
+
tcpSocket?: GoogleCloudAiplatformV1ProbeTcpSocketAction;
|
|
4822
4830
|
/** Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'. */
|
|
4823
4831
|
timeoutSeconds?: number;
|
|
4824
4832
|
}
|
|
@@ -4826,6 +4834,36 @@ declare namespace gapi.client {
|
|
|
4826
4834
|
/** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */
|
|
4827
4835
|
command?: string[];
|
|
4828
4836
|
}
|
|
4837
|
+
interface GoogleCloudAiplatformV1ProbeGrpcAction {
|
|
4838
|
+
/** Port number of the gRPC service. Number must be in the range 1 to 65535. */
|
|
4839
|
+
port?: number;
|
|
4840
|
+
/** Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC. */
|
|
4841
|
+
service?: string;
|
|
4842
|
+
}
|
|
4843
|
+
interface GoogleCloudAiplatformV1ProbeHttpGetAction {
|
|
4844
|
+
/** Host name to connect to, defaults to the model serving container's IP. You probably want to set "Host" in httpHeaders instead. */
|
|
4845
|
+
host?: string;
|
|
4846
|
+
/** Custom headers to set in the request. HTTP allows repeated headers. */
|
|
4847
|
+
httpHeaders?: GoogleCloudAiplatformV1ProbeHttpHeader[];
|
|
4848
|
+
/** Path to access on the HTTP server. */
|
|
4849
|
+
path?: string;
|
|
4850
|
+
/** Number of the port to access on the container. Number must be in the range 1 to 65535. */
|
|
4851
|
+
port?: number;
|
|
4852
|
+
/** Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS". */
|
|
4853
|
+
scheme?: string;
|
|
4854
|
+
}
|
|
4855
|
+
interface GoogleCloudAiplatformV1ProbeHttpHeader {
|
|
4856
|
+
/** The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. */
|
|
4857
|
+
name?: string;
|
|
4858
|
+
/** The header field value */
|
|
4859
|
+
value?: string;
|
|
4860
|
+
}
|
|
4861
|
+
interface GoogleCloudAiplatformV1ProbeTcpSocketAction {
|
|
4862
|
+
/** Optional: Host name to connect to, defaults to the model serving container's IP. */
|
|
4863
|
+
host?: string;
|
|
4864
|
+
/** Number of the port to access on the container. Number must be in the range 1 to 65535. */
|
|
4865
|
+
port?: number;
|
|
4866
|
+
}
|
|
4829
4867
|
interface GoogleCloudAiplatformV1PscAutomatedEndpoints {
|
|
4830
4868
|
/** Ip Address created by the automated forwarding rule. */
|
|
4831
4869
|
matchAddress?: string;
|
|
@@ -7388,6 +7426,12 @@ declare namespace gapi.client {
|
|
|
7388
7426
|
/** Required. Selector choosing Features of the target EntityType. Feature IDs will be deduplicated. */
|
|
7389
7427
|
featureSelector?: GoogleCloudAiplatformV1FeatureSelector;
|
|
7390
7428
|
}
|
|
7429
|
+
interface GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest {
|
|
7430
|
+
/** Optional. Class method to be used for the stream query. It is optional and defaults to "stream_query" if unspecified. */
|
|
7431
|
+
classMethod?: string;
|
|
7432
|
+
/** Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc. */
|
|
7433
|
+
input?: {[P in string]: any};
|
|
7434
|
+
}
|
|
7391
7435
|
interface GoogleCloudAiplatformV1StreamRawPredictRequest {
|
|
7392
7436
|
/** The prediction input. Supports HTTP headers and arbitrary data payload. */
|
|
7393
7437
|
httpBody?: GoogleApiHttpBody;
|
|
@@ -9057,7 +9101,7 @@ declare namespace gapi.client {
|
|
|
9057
9101
|
fields?: string;
|
|
9058
9102
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
9059
9103
|
key?: string;
|
|
9060
|
-
/** Output only. Identifier. The resource name of the Dataset. */
|
|
9104
|
+
/** Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}` */
|
|
9061
9105
|
name: string;
|
|
9062
9106
|
/** OAuth 2.0 token for the current user. */
|
|
9063
9107
|
oauth_token?: string;
|
|
@@ -9088,7 +9132,7 @@ declare namespace gapi.client {
|
|
|
9088
9132
|
fields?: string;
|
|
9089
9133
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
9090
9134
|
key?: string;
|
|
9091
|
-
/** Output only. Identifier. The resource name of the Dataset. */
|
|
9135
|
+
/** Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}` */
|
|
9092
9136
|
name: string;
|
|
9093
9137
|
/** OAuth 2.0 token for the current user. */
|
|
9094
9138
|
oauth_token?: string;
|
|
@@ -11952,7 +11996,7 @@ declare namespace gapi.client {
|
|
|
11952
11996
|
fields?: string;
|
|
11953
11997
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
11954
11998
|
key?: string;
|
|
11955
|
-
/** Output only. Identifier. The resource name of the Dataset. */
|
|
11999
|
+
/** Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}` */
|
|
11956
12000
|
name: string;
|
|
11957
12001
|
/** OAuth 2.0 token for the current user. */
|
|
11958
12002
|
oauth_token?: string;
|
|
@@ -11983,7 +12027,7 @@ declare namespace gapi.client {
|
|
|
11983
12027
|
fields?: string;
|
|
11984
12028
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
11985
12029
|
key?: string;
|
|
11986
|
-
/** Output only. Identifier. The resource name of the Dataset. */
|
|
12030
|
+
/** Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}` */
|
|
11987
12031
|
name: string;
|
|
11988
12032
|
/** OAuth 2.0 token for the current user. */
|
|
11989
12033
|
oauth_token?: string;
|
|
@@ -27033,6 +27077,64 @@ declare namespace gapi.client {
|
|
|
27033
27077
|
},
|
|
27034
27078
|
body: GoogleCloudAiplatformV1QueryReasoningEngineRequest
|
|
27035
27079
|
): Request<GoogleCloudAiplatformV1QueryReasoningEngineResponse>;
|
|
27080
|
+
/** Streams queries using a reasoning engine. */
|
|
27081
|
+
streamQuery(request: {
|
|
27082
|
+
/** V1 error format. */
|
|
27083
|
+
'$.xgafv'?: string;
|
|
27084
|
+
/** OAuth access token. */
|
|
27085
|
+
access_token?: string;
|
|
27086
|
+
/** Data format for response. */
|
|
27087
|
+
alt?: string;
|
|
27088
|
+
/** JSONP */
|
|
27089
|
+
callback?: string;
|
|
27090
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
27091
|
+
fields?: string;
|
|
27092
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
27093
|
+
key?: string;
|
|
27094
|
+
/** Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` */
|
|
27095
|
+
name: string;
|
|
27096
|
+
/** OAuth 2.0 token for the current user. */
|
|
27097
|
+
oauth_token?: string;
|
|
27098
|
+
/** Returns response with indentations and line breaks. */
|
|
27099
|
+
prettyPrint?: boolean;
|
|
27100
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
27101
|
+
quotaUser?: string;
|
|
27102
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
27103
|
+
upload_protocol?: string;
|
|
27104
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
27105
|
+
uploadType?: string;
|
|
27106
|
+
/** Request body */
|
|
27107
|
+
resource: GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest;
|
|
27108
|
+
}): Request<GoogleApiHttpBody>;
|
|
27109
|
+
streamQuery(
|
|
27110
|
+
request: {
|
|
27111
|
+
/** V1 error format. */
|
|
27112
|
+
'$.xgafv'?: string;
|
|
27113
|
+
/** OAuth access token. */
|
|
27114
|
+
access_token?: string;
|
|
27115
|
+
/** Data format for response. */
|
|
27116
|
+
alt?: string;
|
|
27117
|
+
/** JSONP */
|
|
27118
|
+
callback?: string;
|
|
27119
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
27120
|
+
fields?: string;
|
|
27121
|
+
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
27122
|
+
key?: string;
|
|
27123
|
+
/** Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` */
|
|
27124
|
+
name: string;
|
|
27125
|
+
/** OAuth 2.0 token for the current user. */
|
|
27126
|
+
oauth_token?: string;
|
|
27127
|
+
/** Returns response with indentations and line breaks. */
|
|
27128
|
+
prettyPrint?: boolean;
|
|
27129
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
27130
|
+
quotaUser?: string;
|
|
27131
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
27132
|
+
upload_protocol?: string;
|
|
27133
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
27134
|
+
uploadType?: string;
|
|
27135
|
+
},
|
|
27136
|
+
body: GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest
|
|
27137
|
+
): Request<GoogleApiHttpBody>;
|
|
27036
27138
|
operations: OperationsResource;
|
|
27037
27139
|
}
|
|
27038
27140
|
interface OperationsResource {
|