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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +195 -31
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1beta
12
- // Revision: 20240715
12
+ // Revision: 20240729
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -137,6 +137,8 @@ declare namespace gapi.client {
137
137
  interface GoogleCloudDiscoveryengineV1alphaAnswerReference {
138
138
  /** Chunk information. */
139
139
  chunkInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo;
140
+ /** Structured document information. */
141
+ structuredDocumentInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo;
140
142
  /** Unstructured document information. */
141
143
  unstructuredDocumentInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo;
142
144
  }
@@ -147,7 +149,7 @@ declare namespace gapi.client {
147
149
  content?: string;
148
150
  /** Document metadata. */
149
151
  documentMetadata?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata;
150
- /** Relevance score. */
152
+ /** 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. */
151
153
  relevanceScore?: number;
152
154
  }
153
155
  interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata {
@@ -162,6 +164,12 @@ declare namespace gapi.client {
162
164
  /** URI for the document. */
163
165
  uri?: string;
164
166
  }
167
+ interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo {
168
+ /** Document resource name. */
169
+ document?: string;
170
+ /** Structured search data. */
171
+ structData?: {[P in string]: any};
172
+ }
165
173
  interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo {
166
174
  /** List of cited chunk contents derived from document content. */
167
175
  chunkContents?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
@@ -179,6 +187,8 @@ declare namespace gapi.client {
179
187
  content?: string;
180
188
  /** Page identifier. */
181
189
  pageIdentifier?: string;
190
+ /** 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. */
191
+ relevanceScore?: number;
182
192
  }
183
193
  interface GoogleCloudDiscoveryengineV1alphaAnswerStep {
184
194
  /** Actions. */
@@ -219,7 +229,7 @@ declare namespace gapi.client {
219
229
  chunk?: string;
220
230
  /** Chunk textual content. */
221
231
  content?: string;
222
- /** Relevance score. */
232
+ /** 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. */
223
233
  relevanceScore?: number;
224
234
  }
225
235
  interface GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo {
@@ -559,7 +569,7 @@ declare namespace gapi.client {
559
569
  errorSamples?: GoogleRpcStatus[];
560
570
  /** Required. The specification of the evaluation. */
561
571
  evaluationSpec?: GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec;
562
- /** 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. */
572
+ /** 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. */
563
573
  name?: string;
564
574
  /** Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. */
565
575
  qualityMetrics?: GoogleCloudDiscoveryengineV1alphaQualityMetrics;
@@ -583,8 +593,6 @@ declare namespace gapi.client {
583
593
  updateTime?: string;
584
594
  }
585
595
  interface GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse {
586
- /** Output result indicating where the data were exported to. */
587
- outputResult?: GoogleCloudDiscoveryengineV1alphaOutputResult;
588
596
  /** The status of the export operation. */
589
597
  status?: GoogleRpcStatus;
590
598
  }
@@ -740,16 +748,6 @@ declare namespace gapi.client {
740
748
  /** List of custom tuning models. */
741
749
  models?: GoogleCloudDiscoveryengineV1alphaCustomTuningModel[];
742
750
  }
743
- interface GoogleCloudDiscoveryengineV1alphaOutputResult {
744
- /** The BigQuery location where the result is stored. */
745
- bigqueryResult?: GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult;
746
- }
747
- interface GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult {
748
- /** The ID of a BigQuery Dataset. */
749
- datasetId?: string;
750
- /** The ID of a BigQuery Table. */
751
- tableId?: string;
752
- }
753
751
  interface GoogleCloudDiscoveryengineV1alphaProject {
754
752
  /** Output only. The timestamp when this project is created. */
755
753
  createTime?: string;
@@ -930,7 +928,7 @@ declare namespace gapi.client {
930
928
  naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec;
931
929
  /** 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. */
932
930
  offset?: number;
933
- /** 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. */
931
+ /** 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. */
934
932
  orderBy?: string;
935
933
  /** 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. */
936
934
  pageSize?: number;
@@ -1036,6 +1034,8 @@ declare namespace gapi.client {
1036
1034
  interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec {
1037
1035
  /** 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. */
1038
1036
  ignoreAdversarialQuery?: boolean;
1037
+ /** 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. */
1038
+ ignoreLowRelevantContent?: boolean;
1039
1039
  /** 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. */
1040
1040
  ignoreNonSummarySeekingQuery?: boolean;
1041
1041
  /** 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 +1452,8 @@ declare namespace gapi.client {
1452
1452
  interface GoogleCloudDiscoveryengineV1betaAnswerReference {
1453
1453
  /** Chunk information. */
1454
1454
  chunkInfo?: GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo;
1455
+ /** Structured document information. */
1456
+ structuredDocumentInfo?: GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo;
1455
1457
  /** Unstructured document information. */
1456
1458
  unstructuredDocumentInfo?: GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo;
1457
1459
  }
@@ -1462,7 +1464,7 @@ declare namespace gapi.client {
1462
1464
  content?: string;
1463
1465
  /** Document metadata. */
1464
1466
  documentMetadata?: GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata;
1465
- /** Relevance score. */
1467
+ /** 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. */
1466
1468
  relevanceScore?: number;
1467
1469
  }
1468
1470
  interface GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata {
@@ -1477,6 +1479,12 @@ declare namespace gapi.client {
1477
1479
  /** URI for the document. */
1478
1480
  uri?: string;
1479
1481
  }
1482
+ interface GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo {
1483
+ /** Document resource name. */
1484
+ document?: string;
1485
+ /** Structured search data. */
1486
+ structData?: {[P in string]: any};
1487
+ }
1480
1488
  interface GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo {
1481
1489
  /** List of cited chunk contents derived from document content. */
1482
1490
  chunkContents?: GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
@@ -1494,6 +1502,8 @@ declare namespace gapi.client {
1494
1502
  content?: string;
1495
1503
  /** Page identifier. */
1496
1504
  pageIdentifier?: string;
1505
+ /** 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. */
1506
+ relevanceScore?: number;
1497
1507
  }
1498
1508
  interface GoogleCloudDiscoveryengineV1betaAnswerStep {
1499
1509
  /** Actions. */
@@ -1534,7 +1544,7 @@ declare namespace gapi.client {
1534
1544
  chunk?: string;
1535
1545
  /** Chunk textual content. */
1536
1546
  content?: string;
1537
- /** Relevance score. */
1547
+ /** 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. */
1538
1548
  relevanceScore?: number;
1539
1549
  }
1540
1550
  interface GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo {
@@ -2118,7 +2128,7 @@ declare namespace gapi.client {
2118
2128
  errorSamples?: GoogleRpcStatus[];
2119
2129
  /** Required. The specification of the evaluation. */
2120
2130
  evaluationSpec?: GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec;
2121
- /** 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. */
2131
+ /** 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. */
2122
2132
  name?: string;
2123
2133
  /** Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. */
2124
2134
  qualityMetrics?: GoogleCloudDiscoveryengineV1betaQualityMetrics;
@@ -2539,10 +2549,20 @@ declare namespace gapi.client {
2539
2549
  updateTime?: string;
2540
2550
  }
2541
2551
  interface GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest {
2552
+ /** The desired location of errors incurred during the purge. */
2553
+ errorConfig?: GoogleCloudDiscoveryengineV1betaPurgeErrorConfig;
2542
2554
  /** Required. Filter matching documents to purge. Only currently supported value is `*` (all items). */
2543
2555
  filter?: string;
2544
2556
  /** Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents. */
2545
2557
  force?: boolean;
2558
+ /** Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line. */
2559
+ gcsSource?: GoogleCloudDiscoveryengineV1betaGcsSource;
2560
+ /** Inline source for the input content for purge. */
2561
+ inlineSource?: GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequestInlineSource;
2562
+ }
2563
+ interface GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequestInlineSource {
2564
+ /** 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. */
2565
+ documents?: string[];
2546
2566
  }
2547
2567
  interface GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse {
2548
2568
  /** The total count of documents purged as a result of the operation. */
@@ -2550,6 +2570,10 @@ declare namespace gapi.client {
2550
2570
  /** 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. */
2551
2571
  purgeSample?: string[];
2552
2572
  }
2573
+ interface GoogleCloudDiscoveryengineV1betaPurgeErrorConfig {
2574
+ /** 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. */
2575
+ gcsPrefix?: string;
2576
+ }
2553
2577
  interface GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata {
2554
2578
  /** Operation create time. */
2555
2579
  createTime?: string;
@@ -2563,6 +2587,12 @@ declare namespace gapi.client {
2563
2587
  /** Number of suggestion deny list entries purged. */
2564
2588
  purgeCount?: string;
2565
2589
  }
2590
+ interface GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest {
2591
+ /** 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. */
2592
+ filter?: string;
2593
+ /** 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. */
2594
+ force?: boolean;
2595
+ }
2566
2596
  interface GoogleCloudDiscoveryengineV1betaQualityMetrics {
2567
2597
  /** 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 */
2568
2598
  docNdcg?: GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics;
@@ -2677,7 +2707,7 @@ declare namespace gapi.client {
2677
2707
  interface GoogleCloudDiscoveryengineV1betaSampleQuery {
2678
2708
  /** Output only. Timestamp the SampleQuery was created at. */
2679
2709
  createTime?: string;
2680
- /** 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. */
2710
+ /** 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. */
2681
2711
  name?: string;
2682
2712
  /** The query entry. */
2683
2713
  queryEntry?: GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry;
@@ -2703,7 +2733,7 @@ declare namespace gapi.client {
2703
2733
  description?: string;
2704
2734
  /** Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. */
2705
2735
  displayName?: string;
2706
- /** 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. */
2736
+ /** 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. */
2707
2737
  name?: string;
2708
2738
  }
2709
2739
  interface GoogleCloudDiscoveryengineV1betaSchema {
@@ -2747,7 +2777,7 @@ declare namespace gapi.client {
2747
2777
  naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec;
2748
2778
  /** 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. */
2749
2779
  offset?: number;
2750
- /** 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. */
2780
+ /** 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. */
2751
2781
  orderBy?: string;
2752
2782
  /** 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. */
2753
2783
  pageSize?: number;
@@ -2851,6 +2881,8 @@ declare namespace gapi.client {
2851
2881
  interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec {
2852
2882
  /** 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. */
2853
2883
  ignoreAdversarialQuery?: boolean;
2884
+ /** 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. */
2885
+ ignoreLowRelevantContent?: boolean;
2854
2886
  /** 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. */
2855
2887
  ignoreNonSummarySeekingQuery?: boolean;
2856
2888
  /** 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 +2992,8 @@ declare namespace gapi.client {
2960
2992
  naturalLanguageQueryUnderstandingInfo?: GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo;
2961
2993
  /** 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. */
2962
2994
  nextPageToken?: string;
2995
+ /** A list of One Box results. There can be multiple One Box results of different types. */
2996
+ oneBoxResults?: GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult[];
2963
2997
  /** Query expansion information for the returned results. */
2964
2998
  queryExpansionInfo?: GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo;
2965
2999
  /** 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. */
@@ -3061,6 +3095,12 @@ declare namespace gapi.client {
3061
3095
  /** Values of the string field. The record will only be returned if the field value matches one of the values specified here. */
3062
3096
  values?: string[];
3063
3097
  }
3098
+ interface GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult {
3099
+ /** The type of One Box result. */
3100
+ oneBoxType?: string;
3101
+ /** The search results for this One Box. */
3102
+ searchResults?: GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult[];
3103
+ }
3064
3104
  interface GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo {
3065
3105
  /** Bool describing whether query expansion has occurred. */
3066
3106
  expandedQuery?: boolean;
@@ -6814,6 +6854,64 @@ declare namespace gapi.client {
6814
6854
  },
6815
6855
  body: GoogleCloudDiscoveryengineV1betaImportUserEventsRequest
6816
6856
  ): Request<GoogleLongrunningOperation>;
6857
+ /** 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. */
6858
+ purge(request: {
6859
+ /** V1 error format. */
6860
+ '$.xgafv'?: string;
6861
+ /** OAuth access token. */
6862
+ access_token?: string;
6863
+ /** Data format for response. */
6864
+ alt?: string;
6865
+ /** JSONP */
6866
+ callback?: string;
6867
+ /** Selector specifying which fields to include in a partial response. */
6868
+ fields?: string;
6869
+ /** 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. */
6870
+ key?: string;
6871
+ /** OAuth 2.0 token for the current user. */
6872
+ oauth_token?: string;
6873
+ /** Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}` */
6874
+ parent: string;
6875
+ /** Returns response with indentations and line breaks. */
6876
+ prettyPrint?: boolean;
6877
+ /** 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. */
6878
+ quotaUser?: string;
6879
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6880
+ upload_protocol?: string;
6881
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6882
+ uploadType?: string;
6883
+ /** Request body */
6884
+ resource: GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest;
6885
+ }): Request<GoogleLongrunningOperation>;
6886
+ purge(
6887
+ request: {
6888
+ /** V1 error format. */
6889
+ '$.xgafv'?: string;
6890
+ /** OAuth access token. */
6891
+ access_token?: string;
6892
+ /** Data format for response. */
6893
+ alt?: string;
6894
+ /** JSONP */
6895
+ callback?: string;
6896
+ /** Selector specifying which fields to include in a partial response. */
6897
+ fields?: string;
6898
+ /** 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. */
6899
+ key?: string;
6900
+ /** OAuth 2.0 token for the current user. */
6901
+ oauth_token?: string;
6902
+ /** Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}` */
6903
+ parent: string;
6904
+ /** Returns response with indentations and line breaks. */
6905
+ prettyPrint?: boolean;
6906
+ /** 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. */
6907
+ quotaUser?: string;
6908
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6909
+ upload_protocol?: string;
6910
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6911
+ uploadType?: string;
6912
+ },
6913
+ body: GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest
6914
+ ): Request<GoogleLongrunningOperation>;
6817
6915
  /** Writes a single user event. */
6818
6916
  write(request: {
6819
6917
  /** V1 error format. */
@@ -6939,6 +7037,8 @@ declare namespace gapi.client {
6939
7037
  prettyPrint?: boolean;
6940
7038
  /** 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. */
6941
7039
  quotaUser?: string;
7040
+ /** 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. */
7041
+ skipDefaultSchemaCreation?: boolean;
6942
7042
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6943
7043
  upload_protocol?: string;
6944
7044
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -6972,6 +7072,8 @@ declare namespace gapi.client {
6972
7072
  prettyPrint?: boolean;
6973
7073
  /** 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. */
6974
7074
  quotaUser?: string;
7075
+ /** 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. */
7076
+ skipDefaultSchemaCreation?: boolean;
6975
7077
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6976
7078
  upload_protocol?: string;
6977
7079
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -11346,6 +11448,64 @@ declare namespace gapi.client {
11346
11448
  },
11347
11449
  body: GoogleCloudDiscoveryengineV1betaImportUserEventsRequest
11348
11450
  ): Request<GoogleLongrunningOperation>;
11451
+ /** 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. */
11452
+ purge(request: {
11453
+ /** V1 error format. */
11454
+ '$.xgafv'?: string;
11455
+ /** OAuth access token. */
11456
+ access_token?: string;
11457
+ /** Data format for response. */
11458
+ alt?: string;
11459
+ /** JSONP */
11460
+ callback?: string;
11461
+ /** Selector specifying which fields to include in a partial response. */
11462
+ fields?: string;
11463
+ /** 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. */
11464
+ key?: string;
11465
+ /** OAuth 2.0 token for the current user. */
11466
+ oauth_token?: string;
11467
+ /** Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}` */
11468
+ parent: string;
11469
+ /** Returns response with indentations and line breaks. */
11470
+ prettyPrint?: boolean;
11471
+ /** 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. */
11472
+ quotaUser?: string;
11473
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
11474
+ upload_protocol?: string;
11475
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
11476
+ uploadType?: string;
11477
+ /** Request body */
11478
+ resource: GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest;
11479
+ }): Request<GoogleLongrunningOperation>;
11480
+ purge(
11481
+ request: {
11482
+ /** V1 error format. */
11483
+ '$.xgafv'?: string;
11484
+ /** OAuth access token. */
11485
+ access_token?: string;
11486
+ /** Data format for response. */
11487
+ alt?: string;
11488
+ /** JSONP */
11489
+ callback?: string;
11490
+ /** Selector specifying which fields to include in a partial response. */
11491
+ fields?: string;
11492
+ /** 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. */
11493
+ key?: string;
11494
+ /** OAuth 2.0 token for the current user. */
11495
+ oauth_token?: string;
11496
+ /** Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}` */
11497
+ parent: string;
11498
+ /** Returns response with indentations and line breaks. */
11499
+ prettyPrint?: boolean;
11500
+ /** 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. */
11501
+ quotaUser?: string;
11502
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
11503
+ upload_protocol?: string;
11504
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
11505
+ uploadType?: string;
11506
+ },
11507
+ body: GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest
11508
+ ): Request<GoogleLongrunningOperation>;
11349
11509
  /** Writes a single user event. */
11350
11510
  write(request: {
11351
11511
  /** V1 error format. */
@@ -11471,6 +11631,8 @@ declare namespace gapi.client {
11471
11631
  prettyPrint?: boolean;
11472
11632
  /** 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. */
11473
11633
  quotaUser?: string;
11634
+ /** 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. */
11635
+ skipDefaultSchemaCreation?: boolean;
11474
11636
  /** Upload protocol for media (e.g. "raw", "multipart"). */
11475
11637
  upload_protocol?: string;
11476
11638
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -11504,6 +11666,8 @@ declare namespace gapi.client {
11504
11666
  prettyPrint?: boolean;
11505
11667
  /** 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. */
11506
11668
  quotaUser?: string;
11669
+ /** 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. */
11670
+ skipDefaultSchemaCreation?: boolean;
11507
11671
  /** Upload protocol for media (e.g. "raw", "multipart"). */
11508
11672
  upload_protocol?: string;
11509
11673
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -12167,7 +12331,7 @@ declare namespace gapi.client {
12167
12331
  fields?: string;
12168
12332
  /** 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. */
12169
12333
  key?: string;
12170
- /** 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. */
12334
+ /** 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. */
12171
12335
  name: string;
12172
12336
  /** OAuth 2.0 token for the current user. */
12173
12337
  oauth_token?: string;
@@ -12194,7 +12358,7 @@ declare namespace gapi.client {
12194
12358
  fields?: string;
12195
12359
  /** 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. */
12196
12360
  key?: string;
12197
- /** 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. */
12361
+ /** 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. */
12198
12362
  name: string;
12199
12363
  /** OAuth 2.0 token for the current user. */
12200
12364
  oauth_token?: string;
@@ -12310,7 +12474,7 @@ declare namespace gapi.client {
12310
12474
  fields?: string;
12311
12475
  /** 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. */
12312
12476
  key?: string;
12313
- /** 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. */
12477
+ /** 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. */
12314
12478
  name: string;
12315
12479
  /** OAuth 2.0 token for the current user. */
12316
12480
  oauth_token?: string;
@@ -12341,7 +12505,7 @@ declare namespace gapi.client {
12341
12505
  fields?: string;
12342
12506
  /** 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. */
12343
12507
  key?: string;
12344
- /** 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. */
12508
+ /** 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. */
12345
12509
  name: string;
12346
12510
  /** OAuth 2.0 token for the current user. */
12347
12511
  oauth_token?: string;
@@ -12436,7 +12600,7 @@ declare namespace gapi.client {
12436
12600
  fields?: string;
12437
12601
  /** 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. */
12438
12602
  key?: string;
12439
- /** 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. */
12603
+ /** 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. */
12440
12604
  name: string;
12441
12605
  /** OAuth 2.0 token for the current user. */
12442
12606
  oauth_token?: string;
@@ -12463,7 +12627,7 @@ declare namespace gapi.client {
12463
12627
  fields?: string;
12464
12628
  /** 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. */
12465
12629
  key?: string;
12466
- /** 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. */
12630
+ /** 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. */
12467
12631
  name: string;
12468
12632
  /** OAuth 2.0 token for the current user. */
12469
12633
  oauth_token?: string;
@@ -12521,7 +12685,7 @@ declare namespace gapi.client {
12521
12685
  fields?: string;
12522
12686
  /** 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. */
12523
12687
  key?: string;
12524
- /** 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. */
12688
+ /** 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. */
12525
12689
  name: string;
12526
12690
  /** OAuth 2.0 token for the current user. */
12527
12691
  oauth_token?: string;
@@ -12552,7 +12716,7 @@ declare namespace gapi.client {
12552
12716
  fields?: string;
12553
12717
  /** 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. */
12554
12718
  key?: string;
12555
- /** 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. */
12719
+ /** 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. */
12556
12720
  name: string;
12557
12721
  /** OAuth 2.0 token for the current user. */
12558
12722
  oauth_token?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1beta",
3
- "version": "0.0.20240715",
3
+ "version": "0.0.20240729",
4
4
  "description": "TypeScript typings for Discovery Engine API v1beta",
5
5
  "repository": {
6
6
  "type": "git",