@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20250731 → 0.0.20250806

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 +151 -3
  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: 20250731
12
+ // Revision: 20250806
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -1409,6 +1409,10 @@ declare namespace gapi.client {
1409
1409
  right?: number;
1410
1410
  }
1411
1411
  interface GoogleCloudAiplatformV1beta1DatasetStats {
1412
+ /** Output only. A partial sample of the indices (starting from 1) of the dropped examples. */
1413
+ droppedExampleIndices?: string[];
1414
+ /** Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped. */
1415
+ droppedExampleReasons?: string[];
1412
1416
  /** Output only. Number of billable characters in the tuning dataset. */
1413
1417
  totalBillableCharacterCount?: string;
1414
1418
  /** Output only. Number of tuning characters in the tuning dataset. */
@@ -1715,10 +1719,14 @@ declare namespace gapi.client {
1715
1719
  systemLabels?: {[P in string]: string};
1716
1720
  }
1717
1721
  interface GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig {
1718
- /** 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. */
1722
+ /** Optional. By default, if dedicated endpoint is enabled, 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. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com. */
1723
+ dedicatedEndpointDisabled?: boolean;
1724
+ /** Optional. Deprecated. Use dedicated_endpoint_disabled instead. 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. */
1719
1725
  dedicatedEndpointEnabled?: boolean;
1720
1726
  /** Optional. The user-specified display name of the endpoint. If not set, a default name will be used. */
1721
1727
  endpointDisplayName?: string;
1728
+ /** Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body. */
1729
+ endpointUserId?: string;
1722
1730
  }
1723
1731
  interface GoogleCloudAiplatformV1beta1DeployRequestModelConfig {
1724
1732
  /** Optional. Whether the user accepts the End User License Agreement (EULA) for the model. */
@@ -1955,6 +1963,14 @@ declare namespace gapi.client {
1955
1963
  /** Required. Config for evaluation output. */
1956
1964
  outputConfig?: GoogleCloudAiplatformV1beta1OutputConfig;
1957
1965
  }
1966
+ interface GoogleCloudAiplatformV1beta1EvaluateDatasetRun {
1967
+ /** Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints. */
1968
+ checkpointId?: string;
1969
+ /** Output only. The error of the evaluation run if any. */
1970
+ error?: GoogleRpcStatus;
1971
+ /** Output only. The operation ID of the evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation_id}`. */
1972
+ operationName?: string;
1973
+ }
1958
1974
  interface GoogleCloudAiplatformV1beta1EvaluateInstancesRequest {
1959
1975
  /** Optional. Autorater config used for evaluation. */
1960
1976
  autoraterConfig?: GoogleCloudAiplatformV1beta1AutoraterConfig;
@@ -2089,6 +2105,14 @@ declare namespace gapi.client {
2089
2105
  /** Results for trajectory single tool use metric. */
2090
2106
  trajectorySingleToolUseResults?: GoogleCloudAiplatformV1beta1TrajectorySingleToolUseResults;
2091
2107
  }
2108
+ interface GoogleCloudAiplatformV1beta1EvaluationConfig {
2109
+ /** Optional. Autorater config for evaluation. */
2110
+ autoraterConfig?: GoogleCloudAiplatformV1beta1AutoraterConfig;
2111
+ /** Required. The metrics used for evaluation. */
2112
+ metrics?: GoogleCloudAiplatformV1beta1Metric[];
2113
+ /** Required. Config for evaluation output. */
2114
+ outputConfig?: GoogleCloudAiplatformV1beta1OutputConfig;
2115
+ }
2092
2116
  interface GoogleCloudAiplatformV1beta1EvaluationDataset {
2093
2117
  /** BigQuery source holds the dataset. */
2094
2118
  bigquerySource?: GoogleCloudAiplatformV1beta1BigQuerySource;
@@ -3443,6 +3467,8 @@ declare namespace gapi.client {
3443
3467
  generationConfig?: GoogleCloudAiplatformV1beta1GenerationConfig;
3444
3468
  /** Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. */
3445
3469
  labels?: {[P in string]: string};
3470
+ /** Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. */
3471
+ modelArmorConfig?: GoogleCloudAiplatformV1beta1ModelArmorConfig;
3446
3472
  /** Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. */
3447
3473
  safetySettings?: GoogleCloudAiplatformV1beta1SafetySetting[];
3448
3474
  /** Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. */
@@ -3725,6 +3751,8 @@ declare namespace gapi.client {
3725
3751
  review?: string;
3726
3752
  }
3727
3753
  interface GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext {
3754
+ /** Output only. The full document name for the referenced Vertex AI Search document. */
3755
+ documentName?: string;
3728
3756
  /** Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. */
3729
3757
  ragChunk?: GoogleCloudAiplatformV1beta1RagChunk;
3730
3758
  /** Text of the attribution. */
@@ -4605,12 +4633,16 @@ declare namespace gapi.client {
4605
4633
  description?: string;
4606
4634
  /** Optional. Display name of the Memory. */
4607
4635
  displayName?: string;
4636
+ /** Optional. Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input. */
4637
+ expireTime?: string;
4608
4638
  /** Required. Semantic knowledge extracted from the source content. */
4609
4639
  fact?: string;
4610
4640
  /** Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` */
4611
4641
  name?: string;
4612
4642
  /** Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. */
4613
4643
  scope?: {[P in string]: string};
4644
+ /** Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. */
4645
+ ttl?: string;
4614
4646
  /** Output only. Timestamp when this Memory was most recently updated. */
4615
4647
  updateTime?: string;
4616
4648
  }
@@ -4866,6 +4898,12 @@ declare namespace gapi.client {
4866
4898
  /** Output only. Timestamp when this version was most recently updated. */
4867
4899
  versionUpdateTime?: string;
4868
4900
  }
4901
+ interface GoogleCloudAiplatformV1beta1ModelArmorConfig {
4902
+ /** Optional. The name of the Model Armor template to use for prompt sanitization. */
4903
+ promptTemplateName?: string;
4904
+ /** Optional. The name of the Model Armor template to use for response sanitization. */
4905
+ responseTemplateName?: string;
4906
+ }
4869
4907
  interface GoogleCloudAiplatformV1beta1ModelBaseModelSource {
4870
4908
  /** Information about the base model of Genie models. */
4871
4909
  genieSource?: GoogleCloudAiplatformV1beta1GenieSource;
@@ -6405,6 +6443,10 @@ declare namespace gapi.client {
6405
6443
  predictionSchemaUri?: string;
6406
6444
  }
6407
6445
  interface GoogleCloudAiplatformV1beta1PreferenceOptimizationDataStats {
6446
+ /** Output only. A partial sample of the indices (starting from 1) of the dropped examples. */
6447
+ droppedExampleIndices?: string[];
6448
+ /** Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped. */
6449
+ droppedExampleReasons?: string[];
6408
6450
  /** Output only. Dataset distributions for scores. */
6409
6451
  scoresDistribution?: GoogleCloudAiplatformV1beta1DatasetDistribution;
6410
6452
  /** Output only. Dataset distributions for scores variance per example. */
@@ -6433,6 +6475,8 @@ declare namespace gapi.client {
6433
6475
  learningRateMultiplier?: number;
6434
6476
  }
6435
6477
  interface GoogleCloudAiplatformV1beta1PreferenceOptimizationSpec {
6478
+ /** Optional. Evaluation Config for Preference Optimization Job. */
6479
+ evaluationConfig?: GoogleCloudAiplatformV1beta1EvaluationConfig;
6436
6480
  /** Optional. Hyperparameters for Preference Optimization. */
6437
6481
  hyperParameters?: GoogleCloudAiplatformV1beta1PreferenceOptimizationHyperParameters;
6438
6482
  /** Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. */
@@ -6975,7 +7019,7 @@ declare namespace gapi.client {
6975
7019
  name?: string;
6976
7020
  /** Optional. Immutable. The embedding model config of the RagCorpus. */
6977
7021
  ragEmbeddingModelConfig?: GoogleCloudAiplatformV1beta1RagEmbeddingModelConfig;
6978
- /** Output only. Number of RagFiles in the RagCorpus. */
7022
+ /** Output only. Number of RagFiles in the RagCorpus. NOTE: This field is not populated in the response of VertexRagDataService.ListRagCorpora. */
6979
7023
  ragFilesCount?: number;
6980
7024
  /** Optional. Immutable. The Vector DB config of the RagCorpus. */
6981
7025
  ragVectorDbConfig?: GoogleCloudAiplatformV1beta1RagVectorDbConfig;
@@ -7397,8 +7441,18 @@ declare namespace gapi.client {
7397
7441
  serviceAccount?: string;
7398
7442
  }
7399
7443
  interface GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec {
7444
+ /** Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9. */
7445
+ containerConcurrency?: number;
7400
7446
  /** Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API. */
7401
7447
  env?: GoogleCloudAiplatformV1beta1EnvVar[];
7448
+ /** Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. */
7449
+ maxInstances?: number;
7450
+ /** Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. */
7451
+ minInstances?: number;
7452
+ /** Optional. Configuration for PSC-I. */
7453
+ pscInterfaceConfig?: GoogleCloudAiplatformV1beta1PscInterfaceConfig;
7454
+ /** Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}. * The only supported values for CPU are '1', '2', '4', and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits */
7455
+ resourceLimits?: {[P in string]: string};
7402
7456
  /** Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent. */
7403
7457
  secretEnv?: GoogleCloudAiplatformV1beta1SecretEnvVar[];
7404
7458
  }
@@ -7429,6 +7483,36 @@ declare namespace gapi.client {
7429
7483
  progressMessage?: string;
7430
7484
  }
7431
7485
  interface GoogleCloudAiplatformV1beta1RebootPersistentResourceRequest {}
7486
+ interface GoogleCloudAiplatformV1beta1RecommendSpecRequest {
7487
+ /** Optional. If true, check machine availability for the recommended regions. Only return the machine spec in regions where the machine is available. */
7488
+ checkMachineAvailability?: boolean;
7489
+ /** Optional. If true, check user quota for the recommended regions. Returns all the machine spec in regions they are available, and also the user quota state for each machine type in each region. */
7490
+ checkUserQuota?: boolean;
7491
+ /** Required. The Google Cloud Storage URI of the custom model, storing weights and config files (which can be used to infer the base model). */
7492
+ gcsUri?: string;
7493
+ }
7494
+ interface GoogleCloudAiplatformV1beta1RecommendSpecResponse {
7495
+ /** Output only. The base model used to finetune the custom model. */
7496
+ baseModel?: string;
7497
+ /** Output only. Recommendations of deployment options for the given custom weights model. */
7498
+ recommendations?: GoogleCloudAiplatformV1beta1RecommendSpecResponseRecommendation[];
7499
+ /** Output only. The machine and model container specs. */
7500
+ specs?: GoogleCloudAiplatformV1beta1RecommendSpecResponseMachineAndModelContainerSpec[];
7501
+ }
7502
+ interface GoogleCloudAiplatformV1beta1RecommendSpecResponseMachineAndModelContainerSpec {
7503
+ /** Output only. The model container spec. */
7504
+ containerSpec?: GoogleCloudAiplatformV1beta1ModelContainerSpec;
7505
+ /** Output only. The machine spec. */
7506
+ machineSpec?: GoogleCloudAiplatformV1beta1MachineSpec;
7507
+ }
7508
+ interface GoogleCloudAiplatformV1beta1RecommendSpecResponseRecommendation {
7509
+ /** The region for the deployment spec (machine). */
7510
+ region?: string;
7511
+ /** Output only. The machine and model container specs. */
7512
+ spec?: GoogleCloudAiplatformV1beta1RecommendSpecResponseMachineAndModelContainerSpec;
7513
+ /** Output only. The user accelerator quota state. */
7514
+ userQuotaState?: string;
7515
+ }
7432
7516
  interface GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest {
7433
7517
  /** The resource names of the child Contexts. */
7434
7518
  childContexts?: string[];
@@ -10108,6 +10192,8 @@ declare namespace gapi.client {
10108
10192
  userOutputTokenDistribution?: GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistribution;
10109
10193
  }
10110
10194
  interface GoogleCloudAiplatformV1beta1SupervisedTuningSpec {
10195
+ /** Optional. Evaluation Config for Tuning Job. */
10196
+ evaluationConfig?: GoogleCloudAiplatformV1beta1EvaluationConfig;
10111
10197
  /** Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false. */
10112
10198
  exportLastCheckpointOnly?: boolean;
10113
10199
  /** Optional. Hyperparameters for SFT. */
@@ -10712,6 +10798,8 @@ declare namespace gapi.client {
10712
10798
  endTime?: string;
10713
10799
  /** Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. */
10714
10800
  error?: GoogleRpcStatus;
10801
+ /** Output only. Evaluation runs for the Tuning Job. */
10802
+ evaluateDatasetRuns?: GoogleCloudAiplatformV1beta1EvaluateDatasetRun[];
10715
10803
  /** Output only. The Experiment associated with this TuningJob. */
10716
10804
  experiment?: string;
10717
10805
  /** Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. */
@@ -10746,6 +10834,8 @@ declare namespace gapi.client {
10746
10834
  tunedModelDisplayName?: string;
10747
10835
  /** Output only. The tuning data statistics associated with this TuningJob. */
10748
10836
  tuningDataStats?: GoogleCloudAiplatformV1beta1TuningDataStats;
10837
+ /** Output only. The detail state of the tuning job (while the overall `JobState` is running). */
10838
+ tuningJobState?: string;
10749
10839
  /** Output only. Time when the TuningJob was most recently updated. */
10750
10840
  updateTime?: string;
10751
10841
  /** Tuning Spec for Veo Tuning. */
@@ -40369,6 +40459,64 @@ declare namespace gapi.client {
40369
40459
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
40370
40460
  uploadType?: string;
40371
40461
  }): Request<GoogleCloudLocationListLocationsResponse>;
40462
+ /** Gets a Model's spec recommendations. This API is called by UI, SDK, and internal. */
40463
+ recommendSpec(request: {
40464
+ /** V1 error format. */
40465
+ '$.xgafv'?: string;
40466
+ /** OAuth access token. */
40467
+ access_token?: string;
40468
+ /** Data format for response. */
40469
+ alt?: string;
40470
+ /** JSONP */
40471
+ callback?: string;
40472
+ /** Selector specifying which fields to include in a partial response. */
40473
+ fields?: string;
40474
+ /** 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. */
40475
+ key?: string;
40476
+ /** OAuth 2.0 token for the current user. */
40477
+ oauth_token?: string;
40478
+ /** Required. The resource name of the Location from which to recommend specs. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`. */
40479
+ parent: string;
40480
+ /** Returns response with indentations and line breaks. */
40481
+ prettyPrint?: boolean;
40482
+ /** 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. */
40483
+ quotaUser?: string;
40484
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
40485
+ upload_protocol?: string;
40486
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
40487
+ uploadType?: string;
40488
+ /** Request body */
40489
+ resource: GoogleCloudAiplatformV1beta1RecommendSpecRequest;
40490
+ }): Request<GoogleCloudAiplatformV1beta1RecommendSpecResponse>;
40491
+ recommendSpec(
40492
+ request: {
40493
+ /** V1 error format. */
40494
+ '$.xgafv'?: string;
40495
+ /** OAuth access token. */
40496
+ access_token?: string;
40497
+ /** Data format for response. */
40498
+ alt?: string;
40499
+ /** JSONP */
40500
+ callback?: string;
40501
+ /** Selector specifying which fields to include in a partial response. */
40502
+ fields?: string;
40503
+ /** 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. */
40504
+ key?: string;
40505
+ /** OAuth 2.0 token for the current user. */
40506
+ oauth_token?: string;
40507
+ /** Required. The resource name of the Location from which to recommend specs. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`. */
40508
+ parent: string;
40509
+ /** Returns response with indentations and line breaks. */
40510
+ prettyPrint?: boolean;
40511
+ /** 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. */
40512
+ quotaUser?: string;
40513
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
40514
+ upload_protocol?: string;
40515
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
40516
+ uploadType?: string;
40517
+ },
40518
+ body: GoogleCloudAiplatformV1beta1RecommendSpecRequest,
40519
+ ): Request<GoogleCloudAiplatformV1beta1RecommendSpecResponse>;
40372
40520
  /** Retrieves relevant contexts for a query. */
40373
40521
  retrieveContexts(request: {
40374
40522
  /** V1 error format. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.aiplatform-v1beta1",
3
- "version": "0.0.20250731",
3
+ "version": "0.0.20250806",
4
4
  "description": "TypeScript typings for Vertex AI API v1beta1",
5
5
  "repository": {
6
6
  "type": "git",