@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20240925 → 0.0.20241007

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: 20240925
+// Revision: 20241007
 
 /// <reference types="gapi.client" />
 
@@ -41,6 +41,8 @@ declare namespace gapi.client {
       image?: string;
       /** RAI scores for generated image. */
       imageRaiScores?: CloudAiLargeModelsVisionImageRAIScores;
+      /** Image size. The size of the image. Can be self reported, or computed from the image bytes. */
+      imageSize?: CloudAiLargeModelsVisionImageImageSize;
       /** RAI info for image. */
       raiInfo?: CloudAiLargeModelsVisionRaiInfo;
       /** Semantic filter info for image. */
@@ -50,6 +52,11 @@ declare namespace gapi.client {
       /** Path to another storage (typically Google Cloud Storage). */
       uri?: string;
     }
+    interface CloudAiLargeModelsVisionImageImageSize {
+      channels?: number;
+      height?: number;
+      width?: number;
+    }
     interface CloudAiLargeModelsVisionImageRAIScores {
       /** Agile watermark score for image. */
       agileWatermarkDetectionScore?: number;
@@ -907,6 +914,8 @@ declare namespace gapi.client {
       persistentResourceId?: string;
       /** The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations */
       protectedArtifactLocationId?: string;
+      /** Optional. Configuration for PSC-I for CustomJob. */
+      pscInterfaceConfig?: any;
       /** Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. */
       reservedIpRanges?: string[];
       /** Scheduling options for a CustomJob. */
@@ -1266,6 +1275,12 @@ declare namespace gapi.client {
       /** A list of double values. */
       values?: number[];
     }
+    interface GoogleCloudAiplatformV1DynamicRetrievalConfig {
+      /** Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. */
+      dynamicThreshold?: number;
+      /** The mode of the predictor to be used in dynamic retrieval. */
+      mode?: string;
+    }
     interface GoogleCloudAiplatformV1EncryptionSpec {
       /** Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. */
       kmsKeyName?: string;
@@ -2160,6 +2175,8 @@ declare namespace gapi.client {
       syncSummary?: GoogleCloudAiplatformV1FeatureViewSyncSyncSummary;
     }
     interface GoogleCloudAiplatformV1FeatureViewSyncConfig {
+      /** Optional. If true, syncs the FeatureView in a continuous manner to Online Store. */
+      continuous?: boolean;
       /** Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". */
       cron?: string;
     }
@@ -2392,6 +2409,8 @@ declare namespace gapi.client {
       totalTokenCount?: number;
     }
     interface GoogleCloudAiplatformV1GenerationConfig {
+      /** Optional. If enabled, audio timestamp will be included in the request to the model. */
+      audioTimestamp?: boolean;
       /** Optional. Number of candidates to generate. */
       candidateCount?: number;
       /** Optional. Frequency penalties. */
@@ -2447,7 +2466,10 @@ declare namespace gapi.client {
       /** Required. The public base model URI. */
       baseModelUri?: string;
     }
-    interface GoogleCloudAiplatformV1GoogleSearchRetrieval {}
+    interface GoogleCloudAiplatformV1GoogleSearchRetrieval {
+      /** Specifies the dynamic retrieval configuration for the given source. */
+      dynamicRetrievalConfig?: GoogleCloudAiplatformV1DynamicRetrievalConfig;
+    }
     interface GoogleCloudAiplatformV1GroundednessInput {
       /** Required. Groundedness instance. */
       instance?: GoogleCloudAiplatformV1GroundednessInstance;
@@ -2495,6 +2517,8 @@ declare namespace gapi.client {
       groundingChunks?: GoogleCloudAiplatformV1GroundingChunk[];
       /** Optional. List of grounding support. */
       groundingSupports?: GoogleCloudAiplatformV1GroundingSupport[];
+      /** Optional. Output only. Retrieval metadata. */
+      retrievalMetadata?: GoogleCloudAiplatformV1RetrievalMetadata;
       /** Optional. Google search entry for the following-up web searches. */
       searchEntryPoint?: GoogleCloudAiplatformV1SearchEntryPoint;
       /** Optional. Web search queries for the following-up web search. */
@@ -3095,9 +3119,9 @@ declare namespace gapi.client {
     interface GoogleCloudAiplatformV1LogprobsResultCandidate {
       /** The candidate's log probability. */
       logProbability?: number;
-      /** The candidate’s token string value. */
+      /** The candidate's token string value. */
       token?: string;
-      /** The candidate’s token id value. */
+      /** The candidate's token id value. */
       tokenId?: number;
     }
     interface GoogleCloudAiplatformV1LogprobsResultTopCandidates {
@@ -4446,6 +4470,7 @@ declare namespace gapi.client {
       /** Required. Project id used to create forwarding rule. */
       projectId?: string;
     }
+    interface GoogleCloudAiplatformV1PscInterfaceConfig {}
     interface GoogleCloudAiplatformV1PublisherModel {
       /** Optional. Additional information about the model's Frameworks. */
       frameworks?: string[];
@@ -4952,6 +4977,10 @@ declare namespace gapi.client {
       /** Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. */
       vertexRagStore?: GoogleCloudAiplatformV1VertexRagStore;
     }
+    interface GoogleCloudAiplatformV1RetrievalMetadata {
+      /** Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. */
+      googleSearchDynamicRetrievalScore?: number;
+    }
     interface GoogleCloudAiplatformV1RougeInput {
       /** Required. Repeated rouge instances. */
       instances?: GoogleCloudAiplatformV1RougeInstance[];
@@ -5135,7 +5164,7 @@ declare namespace gapi.client {
       default?: any;
       /** Optional. The description of the data. */
       description?: string;
-      /** Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} */
+      /** Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} */
       enum?: string[];
       /** Optional. Example of the object. Will only populated when the object is the root. */
       example?: any;
@@ -5801,6 +5830,62 @@ declare namespace gapi.client {
       /** The topmost coordinate of the bounding box. */
       yMin?: number;
     }
+    interface GoogleCloudAiplatformV1SchemaPromptApiSchema {
+      /** The Schema version that represents changes to the API behavior. */
+      apiSchemaVersion?: string;
+      /** A list of execution instances for constructing a ready-to-use prompt. */
+      executions?: GoogleCloudAiplatformV1SchemaPromptInstancePromptExecution[];
+      /** Multimodal prompt which embeds preambles to prompt string. */
+      multimodalPrompt?: GoogleCloudAiplatformV1SchemaPromptSpecMultimodalPrompt;
+      /** The prompt variation that stores preambles in separate fields. */
+      structuredPrompt?: GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt;
+    }
+    interface GoogleCloudAiplatformV1SchemaPromptInstancePromptExecution {
+      /** Maps variable names to their value. */
+      arguments?: {
+        [P in string]: GoogleCloudAiplatformV1SchemaPromptInstanceVariableValue;
+      };
+    }
+    interface GoogleCloudAiplatformV1SchemaPromptInstanceVariableValue {
+      /** The parts of the variable value. */
+      partList?: GoogleCloudAiplatformV1SchemaPromptSpecPartList;
+    }
+    interface GoogleCloudAiplatformV1SchemaPromptSpecMultimodalPrompt {
+      /** The prompt message. */
+      promptMessage?: GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage;
+    }
+    interface GoogleCloudAiplatformV1SchemaPromptSpecPartList {
+      /** A list of elements that can be part of a prompt. */
+      parts?: GoogleCloudAiplatformV1Part[];
+    }
+    interface GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage {
+      /** The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. */
+      contents?: GoogleCloudAiplatformV1Content[];
+      /** Generation config. */
+      generationConfig?: GoogleCloudAiplatformV1GenerationConfig;
+      /** The model name. */
+      model?: string;
+      /** Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. */
+      safetySettings?: GoogleCloudAiplatformV1SafetySetting[];
+      /** 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. */
+      systemInstruction?: GoogleCloudAiplatformV1Content;
+      /** Tool config. This config is shared for all tools provided in the request. */
+      toolConfig?: GoogleCloudAiplatformV1ToolConfig;
+      /** 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. */
+      tools?: GoogleCloudAiplatformV1Tool[];
+    }
+    interface GoogleCloudAiplatformV1SchemaPromptSpecStructuredPrompt {
+      /** Preamble: The context of the prompt. */
+      context?: GoogleCloudAiplatformV1Content;
+      /** Preamble: A set of examples for expected model response. */
+      examples?: GoogleCloudAiplatformV1SchemaPromptSpecPartList[];
+      /** Preamble: The input prefixes before each example input. */
+      inputPrefixes?: string[];
+      /** Preamble: The output prefixes before each example output. */
+      outputPrefixes?: string[];
+      /** The prompt message. */
+      promptMessage?: GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage;
+    }
     interface GoogleCloudAiplatformV1SchemaTablesDatasetMetadata {
       inputConfig?: GoogleCloudAiplatformV1SchemaTablesDatasetMetadataInputConfig;
     }
@@ -5855,6 +5940,8 @@ declare namespace gapi.client {
       maxOutputTokens?: string;
       /** User-created prompt note. Note size limit is 2KB. */
       note?: string;
+      /** The API schema of the prompt to support both UI and SDK usages. */
+      promptApiSchema?: GoogleCloudAiplatformV1SchemaPromptApiSchema;
       /** Type of the prompt dataset. */
       promptType?: string;
       /** Seeding enables model to return a deterministic response on a best effort basis. Determinism isn't guaranteed. This field determines whether or not seeding is enabled. */
@@ -7189,7 +7276,7 @@ declare namespace gapi.client {
       /** 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 128 function declarations can be provided. */
       functionDeclarations?: GoogleCloudAiplatformV1FunctionDeclaration[];
       /** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
-      googleSearchRetrieval?: any;
+      googleSearchRetrieval?: GoogleCloudAiplatformV1GoogleSearchRetrieval;
       /** 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. */
       retrieval?: GoogleCloudAiplatformV1Retrieval;
     }
@@ -7281,7 +7368,7 @@ declare namespace gapi.client {
       toolParameterKvMatchMetricValues?: GoogleCloudAiplatformV1ToolParameterKVMatchMetricValue[];
     }
     interface GoogleCloudAiplatformV1ToolParameterKVMatchSpec {
-      /** Optional. Whether to use STRCIT string match on parameter values. */
+      /** Optional. Whether to use STRICT string match on parameter values. */
       useStrictStringMatch?: boolean;
     }
     interface GoogleCloudAiplatformV1TrainingConfig {
@@ -11260,6 +11347,66 @@ declare namespace gapi.client {
       }): Request<GoogleCloudAiplatformV1QueryDeployedModelsResponse>;
       operations: OperationsResource;
     }
+    interface ChatResource {
+      /** Exposes an OpenAI-compatible endpoint for chat completions. */
+      completions(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` */
+        endpoint: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** 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;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** 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. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: GoogleApiHttpBody;
+      }): Request<GoogleApiHttpBody>;
+      completions(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` */
+          endpoint: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** 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;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** 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. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: GoogleApiHttpBody
+      ): Request<GoogleApiHttpBody>;
+    }
     interface OperationsResource {
       /** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */
       cancel(request?: {
@@ -12433,6 +12580,7 @@ declare namespace gapi.client {
         },
         body: GoogleCloudAiplatformV1UndeployModelRequest
       ): Request<GoogleLongrunningOperation>;
+      chat: ChatResource;
       operations: OperationsResource;
     }
     interface OperationsResource {
@@ -12554,6 +12702,64 @@ declare namespace gapi.client {
       }): Request<GoogleLongrunningOperation>;
     }
     interface FeaturesResource {
+      /** Creates a batch of Features in a given FeatureGroup. */
+      batchCreate(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** 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;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}` */
+        parent: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** 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. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: GoogleCloudAiplatformV1BatchCreateFeaturesRequest;
+      }): Request<GoogleLongrunningOperation>;
+      batchCreate(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** 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;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}` */
+          parent: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** 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. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: GoogleCloudAiplatformV1BatchCreateFeaturesRequest
+      ): Request<GoogleLongrunningOperation>;
       /** Creates a new Feature in a given FeatureGroup. */
       create(request: {
         /** V1 error format. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.aiplatform-v1",
-  "version": "0.0.20240925",
+  "version": "0.0.20241007",
   "description": "TypeScript typings for Vertex AI API v1",
   "repository": {
     "type": "git",