@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20230812 → 0.0.20230908

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://aiplatform.googleapis.com/$discovery/rest?version=v1
-// Revision: 20230812
+// Revision: 20230908
 
 /// <reference types="gapi.client" />
 
@@ -867,14 +867,11 @@ declare namespace gapi.client {
                 GoogleCloudAiplatformV1Feature;
             /**
              * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are
-             * `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.
+             * `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType .
              */
             featureId?:
                 string;
-            /**
-             * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format:
-             * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`
-             */
+            /** Required. The resource name of the EntityType to create a Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` */
             parent?:
                 string;
         }
@@ -2373,7 +2370,7 @@ declare namespace gapi.client {
             /** Output only. Timestamp when this EntityType was most recently updated. */
             updateTime?:
                 string;
-            /** Required. Immutable. Type of Feature value. */
+            /** Immutable. Type of Feature value. */
             valueType?:
                 string;
         }
@@ -2969,6 +2966,9 @@ declare namespace gapi.client {
             /** Required. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters. */
             displayName?:
                 string;
+            /** Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key. */
+            encryptionSpec?:
+                GoogleCloudAiplatformV1EncryptionSpec;
             /** Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */
             etag?:
                 string;
@@ -3017,8 +3017,8 @@ declare namespace gapi.client {
             featureVector?:
                 number[];
             /**
-             * Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See:
-             * https://cloud.google.com/vertex-ai/docs/matching-engine/filtering
+             * Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. This uses
+             * categorical tokens. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering
              */
             restricts?:
                 GoogleCloudAiplatformV1IndexDatapointRestriction[];
@@ -3032,13 +3032,13 @@ declare namespace gapi.client {
                 string;
         }
         interface GoogleCloudAiplatformV1IndexDatapointRestriction {
-            /** The attributes to allow in this namespace. eg: 'red' */
+            /** The attributes to allow in this namespace. e.g.: 'red' */
             allowList?:
                 string[];
-            /** The attributes to deny in this namespace. eg: 'blue' */
+            /** The attributes to deny in this namespace. e.g.: 'blue' */
             denyList?:
                 string[];
-            /** The namespace of this restriction. eg: color. */
+            /** The namespace of this restriction. e.g.: color. */
             namespace?:
                 string;
         }
@@ -3058,6 +3058,9 @@ declare namespace gapi.client {
             /** Optional. Deprecated: If true, expose the IndexEndpoint via private service connect. Only one of the fields, network or enable_private_service_connect, can be set. */
             enablePrivateServiceConnect?:
                 boolean;
+            /** Immutable. Customer-managed encryption key spec for an IndexEndpoint. If set, this IndexEndpoint and all sub-resources of this IndexEndpoint will be secured by this key. */
+            encryptionSpec?:
+                GoogleCloudAiplatformV1EncryptionSpec;
             /** Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. */
             etag?:
                 string;
@@ -8127,6 +8130,21 @@ declare namespace gapi.client {
              */
             clientId?:
                 string;
+            /**
+             * Optional. This allows you to specify the "context" for a Trial; a context is a slice (a subspace) of the search space. Typical uses for contexts: 1) You are using Vizier to tune a
+             * server for best performance, but there's a strong weekly cycle. The context specifies the day-of-week. This allows Tuesday to generalize from Wednesday without assuming that
+             * everything is identical. 2) Imagine you're optimizing some medical treatment for people. As they walk in the door, you know certain facts about them (e.g. sex, weight, height,
+             * blood-pressure). Put that information in the context, and Vizier will adapt its suggestions to the patient. 3) You want to do a fair A/B test efficiently. Specify the "A" and "B"
+             * conditions as contexts, and Vizier will generalize between "A" and "B" conditions. If they are similar, this will allow Vizier to converge to the optimum faster than if "A" and "B"
+             * were separate Studies. NOTE: You can also enter contexts as REQUESTED Trials, e.g. via the CreateTrial() RPC; that's the asynchronous option where you don't need a close association
+             * between contexts and suggestions. NOTE: All the Parameters you set in a context MUST be defined in the Study. NOTE: You must supply 0 or $suggestion_count contexts. If you don't
+             * supply any contexts, Vizier will make suggestions from the full search space specified in the StudySpec; if you supply a full set of context, each suggestion will match the
+             * corresponding context. NOTE: A Context with no features set matches anything, and allows suggestions from the full search space. NOTE: Contexts MUST lie within the search space
+             * specified in the StudySpec. It's an error if they don't. NOTE: Contexts preferentially match ACTIVE then REQUESTED trials before new suggestions are generated. NOTE: Generation of
+             * suggestions involves a match between a Context and (optionally) a REQUESTED trial; if that match is not fully specified, a suggestion will be geneated in the merged subspace.
+             */
+            contexts?:
+                GoogleCloudAiplatformV1TrialContext[];
             /** Required. The number of suggestions requested. It must be positive. */
             suggestionCount?:
                 number;
@@ -8552,6 +8570,18 @@ declare namespace gapi.client {
             webAccessUris?:
                 { [P in string]: string };
         }
+        interface GoogleCloudAiplatformV1TrialContext {
+            /** A human-readable field which can store a description of this context. This will become part of the resulting Trial's description field. */
+            description?:
+                string;
+            /**
+             * If/when a Trial is generated or selected from this Context, its Parameters will match any parameters specified here. (I.e. if this context specifies parameter name:'a' int_value:3,
+             * then a resulting Trial will have int_value:3 for its parameter named 'a'.) Note that we first attempt to match existing REQUESTED Trials with contexts, and if there are no matches,
+             * we generate suggestions in the subspace defined by the parameters specified here. NOTE: a Context without any Parameters matches the entire feasible search space.
+             */
+            parameters?:
+                GoogleCloudAiplatformV1TrialParameter[];
+        }
         interface GoogleCloudAiplatformV1TrialParameter {
             /** Output only. The ID of the parameter. The parameter should be defined in StudySpec's Parameters. */
             parameterId?:
@@ -14013,7 +14043,7 @@ declare namespace gapi.client {
                     string;
                 /**
                  * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are
-                 * `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.
+                 * `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType .
                  */
                 featureId?:
                     string;
@@ -14026,10 +14056,7 @@ declare namespace gapi.client {
                 /** OAuth 2.0 token for the current user. */
                 oauth_token?:
                     string;
-                /**
-                 * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format:
-                 * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`
-                 */
+                /** Required. The resource name of the EntityType to create a Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` */
                 parent:
                     string;
                 /** Returns response with indentations and line breaks. */
@@ -14063,7 +14090,7 @@ declare namespace gapi.client {
                     string;
                 /**
                  * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are
-                 * `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.
+                 * `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType .
                  */
                 featureId?:
                     string;
@@ -14076,10 +14103,7 @@ declare namespace gapi.client {
                 /** OAuth 2.0 token for the current user. */
                 oauth_token?:
                     string;
-                /**
-                 * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format:
-                 * `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`
-                 */
+                /** Required. The resource name of the EntityType to create a Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` */
                 parent:
                     string;
                 /** Returns response with indentations and line breaks. */
@@ -14116,10 +14140,7 @@ declare namespace gapi.client {
                 /** 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. */
                 key?:
                     string;
-                /**
-                 * Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}`
-                 * `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`
-                 */
+                /** Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` */
                 name:
                     string;
                 /** OAuth 2.0 token for the current user. */
@@ -14158,10 +14179,7 @@ declare namespace gapi.client {
                 /** 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. */
                 key?:
                     string;
-                /**
-                 * Required. The name of the Feature resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
-                 * `projects/{project}/locations/{location}/featureGroups/{feature_group}`
-                 */
+                /** Required. The name of the Feature resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` */
                 name:
                     string;
                 /** OAuth 2.0 token for the current user. */
@@ -14219,8 +14237,8 @@ declare namespace gapi.client {
                 oauth_token?:
                     string;
                 /**
-                 * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` *
-                 * `create_time` * `update_time`
+                 * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not
+                 * supported for FeatureRegistry Feature) * `create_time` * `update_time`
                  */
                 orderBy?:
                     string;
@@ -14236,10 +14254,7 @@ declare namespace gapi.client {
                  */
                 pageToken?:
                     string;
-                /**
-                 * Required. The resource name of the Location to list Features. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
-                 * `projects/{project}/locations/{location}/featureGroups/{feature_group}`
-                 */
+                /** Required. The resource name of the Location to list Features. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` */
                 parent:
                     string;
                 /** Returns response with indentations and line breaks. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.aiplatform-v1",
-  "version": "0.0.20230812",
+  "version": "0.0.20230908",
   "description": "TypeScript typings for Vertex AI API v1",
   "license": "MIT",
   "author": {

package/tests.ts

@@ -3,7 +3,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 
-// Revision: 20230812
+// Revision: 20230908
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -2954,6 +2954,9 @@ gapi.load('client', async () => {
             description: "Test string",
             displayName: "Test string",
             enablePrivateServiceConnect: true,
+            encryptionSpec: {
+                kmsKeyName: "Test string",
+            },
             etag: "Test string",
             labels: {
                 A: "Test string"
@@ -3175,6 +3178,9 @@ gapi.load('client', async () => {
             description: "Test string",
             displayName: "Test string",
             enablePrivateServiceConnect: true,
+            encryptionSpec: {
+                kmsKeyName: "Test string",
+            },
             etag: "Test string",
             labels: {
                 A: "Test string"
@@ -3256,6 +3262,9 @@ gapi.load('client', async () => {
             ],
             description: "Test string",
             displayName: "Test string",
+            encryptionSpec: {
+                kmsKeyName: "Test string",
+            },
             etag: "Test string",
             indexStats: {
                 shardsCount: 42,
@@ -3300,6 +3309,9 @@ gapi.load('client', async () => {
             ],
             description: "Test string",
             displayName: "Test string",
+            encryptionSpec: {
+                kmsKeyName: "Test string",
+            },
             etag: "Test string",
             indexStats: {
                 shardsCount: 42,
@@ -6530,6 +6542,17 @@ gapi.load('client', async () => {
             parent: "Test string",
         }, {
             clientId: "Test string",
+            contexts: [
+                {
+                    description: "Test string",
+                    parameters: [
+                        {
+                            parameterId: "Test string",
+                            value: 42,
+                        }
+                    ],
+                }
+            ],
             suggestionCount: 42,
         });
         /**