@maxim_mazurok/gapi.client.aiplatform-v1beta1 0.0.20240828 → 0.0.20240830

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=v1beta1
-// Revision: 20240828
+// Revision: 20240830
 
 /// <reference types="gapi.client" />
 
@@ -262,6 +262,26 @@ declare namespace gapi.client {
       /** Output only. Name of the explain output. Specified as the key in ExplanationMetadata.outputs. */
       outputName?: string;
     }
+    interface GoogleCloudAiplatformV1beta1AugmentPromptRequest {
+      /** Optional. Input content to augment, only text format is supported for now. */
+      contents?: GoogleCloudAiplatformV1beta1Content[];
+      /** Optional. Metadata of the backend deployed model. */
+      model?: GoogleCloudAiplatformV1beta1AugmentPromptRequestModel;
+      /** Optional. Retrieves contexts from the Vertex RagStore. */
+      vertexRagStore?: GoogleCloudAiplatformV1beta1VertexRagStore;
+    }
+    interface GoogleCloudAiplatformV1beta1AugmentPromptRequestModel {
+      /** Optional. The model that the user will send the augmented prompt for content generation. */
+      model?: string;
+      /** Optional. The model version of the backend deployed model. */
+      modelVersion?: string;
+    }
+    interface GoogleCloudAiplatformV1beta1AugmentPromptResponse {
+      /** Augmented prompt, only text format is supported for now. */
+      augmentedPrompt?: GoogleCloudAiplatformV1beta1Content[];
+      /** Retrieved facts from RAG data sources. */
+      facts?: GoogleCloudAiplatformV1beta1Fact[];
+    }
     interface GoogleCloudAiplatformV1beta1AuthConfig {
       /** Config for API key auth. */
       apiKeyConfig?: GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig;
@@ -694,6 +714,16 @@ declare namespace gapi.client {
       /** Output only. List of citations. */
       citations?: GoogleCloudAiplatformV1beta1Citation[];
     }
+    interface GoogleCloudAiplatformV1beta1Claim {
+      /** Index in the input text where the claim ends (exclusive). */
+      endIndex?: number;
+      /** Indexes of the facts supporting this claim. */
+      factIndexes?: number[];
+      /** Confidence score of this corroboration. */
+      score?: number;
+      /** Index in the input text where the claim starts (inclusive). */
+      startIndex?: number;
+    }
     interface GoogleCloudAiplatformV1beta1CoherenceInput {
       /** Required. Coherence instance. */
       instance?: GoogleCloudAiplatformV1beta1CoherenceInstance;
@@ -816,6 +846,24 @@ declare namespace gapi.client {
       /** Output only. RagCorpus life state. */
       state?: string;
     }
+    interface GoogleCloudAiplatformV1beta1CorroborateContentRequest {
+      /** Optional. Input content to corroborate, only text format is supported for now. */
+      content?: GoogleCloudAiplatformV1beta1Content;
+      /** Optional. Facts used to generate the text can also be used to corroborate the text. */
+      facts?: GoogleCloudAiplatformV1beta1Fact[];
+      /** Optional. Parameters that can be set to override default settings per request. */
+      parameters?: GoogleCloudAiplatformV1beta1CorroborateContentRequestParameters;
+    }
+    interface GoogleCloudAiplatformV1beta1CorroborateContentRequestParameters {
+      /** Optional. Only return claims with citation score larger than the threshold. */
+      citationThreshold?: number;
+    }
+    interface GoogleCloudAiplatformV1beta1CorroborateContentResponse {
+      /** Claims that are extracted from the input content and facts that support the claims. */
+      claims?: GoogleCloudAiplatformV1beta1Claim[];
+      /** Confidence score of corroborating content. Value is [0,1] with 1 is the most confidence. */
+      corroborationScore?: number;
+    }
     interface GoogleCloudAiplatformV1beta1CountTokensRequest {
       /** Optional. Input content. */
       contents?: GoogleCloudAiplatformV1beta1Content[];
@@ -2088,6 +2136,18 @@ declare namespace gapi.client {
       /** Required. The Service Directory resource name in which the service endpoints associated to the extension are registered. Format: `projects/{project_id}/locations/{location_id}/namespaces/{namespace_id}/services/{service_id}` - The Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) should be granted `servicedirectory.viewer` and `servicedirectory.pscAuthorizedService` roles on the resource. */
       serviceDirectory?: string;
     }
+    interface GoogleCloudAiplatformV1beta1Fact {
+      /** Query that is used to retrieve this fact. */
+      query?: string;
+      /** If present, the summary/snippet of the fact. */
+      summary?: string;
+      /** If present, it refers to the title of this fact. */
+      title?: string;
+      /** If present, this uri links to the source of the fact. */
+      uri?: string;
+      /** If present, the distance between the query vector and this fact vector. */
+      vectorDistance?: number;
+    }
     interface GoogleCloudAiplatformV1beta1Feature {
       /** Output only. Only applicable for Vertex AI Feature Store (Legacy). Timestamp when this EntityType was created. */
       createTime?: string;
@@ -33490,6 +33550,122 @@ declare namespace gapi.client {
       }): Request<GoogleCloudAiplatformV1beta1ListTuningJobsResponse>;
     }
     interface LocationsResource {
+      /** Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses. */
+      augmentPrompt(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 Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`. */
+        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: GoogleCloudAiplatformV1beta1AugmentPromptRequest;
+      }): Request<GoogleCloudAiplatformV1beta1AugmentPromptResponse>;
+      augmentPrompt(
+        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 Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`. */
+          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: GoogleCloudAiplatformV1beta1AugmentPromptRequest
+      ): Request<GoogleCloudAiplatformV1beta1AugmentPromptResponse>;
+      /** Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts. */
+      corroborateContent(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 Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`. */
+        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: GoogleCloudAiplatformV1beta1CorroborateContentRequest;
+      }): Request<GoogleCloudAiplatformV1beta1CorroborateContentResponse>;
+      corroborateContent(
+        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 Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`. */
+          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: GoogleCloudAiplatformV1beta1CorroborateContentRequest
+      ): Request<GoogleCloudAiplatformV1beta1CorroborateContentResponse>;
       /** Evaluates instances based on a given metric. */
       evaluateInstances(request: {
         /** V1 error format. */

package/package.json

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