@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20250529 → 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.
Files changed (2) hide show
  1. package/index.d.ts +167 -6
  2. 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: 20250529
12
+ // Revision: 20250606
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -782,6 +782,8 @@ declare namespace gapi.client {
782
782
  logprobsResult?: GoogleCloudAiplatformV1beta1LogprobsResult;
783
783
  /** Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. */
784
784
  safetyRatings?: GoogleCloudAiplatformV1beta1SafetyRating[];
785
+ /** Output only. Metadata related to url context retrieval tool. */
786
+ urlContextMetadata?: GoogleCloudAiplatformV1beta1UrlContextMetadata;
785
787
  }
786
788
  interface GoogleCloudAiplatformV1beta1Checkpoint {
787
789
  /** The ID of the checkpoint. */
@@ -1581,7 +1583,7 @@ declare namespace gapi.client {
1581
1583
  fasterDeploymentConfig?: GoogleCloudAiplatformV1beta1FasterDeploymentConfig;
1582
1584
  /** 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]/`. */
1583
1585
  id?: string;
1584
- /** Required. 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. */
1586
+ /** 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. */
1585
1587
  model?: string;
1586
1588
  /** Output only. The version ID of the model that is deployed. */
1587
1589
  modelVersionId?: string;
@@ -1781,6 +1783,14 @@ declare namespace gapi.client {
1781
1783
  /** Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. */
1782
1784
  validationDatasetUri?: string;
1783
1785
  }
1786
+ interface GoogleCloudAiplatformV1beta1DnsPeeringConfig {
1787
+ /** Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot. */
1788
+ domain?: string;
1789
+ /** Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible. */
1790
+ targetNetwork?: string;
1791
+ /** 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. */
1792
+ targetProject?: string;
1793
+ }
1784
1794
  interface GoogleCloudAiplatformV1beta1DoubleArray {
1785
1795
  /** A list of double values. */
1786
1796
  values?: number[];
@@ -3618,7 +3628,7 @@ declare namespace gapi.client {
3618
3628
  webSearchQueries?: string[];
3619
3629
  }
3620
3630
  interface GoogleCloudAiplatformV1beta1GroundingSupport {
3621
- /** Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. This list must have the same size as the grounding_chunk_indices. */
3631
+ /** 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. */
3622
3632
  confidenceScores?: number[];
3623
3633
  /** 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. */
3624
3634
  groundingChunkIndices?: number[];
@@ -4722,6 +4732,8 @@ declare namespace gapi.client {
4722
4732
  healthRoute?: string;
4723
4733
  /** 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. */
4724
4734
  imageUri?: string;
4735
+ /** 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. */
4736
+ invokeRoutePrefix?: string;
4725
4737
  /** Immutable. Specification for Kubernetes liveness probe. */
4726
4738
  livenessProbe?: GoogleCloudAiplatformV1beta1Probe;
4727
4739
  /** 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). */
@@ -5881,8 +5893,10 @@ declare namespace gapi.client {
5881
5893
  inlineData?: GoogleCloudAiplatformV1beta1Blob;
5882
5894
  /** Optional. Text part (can be code). */
5883
5895
  text?: string;
5884
- /** Output only. Indicates if the part is thought from the model. */
5896
+ /** Optional. Indicates if the part is thought from the model. */
5885
5897
  thought?: boolean;
5898
+ /** Optional. An opaque signature for the thought so it can be reused in subsequent requests. */
5899
+ thoughtSignature?: string;
5886
5900
  /** Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. */
5887
5901
  videoMetadata?: GoogleCloudAiplatformV1beta1VideoMetadata;
5888
5902
  }
@@ -6312,16 +6326,22 @@ declare namespace gapi.client {
6312
6326
  projectId?: string;
6313
6327
  }
6314
6328
  interface GoogleCloudAiplatformV1beta1PSCAutomationConfig {
6315
- /** Output only. Forwarding rule created by the PSC service automation. Note for Vector search, use IndexPrivateEndpoint instead. */
6329
+ /** Output only. Error message if the PSC service automation failed. */
6330
+ errorMessage?: string;
6331
+ /** Output only. Forwarding rule created by the PSC service automation. */
6316
6332
  forwardingRule?: string;
6317
- /** Output only. IP address rule created by the PSC service automation. Note for Vector search, use IndexPrivateEndpoint instead. */
6333
+ /** Output only. IP address rule created by the PSC service automation. */
6318
6334
  ipAddress?: string;
6319
6335
  /** 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. */
6320
6336
  network?: string;
6321
6337
  /** Required. Project id used to create forwarding rule. */
6322
6338
  projectId?: string;
6339
+ /** Output only. The state of the PSC service automation. */
6340
+ state?: string;
6323
6341
  }
6324
6342
  interface GoogleCloudAiplatformV1beta1PscInterfaceConfig {
6343
+ /** 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. */
6344
+ dnsPeeringConfigs?: GoogleCloudAiplatformV1beta1DnsPeeringConfig[];
6325
6345
  /** 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. */
6326
6346
  networkAttachment?: string;
6327
6347
  }
@@ -6434,6 +6454,8 @@ declare namespace gapi.client {
6434
6454
  resourceTitle?: string;
6435
6455
  /** Optional. Use case (CUJ) of the resource. */
6436
6456
  resourceUseCase?: string;
6457
+ /** Optional. For notebook resource, whether the notebook supports Workbench. */
6458
+ supportsWorkbench?: boolean;
6437
6459
  /** Required. */
6438
6460
  title?: string;
6439
6461
  }
@@ -9984,6 +10006,8 @@ declare namespace gapi.client {
9984
10006
  interface GoogleCloudAiplatformV1beta1Tool {
9985
10007
  /** Optional. CodeExecution tool type. Enables the model to execute code as part of generation. */
9986
10008
  codeExecution?: any;
10009
+ /** Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. */
10010
+ computerUse?: GoogleCloudAiplatformV1beta1ToolComputerUse;
9987
10011
  /** Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. */
9988
10012
  enterpriseWebSearch?: any;
9989
10013
  /** Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. */
@@ -9994,6 +10018,8 @@ declare namespace gapi.client {
9994
10018
  googleSearchRetrieval?: GoogleCloudAiplatformV1beta1GoogleSearchRetrieval;
9995
10019
  /** Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. */
9996
10020
  retrieval?: GoogleCloudAiplatformV1beta1Retrieval;
10021
+ /** Optional. Tool to support URL context retrieval. */
10022
+ urlContext?: any;
9997
10023
  }
9998
10024
  interface GoogleCloudAiplatformV1beta1ToolCall {
9999
10025
  /** Optional. Spec for tool input */
@@ -10023,6 +10049,10 @@ declare namespace gapi.client {
10023
10049
  }
10024
10050
  interface GoogleCloudAiplatformV1beta1ToolCallValidSpec {}
10025
10051
  interface GoogleCloudAiplatformV1beta1ToolCodeExecution {}
10052
+ interface GoogleCloudAiplatformV1beta1ToolComputerUse {
10053
+ /** Required. The environment being operated. */
10054
+ environment?: string;
10055
+ }
10026
10056
  interface GoogleCloudAiplatformV1beta1ToolConfig {
10027
10057
  /** Optional. Function calling config. */
10028
10058
  functionCallingConfig?: GoogleCloudAiplatformV1beta1FunctionCallingConfig;
@@ -10384,6 +10414,10 @@ declare namespace gapi.client {
10384
10414
  partnerModelTuningSpec?: GoogleCloudAiplatformV1beta1PartnerModelTuningSpec;
10385
10415
  /** Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`. */
10386
10416
  pipelineJob?: string;
10417
+ /** Output only. Reserved for future use. */
10418
+ satisfiesPzi?: boolean;
10419
+ /** Output only. Reserved for future use. */
10420
+ satisfiesPzs?: boolean;
10387
10421
  /** The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. */
10388
10422
  serviceAccount?: string;
10389
10423
  /** Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. */
@@ -10568,6 +10602,17 @@ declare namespace gapi.client {
10568
10602
  /** The error message of the example that was not created/updated successfully. */
10569
10603
  status?: GoogleRpcStatus;
10570
10604
  }
10605
+ interface GoogleCloudAiplatformV1beta1UrlContext {}
10606
+ interface GoogleCloudAiplatformV1beta1UrlContextMetadata {
10607
+ /** Output only. List of url context. */
10608
+ urlMetadata?: GoogleCloudAiplatformV1beta1UrlMetadata[];
10609
+ }
10610
+ interface GoogleCloudAiplatformV1beta1UrlMetadata {
10611
+ /** Retrieved url by the tool. */
10612
+ retrievedUrl?: string;
10613
+ /** Status of the url retrieval. */
10614
+ urlRetrievalStatus?: string;
10615
+ }
10571
10616
  interface GoogleCloudAiplatformV1beta1UserActionReference {
10572
10617
  /** For API calls that start a LabelingJob. Resource name of the LabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` */
10573
10618
  dataLabelingJob?: string;
@@ -33049,6 +33094,121 @@ declare namespace gapi.client {
33049
33094
  interface RagEngineConfigResource {
33050
33095
  operations: OperationsResource;
33051
33096
  }
33097
+ interface OperationsResource {
33098
+ /** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. */
33099
+ cancel(request?: {
33100
+ /** V1 error format. */
33101
+ '$.xgafv'?: string;
33102
+ /** OAuth access token. */
33103
+ access_token?: string;
33104
+ /** Data format for response. */
33105
+ alt?: string;
33106
+ /** JSONP */
33107
+ callback?: string;
33108
+ /** Selector specifying which fields to include in a partial response. */
33109
+ fields?: string;
33110
+ /** 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. */
33111
+ key?: string;
33112
+ /** The name of the operation resource to be cancelled. */
33113
+ name: string;
33114
+ /** OAuth 2.0 token for the current user. */
33115
+ oauth_token?: string;
33116
+ /** Returns response with indentations and line breaks. */
33117
+ prettyPrint?: boolean;
33118
+ /** 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. */
33119
+ quotaUser?: string;
33120
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
33121
+ upload_protocol?: string;
33122
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
33123
+ uploadType?: string;
33124
+ }): Request<{}>;
33125
+ /** Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. */
33126
+ delete(request?: {
33127
+ /** V1 error format. */
33128
+ '$.xgafv'?: string;
33129
+ /** OAuth access token. */
33130
+ access_token?: string;
33131
+ /** Data format for response. */
33132
+ alt?: string;
33133
+ /** JSONP */
33134
+ callback?: string;
33135
+ /** Selector specifying which fields to include in a partial response. */
33136
+ fields?: string;
33137
+ /** 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. */
33138
+ key?: string;
33139
+ /** The name of the operation resource to be deleted. */
33140
+ name: string;
33141
+ /** OAuth 2.0 token for the current user. */
33142
+ oauth_token?: string;
33143
+ /** Returns response with indentations and line breaks. */
33144
+ prettyPrint?: boolean;
33145
+ /** 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. */
33146
+ quotaUser?: string;
33147
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
33148
+ upload_protocol?: string;
33149
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
33150
+ uploadType?: string;
33151
+ }): Request<{}>;
33152
+ /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
33153
+ get(request?: {
33154
+ /** V1 error format. */
33155
+ '$.xgafv'?: string;
33156
+ /** OAuth access token. */
33157
+ access_token?: string;
33158
+ /** Data format for response. */
33159
+ alt?: string;
33160
+ /** JSONP */
33161
+ callback?: string;
33162
+ /** Selector specifying which fields to include in a partial response. */
33163
+ fields?: string;
33164
+ /** 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. */
33165
+ key?: string;
33166
+ /** The name of the operation resource. */
33167
+ name: string;
33168
+ /** OAuth 2.0 token for the current user. */
33169
+ oauth_token?: string;
33170
+ /** Returns response with indentations and line breaks. */
33171
+ prettyPrint?: boolean;
33172
+ /** 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. */
33173
+ quotaUser?: string;
33174
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
33175
+ upload_protocol?: string;
33176
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
33177
+ uploadType?: string;
33178
+ }): Request<GoogleLongrunningOperation>;
33179
+ /** Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. */
33180
+ wait(request?: {
33181
+ /** V1 error format. */
33182
+ '$.xgafv'?: string;
33183
+ /** OAuth access token. */
33184
+ access_token?: string;
33185
+ /** Data format for response. */
33186
+ alt?: string;
33187
+ /** JSONP */
33188
+ callback?: string;
33189
+ /** Selector specifying which fields to include in a partial response. */
33190
+ fields?: string;
33191
+ /** 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. */
33192
+ key?: string;
33193
+ /** The name of the operation resource to wait on. */
33194
+ name: string;
33195
+ /** OAuth 2.0 token for the current user. */
33196
+ oauth_token?: string;
33197
+ /** Returns response with indentations and line breaks. */
33198
+ prettyPrint?: boolean;
33199
+ /** 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. */
33200
+ quotaUser?: string;
33201
+ /** The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */
33202
+ timeout?: string;
33203
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
33204
+ upload_protocol?: string;
33205
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
33206
+ uploadType?: string;
33207
+ }): Request<GoogleLongrunningOperation>;
33208
+ }
33209
+ interface ExamplesResource {
33210
+ operations: OperationsResource;
33211
+ }
33052
33212
  interface OperationsResource {
33053
33213
  /** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. */
33054
33214
  cancel(request?: {
@@ -34265,6 +34425,7 @@ declare namespace gapi.client {
34265
34425
  },
34266
34426
  body: GoogleCloudAiplatformV1beta1StreamQueryReasoningEngineRequest,
34267
34427
  ): Request<GoogleApiHttpBody>;
34428
+ examples: ExamplesResource;
34268
34429
  memories: MemoriesResource;
34269
34430
  operations: OperationsResource;
34270
34431
  sandboxEnvironments: SandboxEnvironmentsResource;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.aiplatform-v1beta1",
3
- "version": "0.0.20250529",
3
+ "version": "0.0.20250606",
4
4
  "description": "TypeScript typings for Vertex AI API v1beta1",
5
5
  "repository": {
6
6
  "type": "git",