@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20250708 → 0.0.20250716

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: 20250708
+// Revision: 20250716
 
 /// <reference types="gapi.client" />
 
@@ -176,6 +176,104 @@ declare namespace gapi.client {
       /** Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. */
       functionName?: string;
     }
+    interface GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest {
+      /** Optional. Specification to boost suggestions matching the condition. */
+      boostSpec?: GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec;
+      /** Optional. Experiment ids for this request. */
+      experimentIds?: string[];
+      /** Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. */
+      includeTailSuggestions?: boolean;
+      /** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query. */
+      query?: string;
+      /** Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */
+      queryModel?: string;
+      /** Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment. */
+      suggestionTypes?: string[];
+      /** Optional. Specification of each suggestion type. */
+      suggestionTypeSpecs?: GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec[];
+      /** Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. */
+      userInfo?: GoogleCloudDiscoveryengineV1UserInfo;
+      /** A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 */
+      userPseudoId?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec {
+      /** Condition boost specifications. If a suggestion matches multiple conditions in the specifications, boost values from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. Note: Currently only support language condition boost. */
+      conditionBoostSpecs?: GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec[];
+    }
+    interface GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec {
+      /** Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored. */
+      boost?: number;
+      /** An expression which specifies a boost condition. The syntax is the same as [filter expression syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax). Currently, the only supported condition is a list of BCP-47 lang codes. Example: * To boost suggestions in languages `en` or `fr`: `(lang_code: ANY("en", "fr"))` */
+      condition?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec {
+      /** Optional. Maximum number of suggestions to return for each suggestion type. */
+      maxSuggestions?: number;
+      /** Optional. Suggestion type. */
+      suggestionType?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse {
+      /** Results of the matched content suggestions. The result list is ordered and the first result is the top suggestion. */
+      contentSuggestions?: GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion[];
+      /** Results of the matched people suggestions. The result list is ordered and the first result is the top suggestion. */
+      peopleSuggestions?: GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion[];
+      /** Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion. */
+      querySuggestions?: GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion[];
+      /** Results of the matched "recent search" suggestions. The result list is ordered and the first result is the top suggestion. */
+      recentSearchSuggestions?: GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion[];
+      /** True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query. */
+      tailMatchTriggered?: boolean;
+    }
+    interface GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion {
+      /** The type of the content suggestion. */
+      contentType?: string;
+      /** The name of the dataStore that this suggestion belongs to. */
+      dataStore?: string;
+      /** The destination uri of the content suggestion. */
+      destinationUri?: string;
+      /** The document data snippet in the suggestion. Only a subset of fields will be populated. */
+      document?: GoogleCloudDiscoveryengineV1Document;
+      /** The icon uri of the content suggestion. */
+      iconUri?: string;
+      /** The score of each suggestion. The score is in the range of [0, 1]. */
+      score?: number;
+      /** The suggestion for the query. */
+      suggestion?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion {
+      /** The name of the dataStore that this suggestion belongs to. */
+      dataStore?: string;
+      /** The destination uri of the person suggestion. */
+      destinationUri?: string;
+      /** The photo uri of the person suggestion. */
+      displayPhotoUri?: string;
+      /** The document data snippet in the suggestion. Only a subset of fields is populated. */
+      document?: GoogleCloudDiscoveryengineV1Document;
+      /** The type of the person. */
+      personType?: string;
+      /** The score of each suggestion. The score is in the range of [0, 1]. */
+      score?: number;
+      /** The suggestion for the query. */
+      suggestion?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion {
+      /** The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model. */
+      completableFieldPaths?: string[];
+      /** The name of the dataStore that this suggestion belongs to. */
+      dataStore?: string[];
+      /** The score of each suggestion. The score is in the range of [0, 1]. */
+      score?: number;
+      /** The suggestion for the query. */
+      suggestion?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion {
+      /** The time when this recent rearch happened. */
+      recentSearchTime?: string;
+      /** The score of each suggestion. The score is in the range of [0, 1]. */
+      score?: number;
+      /** The suggestion for the query. */
+      suggestion?: string;
+    }
     interface GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig {
       /** If set true, automatic refresh is disabled for the DataStore. */
       disableAutomaticRefresh?: boolean;
@@ -954,6 +1052,8 @@ declare namespace gapi.client {
     }
     interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
     interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {
+      /** Optional. If true, the processed document will be made available for the GetProcessedDocument API. */
+      enableGetProcessedDocument?: boolean;
       /** Optional. If true, the LLM based annotation is added to the image during parsing. */
       enableImageAnnotation?: boolean;
       /** Optional. If true, the LLM based annotation is added to the table during parsing. */
@@ -995,7 +1095,7 @@ declare namespace gapi.client {
       disableAnalytics?: boolean;
       /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
       displayName?: string;
-      /** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` */
+      /** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. */
       features?: {[P in string]: string};
       /** Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. */
       industryVertical?: string;
@@ -1611,7 +1711,7 @@ declare namespace gapi.client {
       searchAsYouTypeSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec;
       /** Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`, or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
       servingConfig?: string;
-      /** 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. */
+      /** 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): 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): 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. 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?: GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec;
@@ -2405,6 +2505,104 @@ declare namespace gapi.client {
       /** The query to search. */
       query?: string;
     }
+    interface GoogleCloudDiscoveryengineV1AssistAnswer {
+      /** Reasons for not answering the assist call. */
+      assistSkippedReasons?: string[];
+      /** Replies of the assistant. */
+      replies?: GoogleCloudDiscoveryengineV1AssistAnswerReply[];
+      /** State of the answer generation. */
+      state?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1AssistAnswerReply {
+      /** Possibly grounded response text or media from the assistant. */
+      groundedContent?: GoogleCloudDiscoveryengineV1AssistantGroundedContent;
+    }
+    interface GoogleCloudDiscoveryengineV1AssistantContent {
+      /** Result of executing an ExecutableCode. */
+      codeExecutionResult?: GoogleCloudDiscoveryengineV1AssistantContentCodeExecutionResult;
+      /** Code generated by the model that is meant to be executed. */
+      executableCode?: GoogleCloudDiscoveryengineV1AssistantContentExecutableCode;
+      /** A file, e.g., an audio summary. */
+      file?: GoogleCloudDiscoveryengineV1AssistantContentFile;
+      /** Inline binary data. */
+      inlineData?: GoogleCloudDiscoveryengineV1AssistantContentBlob;
+      /** The producer of the content. Can be "model" or "user". */
+      role?: string;
+      /** Inline text. */
+      text?: string;
+      /** Optional. Indicates if the part is thought from the model. */
+      thought?: boolean;
+    }
+    interface GoogleCloudDiscoveryengineV1AssistantContentBlob {
+      /** Required. Raw bytes. */
+      data?: string;
+      /** Required. The media type (MIME type) of the generated data. */
+      mimeType?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1AssistantContentCodeExecutionResult {
+      /** Required. Outcome of the code execution. */
+      outcome?: string;
+      /** Optional. Contains stdout when code execution is successful, stderr or other description otherwise. */
+      output?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1AssistantContentExecutableCode {
+      /** Required. The code content. Currently only supports Python. */
+      code?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1AssistantContentFile {
+      /** Required. The file ID. */
+      fileId?: string;
+      /** Required. The media type (MIME type) of the file. */
+      mimeType?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1AssistantGroundedContent {
+      /** The content. */
+      content?: GoogleCloudDiscoveryengineV1AssistantContent;
+      /** Metadata for grounding based on text sources. */
+      textGroundingMetadata?: GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadata;
+    }
+    interface GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadata {
+      /** References for the grounded text. */
+      references?: GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReference[];
+      /** Grounding information for parts of the text. */
+      segments?: GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataSegment[];
+    }
+    interface GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReference {
+      /** Referenced text content. */
+      content?: string;
+      /** Document metadata. */
+      documentMetadata?: GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata;
+    }
+    interface GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata {
+      /** Document resource name. */
+      document?: string;
+      /** Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. */
+      domain?: string;
+      /** Page identifier. */
+      pageIdentifier?: string;
+      /** Title. */
+      title?: string;
+      /** URI for the document. It may contain a URL that redirects to the actual website. */
+      uri?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataSegment {
+      /** End of the segment, exclusive. */
+      endIndex?: string;
+      /** Score for the segment. */
+      groundingScore?: number;
+      /** References for the segment. */
+      referenceIndices?: number[];
+      /** Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). */
+      startIndex?: string;
+      /** The text segment itself. */
+      text?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1AssistUserMetadata {
+      /** Optional. Preferred language to be used for answering if language detection fails. Also used as the language of error messages created by actions, regardless of language detection results. */
+      preferredLanguageCode?: string;
+      /** Optional. IANA time zone, e.g. Europe/Budapest. */
+      timeZone?: string;
+    }
     interface GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -2792,6 +2990,8 @@ declare namespace gapi.client {
     }
     interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
     interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {
+      /** Optional. If true, the processed document will be made available for the GetProcessedDocument API. */
+      enableGetProcessedDocument?: boolean;
       /** Optional. If true, the LLM based annotation is added to the image during parsing. */
       enableImageAnnotation?: boolean;
       /** Optional. If true, the LLM based annotation is added to the table during parsing. */
@@ -2833,7 +3033,7 @@ declare namespace gapi.client {
       disableAnalytics?: boolean;
       /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
       displayName?: string;
-      /** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` */
+      /** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. */
       features?: {[P in string]: string};
       /** Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. */
       industryVertical?: string;
@@ -3258,7 +3458,7 @@ declare namespace gapi.client {
       searchAsYouTypeSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec;
       /** Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`, or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
       servingConfig?: string;
-      /** 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. */
+      /** 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): 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): 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. 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?: GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec;
@@ -4220,6 +4420,8 @@ declare namespace gapi.client {
     }
     interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {}
     interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {
+      /** Optional. If true, the processed document will be made available for the GetProcessedDocument API. */
+      enableGetProcessedDocument?: boolean;
       /** Optional. If true, the LLM based annotation is added to the image during parsing. */
       enableImageAnnotation?: boolean;
       /** Optional. If true, the LLM based annotation is added to the table during parsing. */
@@ -4266,7 +4468,7 @@ declare namespace gapi.client {
       disableAnalytics?: boolean;
       /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
       displayName?: string;
-      /** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` */
+      /** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. */
       features?: {[P in string]: string};
       /** Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. */
       industryVertical?: string;
@@ -4502,7 +4704,7 @@ declare namespace gapi.client {
       forceRefreshContent?: boolean;
       /** Cloud Storage location for the input content. */
       gcsSource?: GoogleCloudDiscoveryengineV1GcsSource;
-      /** The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. */
+      /** The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * BigtableSource. */
       idField?: string;
       /** The Inline source for the input content for documents. */
       inlineSource?: GoogleCloudDiscoveryengineV1ImportDocumentsRequestInlineSource;
@@ -4997,7 +5199,7 @@ declare namespace gapi.client {
       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. */
+      /** 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): 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): 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. 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;
@@ -5412,6 +5614,60 @@ declare namespace gapi.client {
       /** Required. The table name of the Spanner database that needs to be imported. */
       tableId?: string;
     }
+    interface GoogleCloudDiscoveryengineV1StreamAssistRequest {
+      /** Optional. Specification of the generation configuration for the request. */
+      generationSpec?: GoogleCloudDiscoveryengineV1StreamAssistRequestGenerationSpec;
+      /** Optional. Current user query. Empty query is only supported if `file_ids` are provided. In this case, the answer will be generated based on those context files. */
+      query?: GoogleCloudDiscoveryengineV1Query;
+      /** Optional. The session to use for the request. If specified, the assistant has access to the session history, and the query and the answer are stored there. If `-` is specified as the session ID, or it is left empty, then a new session is created with an automatically generated ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` */
+      session?: string;
+      /** Optional. Specification of tools that are used to serve the request. */
+      toolsSpec?: GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpec;
+      /** Optional. Information about the user initiating the query. */
+      userMetadata?: GoogleCloudDiscoveryengineV1AssistUserMetadata;
+    }
+    interface GoogleCloudDiscoveryengineV1StreamAssistRequestGenerationSpec {
+      /** Optional. The Vertex AI model_id used for the generative model. If not set, the default Assistant model will be used. */
+      modelId?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpec {
+      /** Optional. Specification of the image generation tool. */
+      imageGenerationSpec?: any;
+      /** Optional. The name of the tool registry to use. Format: `projects/{project}/locations/{location}/toolRegistries/{tool_registry}` */
+      toolRegistry?: string;
+      /** Optional. Specification of the Vertex AI Search tool. */
+      vertexAiSearchSpec?: GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVertexAiSearchSpec;
+      /** Optional. Specification of the video generation tool. */
+      videoGenerationSpec?: any;
+      /** Optional. Specification of the web grounding tool. If field is present, enables grounding with web search. Works only if Assistant.web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. */
+      webGroundingSpec?: GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecWebGroundingSpec;
+    }
+    interface GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecImageGenerationSpec {}
+    interface GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVertexAiSearchSpec {
+      /** Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. */
+      dataStoreSpecs?: GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec[];
+      /** Optional. Deprecated. Please refrain from using this field. Whether the Vertex AI Search tool is disabled. Default value is false, the tool is enabled by default. */
+      disabled?: boolean;
+      /** Optional. 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. 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;
+    }
+    interface GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVideoGenerationSpec {}
+    interface GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecWebGroundingSpec {
+      /** Optional. Deprecated. Please refrain from using this field. Whether the web grounding tool is enabled. */
+      enabled?: boolean;
+    }
+    interface GoogleCloudDiscoveryengineV1StreamAssistResponse {
+      /** Assist answer resource object containing parts of the assistant's final answer for the user's query. Not present if the current response doesn't add anything to previously sent AssistAnswer.replies. Observe AssistAnswer.state to see if more parts are to be expected. While the state is `IN_PROGRESS`, the AssistAnswer.replies field in each response will contain replies (reply fragments) to be appended to the ones received in previous responses. AssistAnswer.name won't be filled. If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response is the last response and AssistAnswer.name will have a value. */
+      answer?: GoogleCloudDiscoveryengineV1AssistAnswer;
+      /** A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support. */
+      assistToken?: string;
+      /** Session information. */
+      sessionInfo?: GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo;
+    }
+    interface GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo {
+      /** Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`. */
+      session?: string;
+    }
     interface GoogleCloudDiscoveryengineV1SuggestionDenyListEntry {
       /** Required. Phrase to block from suggestions served. Can be maximum 125 characters. */
       blockPhrase?: string;
@@ -6404,6 +6660,66 @@ declare namespace gapi.client {
       documents: DocumentsResource;
       operations: OperationsResource;
     }
+    interface CompletionConfigResource {
+      /** Completes the user input with advanced keyword suggestions. */
+      completeQuery(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*‍/locations/global/collections/default_collection/dataStores/*‍/completionConfig` `projects/*‍/locations/global/collections/default_collection/engines/*‍/completionConfig`. */
+        completionConfig: 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: GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest;
+      }): Request<GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse>;
+      completeQuery(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*‍/locations/global/collections/default_collection/dataStores/*‍/completionConfig` `projects/*‍/locations/global/collections/default_collection/engines/*‍/completionConfig`. */
+          completionConfig: 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: GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest,
+      ): Request<GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse>;
+    }
     interface CompletionSuggestionsResource {
       /** Imports CompletionSuggestions for a DataStore. */
       import(request: {
@@ -9481,6 +9797,7 @@ declare namespace gapi.client {
         body: GoogleCloudDiscoveryengineV1TrainCustomModelRequest,
       ): Request<GoogleLongrunningOperation>;
       branches: BranchesResource;
+      completionConfig: CompletionConfigResource;
       completionSuggestions: CompletionSuggestionsResource;
       controls: ControlsResource;
       conversations: ConversationsResource;
@@ -9494,6 +9811,126 @@ declare namespace gapi.client {
       suggestionDenyListEntries: SuggestionDenyListEntriesResource;
       userEvents: UserEventsResource;
     }
+    interface AssistantsResource {
+      /** Assists the user with a query in a streaming fashion. */
+      streamAssist(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. The resource name of the Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` */
+        name: 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: GoogleCloudDiscoveryengineV1StreamAssistRequest;
+      }): Request<GoogleCloudDiscoveryengineV1StreamAssistResponse>;
+      streamAssist(
+        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. The resource name of the Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` */
+          name: 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: GoogleCloudDiscoveryengineV1StreamAssistRequest,
+      ): Request<GoogleCloudDiscoveryengineV1StreamAssistResponse>;
+    }
+    interface CompletionConfigResource {
+      /** Completes the user input with advanced keyword suggestions. */
+      completeQuery(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*‍/locations/global/collections/default_collection/dataStores/*‍/completionConfig` `projects/*‍/locations/global/collections/default_collection/engines/*‍/completionConfig`. */
+        completionConfig: 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: GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest;
+      }): Request<GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse>;
+      completeQuery(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*‍/locations/global/collections/default_collection/dataStores/*‍/completionConfig` `projects/*‍/locations/global/collections/default_collection/engines/*‍/completionConfig`. */
+          completionConfig: 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: GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest,
+      ): Request<GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse>;
+    }
     interface ControlsResource {
       /** Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. */
       create(request: {
@@ -10905,6 +11342,8 @@ declare namespace gapi.client {
         },
         body: GoogleCloudDiscoveryengineV1Engine,
       ): Request<GoogleCloudDiscoveryengineV1Engine>;
+      assistants: AssistantsResource;
+      completionConfig: CompletionConfigResource;
       controls: ControlsResource;
       conversations: ConversationsResource;
       operations: OperationsResource;
@@ -11465,6 +11904,66 @@ declare namespace gapi.client {
       documents: DocumentsResource;
       operations: OperationsResource;
     }
+    interface CompletionConfigResource {
+      /** Completes the user input with advanced keyword suggestions. */
+      completeQuery(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*‍/locations/global/collections/default_collection/dataStores/*‍/completionConfig` `projects/*‍/locations/global/collections/default_collection/engines/*‍/completionConfig`. */
+        completionConfig: 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: GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest;
+      }): Request<GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse>;
+      completeQuery(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*‍/locations/global/collections/default_collection/dataStores/*‍/completionConfig` `projects/*‍/locations/global/collections/default_collection/engines/*‍/completionConfig`. */
+          completionConfig: 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: GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest,
+      ): Request<GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse>;
+    }
     interface CompletionSuggestionsResource {
       /** Imports CompletionSuggestions for a DataStore. */
       import(request: {
@@ -14177,6 +14676,7 @@ declare namespace gapi.client {
         body: GoogleCloudDiscoveryengineV1DataStore,
       ): Request<GoogleCloudDiscoveryengineV1DataStore>;
       branches: BranchesResource;
+      completionConfig: CompletionConfigResource;
       completionSuggestions: CompletionSuggestionsResource;
       controls: ControlsResource;
       conversations: ConversationsResource;

package/package.json

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

package/readme.md

@@ -48,6 +48,9 @@ Don't forget to authenticate your client before sending any request to resources
 // declare client_id registered in Google Developers Console
 var client_id = '',
   scope = [
+    // Search your organization's data in the Cloud Search index
+    'https://www.googleapis.com/auth/cloud_search.query',
+
     // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
     'https://www.googleapis.com/auth/cloud-platform',
   ],