@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20240715 → 0.0.20240801

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: 20240715
+// Revision: 20240801
 
 /// <reference types="gapi.client" />
 
@@ -137,6 +137,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaAnswerReference {
       /** Chunk information. */
       chunkInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo;
+      /** Structured document information. */
+      structuredDocumentInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo;
       /** Unstructured document information. */
       unstructuredDocumentInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo;
     }
@@ -147,7 +149,7 @@ declare namespace gapi.client {
       content?: string;
       /** Document metadata. */
       documentMetadata?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata;
-      /** Relevance score. */
+      /** The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */
       relevanceScore?: number;
     }
     interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata {
@@ -162,6 +164,12 @@ declare namespace gapi.client {
       /** URI for the document. */
       uri?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo {
+      /** Document resource name. */
+      document?: string;
+      /** Structured search data. */
+      structData?: {[P in string]: any};
+    }
     interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo {
       /** List of cited chunk contents derived from document content. */
       chunkContents?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
@@ -179,6 +187,8 @@ declare namespace gapi.client {
       content?: string;
       /** Page identifier. */
       pageIdentifier?: string;
+      /** The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */
+      relevanceScore?: number;
     }
     interface GoogleCloudDiscoveryengineV1alphaAnswerStep {
       /** Actions. */
@@ -219,7 +229,7 @@ declare namespace gapi.client {
       chunk?: string;
       /** Chunk textual content. */
       content?: string;
-      /** Relevance score. */
+      /** The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */
       relevanceScore?: number;
     }
     interface GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo {
@@ -413,7 +423,7 @@ declare namespace gapi.client {
       defaultParsingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
       /** The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
       name?: string;
-      /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. */
+      /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */
       parsingConfigOverrides?: {
         [P in string]: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
       };
@@ -559,7 +569,7 @@ declare namespace gapi.client {
       errorSamples?: GoogleRpcStatus[];
       /** Required. The specification of the evaluation. */
       evaluationSpec?: GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec;
-      /** Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
+      /** Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
       name?: string;
       /** Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. */
       qualityMetrics?: GoogleCloudDiscoveryengineV1alphaQualityMetrics;
@@ -576,18 +586,6 @@ declare namespace gapi.client {
       /** Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. */
       sampleQuerySet?: string;
     }
-    interface GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata {
-      /** Operation create time. */
-      createTime?: string;
-      /** Operation last update time. If the operation is done, this is also the finish time. */
-      updateTime?: string;
-    }
-    interface GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse {
-      /** Output result indicating where the data were exported to. */
-      outputResult?: GoogleCloudDiscoveryengineV1alphaOutputResult;
-      /** The status of the export operation. */
-      status?: GoogleRpcStatus;
-    }
     interface GoogleCloudDiscoveryengineV1alphaFieldConfig {
       /** If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``. */
       advancedSiteSearchDataSources?: string[];
@@ -740,16 +738,6 @@ declare namespace gapi.client {
       /** List of custom tuning models. */
       models?: GoogleCloudDiscoveryengineV1alphaCustomTuningModel[];
     }
-    interface GoogleCloudDiscoveryengineV1alphaOutputResult {
-      /** The BigQuery location where the result is stored. */
-      bigqueryResult?: GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult;
-    }
-    interface GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult {
-      /** The ID of a BigQuery Dataset. */
-      datasetId?: string;
-      /** The ID of a BigQuery Table. */
-      tableId?: string;
-    }
     interface GoogleCloudDiscoveryengineV1alphaProject {
       /** Output only. The timestamp when this project is created. */
       createTime?: string;
@@ -930,7 +918,7 @@ declare namespace gapi.client {
       naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec;
       /** A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */
       offset?: number;
-      /** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
+      /** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
       orderBy?: string;
       /** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
       pageSize?: number;
@@ -1036,6 +1024,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec {
       /** 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;
+      /** 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. */
@@ -1452,6 +1442,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1betaAnswerReference {
       /** Chunk information. */
       chunkInfo?: GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo;
+      /** Structured document information. */
+      structuredDocumentInfo?: GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo;
       /** Unstructured document information. */
       unstructuredDocumentInfo?: GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo;
     }
@@ -1462,7 +1454,7 @@ declare namespace gapi.client {
       content?: string;
       /** Document metadata. */
       documentMetadata?: GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata;
-      /** Relevance score. */
+      /** The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */
       relevanceScore?: number;
     }
     interface GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata {
@@ -1477,6 +1469,12 @@ declare namespace gapi.client {
       /** URI for the document. */
       uri?: string;
     }
+    interface GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo {
+      /** Document resource name. */
+      document?: string;
+      /** Structured search data. */
+      structData?: {[P in string]: any};
+    }
     interface GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo {
       /** List of cited chunk contents derived from document content. */
       chunkContents?: GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
@@ -1494,6 +1492,8 @@ declare namespace gapi.client {
       content?: string;
       /** Page identifier. */
       pageIdentifier?: string;
+      /** The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */
+      relevanceScore?: number;
     }
     interface GoogleCloudDiscoveryengineV1betaAnswerStep {
       /** Actions. */
@@ -1534,7 +1534,7 @@ declare namespace gapi.client {
       chunk?: string;
       /** Chunk textual content. */
       content?: string;
-      /** Relevance score. */
+      /** The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */
       relevanceScore?: number;
     }
     interface GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo {
@@ -1990,6 +1990,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1betaDocumentInfo {
       /** The Document resource ID. */
       id?: string;
+      /** Output only. Whether the referenced Document can be found in the data store. */
+      joined?: boolean;
       /** The Document resource full name, of the form: `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}` */
       name?: string;
       /** The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID. */
@@ -2006,7 +2008,7 @@ declare namespace gapi.client {
       defaultParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
       /** The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
       name?: string;
-      /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. */
+      /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */
       parsingConfigOverrides?: {
         [P in string]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
       };
@@ -2118,7 +2120,7 @@ declare namespace gapi.client {
       errorSamples?: GoogleRpcStatus[];
       /** Required. The specification of the evaluation. */
       evaluationSpec?: GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec;
-      /** Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
+      /** Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
       name?: string;
       /** Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. */
       qualityMetrics?: GoogleCloudDiscoveryengineV1betaQualityMetrics;
@@ -2158,6 +2160,8 @@ declare namespace gapi.client {
       fhirStore?: string;
       /** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory. */
       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[];
     }
     interface GoogleCloudDiscoveryengineV1betaFirestoreSource {
       /** Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters. */
@@ -2539,10 +2543,20 @@ declare namespace gapi.client {
       updateTime?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest {
+      /** The desired location of errors incurred during the purge. */
+      errorConfig?: GoogleCloudDiscoveryengineV1betaPurgeErrorConfig;
       /** Required. Filter matching documents to purge. Only currently supported value is `*` (all items). */
       filter?: string;
       /** Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents. */
       force?: boolean;
+      /** Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line. */
+      gcsSource?: GoogleCloudDiscoveryengineV1betaGcsSource;
+      /** Inline source for the input content for purge. */
+      inlineSource?: GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequestInlineSource;
+    }
+    interface GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequestInlineSource {
+      /** Required. A list of full resource name of documents to purge. In the format `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/branches/*‍/documents/*`. Recommended max of 100 items. */
+      documents?: string[];
     }
     interface GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse {
       /** The total count of documents purged as a result of the operation. */
@@ -2550,6 +2564,10 @@ declare namespace gapi.client {
       /** A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random. */
       purgeSample?: string[];
     }
+    interface GoogleCloudDiscoveryengineV1betaPurgeErrorConfig {
+      /** Cloud Storage prefix for purge errors. This must be an empty, existing Cloud Storage directory. Purge errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message. */
+      gcsPrefix?: string;
+    }
     interface GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -2563,6 +2581,12 @@ declare namespace gapi.client {
       /** Number of suggestion deny list entries purged. */
       purgeCount?: string;
     }
+    interface GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest {
+      /** Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 "zulu" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * Deleting specific eventType: `eventType = "search"` * Deleting all events for a specific visitor: `userPseudoId = "visitor1024"` * Deleting all events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND. */
+      filter?: string;
+      /** The `force` field is currently not supported. Purge user event requests will permanently delete all purgeable events. Once the development is complete: If `force` is set to false, the method will return the expected purge count without deleting any user events. This field will default to false if not included in the request. */
+      force?: boolean;
+    }
     interface GoogleCloudDiscoveryengineV1betaQualityMetrics {
       /** Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 */
       docNdcg?: GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics;
@@ -2677,7 +2701,7 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1betaSampleQuery {
       /** Output only. Timestamp the SampleQuery was created at. */
       createTime?: string;
-      /** Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
+      /** Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
       name?: string;
       /** The query entry. */
       queryEntry?: GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry;
@@ -2703,7 +2727,7 @@ declare namespace gapi.client {
       description?: string;
       /** Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. */
       displayName?: string;
-      /** Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
+      /** Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
       name?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaSchema {
@@ -2747,7 +2771,7 @@ declare namespace gapi.client {
       naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec;
       /** A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */
       offset?: number;
-      /** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
+      /** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
       orderBy?: string;
       /** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
       pageSize?: number;
@@ -2851,6 +2875,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec {
       /** 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;
+      /** 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. */
@@ -2960,6 +2986,8 @@ declare namespace gapi.client {
       naturalLanguageQueryUnderstandingInfo?: GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo;
       /** A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
       nextPageToken?: string;
+      /** A list of One Box results. There can be multiple One Box results of different types. */
+      oneBoxResults?: GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult[];
       /** Query expansion information for the returned results. */
       queryExpansionInfo?: GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo;
       /** The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response. */
@@ -3040,6 +3068,10 @@ declare namespace gapi.client {
       address?: string;
       /** The name of the geolocation field as defined in the schema. */
       fieldName?: string;
+      /** The latitude of the geolocation inferred from the input query. */
+      latitude?: number;
+      /** The longitude of the geolocation inferred from the input query. */
+      longitude?: number;
       /** The radius in meters around the address. The record is returned if the location of the geolocation field is within the radius. */
       radiusInMeters?: number;
     }
@@ -3061,6 +3093,12 @@ declare namespace gapi.client {
       /** Values of the string field. The record will only be returned if the field value matches one of the values specified here. */
       values?: string[];
     }
+    interface GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult {
+      /** The type of One Box result. */
+      oneBoxType?: string;
+      /** The search results for this One Box. */
+      searchResults?: GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult[];
+    }
     interface GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo {
       /** Bool describing whether query expansion has occurred. */
       expandedQuery?: boolean;
@@ -3541,7 +3579,7 @@ declare namespace gapi.client {
       defaultParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
       /** The full resource name of the Document Processing Config. Format: `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/documentProcessingConfig`. */
       name?: string;
-      /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. */
+      /** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */
       parsingConfigOverrides?: {
         [P in string]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
       };
@@ -6814,6 +6852,64 @@ declare namespace gapi.client {
         },
         body: GoogleCloudDiscoveryengineV1betaImportUserEventsRequest
       ): Request<GoogleLongrunningOperation>;
+      /** Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. */
+      purge(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;
+        /** Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}` */
+        parent: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest;
+      }): Request<GoogleLongrunningOperation>;
+      purge(
+        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;
+          /** Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}` */
+          parent: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest
+      ): Request<GoogleLongrunningOperation>;
       /** Writes a single user event. */
       write(request: {
         /** V1 error format. */
@@ -6939,6 +7035,8 @@ declare namespace gapi.client {
         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;
+        /** A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. */
+        skipDefaultSchemaCreation?: boolean;
         /** Upload protocol for media (e.g. "raw", "multipart"). */
         upload_protocol?: string;
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -6972,6 +7070,8 @@ declare namespace gapi.client {
           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;
+          /** A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. */
+          skipDefaultSchemaCreation?: boolean;
           /** Upload protocol for media (e.g. "raw", "multipart"). */
           upload_protocol?: string;
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -11346,6 +11446,64 @@ declare namespace gapi.client {
         },
         body: GoogleCloudDiscoveryengineV1betaImportUserEventsRequest
       ): Request<GoogleLongrunningOperation>;
+      /** Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. */
+      purge(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;
+        /** Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}` */
+        parent: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest;
+      }): Request<GoogleLongrunningOperation>;
+      purge(
+        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;
+          /** Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}` */
+          parent: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest
+      ): Request<GoogleLongrunningOperation>;
       /** Writes a single user event. */
       write(request: {
         /** V1 error format. */
@@ -11471,6 +11629,8 @@ declare namespace gapi.client {
         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;
+        /** A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. */
+        skipDefaultSchemaCreation?: boolean;
         /** Upload protocol for media (e.g. "raw", "multipart"). */
         upload_protocol?: string;
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -11504,6 +11664,8 @@ declare namespace gapi.client {
           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;
+          /** A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. */
+          skipDefaultSchemaCreation?: boolean;
           /** Upload protocol for media (e.g. "raw", "multipart"). */
           upload_protocol?: string;
           /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -12167,7 +12329,7 @@ declare namespace gapi.client {
         fields?: string;
         /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
         key?: string;
-        /** Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned. */
+        /** Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned. */
         name: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
@@ -12194,7 +12356,7 @@ declare namespace gapi.client {
         fields?: string;
         /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
         key?: string;
-        /** Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned. */
+        /** Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned. */
         name: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
@@ -12310,7 +12472,7 @@ declare namespace gapi.client {
         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;
-        /** Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
+        /** Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
         name: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
@@ -12341,7 +12503,7 @@ declare namespace gapi.client {
           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;
-          /** Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
+          /** Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
           name: string;
           /** OAuth 2.0 token for the current user. */
           oauth_token?: string;
@@ -12436,7 +12598,7 @@ declare namespace gapi.client {
         fields?: string;
         /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
         key?: string;
-        /** Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned. */
+        /** Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned. */
         name: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
@@ -12463,7 +12625,7 @@ declare namespace gapi.client {
         fields?: string;
         /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
         key?: string;
-        /** Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned. */
+        /** Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned. */
         name: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
@@ -12521,7 +12683,7 @@ declare namespace gapi.client {
         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;
-        /** Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
+        /** Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
         name: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
@@ -12552,7 +12714,7 @@ declare namespace gapi.client {
           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;
-          /** Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
+          /** Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
           name: string;
           /** OAuth 2.0 token for the current user. */
           oauth_token?: string;

package/package.json

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