@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20241123 → 0.0.20241205

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=v1beta
-// Revision: 20241123
+// Revision: 20241205
 
 /// <reference types="gapi.client" />
 
@@ -182,6 +182,10 @@ declare namespace gapi.client {
       completeTime?: string;
       /** Output only. Answer creation timestamp. */
       createTime?: string;
+      /** A score in the range of [0, 1] describing how grounded the answer is by the reference chunks. */
+      groundingScore?: number;
+      /** Optional. Grounding supports. */
+      groundingSupports?: GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport[];
       /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*‍/answers/*` */
       name?: string;
       /** Query understanding information. */
@@ -207,6 +211,18 @@ declare namespace gapi.client {
       /** ID of the citation source. */
       referenceId?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport {
+      /** Required. End of the claim, exclusive. */
+      endIndex?: string;
+      /** Indicates that this claim required grounding check. When the system decided this claim didn't require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore `grounding_score`, `sources` is not returned. */
+      groundingCheckRequired?: boolean;
+      /** A score in the range of [0, 1] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks. */
+      groundingScore?: number;
+      /** Optional. Citation sources for the claim. */
+      sources?: GoogleCloudDiscoveryengineV1alphaAnswerCitationSource[];
+      /** Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode). */
+      startIndex?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo {
       /** Query classification information. */
       queryClassificationInfo?: GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo[];
@@ -560,6 +576,10 @@ declare namespace gapi.client {
       /** Operation last update time. If the operation is done, this is also the finish time. */
       updateTime?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest {
+      /** Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
+      name?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -785,6 +805,12 @@ declare namespace gapi.client {
       /** If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. */
       searchableOption?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaGetSessionRequest {
+      /** Optional. If set to true, the full session including all answer details will be returned. */
+      includeAnswerDetails?: boolean;
+      /** Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
+      name?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse {
       /** Document data keyed by URI pattern. For example: document_data_map = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } } */
       documentDataMap?: {[P in string]: {[P in string]: any}};
@@ -913,6 +939,24 @@ declare namespace gapi.client {
       /** List of custom tuning models. */
       models?: GoogleCloudDiscoveryengineV1alphaCustomTuningModel[];
     }
+    interface GoogleCloudDiscoveryengineV1alphaListSessionsRequest {
+      /** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
+      filter?: string;
+      /** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time" */
+      orderBy?: string;
+      /** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
+      pageSize?: number;
+      /** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
+      pageToken?: string;
+      /** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
+      parent?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaListSessionsResponse {
+      /** Pagination token, if not returned indicates the last page. */
+      nextPageToken?: string;
+      /** All the Sessions for a given data store. */
+      sessions?: GoogleCloudDiscoveryengineV1alphaSession[];
+    }
     interface GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig {
       /** Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. */
       mode?: string;
@@ -1269,6 +1313,8 @@ declare namespace gapi.client {
       version?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
+      /** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
+      boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
       /** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
       dataStore?: string;
       /** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
@@ -1345,8 +1391,12 @@ declare namespace gapi.client {
       mode?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaSession {
+      /** Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. */
+      displayName?: string;
       /** Output only. The time the session finished. */
       endTime?: string;
+      /** Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. */
+      isPinned?: boolean;
       /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
       name?: string;
       /** Output only. The time the session started. */
@@ -1452,6 +1502,12 @@ declare namespace gapi.client {
       /** Operation last update time. If the operation is done, this is also the finish time. */
       updateTime?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest {
+      /** Required. The Session to update. */
+      session?: GoogleCloudDiscoveryengineV1alphaSession;
+      /** Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. */
+      updateMask?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -1582,6 +1638,10 @@ declare namespace gapi.client {
       completeTime?: string;
       /** Output only. Answer creation timestamp. */
       createTime?: string;
+      /** A score in the range of [0, 1] describing how grounded the answer is by the reference chunks. */
+      groundingScore?: number;
+      /** Optional. Grounding supports. */
+      groundingSupports?: GoogleCloudDiscoveryengineV1betaAnswerGroundingSupport[];
       /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*‍/answers/*` */
       name?: string;
       /** Query understanding information. */
@@ -1607,6 +1667,18 @@ declare namespace gapi.client {
       /** ID of the citation source. */
       referenceId?: string;
     }
+    interface GoogleCloudDiscoveryengineV1betaAnswerGroundingSupport {
+      /** Required. End of the claim, exclusive. */
+      endIndex?: string;
+      /** Indicates that this claim required grounding check. When the system decided this claim didn't require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore `grounding_score`, `sources` is not returned. */
+      groundingCheckRequired?: boolean;
+      /** A score in the range of [0, 1] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks. */
+      groundingScore?: number;
+      /** Optional. Citation sources for the claim. */
+      sources?: GoogleCloudDiscoveryengineV1betaAnswerCitationSource[];
+      /** Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode). */
+      startIndex?: string;
+    }
     interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequest {
       /** Answer generation specification. */
       answerGenerationSpec?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec;
@@ -1678,6 +1750,12 @@ declare namespace gapi.client {
       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;
+      /** Optional. Query Rephraser Model specification. */
+      modelSpec?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec;
+    }
+    interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec {
+      /** Optional. Enabled query rephraser model type. If not set, it will use LARGE by default. */
+      modelType?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestRelatedQuestionsSpec {
       /** Enable related questions feature if true. */
@@ -2622,6 +2700,8 @@ declare namespace gapi.client {
       gcsStagingDir?: string;
       /** The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty. */
       resourceTypes?: string[];
+      /** Optional. Whether to update the DataStore schema to the latest predefined schema. If true, the DataStore schema will be updated to include any FHIR fields or resource types that have been added since the last import and corresponding FHIR resources will be imported from the FHIR store. Note this field cannot be used in conjunction with `resource_types`. It should be used after initial import. */
+      updateFromLatestPredefinedSchema?: boolean;
     }
     interface GoogleCloudDiscoveryengineV1betaFirestoreSource {
       /** Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters. */
@@ -3389,6 +3469,8 @@ declare namespace gapi.client {
       version?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
+      /** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
+      boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
       /** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
       dataStore?: string;
       /** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
@@ -3738,8 +3820,12 @@ declare namespace gapi.client {
       demotionEventType?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaSession {
+      /** Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. */
+      displayName?: string;
       /** Output only. The time the session finished. */
       endTime?: string;
+      /** Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. */
+      isPinned?: boolean;
       /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
       name?: string;
       /** Output only. The time the session started. */
@@ -4416,6 +4502,130 @@ declare namespace gapi.client {
       /** Required. The URL for the page the user wants to promote. */
       uri?: 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 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;
+      /** The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. */
+      maxExtractiveSegmentCount?: number;
+      /** Return at most `num_next_segments` segments after each selected segments. */
+      numNextSegments?: number;
+      /** Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */
+      numPreviousSegments?: number;
+      /** Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. */
+      returnExtractiveSegmentScore?: boolean;
+    }
+    interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec {
+      /** [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. */
+      maxSnippetCount?: number;
+      /** [DEPRECATED] This field is deprecated and will have no affect on the snippet. */
+      referenceOnly?: boolean;
+      /** If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned. */
+      returnSnippet?: boolean;
+    }
+    interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec {
+      /** Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */
+      ignoreAdversarialQuery?: boolean;
+      /** Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead. */
+      ignoreJailBreakingQuery?: boolean;
+      /** Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */
+      ignoreLowRelevantContent?: boolean;
+      /** Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead. */
+      ignoreNonSummarySeekingQuery?: boolean;
+      /** Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results. */
+      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?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec;
+      /** If specified, the spec will be used to modify the model specification provided to the LLM. */
+      modelSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec;
+      /** 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 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. */
+      summaryResultCount?: number;
+      /** If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list. */
+      useSemanticChunks?: boolean;
+    }
+    interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec {
+      /** Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. */
+      preamble?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec {
+      /** The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). */
+      version?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1ServingConfig {
+      /** Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls. */
+      boostControlIds?: string[];
+      /** Output only. ServingConfig created timestamp. */
+      createTime?: string;
+      /** Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
+      displayName?: string;
+      /** Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
+      dissociateControlIds?: string[];
+      /** How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
+      diversityLevel?: string;
+      /** Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls. */
+      filterControlIds?: string[];
+      /** The GenericConfig of the serving configuration. */
+      genericConfig?: GoogleCloudDiscoveryengineV1ServingConfigGenericConfig;
+      /** Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100. */
+      ignoreControlIds?: string[];
+      /** The MediaConfig of the serving configuration. */
+      mediaConfig?: GoogleCloudDiscoveryengineV1ServingConfigMediaConfig;
+      /** The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
+      modelId?: string;
+      /** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
+      name?: string;
+      /** Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
+      onewaySynonymsControlIds?: string[];
+      /** Condition promote specifications. Maximum number of specifications is 100. */
+      promoteControlIds?: string[];
+      /** The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. */
+      rankingExpression?: string;
+      /** IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
+      redirectControlIds?: string[];
+      /** Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
+      replacementControlIds?: string[];
+      /** Required. Immutable. Specifies the solution type that a serving config can be associated with. */
+      solutionType?: string;
+      /** Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
+      synonymsControlIds?: string[];
+      /** Output only. ServingConfig updated timestamp. */
+      updateTime?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1ServingConfigGenericConfig {
+      /** Specifies the expected behavior of content search. Only valid for content-search enabled data store. */
+      contentSearchSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec;
+    }
+    interface GoogleCloudDiscoveryengineV1ServingConfigMediaConfig {
+      /** Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. */
+      contentFreshnessCutoffDays?: number;
+      /** Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. */
+      contentWatchedPercentageThreshold?: number;
+      /** Specifies the content watched minutes threshold for demotion. */
+      contentWatchedSecondsThreshold?: number;
+      /** Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. */
+      demoteContentWatchedPastDays?: number;
+      /** Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. */
+      demotionEventType?: string;
+    }
     interface GoogleCloudDiscoveryengineV1SiteVerificationInfo {
       /** Site verification state indicating the ownership and validity. */
       siteVerificationState?: string;
@@ -6570,6 +6780,64 @@ declare namespace gapi.client {
         },
         body: GoogleCloudDiscoveryengineV1betaSearchRequest
       ): Request<GoogleCloudDiscoveryengineV1betaSearchResponse>;
+      /** Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream. */
+      streamAnswer(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** 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;
+        /** 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/*‍/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
+        servingConfig: 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: GoogleCloudDiscoveryengineV1betaAnswerQueryRequest;
+      }): Request<GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>;
+      streamAnswer(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+          key?: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** 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;
+          /** 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/*‍/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
+          servingConfig: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: GoogleCloudDiscoveryengineV1betaAnswerQueryRequest
+      ): Request<GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>;
     }
     interface AnswersResource {
       /** Gets a Answer. */
@@ -6698,6 +6966,8 @@ declare namespace gapi.client {
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
+        /** Optional. If set to true, the full session including all answer details will be returned. */
+        includeAnswerDetails?: boolean;
         /** 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 Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
@@ -7690,7 +7960,7 @@ declare namespace gapi.client {
         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}`. */
+        /** Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
         parent: string;
         /** Returns response with indentations and line breaks. */
         prettyPrint?: boolean;
@@ -9204,6 +9474,64 @@ declare namespace gapi.client {
         },
         body: GoogleCloudDiscoveryengineV1betaSearchRequest
       ): Request<GoogleCloudDiscoveryengineV1betaSearchResponse>;
+      /** Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream. */
+      streamAnswer(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** 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;
+        /** 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/*‍/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
+        servingConfig: 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: GoogleCloudDiscoveryengineV1betaAnswerQueryRequest;
+      }): Request<GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>;
+      streamAnswer(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+          key?: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** 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;
+          /** 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/*‍/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
+          servingConfig: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: GoogleCloudDiscoveryengineV1betaAnswerQueryRequest
+      ): Request<GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>;
     }
     interface AnswersResource {
       /** Gets a Answer. */
@@ -9332,6 +9660,8 @@ declare namespace gapi.client {
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
+        /** Optional. If set to true, the full session including all answer details will be returned. */
+        includeAnswerDetails?: boolean;
         /** 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 Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
@@ -11744,6 +12074,64 @@ declare namespace gapi.client {
         },
         body: GoogleCloudDiscoveryengineV1betaSearchRequest
       ): Request<GoogleCloudDiscoveryengineV1betaSearchResponse>;
+      /** Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream. */
+      streamAnswer(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** 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;
+        /** 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/*‍/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
+        servingConfig: 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: GoogleCloudDiscoveryengineV1betaAnswerQueryRequest;
+      }): Request<GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>;
+      streamAnswer(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+          key?: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** 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;
+          /** 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/*‍/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
+          servingConfig: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: GoogleCloudDiscoveryengineV1betaAnswerQueryRequest
+      ): Request<GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>;
     }
     interface AnswersResource {
       /** Gets a Answer. */
@@ -11872,6 +12260,8 @@ declare namespace gapi.client {
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
+        /** Optional. If set to true, the full session including all answer details will be returned. */
+        includeAnswerDetails?: boolean;
         /** 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 Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
@@ -12678,7 +13068,7 @@ declare namespace gapi.client {
         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}`. */
+        /** Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
         parent: string;
         /** Returns response with indentations and line breaks. */
         prettyPrint?: boolean;
@@ -14132,7 +14522,7 @@ declare namespace gapi.client {
         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}`. */
+        /** Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
         parent: string;
         /** Returns response with indentations and line breaks. */
         prettyPrint?: boolean;

package/package.json

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