@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20231130 → 0.0.20231209

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://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
-// Revision: 20231130
+// Revision: 20231209
 
 /// <reference types="gapi.client" />
 
@@ -176,6 +176,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaConverseConversationRequest {
       /** The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session. */
       conversation?: GoogleCloudDiscoveryengineV1alphaConversation;
+      /** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
+      filter?: string;
       /** Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
       name?: string;
       /** Required. Current user input. */
@@ -418,6 +420,40 @@ declare namespace gapi.client {
       searchTier?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig {}
+    interface GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata {
+      /** Operation create time. */
+      createTime?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest {
+      /** Structured or unstructured data. */
+      fileDataSource?: GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource;
+      /** Website data. */
+      websiteDataSource?: GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource {
+      /** BigQuery input source. */
+      bigquerySource?: GoogleCloudDiscoveryengineV1alphaBigQuerySource;
+      /** Cloud Storage location for the input content. */
+      gcsSource?: GoogleCloudDiscoveryengineV1alphaGcsSource;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource {
+      /** Required. The URI patterns to estimate the data sizes. At most 10 patterns are allowed, otherwise an INVALID_ARGUMENT error is thrown. */
+      estimatorUriPatterns?: GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern[];
+    }
+    interface GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern {
+      /** Whether we infer the generated URI or use the exact provided one. */
+      exactMatch?: boolean;
+      /** Whether the pattern is exclusive or not. If set to true, the pattern is considered exclusive. If unset or set to false, the pattern is considered inclusive by default. */
+      exclusive?: boolean;
+      /** User provided URI pattern. For example, `foo.com/bar/*`. */
+      providedUriPattern?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse {
+      /** Data size in terms of bytes. */
+      dataSizeBytes?: string;
+      /** Total number of documents. */
+      documentCount?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse {
       /** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
       nextPageToken?: string;
@@ -849,13 +885,19 @@ declare namespace gapi.client {
       includeCitations?: boolean;
       /** Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature. */
       languageCode?: string;
+      /** If specified, the spec will be used to modify the prompt provided to the LLM. */
+      modelPromptSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec;
       /** If specified, the spec will be used to modify the model specification provided to the LLM. */
       modelSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec;
       /** The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most five results can be used to generate a summary. */
       summaryResultCount?: number;
     }
+    interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec {
+      /** Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. */
+      preamble?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec {
-      /** The string format of the model version. e.g. stable, latest, etc. */
+      /** The string format of the model version. e.g. stable, preview, etc. */
       version?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec {
@@ -990,6 +1032,31 @@ declare namespace gapi.client {
       summarySkippedReasons?: string[];
       /** The summary content. */
       summaryText?: string;
+      summaryWithMetadata?: GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation {
+      /** End of the attributed segment, exclusive. */
+      endIndex?: string;
+      /** Citation sources for the attributed segment. */
+      sources?: GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource[];
+      /** Index indicates the start of the segment, measured in bytes/unicode. */
+      startIndex?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata {
+      /** Citations for segments. */
+      citations?: GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation[];
+    }
+    interface GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource {
+      /** Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly. */
+      referenceIndex?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference {
+      /** Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/branches/*‍/documents/*`. */
+      document?: string;
+      /** Title of the document. */
+      title?: string;
+      /** GCS or HTTP uri for the document. */
+      uri?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes {
       /** The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. */
@@ -997,6 +1064,14 @@ declare namespace gapi.client {
       /** The confidence scores of the each category, higher value means higher confidence. Order matches the Categories. */
       scores?: number[];
     }
+    interface GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata {
+      /** Citation metadata for given summary. */
+      citationMetadata?: GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata;
+      /** Document References. */
+      references?: GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference[];
+      /** Summary text with no citation information. */
+      summary?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaSiteSearchEngine {
       /** The fully qualified resource name of the site search engine. Format: `projects/*‍/locations/*‍/dataStores/*‍/siteSearchEngine` */
       name?: string;
@@ -1038,6 +1113,38 @@ declare namespace gapi.client {
       /** Text input. */
       input?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata {
+      /** Operation create time. */
+      createTime?: string;
+      /** Operation last update time. If the operation is done, this is also the finish time. */
+      updateTime?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest {
+      /** The desired location of errors incurred during the data ingestion and training. */
+      errorConfig?: GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
+      /** Gcs training input. */
+      gcsTrainingInput?: GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput;
+      /** Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided. */
+      modelType?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput {
+      /** The gcs corpus data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file. * For search-tuning model, each line should have the _id, title and text. Example: {"_id": "doc1", title: "relevant doc", "text": "relevant text"} */
+      corpusDataPath?: string;
+      /** The gcs query data which could be associated in train data. The data path format is gs:///. A newline delimited jsonl/ndjson file. * For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"} */
+      queryDataPath?: string;
+      /** Gcs test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path. */
+      testDataPath?: string;
+      /** Gcs training data path whose format should be gs:///. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). * For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in [0, inf+). The larger the number is, the more relevant the pair is. Example: query-id\tcorpus-id\tscore query1\tdoc1\t1 */
+      trainDataPath?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse {
+      /** Echoes the destination for the complete errors in the request if set. */
+      errorConfig?: GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
+      /** A sample of errors encountered while processing the data. */
+      errorSamples?: GoogleRpcStatus[];
+      /** The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training is in progress. * **ready**: The model is ready for serving. */
+      modelStatus?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaTransactionInfo {
       /** All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: * Profit = value - tax - cost */
       cost?: number;
@@ -4047,6 +4154,64 @@ declare namespace gapi.client {
         },
         body: GoogleCloudDiscoveryengineV1alphaDataStore
       ): Request<GoogleCloudDiscoveryengineV1alphaDataStore>;
+      /** Trains a custom model. */
+      trainCustomModel(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Required. The resource name of the Data Store, such as `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. */
+        dataStore: 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;
+        /** 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: GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest;
+      }): Request<GoogleLongrunningOperation>;
+      trainCustomModel(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Required. The resource name of the Data Store, such as `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. */
+          dataStore: 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;
+          /** 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: GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest
+      ): Request<GoogleLongrunningOperation>;
       branches: BranchesResource;
       conversations: ConversationsResource;
       models: ModelsResource;
@@ -7078,6 +7243,64 @@ declare namespace gapi.client {
       }): Request<GoogleLongrunningListOperationsResponse>;
     }
     interface LocationsResource {
+      /** Estimates the data size to be used by a customer. */
+      estimateDataSize(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;
+        /** Required. Full resource name of the Location, such as `projects/{project}/locations/{location}`. */
+        location: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: 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: GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest;
+      }): Request<GoogleLongrunningOperation>;
+      estimateDataSize(
+        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;
+          /** Required. Full resource name of the Location, such as `projects/{project}/locations/{location}`. */
+          location: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: 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: GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest
+      ): Request<GoogleLongrunningOperation>;
       collections: CollectionsResource;
       dataStores: DataStoresResource;
       operations: OperationsResource;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.discoveryengine-v1alpha",
-  "version": "0.0.20231130",
+  "version": "0.0.20231209",
   "description": "TypeScript typings for Discovery Engine API v1alpha",
   "repository": {
     "type": "git",