@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20240621 → 0.0.20240704

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: 20240621
+// Revision: 20240704
 
 /// <reference types="gapi.client" />
 
@@ -221,6 +221,8 @@ declare namespace gapi.client {
       document?: string;
       /** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
       snippetInfo?: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[];
+      /** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). */
+      structData?: {[P in string]: any};
       /** Title. */
       title?: string;
       /** URI for the document. */
@@ -345,6 +347,8 @@ declare namespace gapi.client {
       createTime?: string;
       /** The display name of the model. */
       displayName?: string;
+      /** The metrics of the trained model. */
+      metrics?: {[P in string]: number};
       /** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
       modelState?: string;
       /** The version of the model. */
@@ -418,7 +422,7 @@ declare namespace gapi.client {
       defaultParsingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
       /** The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
       name?: string;
-      /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. */
+      /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. */
       parsingConfigOverrides?: {
         [P in string]: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
       };
@@ -553,6 +557,18 @@ declare namespace gapi.client {
       /** Total number of documents. */
       documentCount?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata {
+      /** Operation create time. */
+      createTime?: string;
+      /** Operation last update time. If the operation is done, this is also the finish time. */
+      updateTime?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse {
+      /** Output result indicating where the data were exported to. */
+      outputResult?: GoogleCloudDiscoveryengineV1alphaOutputResult;
+      /** The status of the export operation. */
+      status?: GoogleRpcStatus;
+    }
     interface GoogleCloudDiscoveryengineV1alphaFieldConfig {
       /** If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``. */
       advancedSiteSearchDataSources?: string[];
@@ -673,6 +689,16 @@ declare namespace gapi.client {
       /** List of custom tuning models. */
       models?: GoogleCloudDiscoveryengineV1alphaCustomTuningModel[];
     }
+    interface GoogleCloudDiscoveryengineV1alphaOutputResult {
+      /** The BigQuery location where the result is stored. */
+      bigqueryResult?: GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult {
+      /** The ID of a BigQuery Dataset. */
+      datasetId?: string;
+      /** The ID of a BigQuery Table. */
+      tableId?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaProject {
       /** Output only. The timestamp when this project is created. */
       createTime?: string;
@@ -990,6 +1016,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec {
       /** Disable query rephraser. */
       disable?: boolean;
+      /** Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default. */
+      maxRephraseSteps?: number;
     }
     interface GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec {
       /** Enable related questions feature if true. */
@@ -1158,6 +1186,8 @@ declare namespace gapi.client {
       document?: string;
       /** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
       snippetInfo?: GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo[];
+      /** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). */
+      structData?: {[P in string]: any};
       /** Title. */
       title?: string;
       /** URI for the document. */
@@ -1297,6 +1327,8 @@ declare namespace gapi.client {
       createTime?: string;
       /** The display name of the model. */
       displayName?: string;
+      /** The metrics of the trained model. */
+      metrics?: {[P in string]: number};
       /** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
       modelState?: string;
       /** The version of the model. */
@@ -1366,7 +1398,7 @@ declare namespace gapi.client {
       defaultParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
       /** The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
       name?: string;
-      /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. */
+      /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. */
       parsingConfigOverrides?: {
         [P in string]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
       };
@@ -2101,7 +2133,7 @@ declare namespace gapi.client {
       defaultParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
       /** The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
       name?: string;
-      /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. */
+      /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. */
       parsingConfigOverrides?: {
         [P in string]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
       };
@@ -2676,6 +2708,12 @@ declare namespace gapi.client {
       queryExpansionSpec?: GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec;
       /** Whether to turn on safe search. This is only supported for website search. */
       safeSearch?: boolean;
+      /** Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */
+      searchAsYouTypeSpec?: GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec;
+      /** The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */
+      session?: string;
+      /** Session specification. Can be used only when `session` is set. */
+      sessionSpec?: GoogleCloudDiscoveryengineV1SearchRequestSessionSpec;
       /** The spell correction specification that specifies the mode under which spell correction takes effect. */
       spellCorrectionSpec?: GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec;
       /** Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. */
@@ -2799,6 +2837,16 @@ declare namespace gapi.client {
       /** Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. */
       pinUnexpandedResults?: boolean;
     }
+    interface GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec {
+      /** The condition under which search as you type should occur. Default to Condition.DISABLED. */
+      condition?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1SearchRequestSessionSpec {
+      /** If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. */
+      queryId?: string;
+      /** The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. */
+      searchResultPersistenceCount?: number;
+    }
     interface GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec {
       /** The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */
       mode?: string;
@@ -2818,6 +2866,8 @@ declare namespace gapi.client {
       redirectUri?: string;
       /** A list of matched documents. The order represents the ranking. */
       results?: GoogleCloudDiscoveryengineV1SearchResponseSearchResult[];
+      /** Session information. Only set if SearchRequest.session is provided. See its description for more details. */
+      sessionInfo?: GoogleCloudDiscoveryengineV1SearchResponseSessionInfo;
       /** A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. */
       summary?: GoogleCloudDiscoveryengineV1SearchResponseSummary;
       /** The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches. */
@@ -2853,6 +2903,12 @@ declare namespace gapi.client {
       /** Document.id of the searched Document. */
       id?: string;
     }
+    interface GoogleCloudDiscoveryengineV1SearchResponseSessionInfo {
+      /** Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. */
+      name?: string;
+      /** Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call. */
+      queryId?: string;
+    }
     interface GoogleCloudDiscoveryengineV1SearchResponseSummary {
       /** A collection of Safety Attribute categories and their associated confidence scores. */
       safetyAttributes?: GoogleCloudDiscoveryengineV1SearchResponseSummarySafetyAttributes;

package/package.json

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