@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20240328 → 0.0.20240417

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 +373 -63
  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=v1
12
- // Revision: 20240328
12
+ // Revision: 20240417
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -41,6 +41,8 @@ declare namespace gapi.client {
41
41
  interface CloudAiLargeModelsVisionGenerateVideoResponse {
42
42
  /** The generates samples. */
43
43
  generatedSamples?: CloudAiLargeModelsVisionMedia[];
44
+ /** Returns rai error message for filtered videos. */
45
+ raiErrorMessage?: string;
44
46
  /** Returns if any videos were filtered due to RAI policies. */
45
47
  raiMediaFilteredCount?: number;
46
48
  /** Returns rai failure reasons if any. */
@@ -198,6 +200,8 @@ declare namespace gapi.client {
198
200
  usageMetadata?: CloudAiNlLlmProtoServiceUsageMetadata;
199
201
  }
200
202
  interface CloudAiNlLlmProtoServiceMessageMetadata {
203
+ /** Factuality-related debug metadata. */
204
+ factualityDebugMetadata?: LearningGenaiRootPerRequestProcessorDebugMetadataFactualityDebugMetadata;
201
205
  /** Filter metadata of the input messages. */
202
206
  inputFilterInfo?: LearningServingLlmMessageMetadata;
203
207
  /** This score is generated by the router model to decide which model to use */
@@ -274,6 +278,8 @@ declare namespace gapi.client {
274
278
  languageFilterResult?: LearningGenaiRootLanguageFilterResult;
275
279
  /** The RAI signals for the text. */
276
280
  raiSignals?: CloudAiNlLlmProtoServiceRaiSignal[];
281
+ /** Translation request info during RAI for debugging purpose. Each TranslationRequestInfo corresponds to a request sent to the translation server. */
282
+ translationRequestInfos?: LearningGenaiRootTranslationRequestInfo[];
277
283
  /** Whether the text triggered the blocklist. */
278
284
  triggeredBlocklist?: boolean;
279
285
  /** Whether the text should be blocked by the recitation result from Aida recitation checker. It is determined from aida_recitation_result. */
@@ -715,6 +721,7 @@ declare namespace gapi.client {
715
721
  interface GoogleCloudAiplatformV1CancelNasJobRequest {}
716
722
  interface GoogleCloudAiplatformV1CancelPipelineJobRequest {}
717
723
  interface GoogleCloudAiplatformV1CancelTrainingPipelineRequest {}
724
+ interface GoogleCloudAiplatformV1CancelTuningJobRequest {}
718
725
  interface GoogleCloudAiplatformV1Candidate {
719
726
  /** Output only. Source attribution of the generated content. */
720
727
  citationMetadata?: GoogleCloudAiplatformV1CitationMetadata;
@@ -1391,6 +1398,8 @@ declare namespace gapi.client {
1391
1398
  network?: string;
1392
1399
  /** Configures the request-response logging for online prediction. */
1393
1400
  predictRequestResponseLoggingConfig?: GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig;
1401
+ /** Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive. */
1402
+ privateServiceConnectConfig?: GoogleCloudAiplatformV1PrivateServiceConnectConfig;
1394
1403
  /** A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. */
1395
1404
  trafficSplit?: {[P in string]: number};
1396
1405
  /** Output only. Timestamp when this Endpoint was last updated. */
@@ -2252,6 +2261,8 @@ declare namespace gapi.client {
2252
2261
  maxOutputTokens?: number;
2253
2262
  /** Optional. Positive penalties. */
2254
2263
  presencePenalty?: number;
2264
+ /** Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. */
2265
+ responseMimeType?: string;
2255
2266
  /** Optional. Stop sequences. */
2256
2267
  stopSequences?: string[];
2257
2268
  /** Optional. Controls the randomness of predictions. */
@@ -2273,29 +2284,7 @@ declare namespace gapi.client {
2273
2284
  /** Required. The public base model URI. */
2274
2285
  baseModelUri?: string;
2275
2286
  }
2276
- interface GoogleCloudAiplatformV1GoogleSearchRetrieval {
2277
- /** Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. */
2278
- disableAttribution?: boolean;
2279
- }
2280
- interface GoogleCloudAiplatformV1GroundingAttribution {
2281
- /** Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. */
2282
- confidenceScore?: number;
2283
- /** Output only. Segment of the content this attribution belongs to. */
2284
- segment?: GoogleCloudAiplatformV1Segment;
2285
- /** Optional. Attribution from the web. */
2286
- web?: GoogleCloudAiplatformV1GroundingAttributionWeb;
2287
- }
2288
- interface GoogleCloudAiplatformV1GroundingAttributionWeb {
2289
- /** Output only. Title of the attribution. */
2290
- title?: string;
2291
- /** Output only. URI reference of the attribution. */
2292
- uri?: string;
2293
- }
2294
2287
  interface GoogleCloudAiplatformV1GroundingMetadata {
2295
- /** Optional. List of grounding attributions. */
2296
- groundingAttributions?: GoogleCloudAiplatformV1GroundingAttribution[];
2297
- /** Optional. Queries executed by the retrieval tools. */
2298
- retrievalQueries?: string[];
2299
2288
  /** Optional. Web search queries for the following-up web search. */
2300
2289
  webSearchQueries?: string[];
2301
2290
  }
@@ -2843,6 +2832,12 @@ declare namespace gapi.client {
2843
2832
  /** The Trials associated with the Study. */
2844
2833
  trials?: GoogleCloudAiplatformV1Trial[];
2845
2834
  }
2835
+ interface GoogleCloudAiplatformV1ListTuningJobsResponse {
2836
+ /** A token to retrieve the next page of results. Pass to ListTuningJobsRequest.page_token to obtain that page. */
2837
+ nextPageToken?: string;
2838
+ /** List of TuningJobs in the requested page. */
2839
+ tuningJobs?: GoogleCloudAiplatformV1TuningJob[];
2840
+ }
2846
2841
  interface GoogleCloudAiplatformV1LookupStudyRequest {
2847
2842
  /** Required. The user-defined display name of the Study */
2848
2843
  displayName?: string;
@@ -3747,7 +3742,7 @@ declare namespace gapi.client {
3747
3742
  /** Required. The spec of the pools of different resources. */
3748
3743
  resourcePools?: GoogleCloudAiplatformV1ResourcePool[];
3749
3744
  /** Output only. Runtime information of the Persistent Resource. */
3750
- resourceRuntime?: GoogleCloudAiplatformV1ResourceRuntime;
3745
+ resourceRuntime?: any;
3751
3746
  /** Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration. */
3752
3747
  resourceRuntimeSpec?: GoogleCloudAiplatformV1ResourceRuntimeSpec;
3753
3748
  /** Output only. Time when the PersistentResource for the first time entered the `RUNNING` state. */
@@ -4006,8 +4001,6 @@ declare namespace gapi.client {
4006
4001
  deploy?: GoogleCloudAiplatformV1PublisherModelCallToActionDeploy;
4007
4002
  /** Optional. Deploy PublisherModel to Google Kubernetes Engine. */
4008
4003
  deployGke?: GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke;
4009
- /** Optional. Multiple setups to deploy the PublisherModel to Vertex Endpoint. */
4010
- multiDeployVertex?: GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex;
4011
4004
  /** Optional. Open evaluation pipeline of the PublisherModel. */
4012
4005
  openEvaluationPipeline?: GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences;
4013
4006
  /** Optional. Open fine-tuning pipeline of the PublisherModel. */
@@ -4053,10 +4046,6 @@ declare namespace gapi.client {
4053
4046
  /** Optional. GKE deployment configuration in yaml format. */
4054
4047
  gkeYamlConfigs?: string[];
4055
4048
  }
4056
- interface GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex {
4057
- /** Optional. One click deployment configurations. */
4058
- multiDeployVertex?: GoogleCloudAiplatformV1PublisherModelCallToActionDeploy[];
4059
- }
4060
4049
  interface GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines {
4061
4050
  /** Required. Regional resource references to fine tuning pipelines. */
4062
4051
  fineTuningPipelines?: GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences[];
@@ -4177,20 +4166,7 @@ declare namespace gapi.client {
4177
4166
  /** The prediction input. Supports HTTP headers and arbitrary data payload. A DeployedModel may have an upper limit on the number of instances it supports per request. When this limit it is exceeded for an AutoML model, the RawPredict method returns an error. When this limit is exceeded for a custom-trained model, the behavior varies depending on the model. You can specify the schema for each instance in the predict_schemata.instance_schema_uri field when you create a Model. This schema applies when you deploy the `Model` as a `DeployedModel` to an Endpoint and use the `RawPredict` method. */
4178
4167
  httpBody?: GoogleApiHttpBody;
4179
4168
  }
4180
- interface GoogleCloudAiplatformV1RayMetricSpec {
4181
- /** Optional. Flag to disable the Ray metrics collection. */
4182
- disabled?: boolean;
4183
- }
4184
- interface GoogleCloudAiplatformV1RaySpec {
4185
- /** Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. */
4186
- headNodeResourcePoolId?: string;
4187
- /** Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. */
4188
- imageUri?: string;
4189
- /** Optional. Ray metrics configurations. */
4190
- rayMetricSpec?: GoogleCloudAiplatformV1RayMetricSpec;
4191
- /** Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" } */
4192
- resourcePoolImages?: {[P in string]: string};
4193
- }
4169
+ interface GoogleCloudAiplatformV1RaySpec {}
4194
4170
  interface GoogleCloudAiplatformV1ReadFeatureValuesRequest {
4195
4171
  /** Required. ID for a specific entity. For example, for a machine learning model predicting user clicks on a website, an entity ID could be `user_123`. */
4196
4172
  entityId?: string;
@@ -4300,15 +4276,10 @@ declare namespace gapi.client {
4300
4276
  /** Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error */
4301
4277
  minReplicaCount?: string;
4302
4278
  }
4303
- interface GoogleCloudAiplatformV1ResourceRuntime {
4304
- /** Output only. URIs for user to connect to the Cluster. Example: { "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" } */
4305
- accessUris?: {[P in string]: string};
4306
- /** Output only. The resource name of NotebookRuntimeTemplate for the RoV Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if set), and with the same Ray and Python version as the Persistent Cluster. Example: "projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123" */
4307
- notebookRuntimeTemplate?: string;
4308
- }
4279
+ interface GoogleCloudAiplatformV1ResourceRuntime {}
4309
4280
  interface GoogleCloudAiplatformV1ResourceRuntimeSpec {
4310
4281
  /** Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. */
4311
- raySpec?: GoogleCloudAiplatformV1RaySpec;
4282
+ raySpec?: any;
4312
4283
  /** Optional. Configure the use of workload identity on the PersistentResource */
4313
4284
  serviceAccountSpec?: GoogleCloudAiplatformV1ServiceAccountSpec;
4314
4285
  }
@@ -4699,6 +4670,34 @@ declare namespace gapi.client {
4699
4670
  /** Recall (True Positive Rate) for the given confidence threshold. */
4700
4671
  recall?: number;
4701
4672
  }
4673
+ interface GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics {
4674
+ /** Fraction of cases where the autorater agreed with the human raters. */
4675
+ accuracy?: number;
4676
+ /** Percentage of time the autorater decided the baseline model had the better response. */
4677
+ baselineModelWinRate?: number;
4678
+ /** A measurement of agreement between the autorater and human raters that takes the likelihood of random agreement into account. */
4679
+ cohensKappa?: number;
4680
+ /** Harmonic mean of precision and recall. */
4681
+ f1Score?: number;
4682
+ /** Number of examples where the autorater chose the baseline model, but humans preferred the model. */
4683
+ falseNegativeCount?: string;
4684
+ /** Number of examples where the autorater chose the model, but humans preferred the baseline model. */
4685
+ falsePositiveCount?: string;
4686
+ /** Percentage of time humans decided the baseline model had the better response. */
4687
+ humanPreferenceBaselineModelWinRate?: number;
4688
+ /** Percentage of time humans decided the model had the better response. */
4689
+ humanPreferenceModelWinRate?: number;
4690
+ /** Percentage of time the autorater decided the model had the better response. */
4691
+ modelWinRate?: number;
4692
+ /** Fraction of cases where the autorater and humans thought the model had a better response out of all cases where the autorater thought the model had a better response. True positive divided by all positive. */
4693
+ precision?: number;
4694
+ /** Fraction of cases where the autorater and humans thought the model had a better response out of all cases where the humans thought the model had a better response. */
4695
+ recall?: number;
4696
+ /** Number of examples where both the autorater and humans decided that the model had the worse response. */
4697
+ trueNegativeCount?: string;
4698
+ /** Number of examples where both the autorater and humans decided that the model had the better response. */
4699
+ truePositiveCount?: string;
4700
+ }
4702
4701
  interface GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics {
4703
4702
  /** The rate at which the input predicted strings exactly match their references. */
4704
4703
  exactMatch?: number;
@@ -5833,18 +5832,10 @@ declare namespace gapi.client {
5833
5832
  /** The nearest neighbors of the query entity. */
5834
5833
  nearestNeighbors?: GoogleCloudAiplatformV1NearestNeighbors;
5835
5834
  }
5836
- interface GoogleCloudAiplatformV1Segment {
5837
- /** Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. */
5838
- endIndex?: number;
5839
- /** Output only. The index of a Part object within its parent Content object. */
5840
- partIndex?: number;
5841
- /** Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. */
5842
- startIndex?: number;
5843
- }
5844
5835
  interface GoogleCloudAiplatformV1ServiceAccountSpec {
5845
5836
  /** Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). */
5846
5837
  enableCustomServiceAccount?: boolean;
5847
- /** Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers are specified in `ResourceRuntimeSpec`. */
5838
+ /** Optional. Required when all below conditions are met * `enable_custom_service_account` is true; * any runtime is specified via `ResourceRuntimeSpec` on creation time, for example, Ray The users must have `iam.serviceAccounts.actAs` permission on this service account and then the specified runtime containers will run as it. Do not set this field if you want to submit jobs using custom service account to this PersistentResource after creation, but only specify the `service_account` inside the job. */
5848
5839
  serviceAccount?: string;
5849
5840
  }
5850
5841
  interface GoogleCloudAiplatformV1ShieldedVmConfig {
@@ -6099,6 +6090,66 @@ declare namespace gapi.client {
6099
6090
  /** A list of Trials. */
6100
6091
  trials?: GoogleCloudAiplatformV1Trial[];
6101
6092
  }
6093
+ interface GoogleCloudAiplatformV1SupervisedHyperParameters {
6094
+ /** Optional. Adapter size for tuning. */
6095
+ adapterSize?: string;
6096
+ /** Optional. Number of training epoches for this tuning job. */
6097
+ epochCount?: string;
6098
+ /** Optional. Learning rate multiplier for tuning. */
6099
+ learningRateMultiplier?: number;
6100
+ }
6101
+ interface GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution {
6102
+ /** Output only. Defines the histogram bucket. */
6103
+ buckets?: GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket[];
6104
+ /** Output only. The maximum of the population values. */
6105
+ max?: number;
6106
+ /** Output only. The arithmetic mean of the values in the population. */
6107
+ mean?: number;
6108
+ /** Output only. The median of the values in the population. */
6109
+ median?: number;
6110
+ /** Output only. The minimum of the population values. */
6111
+ min?: number;
6112
+ /** Output only. The 5th percentile of the values in the population. */
6113
+ p5?: number;
6114
+ /** Output only. The 95th percentile of the values in the population. */
6115
+ p95?: number;
6116
+ /** Output only. Sum of a given population of values. */
6117
+ sum?: string;
6118
+ }
6119
+ interface GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket {
6120
+ /** Output only. Number of values in the bucket. */
6121
+ count?: number;
6122
+ /** Output only. Left bound of the bucket. */
6123
+ left?: number;
6124
+ /** Output only. Right bound of the bucket. */
6125
+ right?: number;
6126
+ }
6127
+ interface GoogleCloudAiplatformV1SupervisedTuningDataStats {
6128
+ /** Output only. Number of billable characters in the tuning dataset. */
6129
+ totalBillableCharacterCount?: string;
6130
+ /** Output only. Number of tuning characters in the tuning dataset. */
6131
+ totalTuningCharacterCount?: string;
6132
+ /** Output only. Number of examples in the tuning dataset. */
6133
+ tuningDatasetExampleCount?: string;
6134
+ /** Output only. Number of tuning steps for this Tuning Job. */
6135
+ tuningStepCount?: string;
6136
+ /** Output only. Sample user messages in the training dataset uri. */
6137
+ userDatasetExamples?: GoogleCloudAiplatformV1Content[];
6138
+ /** Output only. Dataset distributions for the user input tokens. */
6139
+ userInputTokenDistribution?: GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution;
6140
+ /** Output only. Dataset distributions for the messages per example. */
6141
+ userMessagePerExampleDistribution?: GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution;
6142
+ /** Output only. Dataset distributions for the user output tokens. */
6143
+ userOutputTokenDistribution?: GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution;
6144
+ }
6145
+ interface GoogleCloudAiplatformV1SupervisedTuningSpec {
6146
+ /** Optional. Hyperparameters for SFT. */
6147
+ hyperParameters?: GoogleCloudAiplatformV1SupervisedHyperParameters;
6148
+ /** Required. Cloud Storage path to file containing training dataset for tuning. */
6149
+ trainingDatasetUri?: string;
6150
+ /** Optional. Cloud Storage path to file containing validation dataset for tuning. */
6151
+ validationDatasetUri?: string;
6152
+ }
6102
6153
  interface GoogleCloudAiplatformV1SyncFeatureViewRequest {}
6103
6154
  interface GoogleCloudAiplatformV1SyncFeatureViewResponse {
6104
6155
  /** Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` */
@@ -6285,8 +6336,6 @@ declare namespace gapi.client {
6285
6336
  interface GoogleCloudAiplatformV1Tool {
6286
6337
  /** 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 64 function declarations can be provided. */
6287
6338
  functionDeclarations?: GoogleCloudAiplatformV1FunctionDeclaration[];
6288
- /** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
6289
- googleSearchRetrieval?: GoogleCloudAiplatformV1GoogleSearchRetrieval;
6290
6339
  /** 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. */
6291
6340
  retrieval?: GoogleCloudAiplatformV1Retrieval;
6292
6341
  }
@@ -6368,6 +6417,48 @@ declare namespace gapi.client {
6368
6417
  /** Output only. The value of the parameter. `number_value` will be set if a parameter defined in StudySpec is in type 'INTEGER', 'DOUBLE' or 'DISCRETE'. `string_value` will be set if a parameter defined in StudySpec is in type 'CATEGORICAL'. */
6369
6418
  value?: any;
6370
6419
  }
6420
+ interface GoogleCloudAiplatformV1TunedModel {
6421
+ /** Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`. */
6422
+ endpoint?: string;
6423
+ /** Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}`. */
6424
+ model?: string;
6425
+ }
6426
+ interface GoogleCloudAiplatformV1TuningDataStats {
6427
+ /** The SFT Tuning data stats. */
6428
+ supervisedTuningDataStats?: GoogleCloudAiplatformV1SupervisedTuningDataStats;
6429
+ }
6430
+ interface GoogleCloudAiplatformV1TuningJob {
6431
+ /** Model name for tuning, e.g., "gemini-1.0-pro-002". */
6432
+ baseModel?: string;
6433
+ /** Output only. Time when the TuningJob was created. */
6434
+ createTime?: string;
6435
+ /** Optional. The description of the TuningJob. */
6436
+ description?: string;
6437
+ /** Output only. Time when the TuningJob entered any of the following JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`. */
6438
+ endTime?: string;
6439
+ /** Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. */
6440
+ error?: GoogleRpcStatus;
6441
+ /** Output only. The Experiment associated with this TuningJob. */
6442
+ experiment?: string;
6443
+ /** 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. */
6444
+ labels?: {[P in string]: string};
6445
+ /** Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` */
6446
+ name?: string;
6447
+ /** Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. */
6448
+ startTime?: string;
6449
+ /** Output only. The detailed state of the job. */
6450
+ state?: string;
6451
+ /** Tuning Spec for Supervised Fine Tuning. */
6452
+ supervisedTuningSpec?: GoogleCloudAiplatformV1SupervisedTuningSpec;
6453
+ /** Output only. The tuned model resources assiociated with this TuningJob. */
6454
+ tunedModel?: GoogleCloudAiplatformV1TunedModel;
6455
+ /** Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
6456
+ tunedModelDisplayName?: string;
6457
+ /** Output only. The tuning data statistics associated with this TuningJob. */
6458
+ tuningDataStats?: GoogleCloudAiplatformV1TuningDataStats;
6459
+ /** Output only. Time when the TuningJob was most recently updated. */
6460
+ updateTime?: string;
6461
+ }
6371
6462
  interface GoogleCloudAiplatformV1UndeployIndexOperationMetadata {
6372
6463
  /** The operation generic information. */
6373
6464
  genericMetadata?: GoogleCloudAiplatformV1GenericOperationMetadata;
@@ -6506,7 +6597,7 @@ declare namespace gapi.client {
6506
6597
  stringValue?: string;
6507
6598
  }
6508
6599
  interface GoogleCloudAiplatformV1VertexAISearch {
6509
- /** Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore} */
6600
+ /** Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` */
6510
6601
  datastore?: string;
6511
6602
  }
6512
6603
  interface GoogleCloudAiplatformV1VideoMetadata {
@@ -6870,9 +6961,16 @@ declare namespace gapi.client {
6870
6961
  interface LearningGenaiRootCodeyCompletionMetadata {
6871
6962
  checkpoints?: LearningGenaiRootCodeyCheckpoint[];
6872
6963
  }
6964
+ interface LearningGenaiRootCodeyGenerationMetadata {
6965
+ /** Last state of the sample before getting dropped/returned. */
6966
+ output?: string;
6967
+ /** Last Codey postprocessing step for this sample before getting dropped/returned. */
6968
+ postInferenceStep?: string;
6969
+ }
6873
6970
  interface LearningGenaiRootCodeyOutput {
6874
6971
  codeyChatMetadata?: LearningGenaiRootCodeyChatMetadata;
6875
6972
  codeyCompletionMetadata?: LearningGenaiRootCodeyCompletionMetadata;
6973
+ codeyGenerationMetadata?: LearningGenaiRootCodeyGenerationMetadata;
6876
6974
  }
6877
6975
  interface LearningGenaiRootCodeyTruncatorMetadata {
6878
6976
  /** Index of the current sample that trims off truncated text. */
@@ -6880,6 +6978,28 @@ declare namespace gapi.client {
6880
6978
  /** Text that was truncated at a specific checkpoint. */
6881
6979
  truncatedText?: string;
6882
6980
  }
6981
+ interface LearningGenaiRootControlDecodingConfigThreshold {
6982
+ policy?: string;
6983
+ scoreMax?: number;
6984
+ }
6985
+ interface LearningGenaiRootControlDecodingRecord {
6986
+ /** Prefixes feeded into scorer. */
6987
+ prefixes?: string;
6988
+ /** Per policy scores returned from Scorer. Expect to have the same number of scores as in `thresholds`. */
6989
+ scores?: LearningGenaiRootControlDecodingRecordPolicyScore[];
6990
+ /** Suffixes feeded into scorer. */
6991
+ suffiexes?: string;
6992
+ /** Per policy thresholds from user config. */
6993
+ thresholds?: LearningGenaiRootControlDecodingConfigThreshold[];
6994
+ }
6995
+ interface LearningGenaiRootControlDecodingRecordPolicyScore {
6996
+ policy?: string;
6997
+ score?: number;
6998
+ }
6999
+ interface LearningGenaiRootControlDecodingRecords {
7000
+ /** One ControlDecodingRecord record maps to one rewind. */
7001
+ records?: LearningGenaiRootControlDecodingRecord[];
7002
+ }
6883
7003
  interface LearningGenaiRootDataProviderOutput {
6884
7004
  name?: string;
6885
7005
  /** If set, this DataProvider failed and this is the error message. */
@@ -6909,6 +7029,8 @@ declare namespace gapi.client {
6909
7029
  raiOutput?: LearningGenaiRootRAIOutput;
6910
7030
  raiResult?: CloudAiNlLlmProtoServiceRaiResult;
6911
7031
  raiSignal?: CloudAiNlLlmProtoServiceRaiSignal;
7032
+ /** Number of rewinds by controlled decoding. */
7033
+ records?: LearningGenaiRootControlDecodingRecords;
6912
7034
  streamRecitationResult?: LanguageLabsAidaTrustRecitationProtoStreamRecitationResult;
6913
7035
  takedownResult?: LearningGenaiRootTakedownResult;
6914
7036
  toxicityResult?: LearningGenaiRootToxicityResult;
@@ -6987,6 +7109,12 @@ declare namespace gapi.client {
6987
7109
  status?: UtilStatusProto;
6988
7110
  stringValue?: string;
6989
7111
  }
7112
+ interface LearningGenaiRootPerRequestProcessorDebugMetadataFactualityDebugMetadata {
7113
+ /** Latency spent on fact retrievals. There might be multiple retrievals from different fact providers. */
7114
+ factRetrievalMillisecondsByProvider?: {[P in string]: string};
7115
+ /** Latency spent on prompt2query. The procedure generates a search-friendly query given the original prompt. */
7116
+ prompt2queryMilliseconds?: string;
7117
+ }
6990
7118
  interface LearningGenaiRootRAIOutput {
6991
7119
  allowed?: boolean;
6992
7120
  harm?: LearningGenaiRootHarm;
@@ -7117,6 +7245,12 @@ declare namespace gapi.client {
7117
7245
  label?: string;
7118
7246
  score?: number;
7119
7247
  }
7248
+ interface LearningGenaiRootTranslationRequestInfo {
7249
+ /** The ISO-639 language code of source text in the initial request, detected automatically, if no source language was passed within the initial request. If the source language was passed, auto-detection of the language does not occur and this field is empty. */
7250
+ detectedLanguageCodes?: string[];
7251
+ /** The sum of the size of all the contents in the request. */
7252
+ totalContentSize?: string;
7253
+ }
7120
7254
  interface LearningServingLlmMessageMetadata {
7121
7255
  /** Summary of classifier output. We attach this to all messages regardless of whether classification rules triggered or not. */
7122
7256
  classifierSummary?: LearningGenaiRootClassifierOutputSummary;
@@ -26304,6 +26438,182 @@ declare namespace gapi.client {
26304
26438
  }): Request<GoogleLongrunningListOperationsResponse>;
26305
26439
  }
26306
26440
  interface TuningJobsResource {
26441
+ /** Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`. */
26442
+ cancel(request: {
26443
+ /** V1 error format. */
26444
+ '$.xgafv'?: string;
26445
+ /** OAuth access token. */
26446
+ access_token?: string;
26447
+ /** Data format for response. */
26448
+ alt?: string;
26449
+ /** JSONP */
26450
+ callback?: string;
26451
+ /** Selector specifying which fields to include in a partial response. */
26452
+ fields?: string;
26453
+ /** 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. */
26454
+ key?: string;
26455
+ /** Required. The name of the TuningJob to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` */
26456
+ name: string;
26457
+ /** OAuth 2.0 token for the current user. */
26458
+ oauth_token?: string;
26459
+ /** Returns response with indentations and line breaks. */
26460
+ prettyPrint?: boolean;
26461
+ /** 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. */
26462
+ quotaUser?: string;
26463
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
26464
+ upload_protocol?: string;
26465
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
26466
+ uploadType?: string;
26467
+ /** Request body */
26468
+ resource: GoogleCloudAiplatformV1CancelTuningJobRequest;
26469
+ }): Request<{}>;
26470
+ cancel(
26471
+ request: {
26472
+ /** V1 error format. */
26473
+ '$.xgafv'?: string;
26474
+ /** OAuth access token. */
26475
+ access_token?: string;
26476
+ /** Data format for response. */
26477
+ alt?: string;
26478
+ /** JSONP */
26479
+ callback?: string;
26480
+ /** Selector specifying which fields to include in a partial response. */
26481
+ fields?: string;
26482
+ /** 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. */
26483
+ key?: string;
26484
+ /** Required. The name of the TuningJob to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` */
26485
+ name: string;
26486
+ /** OAuth 2.0 token for the current user. */
26487
+ oauth_token?: string;
26488
+ /** Returns response with indentations and line breaks. */
26489
+ prettyPrint?: boolean;
26490
+ /** 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. */
26491
+ quotaUser?: string;
26492
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
26493
+ upload_protocol?: string;
26494
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
26495
+ uploadType?: string;
26496
+ },
26497
+ body: GoogleCloudAiplatformV1CancelTuningJobRequest
26498
+ ): Request<{}>;
26499
+ /** Creates a TuningJob. A created TuningJob right away will be attempted to be run. */
26500
+ create(request: {
26501
+ /** V1 error format. */
26502
+ '$.xgafv'?: string;
26503
+ /** OAuth access token. */
26504
+ access_token?: string;
26505
+ /** Data format for response. */
26506
+ alt?: string;
26507
+ /** JSONP */
26508
+ callback?: string;
26509
+ /** Selector specifying which fields to include in a partial response. */
26510
+ fields?: string;
26511
+ /** 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. */
26512
+ key?: string;
26513
+ /** OAuth 2.0 token for the current user. */
26514
+ oauth_token?: string;
26515
+ /** Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project}/locations/{location}` */
26516
+ parent: string;
26517
+ /** Returns response with indentations and line breaks. */
26518
+ prettyPrint?: boolean;
26519
+ /** 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. */
26520
+ quotaUser?: string;
26521
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
26522
+ upload_protocol?: string;
26523
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
26524
+ uploadType?: string;
26525
+ /** Request body */
26526
+ resource: GoogleCloudAiplatformV1TuningJob;
26527
+ }): Request<GoogleCloudAiplatformV1TuningJob>;
26528
+ create(
26529
+ request: {
26530
+ /** V1 error format. */
26531
+ '$.xgafv'?: string;
26532
+ /** OAuth access token. */
26533
+ access_token?: string;
26534
+ /** Data format for response. */
26535
+ alt?: string;
26536
+ /** JSONP */
26537
+ callback?: string;
26538
+ /** Selector specifying which fields to include in a partial response. */
26539
+ fields?: string;
26540
+ /** 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. */
26541
+ key?: string;
26542
+ /** OAuth 2.0 token for the current user. */
26543
+ oauth_token?: string;
26544
+ /** Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project}/locations/{location}` */
26545
+ parent: string;
26546
+ /** Returns response with indentations and line breaks. */
26547
+ prettyPrint?: boolean;
26548
+ /** 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. */
26549
+ quotaUser?: string;
26550
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
26551
+ upload_protocol?: string;
26552
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
26553
+ uploadType?: string;
26554
+ },
26555
+ body: GoogleCloudAiplatformV1TuningJob
26556
+ ): Request<GoogleCloudAiplatformV1TuningJob>;
26557
+ /** Gets a TuningJob. */
26558
+ get(request?: {
26559
+ /** V1 error format. */
26560
+ '$.xgafv'?: string;
26561
+ /** OAuth access token. */
26562
+ access_token?: string;
26563
+ /** Data format for response. */
26564
+ alt?: string;
26565
+ /** JSONP */
26566
+ callback?: string;
26567
+ /** Selector specifying which fields to include in a partial response. */
26568
+ fields?: string;
26569
+ /** 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. */
26570
+ key?: string;
26571
+ /** Required. The name of the TuningJob resource. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` */
26572
+ name: string;
26573
+ /** OAuth 2.0 token for the current user. */
26574
+ oauth_token?: string;
26575
+ /** Returns response with indentations and line breaks. */
26576
+ prettyPrint?: boolean;
26577
+ /** 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. */
26578
+ quotaUser?: string;
26579
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
26580
+ upload_protocol?: string;
26581
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
26582
+ uploadType?: string;
26583
+ }): Request<GoogleCloudAiplatformV1TuningJob>;
26584
+ /** Lists TuningJobs in a Location. */
26585
+ list(request?: {
26586
+ /** V1 error format. */
26587
+ '$.xgafv'?: string;
26588
+ /** OAuth access token. */
26589
+ access_token?: string;
26590
+ /** Data format for response. */
26591
+ alt?: string;
26592
+ /** JSONP */
26593
+ callback?: string;
26594
+ /** Selector specifying which fields to include in a partial response. */
26595
+ fields?: string;
26596
+ /** Optional. The standard list filter. */
26597
+ filter?: string;
26598
+ /** 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. */
26599
+ key?: string;
26600
+ /** OAuth 2.0 token for the current user. */
26601
+ oauth_token?: string;
26602
+ /** Optional. The standard list page size. */
26603
+ pageSize?: number;
26604
+ /** Optional. The standard list page token. Typically obtained via ListTuningJob.next_page_token of the previous GenAiTuningService.ListTuningJob][] call. */
26605
+ pageToken?: string;
26606
+ /** Required. The resource name of the Location to list the TuningJobs from. Format: `projects/{project}/locations/{location}` */
26607
+ parent: string;
26608
+ /** Returns response with indentations and line breaks. */
26609
+ prettyPrint?: boolean;
26610
+ /** 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. */
26611
+ quotaUser?: string;
26612
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
26613
+ upload_protocol?: string;
26614
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
26615
+ uploadType?: string;
26616
+ }): Request<GoogleCloudAiplatformV1ListTuningJobsResponse>;
26307
26617
  operations: OperationsResource;
26308
26618
  }
26309
26619
  interface LocationsResource {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.aiplatform-v1",
3
- "version": "0.0.20240328",
3
+ "version": "0.0.20240417",
4
4
  "description": "TypeScript typings for Vertex AI API v1",
5
5
  "repository": {
6
6
  "type": "git",