@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20240530 → 0.0.20240607

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=v1
-// Revision: 20240530
+// Revision: 20240607
 
 /// <reference types="gapi.client" />
 
@@ -976,6 +976,8 @@ declare namespace gapi.client {
       maxReturnResults?: number;
       /** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
       orderBy?: string;
+      /** Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) */
+      searchResultMode?: string;
     }
     interface GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList {
       /** Search results. */
@@ -1694,6 +1696,44 @@ declare namespace gapi.client {
       /** The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6. */
       citationThreshold?: number;
     }
+    interface GoogleCloudDiscoveryengineV1Chunk {
+      /** Output only. Metadata of the current chunk. */
+      chunkMetadata?: GoogleCloudDiscoveryengineV1ChunkChunkMetadata;
+      /** Content is a string from a document (parsed content). */
+      content?: string;
+      /** Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */
+      derivedStructData?: {[P in string]: any};
+      /** Metadata of the document from the current chunk. */
+      documentMetadata?: GoogleCloudDiscoveryengineV1ChunkDocumentMetadata;
+      /** Unique chunk ID of the current chunk. */
+      id?: string;
+      /** The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
+      name?: string;
+      /** Page span of the chunk. */
+      pageSpan?: GoogleCloudDiscoveryengineV1ChunkPageSpan;
+      /** Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse. */
+      relevanceScore?: number;
+    }
+    interface GoogleCloudDiscoveryengineV1ChunkChunkMetadata {
+      /** The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API. */
+      nextChunks?: GoogleCloudDiscoveryengineV1Chunk[];
+      /** The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API. */
+      previousChunks?: GoogleCloudDiscoveryengineV1Chunk[];
+    }
+    interface GoogleCloudDiscoveryengineV1ChunkDocumentMetadata {
+      /** Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */
+      structData?: {[P in string]: any};
+      /** Title of the document. */
+      title?: string;
+      /** Uri of the document. */
+      uri?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1ChunkPageSpan {
+      /** The end page of the chunk. */
+      pageEnd?: number;
+      /** The start page of the chunk. */
+      pageStart?: number;
+    }
     interface GoogleCloudDiscoveryengineV1CloudSqlSource {
       /** Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. */
       databaseId?: string;
@@ -2527,13 +2567,23 @@ declare namespace gapi.client {
       condition?: string;
     }
     interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec {
+      /** Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */
+      chunkSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec;
       /** If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */
       extractiveContentSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec;
+      /** Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. */
+      searchResultMode?: string;
       /** If `snippetSpec` is not specified, snippets are not included in the search response. */
       snippetSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec;
       /** If `summarySpec` is not specified, summaries are not included in the search response. */
       summarySpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec;
     }
+    interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec {
+      /** The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. */
+      numNextChunks?: number;
+      /** The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. */
+      numPreviousChunks?: number;
+    }
     interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec {
       /** The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. */
       maxExtractiveAnswerCount?: number;
@@ -2667,6 +2717,8 @@ declare namespace gapi.client {
       pinnedResultCount?: string;
     }
     interface GoogleCloudDiscoveryengineV1SearchResponseSearchResult {
+      /** The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. */
+      chunk?: GoogleCloudDiscoveryengineV1Chunk;
       /** The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. */
       document?: GoogleCloudDiscoveryengineV1Document;
       /** Document.id of the searched Document. */
@@ -10081,6 +10133,39 @@ declare namespace gapi.client {
       ): Request<GoogleCloudDiscoveryengineV1RankResponse>;
     }
     interface UserEventsResource {
+      /** Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly. */
+      collect(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. */
+        ets?: 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 parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
+        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;
+        /** The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests. */
+        uri?: string;
+        /** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
+        userEvent?: string;
+      }): Request<GoogleApiHttpBody>;
       /** Writes a single user event. */
       write(request: {
         /** V1 error format. */

package/package.json

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