@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20240618 → 0.0.20240628

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 +151 -8
  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: 20240618
12
+ // Revision: 20240628
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -547,7 +547,7 @@ declare namespace gapi.client {
547
547
  /** Required. Repeated bleu instances. */
548
548
  instances?: GoogleCloudAiplatformV1beta1BleuInstance[];
549
549
  /** Required. Spec for bleu score metric. */
550
- metricSpec?: any;
550
+ metricSpec?: GoogleCloudAiplatformV1beta1BleuSpec;
551
551
  }
552
552
  interface GoogleCloudAiplatformV1beta1BleuInstance {
553
553
  /** Required. Output of the evaluated model. */
@@ -563,7 +563,10 @@ declare namespace gapi.client {
563
563
  /** Output only. Bleu metric values. */
564
564
  bleuMetricValues?: GoogleCloudAiplatformV1beta1BleuMetricValue[];
565
565
  }
566
- interface GoogleCloudAiplatformV1beta1BleuSpec {}
566
+ interface GoogleCloudAiplatformV1beta1BleuSpec {
567
+ /** Optional. Whether to use_effective_order to compute bleu score. */
568
+ useEffectiveOrder?: boolean;
569
+ }
567
570
  interface GoogleCloudAiplatformV1beta1Blob {
568
571
  /** Required. Raw bytes. */
569
572
  data?: string;
@@ -704,8 +707,12 @@ declare namespace gapi.client {
704
707
  successfulForecastPointCount?: string;
705
708
  }
706
709
  interface GoogleCloudAiplatformV1beta1ComputeTokensRequest {
710
+ /** Required. Input content. */
711
+ contents?: GoogleCloudAiplatformV1beta1Content[];
707
712
  /** Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. */
708
713
  instances?: any[];
714
+ /** Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*‍/models/* */
715
+ model?: string;
709
716
  }
710
717
  interface GoogleCloudAiplatformV1beta1ComputeTokensResponse {
711
718
  /** Lists of tokens info from the input. A ComputeTokensRequest could have multiple instances with a prompt in each instance. We also need to return lists of tokens info for the request with multiple instances. */
@@ -2584,7 +2591,53 @@ declare namespace gapi.client {
2584
2591
  /** Optional. Which version to use for evaluation. */
2585
2592
  version?: number;
2586
2593
  }
2594
+ interface GoogleCloudAiplatformV1beta1GroundingAttribution {
2595
+ /** Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. */
2596
+ confidenceScore?: number;
2597
+ /** Optional. Attribution from context retrieved by the retrieval tools. */
2598
+ retrievedContext?: GoogleCloudAiplatformV1beta1GroundingAttributionRetrievedContext;
2599
+ /** Output only. Segment of the content this attribution belongs to. */
2600
+ segment?: GoogleCloudAiplatformV1beta1Segment;
2601
+ /** Optional. Attribution from the web. */
2602
+ web?: GoogleCloudAiplatformV1beta1GroundingAttributionWeb;
2603
+ }
2604
+ interface GoogleCloudAiplatformV1beta1GroundingAttributionRetrievedContext {
2605
+ /** Output only. Title of the attribution. */
2606
+ title?: string;
2607
+ /** Output only. URI reference of the attribution. */
2608
+ uri?: string;
2609
+ }
2610
+ interface GoogleCloudAiplatformV1beta1GroundingAttributionWeb {
2611
+ /** Output only. Title of the attribution. */
2612
+ title?: string;
2613
+ /** Output only. URI reference of the attribution. */
2614
+ uri?: string;
2615
+ }
2616
+ interface GoogleCloudAiplatformV1beta1GroundingChunk {
2617
+ /** Grounding chunk from context retrieved by the retrieval tools. */
2618
+ retrievedContext?: GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext;
2619
+ /** Grounding chunk from the web. */
2620
+ web?: GoogleCloudAiplatformV1beta1GroundingChunkWeb;
2621
+ }
2622
+ interface GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext {
2623
+ /** Title of the attribution. */
2624
+ title?: string;
2625
+ /** URI reference of the attribution. */
2626
+ uri?: string;
2627
+ }
2628
+ interface GoogleCloudAiplatformV1beta1GroundingChunkWeb {
2629
+ /** Title of the chunk. */
2630
+ title?: string;
2631
+ /** URI reference of the chunk. */
2632
+ uri?: string;
2633
+ }
2587
2634
  interface GoogleCloudAiplatformV1beta1GroundingMetadata {
2635
+ /** Optional. List of grounding attributions. */
2636
+ groundingAttributions?: GoogleCloudAiplatformV1beta1GroundingAttribution[];
2637
+ /** List of supporting references retrieved from specified grounding source. */
2638
+ groundingChunks?: GoogleCloudAiplatformV1beta1GroundingChunk[];
2639
+ /** Optional. List of grounding support. */
2640
+ groundingSupports?: GoogleCloudAiplatformV1beta1GroundingSupport[];
2588
2641
  /** Optional. Queries executed by the retrieval tools. */
2589
2642
  retrievalQueries?: string[];
2590
2643
  /** Optional. Google search entry for the following-up web searches. */
@@ -2592,6 +2645,14 @@ declare namespace gapi.client {
2592
2645
  /** Optional. Web search queries for the following-up web search. */
2593
2646
  webSearchQueries?: string[];
2594
2647
  }
2648
+ interface GoogleCloudAiplatformV1beta1GroundingSupport {
2649
+ /** Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. This list must have the same size as the grounding_chunk_indices. */
2650
+ confidenceScores?: number[];
2651
+ /** A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. */
2652
+ groundingChunkIndices?: number[];
2653
+ /** Segment of the content this support belongs to. */
2654
+ segment?: GoogleCloudAiplatformV1beta1Segment;
2655
+ }
2595
2656
  interface GoogleCloudAiplatformV1beta1HyperparameterTuningJob {
2596
2657
  /** Output only. Time when the HyperparameterTuningJob was created. */
2597
2658
  createTime?: string;
@@ -3437,6 +3498,10 @@ declare namespace gapi.client {
3437
3498
  originalModelInfo?: GoogleCloudAiplatformV1beta1ModelOriginalModelInfo;
3438
3499
  /** The schemata that describe formats of the Model's predictions and explanations as given and returned via PredictionService.Predict and PredictionService.Explain. */
3439
3500
  predictSchemata?: GoogleCloudAiplatformV1beta1PredictSchemata;
3501
+ /** Output only. A read only boolean field reflecting Zone Isolation status of the model. It's false by default. Since Model is a type ZICY 4.2 resource, the field is an aggregated value of ZI status of its underlying dependencies. */
3502
+ satisfiesPzi?: boolean;
3503
+ /** Output only. A read only boolean field reflecting ZS status of the model. It's false by default. Since Model is a type ZICY 4.2 resource, the field is an aggregated value of ZS status of its underlying dependencies. */
3504
+ satisfiesPzs?: boolean;
3440
3505
  /** Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions (PredictionService.Predict or PredictionService.Explain). Such a Model can serve predictions by using a BatchPredictionJob, if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats. */
3441
3506
  supportedDeploymentResourcesTypes?: string[];
3442
3507
  /** Output only. The formats in which this Model may be exported. If empty, this Model is not available for export. */
@@ -4833,6 +4898,8 @@ declare namespace gapi.client {
4833
4898
  containerSpec?: GoogleCloudAiplatformV1beta1ModelContainerSpec;
4834
4899
  /** A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. */
4835
4900
  dedicatedResources?: GoogleCloudAiplatformV1beta1DedicatedResources;
4901
+ /** Optional. Metadata information about this deployment config. */
4902
+ deployMetadata?: GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployDeployMetadata;
4836
4903
  /** Optional. The name of the deploy task (e.g., "text to image generation"). */
4837
4904
  deployTaskName?: string;
4838
4905
  /** Optional. Large model reference. When this is set, model_artifact_spec is not needed. */
@@ -4846,6 +4913,10 @@ declare namespace gapi.client {
4846
4913
  /** Required. The title of the regional resource reference. */
4847
4914
  title?: string;
4848
4915
  }
4916
+ interface GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployDeployMetadata {
4917
+ /** Optional. Labels for the deployment. For managing deployment config like verifying, source of deployment config, etc. */
4918
+ labels?: {[P in string]: string};
4919
+ }
4849
4920
  interface GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployGke {
4850
4921
  /** Optional. GKE deployment configuration in yaml format. */
4851
4922
  gkeYamlConfigs?: string[];
@@ -5181,8 +5252,6 @@ declare namespace gapi.client {
5181
5252
  similarityTopK?: number;
5182
5253
  /** Optional. The query in text format to get relevant contexts. */
5183
5254
  text?: string;
5184
- /** Optional. Only return contexts with vector distance smaller than the threshold. */
5185
- vectorDistanceThreshold?: number;
5186
5255
  }
5187
5256
  interface GoogleCloudAiplatformV1beta1RawPredictRequest {
5188
5257
  /** The prediction input. Supports HTTP headers and arbitrary data payload. A DeployedModel may have an upper limit on the number of instances it supports per request. When this limit it is exceeded for an AutoML model, the RawPredict method returns an error. When this limit is exceeded for a custom-trained model, the behavior varies depending on the model. You can specify the schema for each instance in the predict_schemata.instance_schema_uri field when you create a Model. This schema applies when you deploy the `Model` as a `DeployedModel` to an Endpoint and use the `RawPredict` method. */
@@ -5458,7 +5527,7 @@ declare namespace gapi.client {
5458
5527
  codeInterpreterRuntimeConfig?: GoogleCloudAiplatformV1beta1RuntimeConfigCodeInterpreterRuntimeConfig;
5459
5528
  /** Optional. Default parameters that will be set for all the execution of this extension. If specified, the parameter values can be overridden by values in [[ExecuteExtensionRequest.operation_params]] at request time. The struct should be in a form of map with param name as the key and actual param value as the value. E.g. If this operation requires a param "name" to be set to "abc". you can set this to something like {"name": "abc"}. */
5460
5529
  defaultParams?: {[P in string]: any};
5461
- /** Runtime configuration for Vertext AI Search extension. */
5530
+ /** Runtime configuration for Vertex AI Search extension. */
5462
5531
  vertexAiSearchRuntimeConfig?: GoogleCloudAiplatformV1beta1RuntimeConfigVertexAISearchRuntimeConfig;
5463
5532
  }
5464
5533
  interface GoogleCloudAiplatformV1beta1RuntimeConfigCodeInterpreterRuntimeConfig {
@@ -7049,6 +7118,16 @@ declare namespace gapi.client {
7049
7118
  /** The nearest neighbors of the query entity. */
7050
7119
  nearestNeighbors?: GoogleCloudAiplatformV1beta1NearestNeighbors;
7051
7120
  }
7121
+ interface GoogleCloudAiplatformV1beta1Segment {
7122
+ /** Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. */
7123
+ endIndex?: number;
7124
+ /** Output only. The index of a Part object within its parent Content object. */
7125
+ partIndex?: number;
7126
+ /** Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. */
7127
+ startIndex?: number;
7128
+ /** Output only. The text corresponding to the segment from the response. */
7129
+ text?: string;
7130
+ }
7052
7131
  interface GoogleCloudAiplatformV1beta1ServiceAccountSpec {
7053
7132
  /** Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). */
7054
7133
  enableCustomServiceAccount?: boolean;
@@ -7449,6 +7528,8 @@ declare namespace gapi.client {
7449
7528
  learningRateMultiplier?: number;
7450
7529
  }
7451
7530
  interface GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistribution {
7531
+ /** Output only. Sum of a given population of values that are billable. */
7532
+ billableSum?: string;
7452
7533
  /** Output only. Defines the histogram bucket. */
7453
7534
  buckets?: GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistributionDatasetBucket[];
7454
7535
  /** Output only. The maximum of the population values. */
@@ -7678,6 +7759,8 @@ declare namespace gapi.client {
7678
7759
  validationFraction?: number;
7679
7760
  }
7680
7761
  interface GoogleCloudAiplatformV1beta1TokensInfo {
7762
+ /** Optional. Optional fields for the role from the corresponding Content. */
7763
+ role?: string;
7681
7764
  /** A list of token ids from the input. */
7682
7765
  tokenIds?: string[];
7683
7766
  /** A list of tokens from the input. */
@@ -7911,8 +7994,6 @@ declare namespace gapi.client {
7911
7994
  labels?: {[P in string]: string};
7912
7995
  /** Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` */
7913
7996
  name?: string;
7914
- /** Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`. */
7915
- pipelineJob?: string;
7916
7997
  /** Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. */
7917
7998
  startTime?: string;
7918
7999
  /** Output only. The detailed state of the job. */
@@ -11610,6 +11691,68 @@ declare namespace gapi.client {
11610
11691
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
11611
11692
  uploadType?: string;
11612
11693
  }): Request<GoogleCloudAiplatformV1beta1ListDeploymentResourcePoolsResponse>;
11694
+ /** Update a DeploymentResourcePool. */
11695
+ patch(request: {
11696
+ /** V1 error format. */
11697
+ '$.xgafv'?: string;
11698
+ /** OAuth access token. */
11699
+ access_token?: string;
11700
+ /** Data format for response. */
11701
+ alt?: string;
11702
+ /** JSONP */
11703
+ callback?: string;
11704
+ /** Selector specifying which fields to include in a partial response. */
11705
+ fields?: string;
11706
+ /** 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. */
11707
+ key?: string;
11708
+ /** Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` */
11709
+ name: string;
11710
+ /** OAuth 2.0 token for the current user. */
11711
+ oauth_token?: string;
11712
+ /** Returns response with indentations and line breaks. */
11713
+ prettyPrint?: boolean;
11714
+ /** 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. */
11715
+ quotaUser?: string;
11716
+ /** Required. The list of fields to update. */
11717
+ updateMask?: string;
11718
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
11719
+ upload_protocol?: string;
11720
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
11721
+ uploadType?: string;
11722
+ /** Request body */
11723
+ resource: GoogleCloudAiplatformV1beta1DeploymentResourcePool;
11724
+ }): Request<GoogleLongrunningOperation>;
11725
+ patch(
11726
+ request: {
11727
+ /** V1 error format. */
11728
+ '$.xgafv'?: string;
11729
+ /** OAuth access token. */
11730
+ access_token?: string;
11731
+ /** Data format for response. */
11732
+ alt?: string;
11733
+ /** JSONP */
11734
+ callback?: string;
11735
+ /** Selector specifying which fields to include in a partial response. */
11736
+ fields?: string;
11737
+ /** 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. */
11738
+ key?: string;
11739
+ /** Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` */
11740
+ name: string;
11741
+ /** OAuth 2.0 token for the current user. */
11742
+ oauth_token?: string;
11743
+ /** Returns response with indentations and line breaks. */
11744
+ prettyPrint?: boolean;
11745
+ /** 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. */
11746
+ quotaUser?: string;
11747
+ /** Required. The list of fields to update. */
11748
+ updateMask?: string;
11749
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
11750
+ upload_protocol?: string;
11751
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
11752
+ uploadType?: string;
11753
+ },
11754
+ body: GoogleCloudAiplatformV1beta1DeploymentResourcePool
11755
+ ): Request<GoogleLongrunningOperation>;
11613
11756
  /** List DeployedModels that have been deployed on this DeploymentResourcePool. */
11614
11757
  queryDeployedModels(request?: {
11615
11758
  /** V1 error format. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.aiplatform-v1beta1",
3
- "version": "0.0.20240618",
3
+ "version": "0.0.20240628",
4
4
  "description": "TypeScript typings for Vertex AI API v1beta1",
5
5
  "repository": {
6
6
  "type": "git",