@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20250602 → 0.0.20250606
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 +151 -5
- 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: 20250606
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -707,6 +707,8 @@ declare namespace gapi.client {
|
|
|
707
707
|
logprobsResult?: GoogleCloudAiplatformV1LogprobsResult;
|
|
708
708
|
/** Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. */
|
|
709
709
|
safetyRatings?: GoogleCloudAiplatformV1SafetyRating[];
|
|
710
|
+
/** Output only. Metadata related to url context retrieval tool. */
|
|
711
|
+
urlContextMetadata?: GoogleCloudAiplatformV1UrlContextMetadata;
|
|
710
712
|
}
|
|
711
713
|
interface GoogleCloudAiplatformV1Checkpoint {
|
|
712
714
|
/** The ID of the checkpoint. */
|
|
@@ -1428,7 +1430,7 @@ declare namespace gapi.client {
|
|
|
1428
1430
|
fasterDeploymentConfig?: GoogleCloudAiplatformV1FasterDeploymentConfig;
|
|
1429
1431
|
/** Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI will generate a value for this ID. This value should be 1-10 characters, and valid characters are `/[0-9]/`. */
|
|
1430
1432
|
id?: string;
|
|
1431
|
-
/**
|
|
1433
|
+
/** The resource name of the Model that this is the deployment of. Note that the Model may be in a different location than the DeployedModel's Endpoint. The resource name may contain version id or version alias to specify the version. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` if no version is specified, the default version will be deployed. */
|
|
1432
1434
|
model?: string;
|
|
1433
1435
|
/** Output only. The version ID of the model that is deployed. */
|
|
1434
1436
|
modelVersionId?: string;
|
|
@@ -1507,6 +1509,64 @@ declare namespace gapi.client {
|
|
|
1507
1509
|
/** The DeployedModel that had been deployed in the Endpoint. */
|
|
1508
1510
|
deployedModel?: GoogleCloudAiplatformV1DeployedModel;
|
|
1509
1511
|
}
|
|
1512
|
+
interface GoogleCloudAiplatformV1DeployOperationMetadata {
|
|
1513
|
+
/** Output only. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}` */
|
|
1514
|
+
destination?: string;
|
|
1515
|
+
/** The operation generic information. */
|
|
1516
|
+
genericMetadata?: GoogleCloudAiplatformV1GenericOperationMetadata;
|
|
1517
|
+
/** Output only. The model id to be used at query time. */
|
|
1518
|
+
modelId?: string;
|
|
1519
|
+
/** Output only. The project number where the deploy model request is sent. */
|
|
1520
|
+
projectNumber?: string;
|
|
1521
|
+
/** Output only. The name of the model resource. */
|
|
1522
|
+
publisherModel?: string;
|
|
1523
|
+
}
|
|
1524
|
+
interface GoogleCloudAiplatformV1DeployRequest {
|
|
1525
|
+
/** Optional. The deploy config to use for the deployment. If not specified, the default deploy config will be used. */
|
|
1526
|
+
deployConfig?: GoogleCloudAiplatformV1DeployRequestDeployConfig;
|
|
1527
|
+
/** Optional. The endpoint config to use for the deployment. If not specified, the default endpoint config will be used. */
|
|
1528
|
+
endpointConfig?: GoogleCloudAiplatformV1DeployRequestEndpointConfig;
|
|
1529
|
+
/** The Hugging Face model to deploy. Format: Hugging Face model ID like `google/gemma-2-2b-it`. */
|
|
1530
|
+
huggingFaceModelId?: string;
|
|
1531
|
+
/** Optional. The model config to use for the deployment. If not specified, the default model config will be used. */
|
|
1532
|
+
modelConfig?: GoogleCloudAiplatformV1DeployRequestModelConfig;
|
|
1533
|
+
/** The Model Garden model to deploy. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`. */
|
|
1534
|
+
publisherModelName?: string;
|
|
1535
|
+
}
|
|
1536
|
+
interface GoogleCloudAiplatformV1DeployRequestDeployConfig {
|
|
1537
|
+
/** Optional. The dedicated resources to use for the endpoint. If not set, the default resources will be used. */
|
|
1538
|
+
dedicatedResources?: GoogleCloudAiplatformV1DedicatedResources;
|
|
1539
|
+
/** Optional. If true, enable the QMT fast tryout feature for this model if possible. */
|
|
1540
|
+
fastTryoutEnabled?: boolean;
|
|
1541
|
+
/** Optional. System labels for Model Garden deployments. These labels are managed by Google and for tracking purposes only. */
|
|
1542
|
+
systemLabels?: {[P in string]: string};
|
|
1543
|
+
}
|
|
1544
|
+
interface GoogleCloudAiplatformV1DeployRequestEndpointConfig {
|
|
1545
|
+
/** Optional. If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. */
|
|
1546
|
+
dedicatedEndpointEnabled?: boolean;
|
|
1547
|
+
/** Optional. The user-specified display name of the endpoint. If not set, a default name will be used. */
|
|
1548
|
+
endpointDisplayName?: string;
|
|
1549
|
+
}
|
|
1550
|
+
interface GoogleCloudAiplatformV1DeployRequestModelConfig {
|
|
1551
|
+
/** Optional. Whether the user accepts the End User License Agreement (EULA) for the model. */
|
|
1552
|
+
acceptEula?: boolean;
|
|
1553
|
+
/** Optional. The specification of the container that is to be used when deploying. If not set, the default container spec will be used. */
|
|
1554
|
+
containerSpec?: GoogleCloudAiplatformV1ModelContainerSpec;
|
|
1555
|
+
/** Optional. The Hugging Face read access token used to access the model artifacts of gated models. */
|
|
1556
|
+
huggingFaceAccessToken?: string;
|
|
1557
|
+
/** Optional. If true, the model will deploy with a cached version instead of directly downloading the model artifacts from Hugging Face. This is suitable for VPC-SC users with limited internet access. */
|
|
1558
|
+
huggingFaceCacheEnabled?: boolean;
|
|
1559
|
+
/** Optional. The user-specified display name of the uploaded model. If not set, a default name will be used. */
|
|
1560
|
+
modelDisplayName?: string;
|
|
1561
|
+
}
|
|
1562
|
+
interface GoogleCloudAiplatformV1DeployResponse {
|
|
1563
|
+
/** Output only. The name of the Endpoint created. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` */
|
|
1564
|
+
endpoint?: string;
|
|
1565
|
+
/** Output only. The name of the Model created. Format: `projects/{project}/locations/{location}/models/{model}` */
|
|
1566
|
+
model?: string;
|
|
1567
|
+
/** Output only. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001` */
|
|
1568
|
+
publisherModel?: string;
|
|
1569
|
+
}
|
|
1510
1570
|
interface GoogleCloudAiplatformV1DestinationFeatureSetting {
|
|
1511
1571
|
/** Specify the field name in the export destination. If not specified, Feature ID is used. */
|
|
1512
1572
|
destinationField?: string;
|
|
@@ -1542,6 +1602,14 @@ declare namespace gapi.client {
|
|
|
1542
1602
|
/** Type of the boot disk. For non-A3U machines, the default value is "pd-ssd", for A3U machines, the default value is "hyperdisk-balanced". Valid values: "pd-ssd" (Persistent Disk Solid State Drive), "pd-standard" (Persistent Disk Hard Disk Drive) or "hyperdisk-balanced". */
|
|
1543
1603
|
bootDiskType?: string;
|
|
1544
1604
|
}
|
|
1605
|
+
interface GoogleCloudAiplatformV1DnsPeeringConfig {
|
|
1606
|
+
/** Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot. */
|
|
1607
|
+
domain?: string;
|
|
1608
|
+
/** Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible. */
|
|
1609
|
+
targetNetwork?: string;
|
|
1610
|
+
/** Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project. */
|
|
1611
|
+
targetProject?: string;
|
|
1612
|
+
}
|
|
1545
1613
|
interface GoogleCloudAiplatformV1DoubleArray {
|
|
1546
1614
|
/** A list of double values. */
|
|
1547
1615
|
values?: number[];
|
|
@@ -3016,7 +3084,7 @@ declare namespace gapi.client {
|
|
|
3016
3084
|
webSearchQueries?: string[];
|
|
3017
3085
|
}
|
|
3018
3086
|
interface GoogleCloudAiplatformV1GroundingSupport {
|
|
3019
|
-
/** Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident.
|
|
3087
|
+
/** Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored. */
|
|
3020
3088
|
confidenceScores?: number[];
|
|
3021
3089
|
/** A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. */
|
|
3022
3090
|
groundingChunkIndices?: number[];
|
|
@@ -4010,6 +4078,8 @@ declare namespace gapi.client {
|
|
|
4010
4078
|
healthRoute?: string;
|
|
4011
4079
|
/** 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. */
|
|
4012
4080
|
imageUri?: string;
|
|
4081
|
+
/** Immutable. Invoke route prefix for the custom container. "/*" is the only supported value right now. By setting this field, any non-root route on this model will be accessible with [PredictionService.Invoke] eg: "/invoke/foo/bar". Only one of `predict_route` or `invoke_route_prefix` can be set, and we default to using `predict_route` if this field is not set. If this field is set, the Model can only be deployed to dedicated endpoint. */
|
|
4082
|
+
invokeRoutePrefix?: string;
|
|
4013
4083
|
/** Immutable. Specification for Kubernetes liveness probe. */
|
|
4014
4084
|
livenessProbe?: GoogleCloudAiplatformV1Probe;
|
|
4015
4085
|
/** 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). */
|
|
@@ -5243,16 +5313,22 @@ declare namespace gapi.client {
|
|
|
5243
5313
|
projectId?: string;
|
|
5244
5314
|
}
|
|
5245
5315
|
interface GoogleCloudAiplatformV1PSCAutomationConfig {
|
|
5246
|
-
/** Output only.
|
|
5316
|
+
/** Output only. Error message if the PSC service automation failed. */
|
|
5317
|
+
errorMessage?: string;
|
|
5318
|
+
/** Output only. Forwarding rule created by the PSC service automation. */
|
|
5247
5319
|
forwardingRule?: string;
|
|
5248
|
-
/** Output only. IP address rule created by the PSC service automation.
|
|
5320
|
+
/** Output only. IP address rule created by the PSC service automation. */
|
|
5249
5321
|
ipAddress?: string;
|
|
5250
5322
|
/** Required. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in '12345', and {network} is network name. */
|
|
5251
5323
|
network?: string;
|
|
5252
5324
|
/** Required. Project id used to create forwarding rule. */
|
|
5253
5325
|
projectId?: string;
|
|
5326
|
+
/** Output only. The state of the PSC service automation. */
|
|
5327
|
+
state?: string;
|
|
5254
5328
|
}
|
|
5255
5329
|
interface GoogleCloudAiplatformV1PscInterfaceConfig {
|
|
5330
|
+
/** Optional. DNS peering configurations. When specified, Vertex AI will attempt to configure DNS peering zones in the tenant project VPC to resolve the specified domains using the target network's Cloud DNS. The user must grant the dns.peer role to the Vertex AI Service Agent on the target project. */
|
|
5331
|
+
dnsPeeringConfigs?: GoogleCloudAiplatformV1DnsPeeringConfig[];
|
|
5256
5332
|
/** Optional. The name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource within the region and user project. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. */
|
|
5257
5333
|
networkAttachment?: string;
|
|
5258
5334
|
}
|
|
@@ -5363,6 +5439,8 @@ declare namespace gapi.client {
|
|
|
5363
5439
|
resourceTitle?: string;
|
|
5364
5440
|
/** Optional. Use case (CUJ) of the resource. */
|
|
5365
5441
|
resourceUseCase?: string;
|
|
5442
|
+
/** Optional. For notebook resource, whether the notebook supports Workbench. */
|
|
5443
|
+
supportsWorkbench?: boolean;
|
|
5366
5444
|
/** Required. */
|
|
5367
5445
|
title?: string;
|
|
5368
5446
|
}
|
|
@@ -9046,6 +9124,16 @@ declare namespace gapi.client {
|
|
|
9046
9124
|
}
|
|
9047
9125
|
interface GoogleCloudAiplatformV1UpsertDatapointsResponse {}
|
|
9048
9126
|
interface GoogleCloudAiplatformV1UrlContext {}
|
|
9127
|
+
interface GoogleCloudAiplatformV1UrlContextMetadata {
|
|
9128
|
+
/** Output only. List of url context. */
|
|
9129
|
+
urlMetadata?: GoogleCloudAiplatformV1UrlMetadata[];
|
|
9130
|
+
}
|
|
9131
|
+
interface GoogleCloudAiplatformV1UrlMetadata {
|
|
9132
|
+
/** Retrieved url by the tool. */
|
|
9133
|
+
retrievedUrl?: string;
|
|
9134
|
+
/** Status of the url retrieval. */
|
|
9135
|
+
urlRetrievalStatus?: string;
|
|
9136
|
+
}
|
|
9049
9137
|
interface GoogleCloudAiplatformV1UserActionReference {
|
|
9050
9138
|
/** For API calls that start a LabelingJob. Resource name of the LabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` */
|
|
9051
9139
|
dataLabelingJob?: string;
|
|
@@ -32867,6 +32955,64 @@ declare namespace gapi.client {
|
|
|
32867
32955
|
},
|
|
32868
32956
|
body: GoogleCloudAiplatformV1CorroborateContentRequest,
|
|
32869
32957
|
): Request<GoogleCloudAiplatformV1CorroborateContentResponse>;
|
|
32958
|
+
/** Deploys a model to a new endpoint. */
|
|
32959
|
+
deploy(request: {
|
|
32960
|
+
/** V1 error format. */
|
|
32961
|
+
'$.xgafv'?: string;
|
|
32962
|
+
/** OAuth access token. */
|
|
32963
|
+
access_token?: string;
|
|
32964
|
+
/** Data format for response. */
|
|
32965
|
+
alt?: string;
|
|
32966
|
+
/** JSONP */
|
|
32967
|
+
callback?: string;
|
|
32968
|
+
/** Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}` */
|
|
32969
|
+
destination: string;
|
|
32970
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
32971
|
+
fields?: string;
|
|
32972
|
+
/** 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. */
|
|
32973
|
+
key?: string;
|
|
32974
|
+
/** OAuth 2.0 token for the current user. */
|
|
32975
|
+
oauth_token?: string;
|
|
32976
|
+
/** Returns response with indentations and line breaks. */
|
|
32977
|
+
prettyPrint?: boolean;
|
|
32978
|
+
/** 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. */
|
|
32979
|
+
quotaUser?: string;
|
|
32980
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
32981
|
+
upload_protocol?: string;
|
|
32982
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
32983
|
+
uploadType?: string;
|
|
32984
|
+
/** Request body */
|
|
32985
|
+
resource: GoogleCloudAiplatformV1DeployRequest;
|
|
32986
|
+
}): Request<GoogleLongrunningOperation>;
|
|
32987
|
+
deploy(
|
|
32988
|
+
request: {
|
|
32989
|
+
/** V1 error format. */
|
|
32990
|
+
'$.xgafv'?: string;
|
|
32991
|
+
/** OAuth access token. */
|
|
32992
|
+
access_token?: string;
|
|
32993
|
+
/** Data format for response. */
|
|
32994
|
+
alt?: string;
|
|
32995
|
+
/** JSONP */
|
|
32996
|
+
callback?: string;
|
|
32997
|
+
/** Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}` */
|
|
32998
|
+
destination: string;
|
|
32999
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
33000
|
+
fields?: string;
|
|
33001
|
+
/** 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. */
|
|
33002
|
+
key?: string;
|
|
33003
|
+
/** OAuth 2.0 token for the current user. */
|
|
33004
|
+
oauth_token?: string;
|
|
33005
|
+
/** Returns response with indentations and line breaks. */
|
|
33006
|
+
prettyPrint?: boolean;
|
|
33007
|
+
/** 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. */
|
|
33008
|
+
quotaUser?: string;
|
|
33009
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
33010
|
+
upload_protocol?: string;
|
|
33011
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
33012
|
+
uploadType?: string;
|
|
33013
|
+
},
|
|
33014
|
+
body: GoogleCloudAiplatformV1DeployRequest,
|
|
33015
|
+
): Request<GoogleLongrunningOperation>;
|
|
32870
33016
|
/** Evaluates a dataset based on a set of given metrics. */
|
|
32871
33017
|
evaluateDataset(request: {
|
|
32872
33018
|
/** V1 error format. */
|