@maxim_mazurok/gapi.client.aiplatform-v1 0.0.20240830 → 0.0.20240916

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 +153 -6
  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: 20240830
12
+ // Revision: 20240916
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -70,6 +70,8 @@ declare namespace gapi.client {
70
70
  y2?: number;
71
71
  }
72
72
  interface CloudAiLargeModelsVisionRaiInfo {
73
+ /** List of blocked entities from the blocklist if it is detected. */
74
+ blockedEntities?: string[];
73
75
  /** The list of detected labels for different rai categories. */
74
76
  detectedLabels?: CloudAiLargeModelsVisionRaiInfoDetectedLabels[];
75
77
  /** The model name used to indexing into the RaiFilterConfig map. Would either be one of imagegeneration@002-006, imagen-3.0-... api endpoint names, or internal names used for mapping to different filter configs (genselfie, ai_watermark) than its api endpoint. */
@@ -548,6 +550,8 @@ declare namespace gapi.client {
548
550
  groundingMetadata?: GoogleCloudAiplatformV1GroundingMetadata;
549
551
  /** Output only. Index of the candidate. */
550
552
  index?: number;
553
+ /** Output only. Log-likelihood scores for the response tokens and top tokens */
554
+ logprobsResult?: GoogleCloudAiplatformV1LogprobsResult;
551
555
  /** Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. */
552
556
  safetyRatings?: GoogleCloudAiplatformV1SafetyRating[];
553
557
  }
@@ -701,6 +705,8 @@ declare namespace gapi.client {
701
705
  interface GoogleCloudAiplatformV1CountTokensRequest {
702
706
  /** Optional. Input content. */
703
707
  contents?: GoogleCloudAiplatformV1Content[];
708
+ /** Optional. Generation config that the model will use to generate the response. */
709
+ generationConfig?: GoogleCloudAiplatformV1GenerationConfig;
704
710
  /** Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. */
705
711
  instances?: any[];
706
712
  /** Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*‍/models/*` */
@@ -1117,6 +1123,8 @@ declare namespace gapi.client {
1117
1123
  indexSyncTime?: string;
1118
1124
  /** Output only. Provides paths for users to send requests directly to the deployed index services running on Cloud via private services access. This field is populated if network is configured. */
1119
1125
  privateEndpoints?: GoogleCloudAiplatformV1IndexPrivateEndpoints;
1126
+ /** Optional. If set for PSC deployed index, PSC connection will be automatically created after deployment is done and the endpoint information is populated in private_endpoints.psc_automated_endpoints. */
1127
+ pscAutomationConfigs?: GoogleCloudAiplatformV1PSCAutomationConfig[];
1120
1128
  /** Optional. A list of reserved ip ranges under the VPC network that can be used for this DeployedIndex. If set, we will deploy the index within the provided ip ranges. Otherwise, the index might be deployed to any ip ranges under the provided VPC network. The value should be the name of the address (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) Example: ['vertex-ai-ip-range']. For more information about subnets and network IP ranges, please see https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges. */
1121
1129
  reservedIpRanges?: string[];
1122
1130
  }
@@ -1858,7 +1866,7 @@ declare namespace gapi.client {
1858
1866
  interface GoogleCloudAiplatformV1FeatureGroupBigQuery {
1859
1867
  /** Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View. */
1860
1868
  bigQuerySource?: GoogleCloudAiplatformV1BigQuerySource;
1861
- /** Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema (entity_id, feature_timestamp, f0, f1) and values (e1, 2020-01-01T10:00:00.123Z, 10, 15) (e1, 2020-02-01T10:00:00.123Z, 20, null) If dense is set, (e1, 20, null) is synced to online stores. If dense is not set, (e1, 20, 15) is synced to online stores. */
1869
+ /** Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema `(entity_id, feature_timestamp, f0, f1)` and the following rows: `(e1, 2020-01-01T10:00:00.123Z, 10, 15)` `(e1, 2020-02-01T10:00:00.123Z, 20, null)` If dense is set, `(e1, 20, null)` is synced to online stores. If dense is not set, `(e1, 20, 15)` is synced to online stores. */
1862
1870
  dense?: boolean;
1863
1871
  /** Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. */
1864
1872
  entityIdColumns?: string[];
@@ -2166,7 +2174,7 @@ declare namespace gapi.client {
2166
2174
  interface GoogleCloudAiplatformV1FeatureViewVertexRagSource {
2167
2175
  /** Optional. The RAG corpus id corresponding to this FeatureView. */
2168
2176
  ragCorpusId?: string;
2169
- /** Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns at least: Field name Type Mode corpus_id STRING REQUIRED/NULLABLE file_id STRING REQUIRED/NULLABLE chunk_id STRING REQUIRED/NULLABLE chunk_data_type STRING REQUIRED/NULLABLE chunk_data STRING REQUIRED/NULLABLE embeddings FLOAT REPEATED file_original_uri STRING REQUIRED/NULLABLE */
2177
+ /** Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns and types at least: - `corpus_id` (STRING, NULLABLE/REQUIRED) - `file_id` (STRING, NULLABLE/REQUIRED) - `chunk_id` (STRING, NULLABLE/REQUIRED) - `chunk_data_type` (STRING, NULLABLE/REQUIRED) - `chunk_data` (STRING, NULLABLE/REQUIRED) - `embeddings` (FLOAT, REPEATED) - `file_original_uri` (STRING, NULLABLE/REQUIRED) */
2170
2178
  uri?: string;
2171
2179
  }
2172
2180
  interface GoogleCloudAiplatformV1FetchFeatureValuesRequest {
@@ -2346,6 +2354,8 @@ declare namespace gapi.client {
2346
2354
  contents?: GoogleCloudAiplatformV1Content[];
2347
2355
  /** Optional. Generation config. */
2348
2356
  generationConfig?: GoogleCloudAiplatformV1GenerationConfig;
2357
+ /** Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. */
2358
+ labels?: {[P in string]: string};
2349
2359
  /** Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. */
2350
2360
  safetySettings?: GoogleCloudAiplatformV1SafetySetting[];
2351
2361
  /** 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. */
@@ -2358,6 +2368,8 @@ declare namespace gapi.client {
2358
2368
  interface GoogleCloudAiplatformV1GenerateContentResponse {
2359
2369
  /** Output only. Generated candidates. */
2360
2370
  candidates?: GoogleCloudAiplatformV1Candidate[];
2371
+ /** Output only. The model version used to generate the response. */
2372
+ modelVersion?: string;
2361
2373
  /** Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. */
2362
2374
  promptFeedback?: GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback;
2363
2375
  /** Usage metadata about the response(s). */
@@ -2384,10 +2396,14 @@ declare namespace gapi.client {
2384
2396
  candidateCount?: number;
2385
2397
  /** Optional. Frequency penalties. */
2386
2398
  frequencyPenalty?: number;
2399
+ /** Optional. Logit probabilities. */
2400
+ logprobs?: number;
2387
2401
  /** Optional. The maximum number of output tokens to generate per message. */
2388
2402
  maxOutputTokens?: number;
2389
2403
  /** Optional. Positive penalties. */
2390
2404
  presencePenalty?: number;
2405
+ /** Optional. If true, export the logprobs results in response. */
2406
+ responseLogprobs?: boolean;
2391
2407
  /** 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. */
2392
2408
  responseMimeType?: string;
2393
2409
  /** 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. */
@@ -3070,6 +3086,24 @@ declare namespace gapi.client {
3070
3086
  /** List of TuningJobs in the requested page. */
3071
3087
  tuningJobs?: GoogleCloudAiplatformV1TuningJob[];
3072
3088
  }
3089
+ interface GoogleCloudAiplatformV1LogprobsResult {
3090
+ /** Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. */
3091
+ chosenCandidates?: GoogleCloudAiplatformV1LogprobsResultCandidate[];
3092
+ /** Length = total number of decoding steps. */
3093
+ topCandidates?: GoogleCloudAiplatformV1LogprobsResultTopCandidates[];
3094
+ }
3095
+ interface GoogleCloudAiplatformV1LogprobsResultCandidate {
3096
+ /** The candidate's log probability. */
3097
+ logProbability?: number;
3098
+ /** The candidate’s token string value. */
3099
+ token?: string;
3100
+ /** The candidate’s token id value. */
3101
+ tokenId?: number;
3102
+ }
3103
+ interface GoogleCloudAiplatformV1LogprobsResultTopCandidates {
3104
+ /** Sorted by log probability in descending order. */
3105
+ candidates?: GoogleCloudAiplatformV1LogprobsResultCandidate[];
3106
+ }
3073
3107
  interface GoogleCloudAiplatformV1LookupStudyRequest {
3074
3108
  /** Required. The user-defined display name of the Study */
3075
3109
  displayName?: string;
@@ -4406,6 +4440,12 @@ declare namespace gapi.client {
4406
4440
  /** Corresponding project_id in pscAutomationConfigs */
4407
4441
  projectId?: string;
4408
4442
  }
4443
+ interface GoogleCloudAiplatformV1PSCAutomationConfig {
4444
+ /** Required. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in '12345', and {network} is network name. */
4445
+ network?: string;
4446
+ /** Required. Project id used to create forwarding rule. */
4447
+ projectId?: string;
4448
+ }
4409
4449
  interface GoogleCloudAiplatformV1PublisherModel {
4410
4450
  /** Optional. Additional information about the model's Frameworks. */
4411
4451
  frameworks?: string[];
@@ -4826,6 +4866,16 @@ declare namespace gapi.client {
4826
4866
  /** Number of times the user has read data within the Tensorboard. */
4827
4867
  viewCount?: string;
4828
4868
  }
4869
+ interface GoogleCloudAiplatformV1RebaseTunedModelRequest {
4870
+ /** Optional. The Google Cloud Storage location to write the artifacts. */
4871
+ artifactDestination?: GoogleCloudAiplatformV1GcsDestination;
4872
+ /** Optional. By default, bison to gemini migration will always create new model/endpoint, but for gemini-1.0 to gemini-1.5 migration, we default deploy to the same endpoint. See details in this Section. */
4873
+ deployToSameEndpoint?: boolean;
4874
+ /** Required. TunedModel reference to retrieve the legacy model information. */
4875
+ tunedModelRef?: GoogleCloudAiplatformV1TunedModelRef;
4876
+ /** Optional. The TuningJob to be updated. Users can use this TuningJob field to overwrite tuning configs. */
4877
+ tuningJob?: GoogleCloudAiplatformV1TuningJob;
4878
+ }
4829
4879
  interface GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata {
4830
4880
  /** Operation metadata for PersistentResource. */
4831
4881
  genericMetadata?: GoogleCloudAiplatformV1GenericOperationMetadata;
@@ -5079,6 +5129,8 @@ declare namespace gapi.client {
5079
5129
  timeout?: string;
5080
5130
  }
5081
5131
  interface GoogleCloudAiplatformV1Schema {
5132
+ /** Optional. The value should be validated against any (one or more) of the subschemas in the list. */
5133
+ anyOf?: GoogleCloudAiplatformV1Schema[];
5082
5134
  /** Optional. Default value of the data. */
5083
5135
  default?: any;
5084
5136
  /** Optional. The description of the data. */
@@ -5113,6 +5165,8 @@ declare namespace gapi.client {
5113
5165
  pattern?: string;
5114
5166
  /** Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. */
5115
5167
  properties?: {[P in string]: GoogleCloudAiplatformV1Schema};
5168
+ /** Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. */
5169
+ propertyOrdering?: string[];
5116
5170
  /** Optional. Required properties of Type.OBJECT. */
5117
5171
  required?: string[];
5118
5172
  /** Optional. The title of the Schema. */
@@ -7126,7 +7180,7 @@ declare namespace gapi.client {
7126
7180
  tokens?: string[];
7127
7181
  }
7128
7182
  interface GoogleCloudAiplatformV1Tool {
7129
- /** 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. */
7183
+ /** 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. */
7130
7184
  functionDeclarations?: GoogleCloudAiplatformV1FunctionDeclaration[];
7131
7185
  /** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
7132
7186
  googleSearchRetrieval?: any;
@@ -7308,6 +7362,14 @@ declare namespace gapi.client {
7308
7362
  /** Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}`. */
7309
7363
  model?: string;
7310
7364
  }
7365
+ interface GoogleCloudAiplatformV1TunedModelRef {
7366
+ /** Support migration from tuning job list page, from bison model to gemini model. */
7367
+ pipelineJob?: string;
7368
+ /** Support migration from model registry. */
7369
+ tunedModel?: string;
7370
+ /** Support migration from tuning job list page, from gemini-1.0-pro-002 to 1.5 and above. */
7371
+ tuningJob?: string;
7372
+ }
7311
7373
  interface GoogleCloudAiplatformV1TuningDataStats {
7312
7374
  /** The SFT Tuning data stats. */
7313
7375
  supervisedTuningDataStats?: GoogleCloudAiplatformV1SupervisedTuningDataStats;
@@ -12834,7 +12896,7 @@ declare namespace gapi.client {
12834
12896
  alt?: string;
12835
12897
  /** JSONP */
12836
12898
  callback?: string;
12837
- /** Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. */
12899
+ /** Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup'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 the project and location. */
12838
12900
  featureGroupId?: string;
12839
12901
  /** Selector specifying which fields to include in a partial response. */
12840
12902
  fields?: string;
@@ -12865,7 +12927,7 @@ declare namespace gapi.client {
12865
12927
  alt?: string;
12866
12928
  /** JSONP */
12867
12929
  callback?: string;
12868
- /** Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. */
12930
+ /** Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup'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 the project and location. */
12869
12931
  featureGroupId?: string;
12870
12932
  /** Selector specifying which fields to include in a partial response. */
12871
12933
  fields?: string;
@@ -28347,6 +28409,33 @@ declare namespace gapi.client {
28347
28409
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
28348
28410
  uploadType?: string;
28349
28411
  }): Request<{}>;
28412
+ /** Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. */
28413
+ delete(request?: {
28414
+ /** V1 error format. */
28415
+ '$.xgafv'?: string;
28416
+ /** OAuth access token. */
28417
+ access_token?: string;
28418
+ /** Data format for response. */
28419
+ alt?: string;
28420
+ /** JSONP */
28421
+ callback?: string;
28422
+ /** Selector specifying which fields to include in a partial response. */
28423
+ fields?: string;
28424
+ /** 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. */
28425
+ key?: string;
28426
+ /** The name of the operation resource to be deleted. */
28427
+ name: string;
28428
+ /** OAuth 2.0 token for the current user. */
28429
+ oauth_token?: string;
28430
+ /** Returns response with indentations and line breaks. */
28431
+ prettyPrint?: boolean;
28432
+ /** 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. */
28433
+ quotaUser?: string;
28434
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
28435
+ upload_protocol?: string;
28436
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
28437
+ uploadType?: string;
28438
+ }): Request<{}>;
28350
28439
  /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
28351
28440
  get(request?: {
28352
28441
  /** V1 error format. */
@@ -28585,6 +28674,64 @@ declare namespace gapi.client {
28585
28674
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
28586
28675
  uploadType?: string;
28587
28676
  }): Request<GoogleCloudAiplatformV1ListTuningJobsResponse>;
28677
+ /** Rebase a TunedModel. */
28678
+ rebaseTunedModel(request: {
28679
+ /** V1 error format. */
28680
+ '$.xgafv'?: string;
28681
+ /** OAuth access token. */
28682
+ access_token?: string;
28683
+ /** Data format for response. */
28684
+ alt?: string;
28685
+ /** JSONP */
28686
+ callback?: string;
28687
+ /** Selector specifying which fields to include in a partial response. */
28688
+ fields?: string;
28689
+ /** 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. */
28690
+ key?: string;
28691
+ /** OAuth 2.0 token for the current user. */
28692
+ oauth_token?: string;
28693
+ /** Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project}/locations/{location}` */
28694
+ parent: string;
28695
+ /** Returns response with indentations and line breaks. */
28696
+ prettyPrint?: boolean;
28697
+ /** 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. */
28698
+ quotaUser?: string;
28699
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
28700
+ upload_protocol?: string;
28701
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
28702
+ uploadType?: string;
28703
+ /** Request body */
28704
+ resource: GoogleCloudAiplatformV1RebaseTunedModelRequest;
28705
+ }): Request<GoogleLongrunningOperation>;
28706
+ rebaseTunedModel(
28707
+ request: {
28708
+ /** V1 error format. */
28709
+ '$.xgafv'?: string;
28710
+ /** OAuth access token. */
28711
+ access_token?: string;
28712
+ /** Data format for response. */
28713
+ alt?: string;
28714
+ /** JSONP */
28715
+ callback?: string;
28716
+ /** Selector specifying which fields to include in a partial response. */
28717
+ fields?: string;
28718
+ /** 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. */
28719
+ key?: string;
28720
+ /** OAuth 2.0 token for the current user. */
28721
+ oauth_token?: string;
28722
+ /** Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project}/locations/{location}` */
28723
+ parent: string;
28724
+ /** Returns response with indentations and line breaks. */
28725
+ prettyPrint?: boolean;
28726
+ /** 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. */
28727
+ quotaUser?: string;
28728
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
28729
+ upload_protocol?: string;
28730
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
28731
+ uploadType?: string;
28732
+ },
28733
+ body: GoogleCloudAiplatformV1RebaseTunedModelRequest
28734
+ ): Request<GoogleLongrunningOperation>;
28588
28735
  operations: OperationsResource;
28589
28736
  }
28590
28737
  interface LocationsResource {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.aiplatform-v1",
3
- "version": "0.0.20240830",
3
+ "version": "0.0.20240916",
4
4
  "description": "TypeScript typings for Vertex AI API v1",
5
5
  "repository": {
6
6
  "type": "git",