@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20240925 → 0.0.20241001

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 +42 -17
  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: 20240925
12
+ // Revision: 20241001
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -1539,6 +1539,12 @@ declare namespace gapi.client {
1539
1539
  /** A list of double values. */
1540
1540
  values?: number[];
1541
1541
  }
1542
+ interface GoogleCloudAiplatformV1beta1DynamicRetrievalConfig {
1543
+ /** Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. */
1544
+ dynamicThreshold?: number;
1545
+ /** The mode of the predictor to be used in dynamic retrieval. */
1546
+ mode?: string;
1547
+ }
1542
1548
  interface GoogleCloudAiplatformV1beta1EncryptionSpec {
1543
1549
  /** Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. */
1544
1550
  kmsKeyName?: string;
@@ -2881,7 +2887,10 @@ declare namespace gapi.client {
2881
2887
  /** Required. The type of the Google Drive resource. */
2882
2888
  resourceType?: string;
2883
2889
  }
2884
- interface GoogleCloudAiplatformV1beta1GoogleSearchRetrieval {}
2890
+ interface GoogleCloudAiplatformV1beta1GoogleSearchRetrieval {
2891
+ /** Specifies the dynamic retrieval configuration for the given source. */
2892
+ dynamicRetrievalConfig?: GoogleCloudAiplatformV1beta1DynamicRetrievalConfig;
2893
+ }
2885
2894
  interface GoogleCloudAiplatformV1beta1GroundednessInput {
2886
2895
  /** Required. Groundedness instance. */
2887
2896
  instance?: GoogleCloudAiplatformV1beta1GroundednessInstance;
@@ -2929,6 +2938,8 @@ declare namespace gapi.client {
2929
2938
  groundingChunks?: GoogleCloudAiplatformV1beta1GroundingChunk[];
2930
2939
  /** Optional. List of grounding support. */
2931
2940
  groundingSupports?: GoogleCloudAiplatformV1beta1GroundingSupport[];
2941
+ /** Optional. Output only. Retrieval metadata. */
2942
+ retrievalMetadata?: GoogleCloudAiplatformV1beta1RetrievalMetadata;
2932
2943
  /** Optional. Queries executed by the retrieval tools. */
2933
2944
  retrievalQueries?: string[];
2934
2945
  /** Optional. Google search entry for the following-up web searches. */
@@ -3631,9 +3642,9 @@ declare namespace gapi.client {
3631
3642
  interface GoogleCloudAiplatformV1beta1LogprobsResultCandidate {
3632
3643
  /** The candidate's log probability. */
3633
3644
  logProbability?: number;
3634
- /** The candidates token string value. */
3645
+ /** The candidate's token string value. */
3635
3646
  token?: string;
3636
- /** The candidates token id value. */
3647
+ /** The candidate's token id value. */
3637
3648
  tokenId?: number;
3638
3649
  }
3639
3650
  interface GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates {
@@ -4976,6 +4987,14 @@ declare namespace gapi.client {
4976
4987
  /** Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. */
4977
4988
  videoMetadata?: GoogleCloudAiplatformV1beta1VideoMetadata;
4978
4989
  }
4990
+ interface GoogleCloudAiplatformV1beta1PartnerModelTuningSpec {
4991
+ /** Hyperparameters for tuning. The accepted hyper_parameters and their valid range of values will differ depending on the base model. */
4992
+ hyperParameters?: {[P in string]: any};
4993
+ /** Required. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. */
4994
+ trainingDatasetUri?: string;
4995
+ /** Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. */
4996
+ validationDatasetUri?: string;
4997
+ }
4979
4998
  interface GoogleCloudAiplatformV1beta1PauseModelDeploymentMonitoringJobRequest {}
4980
4999
  interface GoogleCloudAiplatformV1beta1PauseScheduleRequest {}
4981
5000
  interface GoogleCloudAiplatformV1beta1PersistentDiskSpec {
@@ -5039,11 +5058,11 @@ declare namespace gapi.client {
5039
5058
  name?: string;
5040
5059
  /** The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. */
5041
5060
  network?: string;
5042
- /** Output only. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job. */
5061
+ /** Optional. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job. */
5043
5062
  originalPipelineJobId?: string;
5044
5063
  /** The spec of the pipeline. */
5045
5064
  pipelineSpec?: {[P in string]: any};
5046
- /** Output only. The rerun configs for each task in the pipeline job. By default, the rerun will: 1. Use the same input artifacts as the original run. 2. Use the same input parameters as the original run. 3. Skip all the tasks that are already succeeded in the original run. 4. Rerun all the tasks that are not succeeded in the original run. By providing this field, users can override the default behavior and specify the rerun config for each task. */
5065
+ /** Optional. The rerun configs for each task in the pipeline job. By default, the rerun will: 1. Use the same input artifacts as the original run. 2. Use the same input parameters as the original run. 3. Skip all the tasks that are already succeeded in the original run. 4. Rerun all the tasks that are not succeeded in the original run. By providing this field, users can override the default behavior and specify the rerun config for each task. */
5047
5066
  pipelineTaskRerunConfigs?: GoogleCloudAiplatformV1beta1PipelineTaskRerunConfig[];
5048
5067
  /** Optional. Whether to do component level validations before job creation. */
5049
5068
  preflightValidations?: boolean;
@@ -5163,27 +5182,27 @@ declare namespace gapi.client {
5163
5182
  job?: string;
5164
5183
  }
5165
5184
  interface GoogleCloudAiplatformV1beta1PipelineTaskRerunConfig {
5166
- /** Output only. The runtime input of the task overridden by the user. */
5185
+ /** Optional. The runtime input of the task overridden by the user. */
5167
5186
  inputs?: GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigInputs;
5168
- /** Output only. Whether to skip downstream tasks. Default value is False. */
5187
+ /** Optional. Whether to skip downstream tasks. Default value is False. */
5169
5188
  skipDownstreamTasks?: boolean;
5170
- /** Output only. Whether to skip this task. Default value is False. */
5189
+ /** Optional. Whether to skip this task. Default value is False. */
5171
5190
  skipTask?: boolean;
5172
- /** Output only. The system generated ID of the task. Retrieved from original run. */
5191
+ /** Optional. The system generated ID of the task. Retrieved from original run. */
5173
5192
  taskId?: string;
5174
- /** Output only. The name of the task. */
5193
+ /** Optional. The name of the task. */
5175
5194
  taskName?: string;
5176
5195
  }
5177
5196
  interface GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigArtifactList {
5178
- /** Output only. A list of artifact metadata. */
5197
+ /** Optional. A list of artifact metadata. */
5179
5198
  artifacts?: GoogleCloudAiplatformV1beta1RuntimeArtifact[];
5180
5199
  }
5181
5200
  interface GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigInputs {
5182
- /** Output only. Input artifacts. */
5201
+ /** Optional. Input artifacts. */
5183
5202
  artifacts?: {
5184
5203
  [P in string]: GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigArtifactList;
5185
5204
  };
5186
- /** Output only. Input parameters. */
5205
+ /** Optional. Input parameters. */
5187
5206
  parameterValues?: {[P in string]: any};
5188
5207
  }
5189
5208
  interface GoogleCloudAiplatformV1beta1PipelineTemplateMetadata {
@@ -6057,6 +6076,10 @@ declare namespace gapi.client {
6057
6076
  /** Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. */
6058
6077
  vertexRagStore?: GoogleCloudAiplatformV1beta1VertexRagStore;
6059
6078
  }
6079
+ interface GoogleCloudAiplatformV1beta1RetrievalMetadata {
6080
+ /** Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. */
6081
+ googleSearchDynamicRetrievalScore?: number;
6082
+ }
6060
6083
  interface GoogleCloudAiplatformV1beta1RetrieveContextsRequest {
6061
6084
  /** Required. Single RAG retrieve query. */
6062
6085
  query?: GoogleCloudAiplatformV1beta1RagQuery;
@@ -8431,7 +8454,7 @@ declare namespace gapi.client {
8431
8454
  /** 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. */
8432
8455
  functionDeclarations?: GoogleCloudAiplatformV1beta1FunctionDeclaration[];
8433
8456
  /** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
8434
- googleSearchRetrieval?: any;
8457
+ googleSearchRetrieval?: GoogleCloudAiplatformV1beta1GoogleSearchRetrieval;
8435
8458
  /** 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. */
8436
8459
  retrieval?: GoogleCloudAiplatformV1beta1Retrieval;
8437
8460
  }
@@ -8667,6 +8690,8 @@ declare namespace gapi.client {
8667
8690
  labels?: {[P in string]: string};
8668
8691
  /** Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` */
8669
8692
  name?: string;
8693
+ /** Tuning Spec for open sourced and third party Partner models. */
8694
+ partnerModelTuningSpec?: GoogleCloudAiplatformV1beta1PartnerModelTuningSpec;
8670
8695
  /** Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`. */
8671
8696
  pipelineJob?: string;
8672
8697
  /** Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. */
@@ -29291,7 +29316,7 @@ declare namespace gapi.client {
29291
29316
  prettyPrint?: boolean;
29292
29317
  /** 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. */
29293
29318
  quotaUser?: string;
29294
- /** Required. Mask specifying which fields to update. */
29319
+ /** Optional. Mask specifying which fields to update. */
29295
29320
  updateMask?: string;
29296
29321
  /** Upload protocol for media (e.g. "raw", "multipart"). */
29297
29322
  upload_protocol?: string;
@@ -29322,7 +29347,7 @@ declare namespace gapi.client {
29322
29347
  prettyPrint?: boolean;
29323
29348
  /** 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. */
29324
29349
  quotaUser?: string;
29325
- /** Required. Mask specifying which fields to update. */
29350
+ /** Optional. Mask specifying which fields to update. */
29326
29351
  updateMask?: string;
29327
29352
  /** Upload protocol for media (e.g. "raw", "multipart"). */
29328
29353
  upload_protocol?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.aiplatform-v1beta1",
3
- "version": "0.0.20240925",
3
+ "version": "0.0.20241001",
4
4
  "description": "TypeScript typings for Vertex AI API v1beta1",
5
5
  "repository": {
6
6
  "type": "git",