@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20240907 → 0.0.20240923

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 -2
  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=v1beta1
12
- // Revision: 20240907
12
+ // Revision: 20240923
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -692,6 +692,8 @@ declare namespace gapi.client {
692
692
  groundingMetadata?: GoogleCloudAiplatformV1beta1GroundingMetadata;
693
693
  /** Output only. Index of the candidate. */
694
694
  index?: number;
695
+ /** Output only. Log-likelihood scores for the response tokens and top tokens */
696
+ logprobsResult?: GoogleCloudAiplatformV1beta1LogprobsResult;
695
697
  /** Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. */
696
698
  safetyRatings?: GoogleCloudAiplatformV1beta1SafetyRating[];
697
699
  }
@@ -2436,6 +2438,8 @@ declare namespace gapi.client {
2436
2438
  labels?: {[P in string]: string};
2437
2439
  /** Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` */
2438
2440
  name?: string;
2441
+ /** Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore. */
2442
+ optimizedConfig?: GoogleCloudAiplatformV1beta1FeatureViewOptimizedConfig;
2439
2443
  /** Output only. Reserved for future use. */
2440
2444
  satisfiesPzi?: boolean;
2441
2445
  /** Output only. Reserved for future use. */
@@ -2502,6 +2506,10 @@ declare namespace gapi.client {
2502
2506
  /** Optional. Number of embeddings on each leaf node. The default value is 1000 if not set. */
2503
2507
  leafNodeEmbeddingCount?: string;
2504
2508
  }
2509
+ interface GoogleCloudAiplatformV1beta1FeatureViewOptimizedConfig {
2510
+ /** Optional. A description of resources that the FeatureView uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2. If max_replica_count is not set, the default value is 6. The max allowed replica count is 1000. */
2511
+ automaticResources?: GoogleCloudAiplatformV1beta1AutomaticResources;
2512
+ }
2505
2513
  interface GoogleCloudAiplatformV1beta1FeatureViewSync {
2506
2514
  /** Output only. Time when this FeatureViewSync is created. Creation of a FeatureViewSync means that the job is pending / waiting for sufficient resources but may not have started the actual data transfer yet. */
2507
2515
  createTime?: string;
@@ -2774,6 +2782,8 @@ declare namespace gapi.client {
2774
2782
  interface GoogleCloudAiplatformV1beta1GenerateContentResponse {
2775
2783
  /** Output only. Generated candidates. */
2776
2784
  candidates?: GoogleCloudAiplatformV1beta1Candidate[];
2785
+ /** Output only. The model version used to generate the response. */
2786
+ modelVersion?: string;
2777
2787
  /** 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. */
2778
2788
  promptFeedback?: GoogleCloudAiplatformV1beta1GenerateContentResponsePromptFeedback;
2779
2789
  /** Usage metadata about the response(s). */
@@ -2810,10 +2820,14 @@ declare namespace gapi.client {
2810
2820
  candidateCount?: number;
2811
2821
  /** Optional. Frequency penalties. */
2812
2822
  frequencyPenalty?: number;
2823
+ /** Optional. Logit probabilities. */
2824
+ logprobs?: number;
2813
2825
  /** Optional. The maximum number of output tokens to generate per message. */
2814
2826
  maxOutputTokens?: number;
2815
2827
  /** Optional. Positive penalties. */
2816
2828
  presencePenalty?: number;
2829
+ /** Optional. If true, export the logprobs results in response. */
2830
+ responseLogprobs?: boolean;
2817
2831
  /** 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. */
2818
2832
  responseMimeType?: string;
2819
2833
  /** 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. */
@@ -3067,6 +3081,8 @@ declare namespace gapi.client {
3067
3081
  ragFileChunkingConfig?: GoogleCloudAiplatformV1beta1RagFileChunkingConfig;
3068
3082
  /** Specifies the parsing config for RagFiles. */
3069
3083
  ragFileParsingConfig?: GoogleCloudAiplatformV1beta1RagFileParsingConfig;
3084
+ /** SharePoint sources. */
3085
+ sharePointSources?: GoogleCloudAiplatformV1beta1SharePointSources;
3070
3086
  /** Slack channels with their corresponding access tokens. */
3071
3087
  slackSource?: GoogleCloudAiplatformV1beta1SlackSource;
3072
3088
  }
@@ -3606,6 +3622,24 @@ declare namespace gapi.client {
3606
3622
  /** List of TuningJobs in the requested page. */
3607
3623
  tuningJobs?: GoogleCloudAiplatformV1beta1TuningJob[];
3608
3624
  }
3625
+ interface GoogleCloudAiplatformV1beta1LogprobsResult {
3626
+ /** Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. */
3627
+ chosenCandidates?: GoogleCloudAiplatformV1beta1LogprobsResultCandidate[];
3628
+ /** Length = total number of decoding steps. */
3629
+ topCandidates?: GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates[];
3630
+ }
3631
+ interface GoogleCloudAiplatformV1beta1LogprobsResultCandidate {
3632
+ /** The candidate's log probability. */
3633
+ logProbability?: number;
3634
+ /** The candidate’s token string value. */
3635
+ token?: string;
3636
+ /** The candidate’s token id value. */
3637
+ tokenId?: number;
3638
+ }
3639
+ interface GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates {
3640
+ /** Sorted by log probability in descending order. */
3641
+ candidates?: GoogleCloudAiplatformV1beta1LogprobsResultCandidate[];
3642
+ }
3609
3643
  interface GoogleCloudAiplatformV1beta1LookupStudyRequest {
3610
3644
  /** Required. The user-defined display name of the Study */
3611
3645
  displayName?: string;
@@ -5244,6 +5278,8 @@ declare namespace gapi.client {
5244
5278
  interface GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig {
5245
5279
  /** Required. If true, expose the IndexEndpoint via private service connect. */
5246
5280
  enablePrivateServiceConnect?: boolean;
5281
+ /** Optional. If set to true, enable secure private service connect with IAM authorization. Otherwise, private service connect will be done without authorization. Note latency will be slightly increased if authorization is enabled. */
5282
+ enableSecurePrivateServiceConnect?: boolean;
5247
5283
  /** A list of Projects from which the forwarding rule will target the service attachment. */
5248
5284
  projectAllowlist?: string[];
5249
5285
  /** Output only. The name of the generated service attachment resource. This is only populated if the endpoint is deployed with PrivateServiceConnect. */
@@ -5714,6 +5750,8 @@ declare namespace gapi.client {
5714
5750
  name?: string;
5715
5751
  /** Output only. The type of the RagFile. */
5716
5752
  ragFileType?: string;
5753
+ /** The RagFile is imported from a SharePoint source. */
5754
+ sharePointSources?: GoogleCloudAiplatformV1beta1SharePointSources;
5717
5755
  /** Output only. The size of the RagFile in bytes. */
5718
5756
  sizeBytes?: string;
5719
5757
  /** The RagFile is imported from a Slack channel. */
@@ -5906,6 +5944,16 @@ declare namespace gapi.client {
5906
5944
  /** Optional. The Cloud Storage URI of the `requirements.txt` file */
5907
5945
  requirementsGcsUri?: string;
5908
5946
  }
5947
+ interface GoogleCloudAiplatformV1beta1RebaseTunedModelRequest {
5948
+ /** Optional. The Google Cloud Storage location to write the artifacts. */
5949
+ artifactDestination?: GoogleCloudAiplatformV1beta1GcsDestination;
5950
+ /** 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. */
5951
+ deployToSameEndpoint?: boolean;
5952
+ /** Required. TunedModel reference to retrieve the legacy model information. */
5953
+ tunedModelRef?: GoogleCloudAiplatformV1beta1TunedModelRef;
5954
+ /** Optional. The TuningJob to be updated. Users can use this TuningJob field to overwrite tuning configs. */
5955
+ tuningJob?: GoogleCloudAiplatformV1beta1TuningJob;
5956
+ }
5909
5957
  interface GoogleCloudAiplatformV1beta1RebootPersistentResourceOperationMetadata {
5910
5958
  /** Operation metadata for PersistentResource. */
5911
5959
  genericMetadata?: GoogleCloudAiplatformV1beta1GenericOperationMetadata;
@@ -6246,6 +6294,8 @@ declare namespace gapi.client {
6246
6294
  timeout?: string;
6247
6295
  }
6248
6296
  interface GoogleCloudAiplatformV1beta1Schema {
6297
+ /** Optional. The value should be validated against any (one or more) of the subschemas in the list. */
6298
+ anyOf?: GoogleCloudAiplatformV1beta1Schema[];
6249
6299
  /** Optional. Default value of the data. */
6250
6300
  default?: any;
6251
6301
  /** Optional. The description of the data. */
@@ -7693,6 +7743,30 @@ declare namespace gapi.client {
7693
7743
  /** Optional. Required when all below conditions are met * `enable_custom_service_account` is true; * any runtime is specified via `ResourceRuntimeSpec` on creation time, for example, Ray The users must have `iam.serviceAccounts.actAs` permission on this service account and then the specified runtime containers will run as it. Do not set this field if you want to submit jobs using custom service account to this PersistentResource after creation, but only specify the `service_account` inside the job. */
7694
7744
  serviceAccount?: string;
7695
7745
  }
7746
+ interface GoogleCloudAiplatformV1beta1SharePointSources {
7747
+ /** The SharePoint sources. */
7748
+ sharePointSources?: GoogleCloudAiplatformV1beta1SharePointSourcesSharePointSource[];
7749
+ }
7750
+ interface GoogleCloudAiplatformV1beta1SharePointSourcesSharePointSource {
7751
+ /** The Application ID for the app registered in Microsoft Azure Portal. The application must also be configured with MS Graph permissions "Files.ReadAll", "Sites.ReadAll" and BrowserSiteLists.Read.All. */
7752
+ clientId?: string;
7753
+ /** The application secret for the app registered in Azure. */
7754
+ clientSecret?: GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig;
7755
+ /** The ID of the drive to download from. */
7756
+ driveId?: string;
7757
+ /** The name of the drive to download from. */
7758
+ driveName?: string;
7759
+ /** Output only. The SharePoint file id. Output only. */
7760
+ fileId?: string;
7761
+ /** The ID of the SharePoint folder to download from. */
7762
+ sharepointFolderId?: string;
7763
+ /** The path of the SharePoint folder to download from. */
7764
+ sharepointFolderPath?: string;
7765
+ /** The name of the SharePoint site to download from. This can be the site name or the site id. */
7766
+ sharepointSiteName?: string;
7767
+ /** Unique identifier of the Azure Active Directory Instance. */
7768
+ tenantId?: string;
7769
+ }
7696
7770
  interface GoogleCloudAiplatformV1beta1ShieldedVmConfig {
7697
7771
  /** Defines whether the instance has [Secure Boot](https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot) enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. */
7698
7772
  enableSecureBoot?: boolean;
@@ -8354,7 +8428,7 @@ declare namespace gapi.client {
8354
8428
  tokens?: string[];
8355
8429
  }
8356
8430
  interface GoogleCloudAiplatformV1beta1Tool {
8357
- /** 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. */
8431
+ /** 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. */
8358
8432
  functionDeclarations?: GoogleCloudAiplatformV1beta1FunctionDeclaration[];
8359
8433
  /** Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. */
8360
8434
  googleSearchRetrieval?: any;
@@ -8558,6 +8632,14 @@ declare namespace gapi.client {
8558
8632
  /** Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}`. */
8559
8633
  model?: string;
8560
8634
  }
8635
+ interface GoogleCloudAiplatformV1beta1TunedModelRef {
8636
+ /** Support migration from tuning job list page, from bison model to gemini model. */
8637
+ pipelineJob?: string;
8638
+ /** Support migration from model registry. */
8639
+ tunedModel?: string;
8640
+ /** Support migration from tuning job list page, from gemini-1.0-pro-002 to 1.5 and above. */
8641
+ tuningJob?: string;
8642
+ }
8561
8643
  interface GoogleCloudAiplatformV1beta1TuningDataStats {
8562
8644
  /** Output only. Statistics for distillation. */
8563
8645
  distillationDataStats?: GoogleCloudAiplatformV1beta1DistillationDataStats;
@@ -33457,6 +33539,35 @@ declare namespace gapi.client {
33457
33539
  }): Request<GoogleCloudAiplatformV1beta1ListTrainingPipelinesResponse>;
33458
33540
  operations: OperationsResource;
33459
33541
  }
33542
+ interface OperationsResource {
33543
+ /** 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`. */
33544
+ delete(request?: {
33545
+ /** V1 error format. */
33546
+ '$.xgafv'?: string;
33547
+ /** OAuth access token. */
33548
+ access_token?: string;
33549
+ /** Data format for response. */
33550
+ alt?: string;
33551
+ /** JSONP */
33552
+ callback?: string;
33553
+ /** Selector specifying which fields to include in a partial response. */
33554
+ fields?: string;
33555
+ /** 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. */
33556
+ key?: string;
33557
+ /** The name of the operation resource to be deleted. */
33558
+ name: string;
33559
+ /** OAuth 2.0 token for the current user. */
33560
+ oauth_token?: string;
33561
+ /** Returns response with indentations and line breaks. */
33562
+ prettyPrint?: boolean;
33563
+ /** 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. */
33564
+ quotaUser?: string;
33565
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
33566
+ upload_protocol?: string;
33567
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
33568
+ uploadType?: string;
33569
+ }): Request<{}>;
33570
+ }
33460
33571
  interface TuningJobsResource {
33461
33572
  /** Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`. */
33462
33573
  cancel(request: {
@@ -33634,6 +33745,65 @@ declare namespace gapi.client {
33634
33745
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
33635
33746
  uploadType?: string;
33636
33747
  }): Request<GoogleCloudAiplatformV1beta1ListTuningJobsResponse>;
33748
+ /** Rebase a TunedModel. */
33749
+ rebaseTunedModel(request: {
33750
+ /** V1 error format. */
33751
+ '$.xgafv'?: string;
33752
+ /** OAuth access token. */
33753
+ access_token?: string;
33754
+ /** Data format for response. */
33755
+ alt?: string;
33756
+ /** JSONP */
33757
+ callback?: string;
33758
+ /** Selector specifying which fields to include in a partial response. */
33759
+ fields?: string;
33760
+ /** 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. */
33761
+ key?: string;
33762
+ /** OAuth 2.0 token for the current user. */
33763
+ oauth_token?: string;
33764
+ /** Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project}/locations/{location}` */
33765
+ parent: string;
33766
+ /** Returns response with indentations and line breaks. */
33767
+ prettyPrint?: boolean;
33768
+ /** 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. */
33769
+ quotaUser?: string;
33770
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
33771
+ upload_protocol?: string;
33772
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
33773
+ uploadType?: string;
33774
+ /** Request body */
33775
+ resource: GoogleCloudAiplatformV1beta1RebaseTunedModelRequest;
33776
+ }): Request<GoogleLongrunningOperation>;
33777
+ rebaseTunedModel(
33778
+ request: {
33779
+ /** V1 error format. */
33780
+ '$.xgafv'?: string;
33781
+ /** OAuth access token. */
33782
+ access_token?: string;
33783
+ /** Data format for response. */
33784
+ alt?: string;
33785
+ /** JSONP */
33786
+ callback?: string;
33787
+ /** Selector specifying which fields to include in a partial response. */
33788
+ fields?: string;
33789
+ /** 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. */
33790
+ key?: string;
33791
+ /** OAuth 2.0 token for the current user. */
33792
+ oauth_token?: string;
33793
+ /** Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project}/locations/{location}` */
33794
+ parent: string;
33795
+ /** Returns response with indentations and line breaks. */
33796
+ prettyPrint?: boolean;
33797
+ /** 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. */
33798
+ quotaUser?: string;
33799
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
33800
+ upload_protocol?: string;
33801
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
33802
+ uploadType?: string;
33803
+ },
33804
+ body: GoogleCloudAiplatformV1beta1RebaseTunedModelRequest
33805
+ ): Request<GoogleLongrunningOperation>;
33806
+ operations: OperationsResource;
33637
33807
  }
33638
33808
  interface LocationsResource {
33639
33809
  /** Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.aiplatform-v1beta1",
3
- "version": "0.0.20240907",
3
+ "version": "0.0.20240923",
4
4
  "description": "TypeScript typings for Vertex AI API v1beta1",
5
5
  "repository": {
6
6
  "type": "git",