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

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 +81 -5
  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: 20240925
12
+ // Revision: 20241001
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -1266,6 +1266,12 @@ declare namespace gapi.client {
1266
1266
  /** A list of double values. */
1267
1267
  values?: number[];
1268
1268
  }
1269
+ interface GoogleCloudAiplatformV1DynamicRetrievalConfig {
1270
+ /** Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. */
1271
+ dynamicThreshold?: number;
1272
+ /** The mode of the predictor to be used in dynamic retrieval. */
1273
+ mode?: string;
1274
+ }
1269
1275
  interface GoogleCloudAiplatformV1EncryptionSpec {
1270
1276
  /** 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. */
1271
1277
  kmsKeyName?: string;
@@ -2447,7 +2453,10 @@ declare namespace gapi.client {
2447
2453
  /** Required. The public base model URI. */
2448
2454
  baseModelUri?: string;
2449
2455
  }
2450
- interface GoogleCloudAiplatformV1GoogleSearchRetrieval {}
2456
+ interface GoogleCloudAiplatformV1GoogleSearchRetrieval {
2457
+ /** Specifies the dynamic retrieval configuration for the given source. */
2458
+ dynamicRetrievalConfig?: GoogleCloudAiplatformV1DynamicRetrievalConfig;
2459
+ }
2451
2460
  interface GoogleCloudAiplatformV1GroundednessInput {
2452
2461
  /** Required. Groundedness instance. */
2453
2462
  instance?: GoogleCloudAiplatformV1GroundednessInstance;
@@ -2495,6 +2504,8 @@ declare namespace gapi.client {
2495
2504
  groundingChunks?: GoogleCloudAiplatformV1GroundingChunk[];
2496
2505
  /** Optional. List of grounding support. */
2497
2506
  groundingSupports?: GoogleCloudAiplatformV1GroundingSupport[];
2507
+ /** Optional. Output only. Retrieval metadata. */
2508
+ retrievalMetadata?: GoogleCloudAiplatformV1RetrievalMetadata;
2498
2509
  /** Optional. Google search entry for the following-up web searches. */
2499
2510
  searchEntryPoint?: GoogleCloudAiplatformV1SearchEntryPoint;
2500
2511
  /** Optional. Web search queries for the following-up web search. */
@@ -3095,9 +3106,9 @@ declare namespace gapi.client {
3095
3106
  interface GoogleCloudAiplatformV1LogprobsResultCandidate {
3096
3107
  /** The candidate's log probability. */
3097
3108
  logProbability?: number;
3098
- /** The candidates token string value. */
3109
+ /** The candidate's token string value. */
3099
3110
  token?: string;
3100
- /** The candidates token id value. */
3111
+ /** The candidate's token id value. */
3101
3112
  tokenId?: number;
3102
3113
  }
3103
3114
  interface GoogleCloudAiplatformV1LogprobsResultTopCandidates {
@@ -4952,6 +4963,10 @@ declare namespace gapi.client {
4952
4963
  /** Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. */
4953
4964
  vertexRagStore?: GoogleCloudAiplatformV1VertexRagStore;
4954
4965
  }
4966
+ interface GoogleCloudAiplatformV1RetrievalMetadata {
4967
+ /** 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. */
4968
+ googleSearchDynamicRetrievalScore?: number;
4969
+ }
4955
4970
  interface GoogleCloudAiplatformV1RougeInput {
4956
4971
  /** Required. Repeated rouge instances. */
4957
4972
  instances?: GoogleCloudAiplatformV1RougeInstance[];
@@ -7189,7 +7204,7 @@ declare namespace gapi.client {
7189
7204
  /** 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. */
7190
7205
  functionDeclarations?: GoogleCloudAiplatformV1FunctionDeclaration[];
7191
7206
  /** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
7192
- googleSearchRetrieval?: any;
7207
+ googleSearchRetrieval?: GoogleCloudAiplatformV1GoogleSearchRetrieval;
7193
7208
  /** 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. */
7194
7209
  retrieval?: GoogleCloudAiplatformV1Retrieval;
7195
7210
  }
@@ -11260,6 +11275,66 @@ declare namespace gapi.client {
11260
11275
  }): Request<GoogleCloudAiplatformV1QueryDeployedModelsResponse>;
11261
11276
  operations: OperationsResource;
11262
11277
  }
11278
+ interface ChatResource {
11279
+ /** Exposes an OpenAI-compatible endpoint for chat completions. */
11280
+ completions(request: {
11281
+ /** V1 error format. */
11282
+ '$.xgafv'?: string;
11283
+ /** OAuth access token. */
11284
+ access_token?: string;
11285
+ /** Data format for response. */
11286
+ alt?: string;
11287
+ /** JSONP */
11288
+ callback?: string;
11289
+ /** Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` */
11290
+ endpoint: string;
11291
+ /** Selector specifying which fields to include in a partial response. */
11292
+ fields?: string;
11293
+ /** 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. */
11294
+ key?: string;
11295
+ /** OAuth 2.0 token for the current user. */
11296
+ oauth_token?: string;
11297
+ /** Returns response with indentations and line breaks. */
11298
+ prettyPrint?: boolean;
11299
+ /** 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. */
11300
+ quotaUser?: string;
11301
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
11302
+ upload_protocol?: string;
11303
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
11304
+ uploadType?: string;
11305
+ /** Request body */
11306
+ resource: GoogleApiHttpBody;
11307
+ }): Request<GoogleApiHttpBody>;
11308
+ completions(
11309
+ request: {
11310
+ /** V1 error format. */
11311
+ '$.xgafv'?: string;
11312
+ /** OAuth access token. */
11313
+ access_token?: string;
11314
+ /** Data format for response. */
11315
+ alt?: string;
11316
+ /** JSONP */
11317
+ callback?: string;
11318
+ /** Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` */
11319
+ endpoint: string;
11320
+ /** Selector specifying which fields to include in a partial response. */
11321
+ fields?: string;
11322
+ /** 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. */
11323
+ key?: string;
11324
+ /** OAuth 2.0 token for the current user. */
11325
+ oauth_token?: string;
11326
+ /** Returns response with indentations and line breaks. */
11327
+ prettyPrint?: boolean;
11328
+ /** 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. */
11329
+ quotaUser?: string;
11330
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
11331
+ upload_protocol?: string;
11332
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
11333
+ uploadType?: string;
11334
+ },
11335
+ body: GoogleApiHttpBody
11336
+ ): Request<GoogleApiHttpBody>;
11337
+ }
11263
11338
  interface OperationsResource {
11264
11339
  /** 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`. */
11265
11340
  cancel(request?: {
@@ -12433,6 +12508,7 @@ declare namespace gapi.client {
12433
12508
  },
12434
12509
  body: GoogleCloudAiplatformV1UndeployModelRequest
12435
12510
  ): Request<GoogleLongrunningOperation>;
12511
+ chat: ChatResource;
12436
12512
  operations: OperationsResource;
12437
12513
  }
12438
12514
  interface OperationsResource {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.aiplatform-v1",
3
- "version": "0.0.20240925",
3
+ "version": "0.0.20241001",
4
4
  "description": "TypeScript typings for Vertex AI API v1",
5
5
  "repository": {
6
6
  "type": "git",