@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20240328 → 0.0.20240404
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +337 -32
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://aiplatform.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240404
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -198,6 +198,8 @@ declare namespace gapi.client {
|
|
|
198
198
|
usageMetadata?: CloudAiNlLlmProtoServiceUsageMetadata;
|
|
199
199
|
}
|
|
200
200
|
interface CloudAiNlLlmProtoServiceMessageMetadata {
|
|
201
|
+
/** Factuality-related debug metadata. */
|
|
202
|
+
factualityDebugMetadata?: LearningGenaiRootPerRequestProcessorDebugMetadataFactualityDebugMetadata;
|
|
201
203
|
/** Filter metadata of the input messages. */
|
|
202
204
|
inputFilterInfo?: LearningServingLlmMessageMetadata;
|
|
203
205
|
/** This score is generated by the router model to decide which model to use */
|
|
@@ -274,6 +276,8 @@ declare namespace gapi.client {
|
|
|
274
276
|
languageFilterResult?: LearningGenaiRootLanguageFilterResult;
|
|
275
277
|
/** The RAI signals for the text. */
|
|
276
278
|
raiSignals?: CloudAiNlLlmProtoServiceRaiSignal[];
|
|
279
|
+
/** Translation request info during RAI for debugging purpose. Each TranslationRequestInfo corresponds to a request sent to the translation server. */
|
|
280
|
+
translationRequestInfos?: LearningGenaiRootTranslationRequestInfo[];
|
|
277
281
|
/** Whether the text triggered the blocklist. */
|
|
278
282
|
triggeredBlocklist?: boolean;
|
|
279
283
|
/** Whether the text should be blocked by the recitation result from Aida recitation checker. It is determined from aida_recitation_result. */
|
|
@@ -715,6 +719,7 @@ declare namespace gapi.client {
|
|
|
715
719
|
interface GoogleCloudAiplatformV1CancelNasJobRequest {}
|
|
716
720
|
interface GoogleCloudAiplatformV1CancelPipelineJobRequest {}
|
|
717
721
|
interface GoogleCloudAiplatformV1CancelTrainingPipelineRequest {}
|
|
722
|
+
interface GoogleCloudAiplatformV1CancelTuningJobRequest {}
|
|
718
723
|
interface GoogleCloudAiplatformV1Candidate {
|
|
719
724
|
/** Output only. Source attribution of the generated content. */
|
|
720
725
|
citationMetadata?: GoogleCloudAiplatformV1CitationMetadata;
|
|
@@ -2252,6 +2257,8 @@ declare namespace gapi.client {
|
|
|
2252
2257
|
maxOutputTokens?: number;
|
|
2253
2258
|
/** Optional. Positive penalties. */
|
|
2254
2259
|
presencePenalty?: number;
|
|
2260
|
+
/** 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. */
|
|
2261
|
+
responseMimeType?: string;
|
|
2255
2262
|
/** Optional. Stop sequences. */
|
|
2256
2263
|
stopSequences?: string[];
|
|
2257
2264
|
/** Optional. Controls the randomness of predictions. */
|
|
@@ -2294,8 +2301,6 @@ declare namespace gapi.client {
|
|
|
2294
2301
|
interface GoogleCloudAiplatformV1GroundingMetadata {
|
|
2295
2302
|
/** Optional. List of grounding attributions. */
|
|
2296
2303
|
groundingAttributions?: GoogleCloudAiplatformV1GroundingAttribution[];
|
|
2297
|
-
/** Optional. Queries executed by the retrieval tools. */
|
|
2298
|
-
retrievalQueries?: string[];
|
|
2299
2304
|
/** Optional. Web search queries for the following-up web search. */
|
|
2300
2305
|
webSearchQueries?: string[];
|
|
2301
2306
|
}
|
|
@@ -2843,6 +2848,12 @@ declare namespace gapi.client {
|
|
|
2843
2848
|
/** The Trials associated with the Study. */
|
|
2844
2849
|
trials?: GoogleCloudAiplatformV1Trial[];
|
|
2845
2850
|
}
|
|
2851
|
+
interface GoogleCloudAiplatformV1ListTuningJobsResponse {
|
|
2852
|
+
/** A token to retrieve the next page of results. Pass to ListTuningJobsRequest.page_token to obtain that page. */
|
|
2853
|
+
nextPageToken?: string;
|
|
2854
|
+
/** List of TuningJobs in the requested page. */
|
|
2855
|
+
tuningJobs?: GoogleCloudAiplatformV1TuningJob[];
|
|
2856
|
+
}
|
|
2846
2857
|
interface GoogleCloudAiplatformV1LookupStudyRequest {
|
|
2847
2858
|
/** Required. The user-defined display name of the Study */
|
|
2848
2859
|
displayName?: string;
|
|
@@ -3747,7 +3758,7 @@ declare namespace gapi.client {
|
|
|
3747
3758
|
/** Required. The spec of the pools of different resources. */
|
|
3748
3759
|
resourcePools?: GoogleCloudAiplatformV1ResourcePool[];
|
|
3749
3760
|
/** Output only. Runtime information of the Persistent Resource. */
|
|
3750
|
-
resourceRuntime?:
|
|
3761
|
+
resourceRuntime?: any;
|
|
3751
3762
|
/** Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration. */
|
|
3752
3763
|
resourceRuntimeSpec?: GoogleCloudAiplatformV1ResourceRuntimeSpec;
|
|
3753
3764
|
/** Output only. Time when the PersistentResource for the first time entered the `RUNNING` state. */
|
|
@@ -4006,8 +4017,6 @@ declare namespace gapi.client {
|
|
|
4006
4017
|
deploy?: GoogleCloudAiplatformV1PublisherModelCallToActionDeploy;
|
|
4007
4018
|
/** Optional. Deploy PublisherModel to Google Kubernetes Engine. */
|
|
4008
4019
|
deployGke?: GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke;
|
|
4009
|
-
/** Optional. Multiple setups to deploy the PublisherModel to Vertex Endpoint. */
|
|
4010
|
-
multiDeployVertex?: GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex;
|
|
4011
4020
|
/** Optional. Open evaluation pipeline of the PublisherModel. */
|
|
4012
4021
|
openEvaluationPipeline?: GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences;
|
|
4013
4022
|
/** Optional. Open fine-tuning pipeline of the PublisherModel. */
|
|
@@ -4053,10 +4062,6 @@ declare namespace gapi.client {
|
|
|
4053
4062
|
/** Optional. GKE deployment configuration in yaml format. */
|
|
4054
4063
|
gkeYamlConfigs?: string[];
|
|
4055
4064
|
}
|
|
4056
|
-
interface GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex {
|
|
4057
|
-
/** Optional. One click deployment configurations. */
|
|
4058
|
-
multiDeployVertex?: GoogleCloudAiplatformV1PublisherModelCallToActionDeploy[];
|
|
4059
|
-
}
|
|
4060
4065
|
interface GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines {
|
|
4061
4066
|
/** Required. Regional resource references to fine tuning pipelines. */
|
|
4062
4067
|
fineTuningPipelines?: GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences[];
|
|
@@ -4177,20 +4182,7 @@ declare namespace gapi.client {
|
|
|
4177
4182
|
/** 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
4183
|
httpBody?: GoogleApiHttpBody;
|
|
4179
4184
|
}
|
|
4180
|
-
interface
|
|
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
|
-
}
|
|
4185
|
+
interface GoogleCloudAiplatformV1RaySpec {}
|
|
4194
4186
|
interface GoogleCloudAiplatformV1ReadFeatureValuesRequest {
|
|
4195
4187
|
/** 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
4188
|
entityId?: string;
|
|
@@ -4300,15 +4292,10 @@ declare namespace gapi.client {
|
|
|
4300
4292
|
/** Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error */
|
|
4301
4293
|
minReplicaCount?: string;
|
|
4302
4294
|
}
|
|
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
|
-
}
|
|
4295
|
+
interface GoogleCloudAiplatformV1ResourceRuntime {}
|
|
4309
4296
|
interface GoogleCloudAiplatformV1ResourceRuntimeSpec {
|
|
4310
4297
|
/** Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. */
|
|
4311
|
-
raySpec?:
|
|
4298
|
+
raySpec?: any;
|
|
4312
4299
|
/** Optional. Configure the use of workload identity on the PersistentResource */
|
|
4313
4300
|
serviceAccountSpec?: GoogleCloudAiplatformV1ServiceAccountSpec;
|
|
4314
4301
|
}
|
|
@@ -4699,6 +4686,34 @@ declare namespace gapi.client {
|
|
|
4699
4686
|
/** Recall (True Positive Rate) for the given confidence threshold. */
|
|
4700
4687
|
recall?: number;
|
|
4701
4688
|
}
|
|
4689
|
+
interface GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics {
|
|
4690
|
+
/** Fraction of cases where the autorater agreed with the human raters. */
|
|
4691
|
+
accuracy?: number;
|
|
4692
|
+
/** Percentage of time the autorater decided the baseline model had the better response. */
|
|
4693
|
+
baselineModelWinRate?: number;
|
|
4694
|
+
/** A measurement of agreement between the autorater and human raters that takes the likelihood of random agreement into account. */
|
|
4695
|
+
cohensKappa?: number;
|
|
4696
|
+
/** Harmonic mean of precision and recall. */
|
|
4697
|
+
f1Score?: number;
|
|
4698
|
+
/** Number of examples where the autorater chose the baseline model, but humans preferred the model. */
|
|
4699
|
+
falseNegativeCount?: string;
|
|
4700
|
+
/** Number of examples where the autorater chose the model, but humans preferred the baseline model. */
|
|
4701
|
+
falsePositiveCount?: string;
|
|
4702
|
+
/** Percentage of time humans decided the baseline model had the better response. */
|
|
4703
|
+
humanPreferenceBaselineModelWinRate?: number;
|
|
4704
|
+
/** Percentage of time humans decided the model had the better response. */
|
|
4705
|
+
humanPreferenceModelWinRate?: number;
|
|
4706
|
+
/** Percentage of time the autorater decided the model had the better response. */
|
|
4707
|
+
modelWinRate?: number;
|
|
4708
|
+
/** 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. */
|
|
4709
|
+
precision?: number;
|
|
4710
|
+
/** 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. */
|
|
4711
|
+
recall?: number;
|
|
4712
|
+
/** Number of examples where both the autorater and humans decided that the model had the worse response. */
|
|
4713
|
+
trueNegativeCount?: string;
|
|
4714
|
+
/** Number of examples where both the autorater and humans decided that the model had the better response. */
|
|
4715
|
+
truePositiveCount?: string;
|
|
4716
|
+
}
|
|
4702
4717
|
interface GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics {
|
|
4703
4718
|
/** The rate at which the input predicted strings exactly match their references. */
|
|
4704
4719
|
exactMatch?: number;
|
|
@@ -5844,7 +5859,7 @@ declare namespace gapi.client {
|
|
|
5844
5859
|
interface GoogleCloudAiplatformV1ServiceAccountSpec {
|
|
5845
5860
|
/** 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
5861
|
enableCustomServiceAccount?: boolean;
|
|
5847
|
-
/** Optional.
|
|
5862
|
+
/** 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
5863
|
serviceAccount?: string;
|
|
5849
5864
|
}
|
|
5850
5865
|
interface GoogleCloudAiplatformV1ShieldedVmConfig {
|
|
@@ -6099,6 +6114,66 @@ declare namespace gapi.client {
|
|
|
6099
6114
|
/** A list of Trials. */
|
|
6100
6115
|
trials?: GoogleCloudAiplatformV1Trial[];
|
|
6101
6116
|
}
|
|
6117
|
+
interface GoogleCloudAiplatformV1SupervisedHyperParameters {
|
|
6118
|
+
/** Optional. Adapter size for tuning. */
|
|
6119
|
+
adapterSize?: string;
|
|
6120
|
+
/** Optional. Number of training epoches for this tuning job. */
|
|
6121
|
+
epochCount?: string;
|
|
6122
|
+
/** Optional. Learning rate multiplier for tuning. */
|
|
6123
|
+
learningRateMultiplier?: number;
|
|
6124
|
+
}
|
|
6125
|
+
interface GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution {
|
|
6126
|
+
/** Output only. Defines the histogram bucket. */
|
|
6127
|
+
buckets?: GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket[];
|
|
6128
|
+
/** Output only. The maximum of the population values. */
|
|
6129
|
+
max?: number;
|
|
6130
|
+
/** Output only. The arithmetic mean of the values in the population. */
|
|
6131
|
+
mean?: number;
|
|
6132
|
+
/** Output only. The median of the values in the population. */
|
|
6133
|
+
median?: number;
|
|
6134
|
+
/** Output only. The minimum of the population values. */
|
|
6135
|
+
min?: number;
|
|
6136
|
+
/** Output only. The 5th percentile of the values in the population. */
|
|
6137
|
+
p5?: number;
|
|
6138
|
+
/** Output only. The 95th percentile of the values in the population. */
|
|
6139
|
+
p95?: number;
|
|
6140
|
+
/** Output only. Sum of a given population of values. */
|
|
6141
|
+
sum?: string;
|
|
6142
|
+
}
|
|
6143
|
+
interface GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket {
|
|
6144
|
+
/** Output only. Number of values in the bucket. */
|
|
6145
|
+
count?: number;
|
|
6146
|
+
/** Output only. Left bound of the bucket. */
|
|
6147
|
+
left?: number;
|
|
6148
|
+
/** Output only. Right bound of the bucket. */
|
|
6149
|
+
right?: number;
|
|
6150
|
+
}
|
|
6151
|
+
interface GoogleCloudAiplatformV1SupervisedTuningDataStats {
|
|
6152
|
+
/** Output only. Number of billable characters in the tuning dataset. */
|
|
6153
|
+
totalBillableCharacterCount?: string;
|
|
6154
|
+
/** Output only. Number of tuning characters in the tuning dataset. */
|
|
6155
|
+
totalTuningCharacterCount?: string;
|
|
6156
|
+
/** Output only. Number of examples in the tuning dataset. */
|
|
6157
|
+
tuningDatasetExampleCount?: string;
|
|
6158
|
+
/** Output only. Number of tuning steps for this Tuning Job. */
|
|
6159
|
+
tuningStepCount?: string;
|
|
6160
|
+
/** Output only. Sample user messages in the training dataset uri. */
|
|
6161
|
+
userDatasetExamples?: GoogleCloudAiplatformV1Content[];
|
|
6162
|
+
/** Output only. Dataset distributions for the user input tokens. */
|
|
6163
|
+
userInputTokenDistribution?: GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution;
|
|
6164
|
+
/** Output only. Dataset distributions for the messages per example. */
|
|
6165
|
+
userMessagePerExampleDistribution?: GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution;
|
|
6166
|
+
/** Output only. Dataset distributions for the user output tokens. */
|
|
6167
|
+
userOutputTokenDistribution?: GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution;
|
|
6168
|
+
}
|
|
6169
|
+
interface GoogleCloudAiplatformV1SupervisedTuningSpec {
|
|
6170
|
+
/** Optional. Hyperparameters for SFT. */
|
|
6171
|
+
hyperParameters?: GoogleCloudAiplatformV1SupervisedHyperParameters;
|
|
6172
|
+
/** Required. Cloud Storage path to file containing training dataset for tuning. */
|
|
6173
|
+
trainingDatasetUri?: string;
|
|
6174
|
+
/** Optional. Cloud Storage path to file containing validation dataset for tuning. */
|
|
6175
|
+
validationDatasetUri?: string;
|
|
6176
|
+
}
|
|
6102
6177
|
interface GoogleCloudAiplatformV1SyncFeatureViewRequest {}
|
|
6103
6178
|
interface GoogleCloudAiplatformV1SyncFeatureViewResponse {
|
|
6104
6179
|
/** Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}` */
|
|
@@ -6368,6 +6443,48 @@ declare namespace gapi.client {
|
|
|
6368
6443
|
/** 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
6444
|
value?: any;
|
|
6370
6445
|
}
|
|
6446
|
+
interface GoogleCloudAiplatformV1TunedModel {
|
|
6447
|
+
/** Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`. */
|
|
6448
|
+
endpoint?: string;
|
|
6449
|
+
/** Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}`. */
|
|
6450
|
+
model?: string;
|
|
6451
|
+
}
|
|
6452
|
+
interface GoogleCloudAiplatformV1TuningDataStats {
|
|
6453
|
+
/** The SFT Tuning data stats. */
|
|
6454
|
+
supervisedTuningDataStats?: GoogleCloudAiplatformV1SupervisedTuningDataStats;
|
|
6455
|
+
}
|
|
6456
|
+
interface GoogleCloudAiplatformV1TuningJob {
|
|
6457
|
+
/** Model name for tuning, e.g., "gemini-1.0-pro-002". */
|
|
6458
|
+
baseModel?: string;
|
|
6459
|
+
/** Output only. Time when the TuningJob was created. */
|
|
6460
|
+
createTime?: string;
|
|
6461
|
+
/** Optional. The description of the TuningJob. */
|
|
6462
|
+
description?: string;
|
|
6463
|
+
/** Output only. Time when the TuningJob entered any of the following JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`. */
|
|
6464
|
+
endTime?: string;
|
|
6465
|
+
/** Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. */
|
|
6466
|
+
error?: GoogleRpcStatus;
|
|
6467
|
+
/** Output only. The Experiment associated with this TuningJob. */
|
|
6468
|
+
experiment?: string;
|
|
6469
|
+
/** 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. */
|
|
6470
|
+
labels?: {[P in string]: string};
|
|
6471
|
+
/** Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` */
|
|
6472
|
+
name?: string;
|
|
6473
|
+
/** Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. */
|
|
6474
|
+
startTime?: string;
|
|
6475
|
+
/** Output only. The detailed state of the job. */
|
|
6476
|
+
state?: string;
|
|
6477
|
+
/** Tuning Spec for Supervised Fine Tuning. */
|
|
6478
|
+
supervisedTuningSpec?: GoogleCloudAiplatformV1SupervisedTuningSpec;
|
|
6479
|
+
/** Output only. The tuned model resources assiociated with this TuningJob. */
|
|
6480
|
+
tunedModel?: GoogleCloudAiplatformV1TunedModel;
|
|
6481
|
+
/** Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
|
|
6482
|
+
tunedModelDisplayName?: string;
|
|
6483
|
+
/** Output only. The tuning data statistics associated with this TuningJob. */
|
|
6484
|
+
tuningDataStats?: GoogleCloudAiplatformV1TuningDataStats;
|
|
6485
|
+
/** Output only. Time when the TuningJob was most recently updated. */
|
|
6486
|
+
updateTime?: string;
|
|
6487
|
+
}
|
|
6371
6488
|
interface GoogleCloudAiplatformV1UndeployIndexOperationMetadata {
|
|
6372
6489
|
/** The operation generic information. */
|
|
6373
6490
|
genericMetadata?: GoogleCloudAiplatformV1GenericOperationMetadata;
|
|
@@ -6987,6 +7104,12 @@ declare namespace gapi.client {
|
|
|
6987
7104
|
status?: UtilStatusProto;
|
|
6988
7105
|
stringValue?: string;
|
|
6989
7106
|
}
|
|
7107
|
+
interface LearningGenaiRootPerRequestProcessorDebugMetadataFactualityDebugMetadata {
|
|
7108
|
+
/** Latency spent on fact retrievals. There might be multiple retrievals from different fact providers. */
|
|
7109
|
+
factRetrievalMillisecondsByProvider?: {[P in string]: string};
|
|
7110
|
+
/** Latency spent on prompt2query. The procedure generates a search-friendly query given the original prompt. */
|
|
7111
|
+
prompt2queryMilliseconds?: string;
|
|
7112
|
+
}
|
|
6990
7113
|
interface LearningGenaiRootRAIOutput {
|
|
6991
7114
|
allowed?: boolean;
|
|
6992
7115
|
harm?: LearningGenaiRootHarm;
|
|
@@ -7117,6 +7240,12 @@ declare namespace gapi.client {
|
|
|
7117
7240
|
label?: string;
|
|
7118
7241
|
score?: number;
|
|
7119
7242
|
}
|
|
7243
|
+
interface LearningGenaiRootTranslationRequestInfo {
|
|
7244
|
+
/** 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. */
|
|
7245
|
+
detectedLanguageCodes?: string[];
|
|
7246
|
+
/** The sum of the size of all the contents in the request. */
|
|
7247
|
+
totalContentSize?: string;
|
|
7248
|
+
}
|
|
7120
7249
|
interface LearningServingLlmMessageMetadata {
|
|
7121
7250
|
/** Summary of classifier output. We attach this to all messages regardless of whether classification rules triggered or not. */
|
|
7122
7251
|
classifierSummary?: LearningGenaiRootClassifierOutputSummary;
|
|
@@ -26304,6 +26433,182 @@ declare namespace gapi.client {
|
|
|
26304
26433
|
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
26305
26434
|
}
|
|
26306
26435
|
interface TuningJobsResource {
|
|
26436
|
+
/** 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`. */
|
|
26437
|
+
cancel(request: {
|
|
26438
|
+
/** V1 error format. */
|
|
26439
|
+
'$.xgafv'?: string;
|
|
26440
|
+
/** OAuth access token. */
|
|
26441
|
+
access_token?: string;
|
|
26442
|
+
/** Data format for response. */
|
|
26443
|
+
alt?: string;
|
|
26444
|
+
/** JSONP */
|
|
26445
|
+
callback?: string;
|
|
26446
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
26447
|
+
fields?: string;
|
|
26448
|
+
/** 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. */
|
|
26449
|
+
key?: string;
|
|
26450
|
+
/** Required. The name of the TuningJob to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` */
|
|
26451
|
+
name: string;
|
|
26452
|
+
/** OAuth 2.0 token for the current user. */
|
|
26453
|
+
oauth_token?: string;
|
|
26454
|
+
/** Returns response with indentations and line breaks. */
|
|
26455
|
+
prettyPrint?: boolean;
|
|
26456
|
+
/** 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. */
|
|
26457
|
+
quotaUser?: string;
|
|
26458
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
26459
|
+
upload_protocol?: string;
|
|
26460
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
26461
|
+
uploadType?: string;
|
|
26462
|
+
/** Request body */
|
|
26463
|
+
resource: GoogleCloudAiplatformV1CancelTuningJobRequest;
|
|
26464
|
+
}): Request<{}>;
|
|
26465
|
+
cancel(
|
|
26466
|
+
request: {
|
|
26467
|
+
/** V1 error format. */
|
|
26468
|
+
'$.xgafv'?: string;
|
|
26469
|
+
/** OAuth access token. */
|
|
26470
|
+
access_token?: string;
|
|
26471
|
+
/** Data format for response. */
|
|
26472
|
+
alt?: string;
|
|
26473
|
+
/** JSONP */
|
|
26474
|
+
callback?: string;
|
|
26475
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
26476
|
+
fields?: string;
|
|
26477
|
+
/** 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. */
|
|
26478
|
+
key?: string;
|
|
26479
|
+
/** Required. The name of the TuningJob to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` */
|
|
26480
|
+
name: string;
|
|
26481
|
+
/** OAuth 2.0 token for the current user. */
|
|
26482
|
+
oauth_token?: string;
|
|
26483
|
+
/** Returns response with indentations and line breaks. */
|
|
26484
|
+
prettyPrint?: boolean;
|
|
26485
|
+
/** 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. */
|
|
26486
|
+
quotaUser?: string;
|
|
26487
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
26488
|
+
upload_protocol?: string;
|
|
26489
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
26490
|
+
uploadType?: string;
|
|
26491
|
+
},
|
|
26492
|
+
body: GoogleCloudAiplatformV1CancelTuningJobRequest
|
|
26493
|
+
): Request<{}>;
|
|
26494
|
+
/** Creates a TuningJob. A created TuningJob right away will be attempted to be run. */
|
|
26495
|
+
create(request: {
|
|
26496
|
+
/** V1 error format. */
|
|
26497
|
+
'$.xgafv'?: string;
|
|
26498
|
+
/** OAuth access token. */
|
|
26499
|
+
access_token?: string;
|
|
26500
|
+
/** Data format for response. */
|
|
26501
|
+
alt?: string;
|
|
26502
|
+
/** JSONP */
|
|
26503
|
+
callback?: string;
|
|
26504
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
26505
|
+
fields?: string;
|
|
26506
|
+
/** 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. */
|
|
26507
|
+
key?: string;
|
|
26508
|
+
/** OAuth 2.0 token for the current user. */
|
|
26509
|
+
oauth_token?: string;
|
|
26510
|
+
/** Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project}/locations/{location}` */
|
|
26511
|
+
parent: string;
|
|
26512
|
+
/** Returns response with indentations and line breaks. */
|
|
26513
|
+
prettyPrint?: boolean;
|
|
26514
|
+
/** 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. */
|
|
26515
|
+
quotaUser?: string;
|
|
26516
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
26517
|
+
upload_protocol?: string;
|
|
26518
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
26519
|
+
uploadType?: string;
|
|
26520
|
+
/** Request body */
|
|
26521
|
+
resource: GoogleCloudAiplatformV1TuningJob;
|
|
26522
|
+
}): Request<GoogleCloudAiplatformV1TuningJob>;
|
|
26523
|
+
create(
|
|
26524
|
+
request: {
|
|
26525
|
+
/** V1 error format. */
|
|
26526
|
+
'$.xgafv'?: string;
|
|
26527
|
+
/** OAuth access token. */
|
|
26528
|
+
access_token?: string;
|
|
26529
|
+
/** Data format for response. */
|
|
26530
|
+
alt?: string;
|
|
26531
|
+
/** JSONP */
|
|
26532
|
+
callback?: string;
|
|
26533
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
26534
|
+
fields?: string;
|
|
26535
|
+
/** 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. */
|
|
26536
|
+
key?: string;
|
|
26537
|
+
/** OAuth 2.0 token for the current user. */
|
|
26538
|
+
oauth_token?: string;
|
|
26539
|
+
/** Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project}/locations/{location}` */
|
|
26540
|
+
parent: string;
|
|
26541
|
+
/** Returns response with indentations and line breaks. */
|
|
26542
|
+
prettyPrint?: boolean;
|
|
26543
|
+
/** 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. */
|
|
26544
|
+
quotaUser?: string;
|
|
26545
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
26546
|
+
upload_protocol?: string;
|
|
26547
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
26548
|
+
uploadType?: string;
|
|
26549
|
+
},
|
|
26550
|
+
body: GoogleCloudAiplatformV1TuningJob
|
|
26551
|
+
): Request<GoogleCloudAiplatformV1TuningJob>;
|
|
26552
|
+
/** Gets a TuningJob. */
|
|
26553
|
+
get(request?: {
|
|
26554
|
+
/** V1 error format. */
|
|
26555
|
+
'$.xgafv'?: string;
|
|
26556
|
+
/** OAuth access token. */
|
|
26557
|
+
access_token?: string;
|
|
26558
|
+
/** Data format for response. */
|
|
26559
|
+
alt?: string;
|
|
26560
|
+
/** JSONP */
|
|
26561
|
+
callback?: string;
|
|
26562
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
26563
|
+
fields?: string;
|
|
26564
|
+
/** 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. */
|
|
26565
|
+
key?: string;
|
|
26566
|
+
/** Required. The name of the TuningJob resource. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` */
|
|
26567
|
+
name: string;
|
|
26568
|
+
/** OAuth 2.0 token for the current user. */
|
|
26569
|
+
oauth_token?: string;
|
|
26570
|
+
/** Returns response with indentations and line breaks. */
|
|
26571
|
+
prettyPrint?: boolean;
|
|
26572
|
+
/** 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. */
|
|
26573
|
+
quotaUser?: string;
|
|
26574
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
26575
|
+
upload_protocol?: string;
|
|
26576
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
26577
|
+
uploadType?: string;
|
|
26578
|
+
}): Request<GoogleCloudAiplatformV1TuningJob>;
|
|
26579
|
+
/** Lists TuningJobs in a Location. */
|
|
26580
|
+
list(request?: {
|
|
26581
|
+
/** V1 error format. */
|
|
26582
|
+
'$.xgafv'?: string;
|
|
26583
|
+
/** OAuth access token. */
|
|
26584
|
+
access_token?: string;
|
|
26585
|
+
/** Data format for response. */
|
|
26586
|
+
alt?: string;
|
|
26587
|
+
/** JSONP */
|
|
26588
|
+
callback?: string;
|
|
26589
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
26590
|
+
fields?: string;
|
|
26591
|
+
/** Optional. The standard list filter. */
|
|
26592
|
+
filter?: string;
|
|
26593
|
+
/** 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. */
|
|
26594
|
+
key?: string;
|
|
26595
|
+
/** OAuth 2.0 token for the current user. */
|
|
26596
|
+
oauth_token?: string;
|
|
26597
|
+
/** Optional. The standard list page size. */
|
|
26598
|
+
pageSize?: number;
|
|
26599
|
+
/** Optional. The standard list page token. Typically obtained via ListTuningJob.next_page_token of the previous GenAiTuningService.ListTuningJob][] call. */
|
|
26600
|
+
pageToken?: string;
|
|
26601
|
+
/** Required. The resource name of the Location to list the TuningJobs from. Format: `projects/{project}/locations/{location}` */
|
|
26602
|
+
parent: string;
|
|
26603
|
+
/** Returns response with indentations and line breaks. */
|
|
26604
|
+
prettyPrint?: boolean;
|
|
26605
|
+
/** 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. */
|
|
26606
|
+
quotaUser?: string;
|
|
26607
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
26608
|
+
upload_protocol?: string;
|
|
26609
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
26610
|
+
uploadType?: string;
|
|
26611
|
+
}): Request<GoogleCloudAiplatformV1ListTuningJobsResponse>;
|
|
26307
26612
|
operations: OperationsResource;
|
|
26308
26613
|
}
|
|
26309
26614
|
interface LocationsResource {
|