@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20241203 → 0.0.20241210
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 +137 -9
- 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=v1beta1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20241210
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -320,8 +320,10 @@ declare namespace gapi.client {
|
|
|
320
320
|
oidcConfig?: GoogleCloudAiplatformV1beta1AuthConfigOidcConfig;
|
|
321
321
|
}
|
|
322
322
|
interface GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig {
|
|
323
|
-
/**
|
|
323
|
+
/** Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. */
|
|
324
324
|
apiKeySecret?: string;
|
|
325
|
+
/** Optional. The API key to be used in the request directly. */
|
|
326
|
+
apiKeyString?: string;
|
|
325
327
|
/** Required. The location of the API key. */
|
|
326
328
|
httpElementLocation?: string;
|
|
327
329
|
/** Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. */
|
|
@@ -1250,7 +1252,7 @@ declare namespace gapi.client {
|
|
|
1250
1252
|
metadataSchemaUri?: string;
|
|
1251
1253
|
/** Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. */
|
|
1252
1254
|
modelReference?: string;
|
|
1253
|
-
/** Output only. Identifier. The resource name of the Dataset. */
|
|
1255
|
+
/** Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}` */
|
|
1254
1256
|
name?: string;
|
|
1255
1257
|
/** Output only. Reserved for future use. */
|
|
1256
1258
|
satisfiesPzi?: boolean;
|
|
@@ -3047,6 +3049,8 @@ declare namespace gapi.client {
|
|
|
3047
3049
|
logprobs?: number;
|
|
3048
3050
|
/** Optional. The maximum number of output tokens to generate per message. */
|
|
3049
3051
|
maxOutputTokens?: number;
|
|
3052
|
+
/** Optional. If specified, the media resolution specified will be used. */
|
|
3053
|
+
mediaResolution?: string;
|
|
3050
3054
|
/** Optional. Positive penalties. */
|
|
3051
3055
|
presencePenalty?: number;
|
|
3052
3056
|
/** Optional. If true, export the logprobs results in response. */
|
|
@@ -3067,8 +3071,6 @@ declare namespace gapi.client {
|
|
|
3067
3071
|
stopSequences?: string[];
|
|
3068
3072
|
/** Optional. Controls the randomness of predictions. */
|
|
3069
3073
|
temperature?: number;
|
|
3070
|
-
/** Optional. If specified, the token resolution specified will be used. */
|
|
3071
|
-
tokenResolution?: string;
|
|
3072
3074
|
/** Optional. If specified, top-k sampling will be used. */
|
|
3073
3075
|
topK?: number;
|
|
3074
3076
|
/** Optional. If specified, nucleus sampling will be used. */
|
|
@@ -4175,6 +4177,8 @@ declare namespace gapi.client {
|
|
|
4175
4177
|
healthRoute?: string;
|
|
4176
4178
|
/** 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. */
|
|
4177
4179
|
imageUri?: string;
|
|
4180
|
+
/** Immutable. Specification for Kubernetes liveness probe. */
|
|
4181
|
+
livenessProbe?: GoogleCloudAiplatformV1beta1Probe;
|
|
4178
4182
|
/** 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). */
|
|
4179
4183
|
ports?: GoogleCloudAiplatformV1beta1Port[];
|
|
4180
4184
|
/** 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).) */
|
|
@@ -5627,8 +5631,14 @@ declare namespace gapi.client {
|
|
|
5627
5631
|
interface GoogleCloudAiplatformV1beta1Probe {
|
|
5628
5632
|
/** ExecAction probes the health of a container by executing a command. */
|
|
5629
5633
|
exec?: GoogleCloudAiplatformV1beta1ProbeExecAction;
|
|
5634
|
+
/** GrpcAction probes the health of a container by sending a gRPC request. */
|
|
5635
|
+
grpc?: GoogleCloudAiplatformV1beta1ProbeGrpcAction;
|
|
5636
|
+
/** HttpGetAction probes the health of a container by sending an HTTP GET request. */
|
|
5637
|
+
httpGet?: GoogleCloudAiplatformV1beta1ProbeHttpGetAction;
|
|
5630
5638
|
/** 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'. */
|
|
5631
5639
|
periodSeconds?: number;
|
|
5640
|
+
/** TcpSocketAction probes the health of a container by opening a TCP socket connection. */
|
|
5641
|
+
tcpSocket?: GoogleCloudAiplatformV1beta1ProbeTcpSocketAction;
|
|
5632
5642
|
/** 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'. */
|
|
5633
5643
|
timeoutSeconds?: number;
|
|
5634
5644
|
}
|
|
@@ -5636,6 +5646,36 @@ declare namespace gapi.client {
|
|
|
5636
5646
|
/** 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. */
|
|
5637
5647
|
command?: string[];
|
|
5638
5648
|
}
|
|
5649
|
+
interface GoogleCloudAiplatformV1beta1ProbeGrpcAction {
|
|
5650
|
+
/** Port number of the gRPC service. Number must be in the range 1 to 65535. */
|
|
5651
|
+
port?: number;
|
|
5652
|
+
/** 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. */
|
|
5653
|
+
service?: string;
|
|
5654
|
+
}
|
|
5655
|
+
interface GoogleCloudAiplatformV1beta1ProbeHttpGetAction {
|
|
5656
|
+
/** Host name to connect to, defaults to the model serving container's IP. You probably want to set "Host" in httpHeaders instead. */
|
|
5657
|
+
host?: string;
|
|
5658
|
+
/** Custom headers to set in the request. HTTP allows repeated headers. */
|
|
5659
|
+
httpHeaders?: GoogleCloudAiplatformV1beta1ProbeHttpHeader[];
|
|
5660
|
+
/** Path to access on the HTTP server. */
|
|
5661
|
+
path?: string;
|
|
5662
|
+
/** Number of the port to access on the container. Number must be in the range 1 to 65535. */
|
|
5663
|
+
port?: number;
|
|
5664
|
+
/** Scheme to use for connecting to the host. Defaults to HTTP. Acceptable values are "HTTP" or "HTTPS". */
|
|
5665
|
+
scheme?: string;
|
|
5666
|
+
}
|
|
5667
|
+
interface GoogleCloudAiplatformV1beta1ProbeHttpHeader {
|
|
5668
|
+
/** The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. */
|
|
5669
|
+
name?: string;
|
|
5670
|
+
/** The header field value */
|
|
5671
|
+
value?: string;
|
|
5672
|
+
}
|
|
5673
|
+
interface GoogleCloudAiplatformV1beta1ProbeTcpSocketAction {
|
|
5674
|
+
/** Optional: Host name to connect to, defaults to the model serving container's IP. */
|
|
5675
|
+
host?: string;
|
|
5676
|
+
/** Number of the port to access on the container. Number must be in the range 1 to 65535. */
|
|
5677
|
+
port?: number;
|
|
5678
|
+
}
|
|
5639
5679
|
interface GoogleCloudAiplatformV1beta1PscAutomatedEndpoints {
|
|
5640
5680
|
/** Ip Address created by the automated forwarding rule. */
|
|
5641
5681
|
matchAddress?: string;
|
|
@@ -10214,7 +10254,7 @@ declare namespace gapi.client {
|
|
|
10214
10254
|
fields?: string;
|
|
10215
10255
|
/** 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. */
|
|
10216
10256
|
key?: string;
|
|
10217
|
-
/** Output only. Identifier. The resource name of the Dataset. */
|
|
10257
|
+
/** Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}` */
|
|
10218
10258
|
name: string;
|
|
10219
10259
|
/** OAuth 2.0 token for the current user. */
|
|
10220
10260
|
oauth_token?: string;
|
|
@@ -10245,7 +10285,7 @@ declare namespace gapi.client {
|
|
|
10245
10285
|
fields?: string;
|
|
10246
10286
|
/** 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. */
|
|
10247
10287
|
key?: string;
|
|
10248
|
-
/** Output only. Identifier. The resource name of the Dataset. */
|
|
10288
|
+
/** Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}` */
|
|
10249
10289
|
name: string;
|
|
10250
10290
|
/** OAuth 2.0 token for the current user. */
|
|
10251
10291
|
oauth_token?: string;
|
|
@@ -13405,7 +13445,7 @@ declare namespace gapi.client {
|
|
|
13405
13445
|
fields?: string;
|
|
13406
13446
|
/** 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. */
|
|
13407
13447
|
key?: string;
|
|
13408
|
-
/** Output only. Identifier. The resource name of the Dataset. */
|
|
13448
|
+
/** Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}` */
|
|
13409
13449
|
name: string;
|
|
13410
13450
|
/** OAuth 2.0 token for the current user. */
|
|
13411
13451
|
oauth_token?: string;
|
|
@@ -13436,7 +13476,7 @@ declare namespace gapi.client {
|
|
|
13436
13476
|
fields?: string;
|
|
13437
13477
|
/** 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. */
|
|
13438
13478
|
key?: string;
|
|
13439
|
-
/** Output only. Identifier. The resource name of the Dataset. */
|
|
13479
|
+
/** Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}` */
|
|
13440
13480
|
name: string;
|
|
13441
13481
|
/** OAuth 2.0 token for the current user. */
|
|
13442
13482
|
oauth_token?: string;
|
|
@@ -17467,6 +17507,35 @@ declare namespace gapi.client {
|
|
|
17467
17507
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
17468
17508
|
uploadType?: string;
|
|
17469
17509
|
}): Request<GoogleCloudAiplatformV1beta1FeatureGroup>;
|
|
17510
|
+
/** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
|
|
17511
|
+
getIamPolicy(request?: {
|
|
17512
|
+
/** V1 error format. */
|
|
17513
|
+
'$.xgafv'?: string;
|
|
17514
|
+
/** OAuth access token. */
|
|
17515
|
+
access_token?: string;
|
|
17516
|
+
/** Data format for response. */
|
|
17517
|
+
alt?: string;
|
|
17518
|
+
/** JSONP */
|
|
17519
|
+
callback?: string;
|
|
17520
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
17521
|
+
fields?: string;
|
|
17522
|
+
/** 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. */
|
|
17523
|
+
key?: string;
|
|
17524
|
+
/** OAuth 2.0 token for the current user. */
|
|
17525
|
+
oauth_token?: string;
|
|
17526
|
+
/** Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */
|
|
17527
|
+
'options.requestedPolicyVersion'?: number;
|
|
17528
|
+
/** Returns response with indentations and line breaks. */
|
|
17529
|
+
prettyPrint?: boolean;
|
|
17530
|
+
/** 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. */
|
|
17531
|
+
quotaUser?: string;
|
|
17532
|
+
/** REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */
|
|
17533
|
+
resource: string;
|
|
17534
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
17535
|
+
upload_protocol?: string;
|
|
17536
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
17537
|
+
uploadType?: string;
|
|
17538
|
+
}): Request<GoogleIamV1Policy>;
|
|
17470
17539
|
/** Lists FeatureGroups in a given project and location. */
|
|
17471
17540
|
list(request?: {
|
|
17472
17541
|
/** V1 error format. */
|
|
@@ -17564,6 +17633,65 @@ declare namespace gapi.client {
|
|
|
17564
17633
|
},
|
|
17565
17634
|
body: GoogleCloudAiplatformV1beta1FeatureGroup
|
|
17566
17635
|
): Request<GoogleLongrunningOperation>;
|
|
17636
|
+
/** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
|
|
17637
|
+
setIamPolicy(
|
|
17638
|
+
request: {
|
|
17639
|
+
/** V1 error format. */
|
|
17640
|
+
'$.xgafv'?: string;
|
|
17641
|
+
/** OAuth access token. */
|
|
17642
|
+
access_token?: string;
|
|
17643
|
+
/** Data format for response. */
|
|
17644
|
+
alt?: string;
|
|
17645
|
+
/** JSONP */
|
|
17646
|
+
callback?: string;
|
|
17647
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
17648
|
+
fields?: string;
|
|
17649
|
+
/** 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. */
|
|
17650
|
+
key?: string;
|
|
17651
|
+
/** OAuth 2.0 token for the current user. */
|
|
17652
|
+
oauth_token?: string;
|
|
17653
|
+
/** Returns response with indentations and line breaks. */
|
|
17654
|
+
prettyPrint?: boolean;
|
|
17655
|
+
/** 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. */
|
|
17656
|
+
quotaUser?: string;
|
|
17657
|
+
/** REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */
|
|
17658
|
+
resource: string;
|
|
17659
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
17660
|
+
upload_protocol?: string;
|
|
17661
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
17662
|
+
uploadType?: string;
|
|
17663
|
+
},
|
|
17664
|
+
body: GoogleIamV1SetIamPolicyRequest
|
|
17665
|
+
): Request<GoogleIamV1Policy>;
|
|
17666
|
+
/** 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. */
|
|
17667
|
+
testIamPermissions(request?: {
|
|
17668
|
+
/** V1 error format. */
|
|
17669
|
+
'$.xgafv'?: string;
|
|
17670
|
+
/** OAuth access token. */
|
|
17671
|
+
access_token?: string;
|
|
17672
|
+
/** Data format for response. */
|
|
17673
|
+
alt?: string;
|
|
17674
|
+
/** JSONP */
|
|
17675
|
+
callback?: string;
|
|
17676
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
17677
|
+
fields?: string;
|
|
17678
|
+
/** 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. */
|
|
17679
|
+
key?: string;
|
|
17680
|
+
/** OAuth 2.0 token for the current user. */
|
|
17681
|
+
oauth_token?: string;
|
|
17682
|
+
/** The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). */
|
|
17683
|
+
permissions?: string | string[];
|
|
17684
|
+
/** Returns response with indentations and line breaks. */
|
|
17685
|
+
prettyPrint?: boolean;
|
|
17686
|
+
/** 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. */
|
|
17687
|
+
quotaUser?: string;
|
|
17688
|
+
/** REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */
|
|
17689
|
+
resource: string;
|
|
17690
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
17691
|
+
upload_protocol?: string;
|
|
17692
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
17693
|
+
uploadType?: string;
|
|
17694
|
+
}): Request<GoogleIamV1TestIamPermissionsResponse>;
|
|
17567
17695
|
featureMonitors: FeatureMonitorsResource;
|
|
17568
17696
|
features: FeaturesResource;
|
|
17569
17697
|
operations: OperationsResource;
|