@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20240510 → 0.0.20240529

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 +231 -34
  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: 20240510
12
+ // Revision: 20240529
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -24,27 +24,13 @@ declare namespace gapi.client {
24
24
  function load(name: 'aiplatform', version: 'v1', callback: () => any): void;
25
25
 
26
26
  namespace aiplatform {
27
- interface CloudAiLargeModelsVisionFilteredText {
28
- /** Confidence level */
29
- category?: string;
30
- /** Filtered category */
31
- confidence?: string;
32
- /** Input prompt */
33
- prompt?: string;
34
- /** Score for category */
35
- score?: number;
36
- }
37
27
  interface CloudAiLargeModelsVisionGenerateVideoResponse {
38
28
  /** The generates samples. */
39
29
  generatedSamples?: CloudAiLargeModelsVisionMedia[];
40
- /** Returns rai error message for filtered videos. */
41
- raiErrorMessage?: string;
42
30
  /** Returns if any videos were filtered due to RAI policies. */
43
31
  raiMediaFilteredCount?: number;
44
32
  /** Returns rai failure reasons if any. */
45
33
  raiMediaFilteredReasons?: string[];
46
- /** Returns filtered text rai info. */
47
- raiTextFilteredReason?: CloudAiLargeModelsVisionFilteredText;
48
34
  }
49
35
  interface CloudAiLargeModelsVisionImage {
50
36
  /** Image encoding, encoded as "image/png" or "image/jpg". */
@@ -82,11 +68,41 @@ declare namespace gapi.client {
82
68
  y2?: number;
83
69
  }
84
70
  interface CloudAiLargeModelsVisionRaiInfo {
71
+ /** The list of detected labels for different rai categories. */
72
+ detectedLabels?: CloudAiLargeModelsVisionRaiInfoDetectedLabels[];
85
73
  /** List of rai categories' information to return */
86
74
  raiCategories?: string[];
87
75
  /** List of rai scores mapping to the rai categories. Rounded to 1 decimal place. */
88
76
  scores?: number[];
89
77
  }
78
+ interface CloudAiLargeModelsVisionRaiInfoDetectedLabels {
79
+ /** The list of detected entities for the rai signal. */
80
+ entities?: CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity[];
81
+ /** The RAI category for the deteceted labels. */
82
+ raiCategory?: string;
83
+ }
84
+ interface CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox {
85
+ /** The X coordinate of the top-left corner, in pixels. */
86
+ x1?: number;
87
+ /** The X coordinate of the bottom-right corner, in pixels. */
88
+ x2?: number;
89
+ /** The Y coordinate of the top-left corner, in pixels. */
90
+ y1?: number;
91
+ /** The Y coordinate of the bottom-right corner, in pixels. */
92
+ y2?: number;
93
+ }
94
+ interface CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity {
95
+ /** Bounding box of the label */
96
+ boundingBox?: CloudAiLargeModelsVisionRaiInfoDetectedLabelsBoundingBox;
97
+ /** Description of the label */
98
+ description?: string;
99
+ /** The intersection ratio between the detection bounding box and the mask. */
100
+ iouScore?: number;
101
+ /** MID of the label */
102
+ mid?: string;
103
+ /** Confidence score of the label */
104
+ score?: number;
105
+ }
90
106
  interface CloudAiLargeModelsVisionSemanticFilterResponse {
91
107
  /** Class labels of the bounding boxes that failed the semantic filtering. Bounding box coordinates. */
92
108
  namedBoundingBoxes?: CloudAiLargeModelsVisionNamedBoundingBox[];
@@ -99,6 +115,12 @@ declare namespace gapi.client {
99
115
  /** Raw bytes. */
100
116
  video?: string;
101
117
  }
118
+ interface CloudAiPlatformCommonCreatePipelineJobApiErrorDetail {
119
+ /** The error root cause returned by CreatePipelineJob API. */
120
+ errorCause?: string;
121
+ /** Public messages contains actionable items for the error cause. */
122
+ publicMessage?: string;
123
+ }
102
124
  interface GoogleApiHttpBody {
103
125
  /** The HTTP Content-Type header value specifying the content type of the body. */
104
126
  contentType?: string;
@@ -898,6 +920,50 @@ declare namespace gapi.client {
898
920
  /** Output only. Timestamp when this Dataset was last updated. */
899
921
  updateTime?: string;
900
922
  }
923
+ interface GoogleCloudAiplatformV1DatasetDistribution {
924
+ /** Output only. Defines the histogram bucket. */
925
+ buckets?: GoogleCloudAiplatformV1DatasetDistributionDistributionBucket[];
926
+ /** Output only. The maximum of the population values. */
927
+ max?: number;
928
+ /** Output only. The arithmetic mean of the values in the population. */
929
+ mean?: number;
930
+ /** Output only. The median of the values in the population. */
931
+ median?: number;
932
+ /** Output only. The minimum of the population values. */
933
+ min?: number;
934
+ /** Output only. The 5th percentile of the values in the population. */
935
+ p5?: number;
936
+ /** Output only. The 95th percentile of the values in the population. */
937
+ p95?: number;
938
+ /** Output only. Sum of a given population of values. */
939
+ sum?: number;
940
+ }
941
+ interface GoogleCloudAiplatformV1DatasetDistributionDistributionBucket {
942
+ /** Output only. Number of values in the bucket. */
943
+ count?: string;
944
+ /** Output only. Left bound of the bucket. */
945
+ left?: number;
946
+ /** Output only. Right bound of the bucket. */
947
+ right?: number;
948
+ }
949
+ interface GoogleCloudAiplatformV1DatasetStats {
950
+ /** Output only. Number of billable characters in the tuning dataset. */
951
+ totalBillableCharacterCount?: string;
952
+ /** Output only. Number of tuning characters in the tuning dataset. */
953
+ totalTuningCharacterCount?: string;
954
+ /** Output only. Number of examples in the tuning dataset. */
955
+ tuningDatasetExampleCount?: string;
956
+ /** Output only. Number of tuning steps for this Tuning Job. */
957
+ tuningStepCount?: string;
958
+ /** Output only. Sample user messages in the training dataset uri. */
959
+ userDatasetExamples?: GoogleCloudAiplatformV1Content[];
960
+ /** Output only. Dataset distributions for the user input tokens. */
961
+ userInputTokenDistribution?: GoogleCloudAiplatformV1DatasetDistribution;
962
+ /** Output only. Dataset distributions for the messages per example. */
963
+ userMessagePerExampleDistribution?: GoogleCloudAiplatformV1DatasetDistribution;
964
+ /** Output only. Dataset distributions for the user output tokens. */
965
+ userOutputTokenDistribution?: GoogleCloudAiplatformV1DatasetDistribution;
966
+ }
901
967
  interface GoogleCloudAiplatformV1DatasetVersion {
902
968
  /** Output only. Name of the associated BigQuery dataset. */
903
969
  bigQueryDatasetName?: string;
@@ -1075,8 +1141,14 @@ declare namespace gapi.client {
1075
1141
  createTime?: string;
1076
1142
  /** Required. The underlying DedicatedResources that the DeploymentResourcePool uses. */
1077
1143
  dedicatedResources?: GoogleCloudAiplatformV1DedicatedResources;
1144
+ /** If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send `stderr` and `stdout` streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging/pricing). User can disable container logging by setting this flag to true. */
1145
+ disableContainerLogging?: boolean;
1146
+ /** Customer-managed encryption key spec for a DeploymentResourcePool. If set, this DeploymentResourcePool will be secured by this key. Endpoints and the DeploymentResourcePool they deploy in need to have the same EncryptionSpec. */
1147
+ encryptionSpec?: GoogleCloudAiplatformV1EncryptionSpec;
1078
1148
  /** Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` */
1079
1149
  name?: string;
1150
+ /** The service account that the DeploymentResourcePool's container(s) run as. Specify the email address of the service account. If this service account is not specified, the container(s) run as a service account that doesn't have access to the resource project. Users deploying the Models to this DeploymentResourcePool must have the `iam.serviceAccounts.actAs` permission on this service account. */
1151
+ serviceAccount?: string;
1080
1152
  }
1081
1153
  interface GoogleCloudAiplatformV1DeployModelOperationMetadata {
1082
1154
  /** The operation generic information. */
@@ -1126,6 +1198,10 @@ declare namespace gapi.client {
1126
1198
  /** Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive). */
1127
1199
  bootDiskType?: string;
1128
1200
  }
1201
+ interface GoogleCloudAiplatformV1DistillationDataStats {
1202
+ /** Output only. Statistics computed for the training dataset. */
1203
+ trainingDatasetStats?: GoogleCloudAiplatformV1DatasetStats;
1204
+ }
1129
1205
  interface GoogleCloudAiplatformV1DoubleArray {
1130
1206
  /** A list of double values. */
1131
1207
  values?: number[];
@@ -1627,6 +1703,8 @@ declare namespace gapi.client {
1627
1703
  createTime?: string;
1628
1704
  /** Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint. */
1629
1705
  dedicatedServingEndpoint?: GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint;
1706
+ /** Optional. Customer-managed encryption key spec for data storage. If set, online store will be secured by this key. */
1707
+ encryptionSpec?: GoogleCloudAiplatformV1EncryptionSpec;
1630
1708
  /** Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */
1631
1709
  etag?: string;
1632
1710
  /** Optional. The labels with user-defined metadata to organize your FeatureOnlineStore. 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 on and examples of labels. No more than 64 user labels can be associated with one FeatureOnlineStore(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. */
@@ -1760,6 +1838,8 @@ declare namespace gapi.client {
1760
1838
  stringArrayValue?: GoogleCloudAiplatformV1StringArray;
1761
1839
  /** String feature value. */
1762
1840
  stringValue?: string;
1841
+ /** A struct type feature value. */
1842
+ structValue?: GoogleCloudAiplatformV1StructValue;
1763
1843
  }
1764
1844
  interface GoogleCloudAiplatformV1FeatureValueDestination {
1765
1845
  /** Output in BigQuery format. BigQueryDestination.output_uri in FeatureValueDestination.bigquery_destination must refer to a table. */
@@ -1964,6 +2044,12 @@ declare namespace gapi.client {
1964
2044
  /** Required. The name of the function to call. Matches [FunctionDeclaration.name]. */
1965
2045
  name?: string;
1966
2046
  }
2047
+ interface GoogleCloudAiplatformV1FunctionCallingConfig {
2048
+ /** Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided. */
2049
+ allowedFunctionNames?: string[];
2050
+ /** Optional. Function calling mode. */
2051
+ mode?: string;
2052
+ }
1967
2053
  interface GoogleCloudAiplatformV1FunctionDeclaration {
1968
2054
  /** Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. */
1969
2055
  description?: string;
@@ -1995,6 +2081,8 @@ declare namespace gapi.client {
1995
2081
  safetySettings?: GoogleCloudAiplatformV1SafetySetting[];
1996
2082
  /** 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. */
1997
2083
  systemInstruction?: GoogleCloudAiplatformV1Content;
2084
+ /** Optional. Tool config. This config is shared for all tools provided in the request. */
2085
+ toolConfig?: GoogleCloudAiplatformV1ToolConfig;
1998
2086
  /** Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. */
1999
2087
  tools?: GoogleCloudAiplatformV1Tool[];
2000
2088
  }
@@ -2032,8 +2120,8 @@ declare namespace gapi.client {
2032
2120
  presencePenalty?: number;
2033
2121
  /** 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. */
2034
2122
  responseMimeType?: string;
2035
- /** Optional. Control Three levels of creativity in the model output. Default: RESPONSE_STYLE_BALANCED */
2036
- responseStyle?: string;
2123
+ /** Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. */
2124
+ responseSchema?: GoogleCloudAiplatformV1Schema;
2037
2125
  /** Optional. Stop sequences. */
2038
2126
  stopSequences?: string[];
2039
2127
  /** Optional. Controls the randomness of predictions. */
@@ -2055,6 +2143,7 @@ declare namespace gapi.client {
2055
2143
  /** Required. The public base model URI. */
2056
2144
  baseModelUri?: string;
2057
2145
  }
2146
+ interface GoogleCloudAiplatformV1GoogleSearchRetrieval {}
2058
2147
  interface GoogleCloudAiplatformV1GroundingMetadata {
2059
2148
  /** Optional. Google search entry for the following-up web searches. */
2060
2149
  searchEntryPoint?: GoogleCloudAiplatformV1SearchEntryPoint;
@@ -2674,6 +2763,8 @@ declare namespace gapi.client {
2674
2763
  interface GoogleCloudAiplatformV1MetadataStore {
2675
2764
  /** Output only. Timestamp when this MetadataStore was created. */
2676
2765
  createTime?: string;
2766
+ /** Optional. Dataplex integration settings. */
2767
+ dataplexConfig?: GoogleCloudAiplatformV1MetadataStoreDataplexConfig;
2677
2768
  /** Description of the MetadataStore. */
2678
2769
  description?: string;
2679
2770
  /** Customer-managed encryption key spec for a Metadata Store. If set, this Metadata Store and all sub-resources of this Metadata Store are secured using this key. */
@@ -2685,6 +2776,10 @@ declare namespace gapi.client {
2685
2776
  /** Output only. Timestamp when this MetadataStore was last updated. */
2686
2777
  updateTime?: string;
2687
2778
  }
2779
+ interface GoogleCloudAiplatformV1MetadataStoreDataplexConfig {
2780
+ /** Optional. Whether or not Data Lineage synchronization is enabled for Vertex Pipelines. */
2781
+ enabledPipelinesLineage?: boolean;
2782
+ }
2688
2783
  interface GoogleCloudAiplatformV1MetadataStoreMetadataStoreState {
2689
2784
  /** The disk utilization of the MetadataStore in bytes. */
2690
2785
  diskUtilizationBytes?: string;
@@ -3399,14 +3494,6 @@ declare namespace gapi.client {
3399
3494
  /** Required. Duration is accurate to the second. In Notebook, Idle Timeout is accurate to minute so the range of idle_timeout (second) is: 10 * 60 ~ 1440 * 60. */
3400
3495
  idleTimeout?: string;
3401
3496
  }
3402
- interface GoogleCloudAiplatformV1NotebookReservationAffinity {
3403
- /** Required. Specifies the type of reservation from which this instance can consume resources: RESERVATION_ANY (default), RESERVATION_SPECIFIC, or RESERVATION_NONE. See Consuming reserved instances for examples. */
3404
- consumeReservationType?: string;
3405
- /** Optional. Corresponds to the label key of a reservation resource. To target a RESERVATION_SPECIFIC by name, use compute.googleapis.com/reservation-name as the key and specify the name of your reservation as its value. */
3406
- key?: string;
3407
- /** Optional. Corresponds to the label values of a reservation resource. This must be the full path name of Reservation. */
3408
- values?: string[];
3409
- }
3410
3497
  interface GoogleCloudAiplatformV1NotebookRuntime {
3411
3498
  /** Output only. Timestamp when this NotebookRuntime was created. */
3412
3499
  createTime?: string;
@@ -3414,10 +3501,14 @@ declare namespace gapi.client {
3414
3501
  description?: string;
3415
3502
  /** Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
3416
3503
  displayName?: string;
3504
+ /** Output only. Customer-managed encryption key spec for the notebook runtime. */
3505
+ encryptionSpec?: GoogleCloudAiplatformV1EncryptionSpec;
3417
3506
  /** Output only. Timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade. */
3418
3507
  expirationTime?: string;
3419
3508
  /** Output only. The health state of the NotebookRuntime. */
3420
3509
  healthState?: string;
3510
+ /** Output only. The idle shutdown configuration of the notebook runtime. */
3511
+ idleShutdownConfig?: GoogleCloudAiplatformV1NotebookIdleShutdownConfig;
3421
3512
  /** Output only. Whether NotebookRuntime is upgradable. */
3422
3513
  isUpgradable?: boolean;
3423
3514
  /** The labels with user-defined metadata to organize your NotebookRuntime. 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. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime: * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id. * "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex. */
@@ -3432,8 +3523,6 @@ declare namespace gapi.client {
3432
3523
  notebookRuntimeType?: string;
3433
3524
  /** Output only. The proxy endpoint used to access the NotebookRuntime. */
3434
3525
  proxyUri?: string;
3435
- /** Output only. Reservation Affinity of the notebook runtime. */
3436
- reservationAffinity?: GoogleCloudAiplatformV1NotebookReservationAffinity;
3437
3526
  /** Output only. The runtime (instance) state of the NotebookRuntime. */
3438
3527
  runtimeState?: string;
3439
3528
  /** Required. The user email of the NotebookRuntime. */
@@ -3458,6 +3547,8 @@ declare namespace gapi.client {
3458
3547
  description?: string;
3459
3548
  /** Required. The display name of the NotebookRuntimeTemplate. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
3460
3549
  displayName?: string;
3550
+ /** Customer-managed encryption key spec for the notebook runtime. */
3551
+ encryptionSpec?: GoogleCloudAiplatformV1EncryptionSpec;
3461
3552
  /** Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */
3462
3553
  etag?: string;
3463
3554
  /** EUC configuration of the NotebookRuntimeTemplate. */
@@ -3478,8 +3569,6 @@ declare namespace gapi.client {
3478
3569
  networkTags?: string[];
3479
3570
  /** Optional. Immutable. The type of the notebook runtime template. */
3480
3571
  notebookRuntimeType?: string;
3481
- /** Optional. Reservation Affinity of the notebook runtime template. */
3482
- reservationAffinity?: GoogleCloudAiplatformV1NotebookReservationAffinity;
3483
3572
  /** The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. */
3484
3573
  serviceAccount?: string;
3485
3574
  /** Optional. Immutable. Runtime Shielded VM spec. */
@@ -3533,7 +3622,7 @@ declare namespace gapi.client {
3533
3622
  /** Required. The spec of the pools of different resources. */
3534
3623
  resourcePools?: GoogleCloudAiplatformV1ResourcePool[];
3535
3624
  /** Output only. Runtime information of the Persistent Resource. */
3536
- resourceRuntime?: any;
3625
+ resourceRuntime?: GoogleCloudAiplatformV1ResourceRuntime;
3537
3626
  /** Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration. */
3538
3627
  resourceRuntimeSpec?: GoogleCloudAiplatformV1ResourceRuntimeSpec;
3539
3628
  /** Output only. Time when the PersistentResource for the first time entered the `RUNNING` state. */
@@ -3746,7 +3835,7 @@ declare namespace gapi.client {
3746
3835
  projectAllowlist?: string[];
3747
3836
  }
3748
3837
  interface GoogleCloudAiplatformV1Probe {
3749
- /** Exec specifies the action to take. */
3838
+ /** ExecAction probes the health of a container by executing a command. */
3750
3839
  exec?: GoogleCloudAiplatformV1ProbeExecAction;
3751
3840
  /** How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'. */
3752
3841
  periodSeconds?: number;
@@ -3961,7 +4050,20 @@ declare namespace gapi.client {
3961
4050
  /** 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. */
3962
4051
  httpBody?: GoogleApiHttpBody;
3963
4052
  }
3964
- interface GoogleCloudAiplatformV1RaySpec {}
4053
+ interface GoogleCloudAiplatformV1RayMetricSpec {
4054
+ /** Optional. Flag to disable the Ray metrics collection. */
4055
+ disabled?: boolean;
4056
+ }
4057
+ interface GoogleCloudAiplatformV1RaySpec {
4058
+ /** 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. */
4059
+ headNodeResourcePoolId?: string;
4060
+ /** 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. */
4061
+ imageUri?: string;
4062
+ /** Optional. Ray metrics configurations. */
4063
+ rayMetricSpec?: GoogleCloudAiplatformV1RayMetricSpec;
4064
+ /** 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" } */
4065
+ resourcePoolImages?: {[P in string]: string};
4066
+ }
3965
4067
  interface GoogleCloudAiplatformV1ReadFeatureValuesRequest {
3966
4068
  /** 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`. */
3967
4069
  entityId?: string;
@@ -4041,6 +4143,12 @@ declare namespace gapi.client {
4041
4143
  progressMessage?: string;
4042
4144
  }
4043
4145
  interface GoogleCloudAiplatformV1RebootPersistentResourceRequest {}
4146
+ interface GoogleCloudAiplatformV1ReinforcementLearningDataStats {
4147
+ /** Output only. Statistics computed for the preference dataset. This can be either a human preference dataset or a preference dataset generated from AI feedback. */
4148
+ preferenceDatasetStats?: GoogleCloudAiplatformV1DatasetStats;
4149
+ /** Output only. Statistics computed for the prompt dataset used during reinforcement learning. */
4150
+ promptDatasetStats?: GoogleCloudAiplatformV1DatasetStats;
4151
+ }
4044
4152
  interface GoogleCloudAiplatformV1RemoveContextChildrenRequest {
4045
4153
  /** The resource names of the child Contexts. */
4046
4154
  childContexts?: string[];
@@ -4071,10 +4179,13 @@ declare namespace gapi.client {
4071
4179
  /** Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error */
4072
4180
  minReplicaCount?: string;
4073
4181
  }
4074
- interface GoogleCloudAiplatformV1ResourceRuntime {}
4182
+ interface GoogleCloudAiplatformV1ResourceRuntime {
4183
+ /** 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" } */
4184
+ accessUris?: {[P in string]: string};
4185
+ }
4075
4186
  interface GoogleCloudAiplatformV1ResourceRuntimeSpec {
4076
4187
  /** Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. */
4077
- raySpec?: any;
4188
+ raySpec?: GoogleCloudAiplatformV1RaySpec;
4078
4189
  /** Optional. Configure the use of workload identity on the PersistentResource */
4079
4190
  serviceAccountSpec?: GoogleCloudAiplatformV1ServiceAccountSpec;
4080
4191
  }
@@ -4932,6 +5043,8 @@ declare namespace gapi.client {
4932
5043
  gcsUri?: string;
4933
5044
  /** Grounding checking configuration. */
4934
5045
  groundingConfig?: GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig;
5046
+ /** Whether the prompt dataset has prompt variable. */
5047
+ hasPromptVariable?: boolean;
4935
5048
  /** Value of the maximum number of tokens generated set when the dataset was saved. */
4936
5049
  maxOutputTokens?: string;
4937
5050
  /** User-created prompt note. Note size limit is 2KB. */
@@ -4940,6 +5053,8 @@ declare namespace gapi.client {
4940
5053
  promptType?: string;
4941
5054
  /** Customized stop sequences. */
4942
5055
  stopSequences?: string[];
5056
+ /** The content of the prompt dataset system instruction. */
5057
+ systemInstruction?: string;
4943
5058
  /** The Google Cloud Storage URI that stores the system instruction, starting with gs://. */
4944
5059
  systemInstructionGcsUri?: string;
4945
5060
  /** Temperature value used for sampling set when the dataset was saved. This value is used to tune the degree of randomness. */
@@ -5711,6 +5826,16 @@ declare namespace gapi.client {
5711
5826
  /** A list of string values. */
5712
5827
  values?: string[];
5713
5828
  }
5829
+ interface GoogleCloudAiplatformV1StructFieldValue {
5830
+ /** Name of the field in the struct feature. */
5831
+ name?: string;
5832
+ /** The value for this field. */
5833
+ value?: GoogleCloudAiplatformV1FeatureValue;
5834
+ }
5835
+ interface GoogleCloudAiplatformV1StructValue {
5836
+ /** A list of field values. */
5837
+ values?: GoogleCloudAiplatformV1StructFieldValue[];
5838
+ }
5714
5839
  interface GoogleCloudAiplatformV1Study {
5715
5840
  /** Output only. Time at which the study was created. */
5716
5841
  createTime?: string;
@@ -6139,9 +6264,15 @@ declare namespace gapi.client {
6139
6264
  interface GoogleCloudAiplatformV1Tool {
6140
6265
  /** 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. */
6141
6266
  functionDeclarations?: GoogleCloudAiplatformV1FunctionDeclaration[];
6267
+ /** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
6268
+ googleSearchRetrieval?: any;
6142
6269
  /** 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. */
6143
6270
  retrieval?: GoogleCloudAiplatformV1Retrieval;
6144
6271
  }
6272
+ interface GoogleCloudAiplatformV1ToolConfig {
6273
+ /** Optional. Function calling config. */
6274
+ functionCallingConfig?: GoogleCloudAiplatformV1FunctionCallingConfig;
6275
+ }
6145
6276
  interface GoogleCloudAiplatformV1TrainingConfig {
6146
6277
  /** The timeout hours for the CMLE training job, expressed in milli hours i.e. 1,000 value in this field means 1 hour. */
6147
6278
  timeoutTrainingMilliHours?: string;
@@ -6227,6 +6358,10 @@ declare namespace gapi.client {
6227
6358
  model?: string;
6228
6359
  }
6229
6360
  interface GoogleCloudAiplatformV1TuningDataStats {
6361
+ /** Statistics for distillation. */
6362
+ distillationDataStats?: GoogleCloudAiplatformV1DistillationDataStats;
6363
+ /** Statistics for reinforcement learning. */
6364
+ reinforcementLearningDataStats?: GoogleCloudAiplatformV1ReinforcementLearningDataStats;
6230
6365
  /** The SFT Tuning data stats. */
6231
6366
  supervisedTuningDataStats?: GoogleCloudAiplatformV1SupervisedTuningDataStats;
6232
6367
  }
@@ -20014,6 +20149,68 @@ declare namespace gapi.client {
20014
20149
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
20015
20150
  uploadType?: string;
20016
20151
  }): Request<GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse>;
20152
+ /** Updates a NotebookRuntimeTemplate. */
20153
+ patch(request: {
20154
+ /** V1 error format. */
20155
+ '$.xgafv'?: string;
20156
+ /** OAuth access token. */
20157
+ access_token?: string;
20158
+ /** Data format for response. */
20159
+ alt?: string;
20160
+ /** JSONP */
20161
+ callback?: string;
20162
+ /** Selector specifying which fields to include in a partial response. */
20163
+ fields?: string;
20164
+ /** 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. */
20165
+ key?: string;
20166
+ /** The resource name of the NotebookRuntimeTemplate. */
20167
+ name: string;
20168
+ /** OAuth 2.0 token for the current user. */
20169
+ oauth_token?: string;
20170
+ /** Returns response with indentations and line breaks. */
20171
+ prettyPrint?: boolean;
20172
+ /** 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. */
20173
+ quotaUser?: string;
20174
+ /** Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: "${updated_filed}"}` Updatable fields: * `encryption_spec.kms_key_name` */
20175
+ updateMask?: string;
20176
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
20177
+ upload_protocol?: string;
20178
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
20179
+ uploadType?: string;
20180
+ /** Request body */
20181
+ resource: GoogleCloudAiplatformV1NotebookRuntimeTemplate;
20182
+ }): Request<GoogleCloudAiplatformV1NotebookRuntimeTemplate>;
20183
+ patch(
20184
+ request: {
20185
+ /** V1 error format. */
20186
+ '$.xgafv'?: string;
20187
+ /** OAuth access token. */
20188
+ access_token?: string;
20189
+ /** Data format for response. */
20190
+ alt?: string;
20191
+ /** JSONP */
20192
+ callback?: string;
20193
+ /** Selector specifying which fields to include in a partial response. */
20194
+ fields?: string;
20195
+ /** 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. */
20196
+ key?: string;
20197
+ /** The resource name of the NotebookRuntimeTemplate. */
20198
+ name: string;
20199
+ /** OAuth 2.0 token for the current user. */
20200
+ oauth_token?: string;
20201
+ /** Returns response with indentations and line breaks. */
20202
+ prettyPrint?: boolean;
20203
+ /** 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. */
20204
+ quotaUser?: string;
20205
+ /** Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: "${updated_filed}"}` Updatable fields: * `encryption_spec.kms_key_name` */
20206
+ updateMask?: string;
20207
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
20208
+ upload_protocol?: string;
20209
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
20210
+ uploadType?: string;
20211
+ },
20212
+ body: GoogleCloudAiplatformV1NotebookRuntimeTemplate
20213
+ ): Request<GoogleCloudAiplatformV1NotebookRuntimeTemplate>;
20017
20214
  /** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
20018
20215
  setIamPolicy(
20019
20216
  request: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.aiplatform-v1",
3
- "version": "0.0.20240510",
3
+ "version": "0.0.20240529",
4
4
  "description": "TypeScript typings for Vertex AI API v1",
5
5
  "repository": {
6
6
  "type": "git",