@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20240520 → 0.0.20240531

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 +172 -21
  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: 20240520
12
+ // Revision: 20240531
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
- /** Filtered category */
29
- category?: string;
30
- /** Confidence score */
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,6 +68,7 @@ declare namespace gapi.client {
82
68
  y2?: number;
83
69
  }
84
70
  interface CloudAiLargeModelsVisionRaiInfo {
71
+ /** The list of detected labels for different rai categories. */
85
72
  detectedLabels?: CloudAiLargeModelsVisionRaiInfoDetectedLabels[];
86
73
  /** List of rai categories' information to return */
87
74
  raiCategories?: string[];
@@ -89,12 +76,32 @@ declare namespace gapi.client {
89
76
  scores?: number[];
90
77
  }
91
78
  interface CloudAiLargeModelsVisionRaiInfoDetectedLabels {
92
- /** Descriptions of the detected labels. */
93
- descriptions?: string[];
79
+ /** The list of detected entities for the rai signal. */
80
+ entities?: CloudAiLargeModelsVisionRaiInfoDetectedLabelsEntity[];
94
81
  /** The RAI category for the deteceted labels. */
95
82
  raiCategory?: string;
96
- /** Confidence scores mapping to the labels. */
97
- scores?: number[];
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;
98
105
  }
99
106
  interface CloudAiLargeModelsVisionSemanticFilterResponse {
100
107
  /** Class labels of the bounding boxes that failed the semantic filtering. Bounding box coordinates. */
@@ -108,6 +115,12 @@ declare namespace gapi.client {
108
115
  /** Raw bytes. */
109
116
  video?: string;
110
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
+ }
111
124
  interface GoogleApiHttpBody {
112
125
  /** The HTTP Content-Type header value specifying the content type of the body. */
113
126
  contentType?: string;
@@ -907,6 +920,50 @@ declare namespace gapi.client {
907
920
  /** Output only. Timestamp when this Dataset was last updated. */
908
921
  updateTime?: string;
909
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
+ }
910
967
  interface GoogleCloudAiplatformV1DatasetVersion {
911
968
  /** Output only. Name of the associated BigQuery dataset. */
912
969
  bigQueryDatasetName?: string;
@@ -1141,6 +1198,10 @@ declare namespace gapi.client {
1141
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). */
1142
1199
  bootDiskType?: string;
1143
1200
  }
1201
+ interface GoogleCloudAiplatformV1DistillationDataStats {
1202
+ /** Output only. Statistics computed for the training dataset. */
1203
+ trainingDatasetStats?: GoogleCloudAiplatformV1DatasetStats;
1204
+ }
1144
1205
  interface GoogleCloudAiplatformV1DoubleArray {
1145
1206
  /** A list of double values. */
1146
1207
  values?: number[];
@@ -1642,6 +1703,8 @@ declare namespace gapi.client {
1642
1703
  createTime?: string;
1643
1704
  /** Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint. */
1644
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;
1645
1708
  /** Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */
1646
1709
  etag?: string;
1647
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. */
@@ -1981,6 +2044,12 @@ declare namespace gapi.client {
1981
2044
  /** Required. The name of the function to call. Matches [FunctionDeclaration.name]. */
1982
2045
  name?: string;
1983
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
+ }
1984
2053
  interface GoogleCloudAiplatformV1FunctionDeclaration {
1985
2054
  /** Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. */
1986
2055
  description?: string;
@@ -2012,6 +2081,8 @@ declare namespace gapi.client {
2012
2081
  safetySettings?: GoogleCloudAiplatformV1SafetySetting[];
2013
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. */
2014
2083
  systemInstruction?: GoogleCloudAiplatformV1Content;
2084
+ /** Optional. Tool config. This config is shared for all tools provided in the request. */
2085
+ toolConfig?: GoogleCloudAiplatformV1ToolConfig;
2015
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. */
2016
2087
  tools?: GoogleCloudAiplatformV1Tool[];
2017
2088
  }
@@ -2049,6 +2120,8 @@ declare namespace gapi.client {
2049
2120
  presencePenalty?: number;
2050
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. */
2051
2122
  responseMimeType?: 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;
2052
2125
  /** Optional. Stop sequences. */
2053
2126
  stopSequences?: string[];
2054
2127
  /** Optional. Controls the randomness of predictions. */
@@ -3428,6 +3501,8 @@ declare namespace gapi.client {
3428
3501
  description?: string;
3429
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. */
3430
3503
  displayName?: string;
3504
+ /** Output only. Customer-managed encryption key spec for the notebook runtime. */
3505
+ encryptionSpec?: GoogleCloudAiplatformV1EncryptionSpec;
3431
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. */
3432
3507
  expirationTime?: string;
3433
3508
  /** Output only. The health state of the NotebookRuntime. */
@@ -3806,8 +3881,6 @@ declare namespace gapi.client {
3806
3881
  deploy?: GoogleCloudAiplatformV1PublisherModelCallToActionDeploy;
3807
3882
  /** Optional. Deploy PublisherModel to Google Kubernetes Engine. */
3808
3883
  deployGke?: GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke;
3809
- /** Optional. Fine tune the PublisherModel with the third-party model tuning UI. */
3810
- fineTune?: GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences;
3811
3884
  /** Optional. Open evaluation pipeline of the PublisherModel. */
3812
3885
  openEvaluationPipeline?: GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences;
3813
3886
  /** Optional. Open fine-tuning pipeline of the PublisherModel. */
@@ -4068,6 +4141,12 @@ declare namespace gapi.client {
4068
4141
  progressMessage?: string;
4069
4142
  }
4070
4143
  interface GoogleCloudAiplatformV1RebootPersistentResourceRequest {}
4144
+ interface GoogleCloudAiplatformV1ReinforcementLearningDataStats {
4145
+ /** Output only. Statistics computed for the preference dataset. This can be either a human preference dataset or a preference dataset generated from AI feedback. */
4146
+ preferenceDatasetStats?: GoogleCloudAiplatformV1DatasetStats;
4147
+ /** Output only. Statistics computed for the prompt dataset used during reinforcement learning. */
4148
+ promptDatasetStats?: GoogleCloudAiplatformV1DatasetStats;
4149
+ }
4071
4150
  interface GoogleCloudAiplatformV1RemoveContextChildrenRequest {
4072
4151
  /** The resource names of the child Contexts. */
4073
4152
  childContexts?: string[];
@@ -4972,6 +5051,8 @@ declare namespace gapi.client {
4972
5051
  promptType?: string;
4973
5052
  /** Customized stop sequences. */
4974
5053
  stopSequences?: string[];
5054
+ /** The content of the prompt dataset system instruction. */
5055
+ systemInstruction?: string;
4975
5056
  /** The Google Cloud Storage URI that stores the system instruction, starting with gs://. */
4976
5057
  systemInstructionGcsUri?: string;
4977
5058
  /** Temperature value used for sampling set when the dataset was saved. This value is used to tune the degree of randomness. */
@@ -6186,6 +6267,10 @@ declare namespace gapi.client {
6186
6267
  /** 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. */
6187
6268
  retrieval?: GoogleCloudAiplatformV1Retrieval;
6188
6269
  }
6270
+ interface GoogleCloudAiplatformV1ToolConfig {
6271
+ /** Optional. Function calling config. */
6272
+ functionCallingConfig?: GoogleCloudAiplatformV1FunctionCallingConfig;
6273
+ }
6189
6274
  interface GoogleCloudAiplatformV1TrainingConfig {
6190
6275
  /** The timeout hours for the CMLE training job, expressed in milli hours i.e. 1,000 value in this field means 1 hour. */
6191
6276
  timeoutTrainingMilliHours?: string;
@@ -6271,6 +6356,10 @@ declare namespace gapi.client {
6271
6356
  model?: string;
6272
6357
  }
6273
6358
  interface GoogleCloudAiplatformV1TuningDataStats {
6359
+ /** Statistics for distillation. */
6360
+ distillationDataStats?: GoogleCloudAiplatformV1DistillationDataStats;
6361
+ /** Statistics for reinforcement learning. */
6362
+ reinforcementLearningDataStats?: GoogleCloudAiplatformV1ReinforcementLearningDataStats;
6274
6363
  /** The SFT Tuning data stats. */
6275
6364
  supervisedTuningDataStats?: GoogleCloudAiplatformV1SupervisedTuningDataStats;
6276
6365
  }
@@ -20058,6 +20147,68 @@ declare namespace gapi.client {
20058
20147
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
20059
20148
  uploadType?: string;
20060
20149
  }): Request<GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse>;
20150
+ /** Updates a NotebookRuntimeTemplate. */
20151
+ patch(request: {
20152
+ /** V1 error format. */
20153
+ '$.xgafv'?: string;
20154
+ /** OAuth access token. */
20155
+ access_token?: string;
20156
+ /** Data format for response. */
20157
+ alt?: string;
20158
+ /** JSONP */
20159
+ callback?: string;
20160
+ /** Selector specifying which fields to include in a partial response. */
20161
+ fields?: string;
20162
+ /** 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. */
20163
+ key?: string;
20164
+ /** The resource name of the NotebookRuntimeTemplate. */
20165
+ name: string;
20166
+ /** OAuth 2.0 token for the current user. */
20167
+ oauth_token?: string;
20168
+ /** Returns response with indentations and line breaks. */
20169
+ prettyPrint?: boolean;
20170
+ /** 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. */
20171
+ quotaUser?: string;
20172
+ /** 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` */
20173
+ updateMask?: string;
20174
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
20175
+ upload_protocol?: string;
20176
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
20177
+ uploadType?: string;
20178
+ /** Request body */
20179
+ resource: GoogleCloudAiplatformV1NotebookRuntimeTemplate;
20180
+ }): Request<GoogleCloudAiplatformV1NotebookRuntimeTemplate>;
20181
+ patch(
20182
+ request: {
20183
+ /** V1 error format. */
20184
+ '$.xgafv'?: string;
20185
+ /** OAuth access token. */
20186
+ access_token?: string;
20187
+ /** Data format for response. */
20188
+ alt?: string;
20189
+ /** JSONP */
20190
+ callback?: string;
20191
+ /** Selector specifying which fields to include in a partial response. */
20192
+ fields?: string;
20193
+ /** 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. */
20194
+ key?: string;
20195
+ /** The resource name of the NotebookRuntimeTemplate. */
20196
+ name: string;
20197
+ /** OAuth 2.0 token for the current user. */
20198
+ oauth_token?: string;
20199
+ /** Returns response with indentations and line breaks. */
20200
+ prettyPrint?: boolean;
20201
+ /** 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. */
20202
+ quotaUser?: string;
20203
+ /** 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` */
20204
+ updateMask?: string;
20205
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
20206
+ upload_protocol?: string;
20207
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
20208
+ uploadType?: string;
20209
+ },
20210
+ body: GoogleCloudAiplatformV1NotebookRuntimeTemplate
20211
+ ): Request<GoogleCloudAiplatformV1NotebookRuntimeTemplate>;
20061
20212
  /** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
20062
20213
  setIamPolicy(
20063
20214
  request: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.aiplatform-v1",
3
- "version": "0.0.20240520",
3
+ "version": "0.0.20240531",
4
4
  "description": "TypeScript typings for Vertex AI API v1",
5
5
  "repository": {
6
6
  "type": "git",