@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20240704 → 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.
- package/index.d.ts +1326 -63
- 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:
|
|
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
|
-
/**
|
|
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. */
|
|
@@ -207,7 +217,7 @@ declare namespace gapi.client {
|
|
|
207
217
|
document?: string;
|
|
208
218
|
/** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
|
|
209
219
|
snippetInfo?: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[];
|
|
210
|
-
/** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document
|
|
220
|
+
/** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . */
|
|
211
221
|
structData?: {[P in string]: any};
|
|
212
222
|
/** Title. */
|
|
213
223
|
title?: string;
|
|
@@ -219,7 +229,7 @@ declare namespace gapi.client {
|
|
|
219
229
|
chunk?: string;
|
|
220
230
|
/** Chunk textual content. */
|
|
221
231
|
content?: string;
|
|
222
|
-
/**
|
|
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 {
|
|
@@ -316,6 +326,7 @@ declare namespace gapi.client {
|
|
|
316
326
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
317
327
|
updateTime?: string;
|
|
318
328
|
}
|
|
329
|
+
interface GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata {}
|
|
319
330
|
interface GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata {
|
|
320
331
|
/** Operation create time. */
|
|
321
332
|
createTime?: string;
|
|
@@ -328,6 +339,10 @@ declare namespace gapi.client {
|
|
|
328
339
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
329
340
|
updateTime?: string;
|
|
330
341
|
}
|
|
342
|
+
interface GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec {
|
|
343
|
+
/** Whether or not to enable and include custom fine tuned search adaptor model. */
|
|
344
|
+
enableSearchAdaptor?: boolean;
|
|
345
|
+
}
|
|
331
346
|
interface GoogleCloudDiscoveryengineV1alphaCustomTuningModel {
|
|
332
347
|
/** Timestamp the Model was created at. */
|
|
333
348
|
createTime?: string;
|
|
@@ -543,6 +558,34 @@ declare namespace gapi.client {
|
|
|
543
558
|
/** Total number of documents. */
|
|
544
559
|
documentCount?: string;
|
|
545
560
|
}
|
|
561
|
+
interface GoogleCloudDiscoveryengineV1alphaEvaluation {
|
|
562
|
+
/** Output only. Timestamp the Evaluation was created at. */
|
|
563
|
+
createTime?: string;
|
|
564
|
+
/** Output only. Timestamp the Evaluation was completed at. */
|
|
565
|
+
endTime?: string;
|
|
566
|
+
/** Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED. */
|
|
567
|
+
error?: GoogleRpcStatus;
|
|
568
|
+
/** Output only. A sample of errors encountered while processing the request. */
|
|
569
|
+
errorSamples?: GoogleRpcStatus[];
|
|
570
|
+
/** Required. The specification of the evaluation. */
|
|
571
|
+
evaluationSpec?: GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec;
|
|
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. */
|
|
573
|
+
name?: string;
|
|
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. */
|
|
575
|
+
qualityMetrics?: GoogleCloudDiscoveryengineV1alphaQualityMetrics;
|
|
576
|
+
/** Output only. The state of the evaluation. */
|
|
577
|
+
state?: string;
|
|
578
|
+
}
|
|
579
|
+
interface GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec {
|
|
580
|
+
/** Required. The specification of the query set. */
|
|
581
|
+
querySetSpec?: GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec;
|
|
582
|
+
/** Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id */
|
|
583
|
+
searchRequest?: GoogleCloudDiscoveryengineV1alphaSearchRequest;
|
|
584
|
+
}
|
|
585
|
+
interface GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec {
|
|
586
|
+
/** Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. */
|
|
587
|
+
sampleQuerySet?: string;
|
|
588
|
+
}
|
|
546
589
|
interface GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata {
|
|
547
590
|
/** Operation create time. */
|
|
548
591
|
createTime?: string;
|
|
@@ -550,8 +593,6 @@ declare namespace gapi.client {
|
|
|
550
593
|
updateTime?: string;
|
|
551
594
|
}
|
|
552
595
|
interface GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse {
|
|
553
|
-
/** Output result indicating where the data were exported to. */
|
|
554
|
-
outputResult?: GoogleCloudDiscoveryengineV1alphaOutputResult;
|
|
555
596
|
/** The status of the export operation. */
|
|
556
597
|
status?: GoogleRpcStatus;
|
|
557
598
|
}
|
|
@@ -579,6 +620,10 @@ declare namespace gapi.client {
|
|
|
579
620
|
/** If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. */
|
|
580
621
|
searchableOption?: string;
|
|
581
622
|
}
|
|
623
|
+
interface GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse {
|
|
624
|
+
/** Document data keyed by URI pattern. For example: document_data_map = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } } */
|
|
625
|
+
documentDataMap?: {[P in string]: {[P in string]: any}};
|
|
626
|
+
}
|
|
582
627
|
interface GoogleCloudDiscoveryengineV1alphaIdpConfig {
|
|
583
628
|
/** External Identity provider config. */
|
|
584
629
|
externalIdpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig;
|
|
@@ -627,6 +672,24 @@ declare namespace gapi.client {
|
|
|
627
672
|
/** Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message. */
|
|
628
673
|
gcsPrefix?: string;
|
|
629
674
|
}
|
|
675
|
+
interface GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata {
|
|
676
|
+
/** ImportSampleQueries operation create time. */
|
|
677
|
+
createTime?: string;
|
|
678
|
+
/** Count of SampleQuerys that failed to be imported. */
|
|
679
|
+
failureCount?: string;
|
|
680
|
+
/** Count of SampleQuerys successfully imported. */
|
|
681
|
+
successCount?: string;
|
|
682
|
+
/** Total count of SampleQuerys that were processed. */
|
|
683
|
+
totalCount?: string;
|
|
684
|
+
/** ImportSampleQueries operation last update time. If the operation is done, this is also the finish time. */
|
|
685
|
+
updateTime?: string;
|
|
686
|
+
}
|
|
687
|
+
interface GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse {
|
|
688
|
+
/** The desired location of errors incurred during the Import. */
|
|
689
|
+
errorConfig?: GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
|
|
690
|
+
/** A sample of errors encountered while processing the request. */
|
|
691
|
+
errorSamples?: GoogleRpcStatus[];
|
|
692
|
+
}
|
|
630
693
|
interface GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata {
|
|
631
694
|
/** Operation create time. */
|
|
632
695
|
createTime?: string;
|
|
@@ -661,6 +724,16 @@ declare namespace gapi.client {
|
|
|
661
724
|
/** Count of user events imported, but with Document information not found in the existing Branch. */
|
|
662
725
|
unjoinedEventsCount?: string;
|
|
663
726
|
}
|
|
727
|
+
interface GoogleCloudDiscoveryengineV1alphaInterval {
|
|
728
|
+
/** Exclusive upper bound. */
|
|
729
|
+
exclusiveMaximum?: number;
|
|
730
|
+
/** Exclusive lower bound. */
|
|
731
|
+
exclusiveMinimum?: number;
|
|
732
|
+
/** Inclusive upper bound. */
|
|
733
|
+
maximum?: number;
|
|
734
|
+
/** Inclusive lower bound. */
|
|
735
|
+
minimum?: number;
|
|
736
|
+
}
|
|
664
737
|
interface GoogleCloudDiscoveryengineV1alphaLanguageInfo {
|
|
665
738
|
/** Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. */
|
|
666
739
|
language?: string;
|
|
@@ -675,16 +748,6 @@ declare namespace gapi.client {
|
|
|
675
748
|
/** List of custom tuning models. */
|
|
676
749
|
models?: GoogleCloudDiscoveryengineV1alphaCustomTuningModel[];
|
|
677
750
|
}
|
|
678
|
-
interface GoogleCloudDiscoveryengineV1alphaOutputResult {
|
|
679
|
-
/** The BigQuery location where the result is stored. */
|
|
680
|
-
bigqueryResult?: GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult;
|
|
681
|
-
}
|
|
682
|
-
interface GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult {
|
|
683
|
-
/** The ID of a BigQuery Dataset. */
|
|
684
|
-
datasetId?: string;
|
|
685
|
-
/** The ID of a BigQuery Table. */
|
|
686
|
-
tableId?: string;
|
|
687
|
-
}
|
|
688
751
|
interface GoogleCloudDiscoveryengineV1alphaProject {
|
|
689
752
|
/** Output only. The timestamp when this project is created. */
|
|
690
753
|
createTime?: string;
|
|
@@ -766,6 +829,28 @@ declare namespace gapi.client {
|
|
|
766
829
|
/** The total count of events purged as a result of the operation. */
|
|
767
830
|
purgeCount?: string;
|
|
768
831
|
}
|
|
832
|
+
interface GoogleCloudDiscoveryengineV1alphaQualityMetrics {
|
|
833
|
+
/** 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 */
|
|
834
|
+
docNdcg?: GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics;
|
|
835
|
+
/** Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8 */
|
|
836
|
+
docPrecision?: GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics;
|
|
837
|
+
/** Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6 */
|
|
838
|
+
docRecall?: GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics;
|
|
839
|
+
/** Normalized discounted cumulative gain (NDCG) per page, 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 pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for 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 */
|
|
840
|
+
pageNdcg?: GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics;
|
|
841
|
+
/** Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6 */
|
|
842
|
+
pageRecall?: GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics;
|
|
843
|
+
}
|
|
844
|
+
interface GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics {
|
|
845
|
+
/** The top-1 value. */
|
|
846
|
+
top1?: number;
|
|
847
|
+
/** The top-10 value. */
|
|
848
|
+
top10?: number;
|
|
849
|
+
/** The top-3 value. */
|
|
850
|
+
top3?: number;
|
|
851
|
+
/** The top-5 value. */
|
|
852
|
+
top5?: number;
|
|
853
|
+
}
|
|
769
854
|
interface GoogleCloudDiscoveryengineV1alphaQuery {
|
|
770
855
|
/** Unique Id for the query. */
|
|
771
856
|
queryId?: string;
|
|
@@ -816,6 +901,234 @@ declare namespace gapi.client {
|
|
|
816
901
|
/** The structured representation of the schema. */
|
|
817
902
|
structSchema?: {[P in string]: any};
|
|
818
903
|
}
|
|
904
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequest {
|
|
905
|
+
/** Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
|
|
906
|
+
boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
907
|
+
/** The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch. */
|
|
908
|
+
branch?: string;
|
|
909
|
+
/** The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter. */
|
|
910
|
+
canonicalFilter?: string;
|
|
911
|
+
/** A specification for configuring the behavior of content search. */
|
|
912
|
+
contentSearchSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
913
|
+
/** Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. */
|
|
914
|
+
customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
915
|
+
/** Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. */
|
|
916
|
+
dataStoreSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[];
|
|
917
|
+
/** Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. */
|
|
918
|
+
embeddingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec;
|
|
919
|
+
/** Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
920
|
+
facetSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec[];
|
|
921
|
+
/** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
|
|
922
|
+
filter?: string;
|
|
923
|
+
/** Raw image query. */
|
|
924
|
+
imageQuery?: GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery;
|
|
925
|
+
/** The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. */
|
|
926
|
+
languageCode?: string;
|
|
927
|
+
/** If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */
|
|
928
|
+
naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec;
|
|
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. */
|
|
930
|
+
offset?: number;
|
|
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. */
|
|
932
|
+
orderBy?: string;
|
|
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. */
|
|
934
|
+
pageSize?: number;
|
|
935
|
+
/** A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
936
|
+
pageToken?: string;
|
|
937
|
+
/** Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1` */
|
|
938
|
+
params?: {[P in string]: any};
|
|
939
|
+
/** Raw search query. */
|
|
940
|
+
query?: string;
|
|
941
|
+
/** The query expansion specification that specifies the conditions under which query expansion occurs. */
|
|
942
|
+
queryExpansionSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec;
|
|
943
|
+
/** The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. */
|
|
944
|
+
rankingExpression?: string;
|
|
945
|
+
/** The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. */
|
|
946
|
+
regionCode?: string;
|
|
947
|
+
/** The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. */
|
|
948
|
+
relevanceThreshold?: string;
|
|
949
|
+
/** Whether to turn on safe search. This is only supported for website search. */
|
|
950
|
+
safeSearch?: boolean;
|
|
951
|
+
/** Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */
|
|
952
|
+
searchAsYouTypeSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec;
|
|
953
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
954
|
+
servingConfig?: string;
|
|
955
|
+
/** The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */
|
|
956
|
+
session?: string;
|
|
957
|
+
/** Session specification. Can be used only when `session` is set. */
|
|
958
|
+
sessionSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec;
|
|
959
|
+
/** The spell correction specification that specifies the mode under which spell correction takes effect. */
|
|
960
|
+
spellCorrectionSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec;
|
|
961
|
+
/** Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. */
|
|
962
|
+
userInfo?: GoogleCloudDiscoveryengineV1alphaUserInfo;
|
|
963
|
+
/** The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */
|
|
964
|
+
userLabels?: {[P in string]: string};
|
|
965
|
+
/** A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
966
|
+
userPseudoId?: string;
|
|
967
|
+
}
|
|
968
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec {
|
|
969
|
+
/** Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. */
|
|
970
|
+
conditionBoostSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec[];
|
|
971
|
+
}
|
|
972
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec {
|
|
973
|
+
/** Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied. */
|
|
974
|
+
boost?: number;
|
|
975
|
+
/** Complex specification for custom ranking based on customer defined attribute value. */
|
|
976
|
+
boostControlSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec;
|
|
977
|
+
/** An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` */
|
|
978
|
+
condition?: string;
|
|
979
|
+
}
|
|
980
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec {
|
|
981
|
+
/** The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). */
|
|
982
|
+
attributeType?: string;
|
|
983
|
+
/** The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. */
|
|
984
|
+
controlPoints?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint[];
|
|
985
|
+
/** The name of the field whose value will be used to determine the boost amount. */
|
|
986
|
+
fieldName?: string;
|
|
987
|
+
/** The interpolation type to be applied to connect the control points listed below. */
|
|
988
|
+
interpolationType?: string;
|
|
989
|
+
}
|
|
990
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint {
|
|
991
|
+
/** Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. */
|
|
992
|
+
attributeValue?: string;
|
|
993
|
+
/** The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. */
|
|
994
|
+
boostAmount?: number;
|
|
995
|
+
}
|
|
996
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec {
|
|
997
|
+
/** Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */
|
|
998
|
+
chunkSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec;
|
|
999
|
+
/** If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */
|
|
1000
|
+
extractiveContentSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
1001
|
+
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
|
|
1002
|
+
searchResultMode?: string;
|
|
1003
|
+
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
1004
|
+
snippetSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec;
|
|
1005
|
+
/** If `summarySpec` is not specified, summaries are not included in the search response. */
|
|
1006
|
+
summarySpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec;
|
|
1007
|
+
}
|
|
1008
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec {
|
|
1009
|
+
/** The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. */
|
|
1010
|
+
numNextChunks?: number;
|
|
1011
|
+
/** The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. */
|
|
1012
|
+
numPreviousChunks?: number;
|
|
1013
|
+
}
|
|
1014
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec {
|
|
1015
|
+
/** The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. */
|
|
1016
|
+
maxExtractiveAnswerCount?: number;
|
|
1017
|
+
/** The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. */
|
|
1018
|
+
maxExtractiveSegmentCount?: number;
|
|
1019
|
+
/** Return at most `num_next_segments` segments after each selected segments. */
|
|
1020
|
+
numNextSegments?: number;
|
|
1021
|
+
/** Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */
|
|
1022
|
+
numPreviousSegments?: number;
|
|
1023
|
+
/** Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. */
|
|
1024
|
+
returnExtractiveSegmentScore?: boolean;
|
|
1025
|
+
}
|
|
1026
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec {
|
|
1027
|
+
/** [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. */
|
|
1028
|
+
maxSnippetCount?: number;
|
|
1029
|
+
/** [DEPRECATED] This field is deprecated and will have no affect on the snippet. */
|
|
1030
|
+
referenceOnly?: boolean;
|
|
1031
|
+
/** If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned. */
|
|
1032
|
+
returnSnippet?: boolean;
|
|
1033
|
+
}
|
|
1034
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec {
|
|
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. */
|
|
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
|
+
/** 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
|
+
ignoreNonSummarySeekingQuery?: boolean;
|
|
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. */
|
|
1042
|
+
includeCitations?: boolean;
|
|
1043
|
+
/** Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature. */
|
|
1044
|
+
languageCode?: string;
|
|
1045
|
+
/** If specified, the spec will be used to modify the prompt provided to the LLM. */
|
|
1046
|
+
modelPromptSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec;
|
|
1047
|
+
/** If specified, the spec will be used to modify the model specification provided to the LLM. */
|
|
1048
|
+
modelSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec;
|
|
1049
|
+
/** The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. */
|
|
1050
|
+
summaryResultCount?: number;
|
|
1051
|
+
/** If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list. */
|
|
1052
|
+
useSemanticChunks?: boolean;
|
|
1053
|
+
}
|
|
1054
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec {
|
|
1055
|
+
/** Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. */
|
|
1056
|
+
preamble?: string;
|
|
1057
|
+
}
|
|
1058
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec {
|
|
1059
|
+
/** The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). */
|
|
1060
|
+
version?: string;
|
|
1061
|
+
}
|
|
1062
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
|
|
1063
|
+
/** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
|
|
1064
|
+
dataStore?: string;
|
|
1065
|
+
}
|
|
1066
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec {
|
|
1067
|
+
/** The embedding vector used for retrieval. Limit to 1. */
|
|
1068
|
+
embeddingVectors?: GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector[];
|
|
1069
|
+
}
|
|
1070
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector {
|
|
1071
|
+
/** Embedding field path in schema. */
|
|
1072
|
+
fieldPath?: string;
|
|
1073
|
+
/** Query embedding vector. */
|
|
1074
|
+
vector?: number[];
|
|
1075
|
+
}
|
|
1076
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec {
|
|
1077
|
+
/** Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. */
|
|
1078
|
+
enableDynamicPosition?: boolean;
|
|
1079
|
+
/** List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
1080
|
+
excludedFilterKeys?: string[];
|
|
1081
|
+
/** Required. The facet key specification. */
|
|
1082
|
+
facetKey?: GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey;
|
|
1083
|
+
/** Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned. */
|
|
1084
|
+
limit?: number;
|
|
1085
|
+
}
|
|
1086
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey {
|
|
1087
|
+
/** True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. */
|
|
1088
|
+
caseInsensitive?: boolean;
|
|
1089
|
+
/** Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10. */
|
|
1090
|
+
contains?: string[];
|
|
1091
|
+
/** Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30. */
|
|
1092
|
+
intervals?: GoogleCloudDiscoveryengineV1alphaInterval[];
|
|
1093
|
+
/** Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive. */
|
|
1094
|
+
key?: string;
|
|
1095
|
+
/** The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals. */
|
|
1096
|
+
orderBy?: string;
|
|
1097
|
+
/** Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10. */
|
|
1098
|
+
prefixes?: string[];
|
|
1099
|
+
/** Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10. */
|
|
1100
|
+
restrictedValues?: string[];
|
|
1101
|
+
}
|
|
1102
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery {
|
|
1103
|
+
/** Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. */
|
|
1104
|
+
imageBytes?: string;
|
|
1105
|
+
}
|
|
1106
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec {
|
|
1107
|
+
/** The condition under which filter extraction should occur. Default to Condition.DISABLED. */
|
|
1108
|
+
filterExtractionCondition?: string;
|
|
1109
|
+
/** Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. */
|
|
1110
|
+
geoSearchQueryDetectionFieldNames?: string[];
|
|
1111
|
+
}
|
|
1112
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec {
|
|
1113
|
+
/** The condition under which query expansion should occur. Default to Condition.DISABLED. */
|
|
1114
|
+
condition?: string;
|
|
1115
|
+
/** Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. */
|
|
1116
|
+
pinUnexpandedResults?: boolean;
|
|
1117
|
+
}
|
|
1118
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec {
|
|
1119
|
+
/** The condition under which search as you type should occur. Default to Condition.DISABLED. */
|
|
1120
|
+
condition?: string;
|
|
1121
|
+
}
|
|
1122
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec {
|
|
1123
|
+
/** If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. */
|
|
1124
|
+
queryId?: string;
|
|
1125
|
+
/** The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. */
|
|
1126
|
+
searchResultPersistenceCount?: number;
|
|
1127
|
+
}
|
|
1128
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec {
|
|
1129
|
+
/** The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */
|
|
1130
|
+
mode?: string;
|
|
1131
|
+
}
|
|
819
1132
|
interface GoogleCloudDiscoveryengineV1alphaSession {
|
|
820
1133
|
/** Output only. The time the session finished. */
|
|
821
1134
|
endTime?: string;
|
|
@@ -836,6 +1149,13 @@ declare namespace gapi.client {
|
|
|
836
1149
|
/** The user query. */
|
|
837
1150
|
query?: GoogleCloudDiscoveryengineV1alphaQuery;
|
|
838
1151
|
}
|
|
1152
|
+
interface GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata {
|
|
1153
|
+
/** Operation create time. */
|
|
1154
|
+
createTime?: string;
|
|
1155
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1156
|
+
updateTime?: string;
|
|
1157
|
+
}
|
|
1158
|
+
interface GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse {}
|
|
839
1159
|
interface GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo {
|
|
840
1160
|
/** Site verification state indicating the ownership and validity. */
|
|
841
1161
|
siteVerificationState?: string;
|
|
@@ -907,6 +1227,12 @@ declare namespace gapi.client {
|
|
|
907
1227
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
908
1228
|
updateTime?: string;
|
|
909
1229
|
}
|
|
1230
|
+
interface GoogleCloudDiscoveryengineV1alphaUserInfo {
|
|
1231
|
+
/** User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. */
|
|
1232
|
+
userAgent?: string;
|
|
1233
|
+
/** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
1234
|
+
userId?: string;
|
|
1235
|
+
}
|
|
910
1236
|
interface GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata {
|
|
911
1237
|
/** Operation create time. */
|
|
912
1238
|
createTime?: string;
|
|
@@ -1054,7 +1380,7 @@ declare namespace gapi.client {
|
|
|
1054
1380
|
maxReturnResults?: number;
|
|
1055
1381
|
/** 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, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
|
|
1056
1382
|
orderBy?: string;
|
|
1057
|
-
/** Specifies the search result mode. If unspecified, the search result mode
|
|
1383
|
+
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) */
|
|
1058
1384
|
searchResultMode?: string;
|
|
1059
1385
|
}
|
|
1060
1386
|
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultList {
|
|
@@ -1106,7 +1432,7 @@ declare namespace gapi.client {
|
|
|
1106
1432
|
pageIdentifier?: string;
|
|
1107
1433
|
}
|
|
1108
1434
|
interface GoogleCloudDiscoveryengineV1betaAnswerQueryResponse {
|
|
1109
|
-
/** Answer resource object. If AnswerQueryRequest.
|
|
1435
|
+
/** Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. */
|
|
1110
1436
|
answer?: GoogleCloudDiscoveryengineV1betaAnswer;
|
|
1111
1437
|
/** A global unique ID used for logging. */
|
|
1112
1438
|
answerQueryToken?: string;
|
|
@@ -1126,6 +1452,8 @@ declare namespace gapi.client {
|
|
|
1126
1452
|
interface GoogleCloudDiscoveryengineV1betaAnswerReference {
|
|
1127
1453
|
/** Chunk information. */
|
|
1128
1454
|
chunkInfo?: GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo;
|
|
1455
|
+
/** Structured document information. */
|
|
1456
|
+
structuredDocumentInfo?: GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo;
|
|
1129
1457
|
/** Unstructured document information. */
|
|
1130
1458
|
unstructuredDocumentInfo?: GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo;
|
|
1131
1459
|
}
|
|
@@ -1136,7 +1464,7 @@ declare namespace gapi.client {
|
|
|
1136
1464
|
content?: string;
|
|
1137
1465
|
/** Document metadata. */
|
|
1138
1466
|
documentMetadata?: GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata;
|
|
1139
|
-
/**
|
|
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. */
|
|
1140
1468
|
relevanceScore?: number;
|
|
1141
1469
|
}
|
|
1142
1470
|
interface GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata {
|
|
@@ -1151,6 +1479,12 @@ declare namespace gapi.client {
|
|
|
1151
1479
|
/** URI for the document. */
|
|
1152
1480
|
uri?: string;
|
|
1153
1481
|
}
|
|
1482
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo {
|
|
1483
|
+
/** Document resource name. */
|
|
1484
|
+
document?: string;
|
|
1485
|
+
/** Structured search data. */
|
|
1486
|
+
structData?: {[P in string]: any};
|
|
1487
|
+
}
|
|
1154
1488
|
interface GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo {
|
|
1155
1489
|
/** List of cited chunk contents derived from document content. */
|
|
1156
1490
|
chunkContents?: GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
|
|
@@ -1168,6 +1502,8 @@ declare namespace gapi.client {
|
|
|
1168
1502
|
content?: string;
|
|
1169
1503
|
/** Page identifier. */
|
|
1170
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;
|
|
1171
1507
|
}
|
|
1172
1508
|
interface GoogleCloudDiscoveryengineV1betaAnswerStep {
|
|
1173
1509
|
/** Actions. */
|
|
@@ -1196,7 +1532,7 @@ declare namespace gapi.client {
|
|
|
1196
1532
|
document?: string;
|
|
1197
1533
|
/** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
|
|
1198
1534
|
snippetInfo?: GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo[];
|
|
1199
|
-
/** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document
|
|
1535
|
+
/** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . */
|
|
1200
1536
|
structData?: {[P in string]: any};
|
|
1201
1537
|
/** Title. */
|
|
1202
1538
|
title?: string;
|
|
@@ -1208,7 +1544,7 @@ declare namespace gapi.client {
|
|
|
1208
1544
|
chunk?: string;
|
|
1209
1545
|
/** Chunk textual content. */
|
|
1210
1546
|
content?: string;
|
|
1211
|
-
/**
|
|
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. */
|
|
1212
1548
|
relevanceScore?: number;
|
|
1213
1549
|
}
|
|
1214
1550
|
interface GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo {
|
|
@@ -1538,6 +1874,7 @@ declare namespace gapi.client {
|
|
|
1538
1874
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1539
1875
|
updateTime?: string;
|
|
1540
1876
|
}
|
|
1877
|
+
interface GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata {}
|
|
1541
1878
|
interface GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata {
|
|
1542
1879
|
/** Operation create time. */
|
|
1543
1880
|
createTime?: string;
|
|
@@ -1780,6 +2117,34 @@ declare namespace gapi.client {
|
|
|
1780
2117
|
/** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
|
|
1781
2118
|
searchTier?: string;
|
|
1782
2119
|
}
|
|
2120
|
+
interface GoogleCloudDiscoveryengineV1betaEvaluation {
|
|
2121
|
+
/** Output only. Timestamp the Evaluation was created at. */
|
|
2122
|
+
createTime?: string;
|
|
2123
|
+
/** Output only. Timestamp the Evaluation was completed at. */
|
|
2124
|
+
endTime?: string;
|
|
2125
|
+
/** Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED. */
|
|
2126
|
+
error?: GoogleRpcStatus;
|
|
2127
|
+
/** Output only. A sample of errors encountered while processing the request. */
|
|
2128
|
+
errorSamples?: GoogleRpcStatus[];
|
|
2129
|
+
/** Required. The specification of the evaluation. */
|
|
2130
|
+
evaluationSpec?: GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec;
|
|
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. */
|
|
2132
|
+
name?: string;
|
|
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. */
|
|
2134
|
+
qualityMetrics?: GoogleCloudDiscoveryengineV1betaQualityMetrics;
|
|
2135
|
+
/** Output only. The state of the evaluation. */
|
|
2136
|
+
state?: string;
|
|
2137
|
+
}
|
|
2138
|
+
interface GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec {
|
|
2139
|
+
/** Required. The specification of the query set. */
|
|
2140
|
+
querySetSpec?: GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec;
|
|
2141
|
+
/** Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id */
|
|
2142
|
+
searchRequest?: GoogleCloudDiscoveryengineV1betaSearchRequest;
|
|
2143
|
+
}
|
|
2144
|
+
interface GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec {
|
|
2145
|
+
/** Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. */
|
|
2146
|
+
sampleQuerySet?: string;
|
|
2147
|
+
}
|
|
1783
2148
|
interface GoogleCloudDiscoveryengineV1betaFactChunk {
|
|
1784
2149
|
/** Text content of the fact chunk. Can be at most 10K characters long. */
|
|
1785
2150
|
chunkText?: string;
|
|
@@ -1912,6 +2277,38 @@ declare namespace gapi.client {
|
|
|
1912
2277
|
/** Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message. */
|
|
1913
2278
|
gcsPrefix?: string;
|
|
1914
2279
|
}
|
|
2280
|
+
interface GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata {
|
|
2281
|
+
/** ImportSampleQueries operation create time. */
|
|
2282
|
+
createTime?: string;
|
|
2283
|
+
/** Count of SampleQuerys that failed to be imported. */
|
|
2284
|
+
failureCount?: string;
|
|
2285
|
+
/** Count of SampleQuerys successfully imported. */
|
|
2286
|
+
successCount?: string;
|
|
2287
|
+
/** Total count of SampleQuerys that were processed. */
|
|
2288
|
+
totalCount?: string;
|
|
2289
|
+
/** ImportSampleQueries operation last update time. If the operation is done, this is also the finish time. */
|
|
2290
|
+
updateTime?: string;
|
|
2291
|
+
}
|
|
2292
|
+
interface GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest {
|
|
2293
|
+
/** BigQuery input source. */
|
|
2294
|
+
bigquerySource?: GoogleCloudDiscoveryengineV1betaBigQuerySource;
|
|
2295
|
+
/** The desired location of errors incurred during the Import. */
|
|
2296
|
+
errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
2297
|
+
/** Cloud Storage location for the input content. */
|
|
2298
|
+
gcsSource?: GoogleCloudDiscoveryengineV1betaGcsSource;
|
|
2299
|
+
/** The Inline source for sample query entries. */
|
|
2300
|
+
inlineSource?: GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource;
|
|
2301
|
+
}
|
|
2302
|
+
interface GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource {
|
|
2303
|
+
/** Required. A list of SampleQuerys to import. Max of 1000 items. */
|
|
2304
|
+
sampleQueries?: GoogleCloudDiscoveryengineV1betaSampleQuery[];
|
|
2305
|
+
}
|
|
2306
|
+
interface GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse {
|
|
2307
|
+
/** The desired location of errors incurred during the Import. */
|
|
2308
|
+
errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
2309
|
+
/** A sample of errors encountered while processing the request. */
|
|
2310
|
+
errorSamples?: GoogleRpcStatus[];
|
|
2311
|
+
}
|
|
1915
2312
|
interface GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata {
|
|
1916
2313
|
/** Operation create time. */
|
|
1917
2314
|
createTime?: string;
|
|
@@ -2024,6 +2421,36 @@ declare namespace gapi.client {
|
|
|
2024
2421
|
/** Not supported. */
|
|
2025
2422
|
nextPageToken?: string;
|
|
2026
2423
|
}
|
|
2424
|
+
interface GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse {
|
|
2425
|
+
/** The EvaluationResults. */
|
|
2426
|
+
evaluationResults?: GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult[];
|
|
2427
|
+
/** A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
2428
|
+
nextPageToken?: string;
|
|
2429
|
+
}
|
|
2430
|
+
interface GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult {
|
|
2431
|
+
/** Output only. The metrics produced by the evaluation, for a given SampleQuery. */
|
|
2432
|
+
qualityMetrics?: GoogleCloudDiscoveryengineV1betaQualityMetrics;
|
|
2433
|
+
/** Output only. The SampleQuery that was evaluated. */
|
|
2434
|
+
sampleQuery?: GoogleCloudDiscoveryengineV1betaSampleQuery;
|
|
2435
|
+
}
|
|
2436
|
+
interface GoogleCloudDiscoveryengineV1betaListEvaluationsResponse {
|
|
2437
|
+
/** The Evaluations. */
|
|
2438
|
+
evaluations?: GoogleCloudDiscoveryengineV1betaEvaluation[];
|
|
2439
|
+
/** A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
2440
|
+
nextPageToken?: string;
|
|
2441
|
+
}
|
|
2442
|
+
interface GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse {
|
|
2443
|
+
/** A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
2444
|
+
nextPageToken?: string;
|
|
2445
|
+
/** The SampleQuerys. */
|
|
2446
|
+
sampleQueries?: GoogleCloudDiscoveryengineV1betaSampleQuery[];
|
|
2447
|
+
}
|
|
2448
|
+
interface GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse {
|
|
2449
|
+
/** A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
2450
|
+
nextPageToken?: string;
|
|
2451
|
+
/** The SampleQuerySets. */
|
|
2452
|
+
sampleQuerySets?: GoogleCloudDiscoveryengineV1betaSampleQuerySet[];
|
|
2453
|
+
}
|
|
2027
2454
|
interface GoogleCloudDiscoveryengineV1betaListSchemasResponse {
|
|
2028
2455
|
/** A token that can be sent as ListSchemasRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
2029
2456
|
nextPageToken?: string;
|
|
@@ -2122,10 +2549,20 @@ declare namespace gapi.client {
|
|
|
2122
2549
|
updateTime?: string;
|
|
2123
2550
|
}
|
|
2124
2551
|
interface GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest {
|
|
2552
|
+
/** The desired location of errors incurred during the purge. */
|
|
2553
|
+
errorConfig?: GoogleCloudDiscoveryengineV1betaPurgeErrorConfig;
|
|
2125
2554
|
/** Required. Filter matching documents to purge. Only currently supported value is `*` (all items). */
|
|
2126
2555
|
filter?: string;
|
|
2127
2556
|
/** Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents. */
|
|
2128
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[];
|
|
2129
2566
|
}
|
|
2130
2567
|
interface GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse {
|
|
2131
2568
|
/** The total count of documents purged as a result of the operation. */
|
|
@@ -2133,6 +2570,10 @@ declare namespace gapi.client {
|
|
|
2133
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. */
|
|
2134
2571
|
purgeSample?: string[];
|
|
2135
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
|
+
}
|
|
2136
2577
|
interface GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata {
|
|
2137
2578
|
/** Operation create time. */
|
|
2138
2579
|
createTime?: string;
|
|
@@ -2146,6 +2587,34 @@ declare namespace gapi.client {
|
|
|
2146
2587
|
/** Number of suggestion deny list entries purged. */
|
|
2147
2588
|
purgeCount?: string;
|
|
2148
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
|
+
}
|
|
2596
|
+
interface GoogleCloudDiscoveryengineV1betaQualityMetrics {
|
|
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 */
|
|
2598
|
+
docNdcg?: GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics;
|
|
2599
|
+
/** Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8 */
|
|
2600
|
+
docPrecision?: GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics;
|
|
2601
|
+
/** Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6 */
|
|
2602
|
+
docRecall?: GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics;
|
|
2603
|
+
/** Normalized discounted cumulative gain (NDCG) per page, 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 pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for 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 */
|
|
2604
|
+
pageNdcg?: GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics;
|
|
2605
|
+
/** Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6 */
|
|
2606
|
+
pageRecall?: GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics;
|
|
2607
|
+
}
|
|
2608
|
+
interface GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics {
|
|
2609
|
+
/** The top-1 value. */
|
|
2610
|
+
top1?: number;
|
|
2611
|
+
/** The top-10 value. */
|
|
2612
|
+
top10?: number;
|
|
2613
|
+
/** The top-3 value. */
|
|
2614
|
+
top3?: number;
|
|
2615
|
+
/** The top-5 value. */
|
|
2616
|
+
top5?: number;
|
|
2617
|
+
}
|
|
2149
2618
|
interface GoogleCloudDiscoveryengineV1betaQuery {
|
|
2150
2619
|
/** Unique Id for the query. */
|
|
2151
2620
|
queryId?: string;
|
|
@@ -2235,6 +2704,38 @@ declare namespace gapi.client {
|
|
|
2235
2704
|
uri?: string;
|
|
2236
2705
|
}
|
|
2237
2706
|
interface GoogleCloudDiscoveryengineV1betaResumeEngineRequest {}
|
|
2707
|
+
interface GoogleCloudDiscoveryengineV1betaSampleQuery {
|
|
2708
|
+
/** Output only. Timestamp the SampleQuery was created at. */
|
|
2709
|
+
createTime?: string;
|
|
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. */
|
|
2711
|
+
name?: string;
|
|
2712
|
+
/** The query entry. */
|
|
2713
|
+
queryEntry?: GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry;
|
|
2714
|
+
}
|
|
2715
|
+
interface GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry {
|
|
2716
|
+
/** Required. The query. */
|
|
2717
|
+
query?: string;
|
|
2718
|
+
/** List of targets for the query. */
|
|
2719
|
+
targets?: GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget[];
|
|
2720
|
+
}
|
|
2721
|
+
interface GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget {
|
|
2722
|
+
/** Expected page numbers of the target. Each page number must be non negative. */
|
|
2723
|
+
pageNumbers?: number[];
|
|
2724
|
+
/** Relevance score of the target. */
|
|
2725
|
+
score?: number;
|
|
2726
|
+
/** Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`. */
|
|
2727
|
+
uri?: string;
|
|
2728
|
+
}
|
|
2729
|
+
interface GoogleCloudDiscoveryengineV1betaSampleQuerySet {
|
|
2730
|
+
/** Output only. Timestamp the SampleQuerySet was created at. */
|
|
2731
|
+
createTime?: string;
|
|
2732
|
+
/** The description of the SampleQuerySet. */
|
|
2733
|
+
description?: string;
|
|
2734
|
+
/** Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. */
|
|
2735
|
+
displayName?: string;
|
|
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. */
|
|
2737
|
+
name?: string;
|
|
2738
|
+
}
|
|
2238
2739
|
interface GoogleCloudDiscoveryengineV1betaSchema {
|
|
2239
2740
|
/** The JSON representation of the schema. */
|
|
2240
2741
|
jsonSchema?: string;
|
|
@@ -2276,7 +2777,7 @@ declare namespace gapi.client {
|
|
|
2276
2777
|
naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec;
|
|
2277
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. */
|
|
2278
2779
|
offset?: number;
|
|
2279
|
-
/** 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
|
|
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. */
|
|
2280
2781
|
orderBy?: string;
|
|
2281
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. */
|
|
2282
2783
|
pageSize?: number;
|
|
@@ -2296,6 +2797,8 @@ declare namespace gapi.client {
|
|
|
2296
2797
|
safeSearch?: boolean;
|
|
2297
2798
|
/** Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */
|
|
2298
2799
|
searchAsYouTypeSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec;
|
|
2800
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
2801
|
+
servingConfig?: string;
|
|
2299
2802
|
/** The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */
|
|
2300
2803
|
session?: string;
|
|
2301
2804
|
/** Session specification. Can be used only when `session` is set. */
|
|
@@ -2342,7 +2845,7 @@ declare namespace gapi.client {
|
|
|
2342
2845
|
chunkSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec;
|
|
2343
2846
|
/** If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */
|
|
2344
2847
|
extractiveContentSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
2345
|
-
/** Specifies the search result mode. If unspecified, the search result mode
|
|
2848
|
+
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
|
|
2346
2849
|
searchResultMode?: string;
|
|
2347
2850
|
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
2348
2851
|
snippetSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec;
|
|
@@ -2378,6 +2881,8 @@ declare namespace gapi.client {
|
|
|
2378
2881
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec {
|
|
2379
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. */
|
|
2380
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;
|
|
2381
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. */
|
|
2382
2887
|
ignoreNonSummarySeekingQuery?: boolean;
|
|
2383
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. */
|
|
@@ -2448,7 +2953,7 @@ declare namespace gapi.client {
|
|
|
2448
2953
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec {
|
|
2449
2954
|
/** The condition under which filter extraction should occur. Default to Condition.DISABLED. */
|
|
2450
2955
|
filterExtractionCondition?: string;
|
|
2451
|
-
/** Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in
|
|
2956
|
+
/** Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. */
|
|
2452
2957
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
2453
2958
|
}
|
|
2454
2959
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec {
|
|
@@ -2487,6 +2992,8 @@ declare namespace gapi.client {
|
|
|
2487
2992
|
naturalLanguageQueryUnderstandingInfo?: GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo;
|
|
2488
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. */
|
|
2489
2994
|
nextPageToken?: string;
|
|
2995
|
+
/** A list of One Box results. There can be multiple One Box results of different types. */
|
|
2996
|
+
oneBoxResults?: GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult[];
|
|
2490
2997
|
/** Query expansion information for the returned results. */
|
|
2491
2998
|
queryExpansionInfo?: GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo;
|
|
2492
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. */
|
|
@@ -2588,6 +3095,12 @@ declare namespace gapi.client {
|
|
|
2588
3095
|
/** Values of the string field. The record will only be returned if the field value matches one of the values specified here. */
|
|
2589
3096
|
values?: string[];
|
|
2590
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
|
+
}
|
|
2591
3104
|
interface GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo {
|
|
2592
3105
|
/** Bool describing whether query expansion has occurred. */
|
|
2593
3106
|
expandedQuery?: boolean;
|
|
@@ -6341,6 +6854,64 @@ declare namespace gapi.client {
|
|
|
6341
6854
|
},
|
|
6342
6855
|
body: GoogleCloudDiscoveryengineV1betaImportUserEventsRequest
|
|
6343
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>;
|
|
6344
6915
|
/** Writes a single user event. */
|
|
6345
6916
|
write(request: {
|
|
6346
6917
|
/** V1 error format. */
|
|
@@ -6466,6 +7037,8 @@ declare namespace gapi.client {
|
|
|
6466
7037
|
prettyPrint?: boolean;
|
|
6467
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. */
|
|
6468
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;
|
|
6469
7042
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6470
7043
|
upload_protocol?: string;
|
|
6471
7044
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -6499,6 +7072,8 @@ declare namespace gapi.client {
|
|
|
6499
7072
|
prettyPrint?: boolean;
|
|
6500
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. */
|
|
6501
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;
|
|
6502
7077
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6503
7078
|
upload_protocol?: string;
|
|
6504
7079
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -10873,6 +11448,64 @@ declare namespace gapi.client {
|
|
|
10873
11448
|
},
|
|
10874
11449
|
body: GoogleCloudDiscoveryengineV1betaImportUserEventsRequest
|
|
10875
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>;
|
|
10876
11509
|
/** Writes a single user event. */
|
|
10877
11510
|
write(request: {
|
|
10878
11511
|
/** V1 error format. */
|
|
@@ -10998,6 +11631,8 @@ declare namespace gapi.client {
|
|
|
10998
11631
|
prettyPrint?: boolean;
|
|
10999
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. */
|
|
11000
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;
|
|
11001
11636
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11002
11637
|
upload_protocol?: string;
|
|
11003
11638
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -11031,6 +11666,8 @@ declare namespace gapi.client {
|
|
|
11031
11666
|
prettyPrint?: boolean;
|
|
11032
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. */
|
|
11033
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;
|
|
11034
11671
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11035
11672
|
upload_protocol?: string;
|
|
11036
11673
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -11257,11 +11894,8 @@ declare namespace gapi.client {
|
|
|
11257
11894
|
}): Request<GoogleLongrunningOperation>;
|
|
11258
11895
|
}
|
|
11259
11896
|
interface EvaluationsResource {
|
|
11260
|
-
|
|
11261
|
-
|
|
11262
|
-
interface GroundingConfigsResource {
|
|
11263
|
-
/** Performs a grounding check. */
|
|
11264
|
-
check(request: {
|
|
11897
|
+
/** Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution. */
|
|
11898
|
+
create(request: {
|
|
11265
11899
|
/** V1 error format. */
|
|
11266
11900
|
'$.xgafv'?: string;
|
|
11267
11901
|
/** OAuth access token. */
|
|
@@ -11272,12 +11906,12 @@ declare namespace gapi.client {
|
|
|
11272
11906
|
callback?: string;
|
|
11273
11907
|
/** Selector specifying which fields to include in a partial response. */
|
|
11274
11908
|
fields?: string;
|
|
11275
|
-
/** Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`. */
|
|
11276
|
-
groundingConfig: string;
|
|
11277
11909
|
/** 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. */
|
|
11278
11910
|
key?: string;
|
|
11279
11911
|
/** OAuth 2.0 token for the current user. */
|
|
11280
11912
|
oauth_token?: string;
|
|
11913
|
+
/** Required. The parent resource name, such as `projects/{project}/locations/{location}`. */
|
|
11914
|
+
parent: string;
|
|
11281
11915
|
/** Returns response with indentations and line breaks. */
|
|
11282
11916
|
prettyPrint?: boolean;
|
|
11283
11917
|
/** 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. */
|
|
@@ -11287,9 +11921,9 @@ declare namespace gapi.client {
|
|
|
11287
11921
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11288
11922
|
uploadType?: string;
|
|
11289
11923
|
/** Request body */
|
|
11290
|
-
resource:
|
|
11291
|
-
}): Request<
|
|
11292
|
-
|
|
11924
|
+
resource: GoogleCloudDiscoveryengineV1betaEvaluation;
|
|
11925
|
+
}): Request<GoogleLongrunningOperation>;
|
|
11926
|
+
create(
|
|
11293
11927
|
request: {
|
|
11294
11928
|
/** V1 error format. */
|
|
11295
11929
|
'$.xgafv'?: string;
|
|
@@ -11301,12 +11935,12 @@ declare namespace gapi.client {
|
|
|
11301
11935
|
callback?: string;
|
|
11302
11936
|
/** Selector specifying which fields to include in a partial response. */
|
|
11303
11937
|
fields?: string;
|
|
11304
|
-
/** Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`. */
|
|
11305
|
-
groundingConfig: string;
|
|
11306
11938
|
/** 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. */
|
|
11307
11939
|
key?: string;
|
|
11308
11940
|
/** OAuth 2.0 token for the current user. */
|
|
11309
11941
|
oauth_token?: string;
|
|
11942
|
+
/** Required. The parent resource name, such as `projects/{project}/locations/{location}`. */
|
|
11943
|
+
parent: string;
|
|
11310
11944
|
/** Returns response with indentations and line breaks. */
|
|
11311
11945
|
prettyPrint?: boolean;
|
|
11312
11946
|
/** 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. */
|
|
@@ -11316,11 +11950,9 @@ declare namespace gapi.client {
|
|
|
11316
11950
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11317
11951
|
uploadType?: string;
|
|
11318
11952
|
},
|
|
11319
|
-
body:
|
|
11320
|
-
): Request<
|
|
11321
|
-
|
|
11322
|
-
interface OperationsResource {
|
|
11323
|
-
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
11953
|
+
body: GoogleCloudDiscoveryengineV1betaEvaluation
|
|
11954
|
+
): Request<GoogleLongrunningOperation>;
|
|
11955
|
+
/** Gets a Evaluation. */
|
|
11324
11956
|
get(request?: {
|
|
11325
11957
|
/** V1 error format. */
|
|
11326
11958
|
'$.xgafv'?: string;
|
|
@@ -11334,7 +11966,7 @@ declare namespace gapi.client {
|
|
|
11334
11966
|
fields?: string;
|
|
11335
11967
|
/** 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. */
|
|
11336
11968
|
key?: string;
|
|
11337
|
-
/**
|
|
11969
|
+
/** Required. Full resource name of Evaluation, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned. */
|
|
11338
11970
|
name: string;
|
|
11339
11971
|
/** OAuth 2.0 token for the current user. */
|
|
11340
11972
|
oauth_token?: string;
|
|
@@ -11346,8 +11978,8 @@ declare namespace gapi.client {
|
|
|
11346
11978
|
upload_protocol?: string;
|
|
11347
11979
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11348
11980
|
uploadType?: string;
|
|
11349
|
-
}): Request<
|
|
11350
|
-
/**
|
|
11981
|
+
}): Request<GoogleCloudDiscoveryengineV1betaEvaluation>;
|
|
11982
|
+
/** Gets a list of Evaluations. */
|
|
11351
11983
|
list(request?: {
|
|
11352
11984
|
/** V1 error format. */
|
|
11353
11985
|
'$.xgafv'?: string;
|
|
@@ -11359,18 +11991,16 @@ declare namespace gapi.client {
|
|
|
11359
11991
|
callback?: string;
|
|
11360
11992
|
/** Selector specifying which fields to include in a partial response. */
|
|
11361
11993
|
fields?: string;
|
|
11362
|
-
/** The standard list filter. */
|
|
11363
|
-
filter?: string;
|
|
11364
11994
|
/** 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. */
|
|
11365
11995
|
key?: string;
|
|
11366
|
-
/** The name of the operation's parent resource. */
|
|
11367
|
-
name: string;
|
|
11368
11996
|
/** OAuth 2.0 token for the current user. */
|
|
11369
11997
|
oauth_token?: string;
|
|
11370
|
-
/** The
|
|
11998
|
+
/** Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
|
|
11371
11999
|
pageSize?: number;
|
|
11372
|
-
/**
|
|
12000
|
+
/** A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
11373
12001
|
pageToken?: string;
|
|
12002
|
+
/** Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. */
|
|
12003
|
+
parent: string;
|
|
11374
12004
|
/** Returns response with indentations and line breaks. */
|
|
11375
12005
|
prettyPrint?: boolean;
|
|
11376
12006
|
/** 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. */
|
|
@@ -11379,11 +12009,43 @@ declare namespace gapi.client {
|
|
|
11379
12009
|
upload_protocol?: string;
|
|
11380
12010
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11381
12011
|
uploadType?: string;
|
|
11382
|
-
}): Request<
|
|
12012
|
+
}): Request<GoogleCloudDiscoveryengineV1betaListEvaluationsResponse>;
|
|
12013
|
+
/** Gets a list of results for a given a Evaluation. */
|
|
12014
|
+
listResults(request?: {
|
|
12015
|
+
/** V1 error format. */
|
|
12016
|
+
'$.xgafv'?: string;
|
|
12017
|
+
/** OAuth access token. */
|
|
12018
|
+
access_token?: string;
|
|
12019
|
+
/** Data format for response. */
|
|
12020
|
+
alt?: string;
|
|
12021
|
+
/** JSONP */
|
|
12022
|
+
callback?: string;
|
|
12023
|
+
/** Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned. */
|
|
12024
|
+
evaluation: string;
|
|
12025
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12026
|
+
fields?: string;
|
|
12027
|
+
/** 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. */
|
|
12028
|
+
key?: string;
|
|
12029
|
+
/** OAuth 2.0 token for the current user. */
|
|
12030
|
+
oauth_token?: string;
|
|
12031
|
+
/** Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
|
|
12032
|
+
pageSize?: number;
|
|
12033
|
+
/** A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
12034
|
+
pageToken?: string;
|
|
12035
|
+
/** Returns response with indentations and line breaks. */
|
|
12036
|
+
prettyPrint?: boolean;
|
|
12037
|
+
/** 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. */
|
|
12038
|
+
quotaUser?: string;
|
|
12039
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12040
|
+
upload_protocol?: string;
|
|
12041
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12042
|
+
uploadType?: string;
|
|
12043
|
+
}): Request<GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse>;
|
|
12044
|
+
operations: OperationsResource;
|
|
11383
12045
|
}
|
|
11384
|
-
interface
|
|
11385
|
-
/**
|
|
11386
|
-
|
|
12046
|
+
interface GroundingConfigsResource {
|
|
12047
|
+
/** Performs a grounding check. */
|
|
12048
|
+
check(request: {
|
|
11387
12049
|
/** V1 error format. */
|
|
11388
12050
|
'$.xgafv'?: string;
|
|
11389
12051
|
/** OAuth access token. */
|
|
@@ -11394,6 +12056,8 @@ declare namespace gapi.client {
|
|
|
11394
12056
|
callback?: string;
|
|
11395
12057
|
/** Selector specifying which fields to include in a partial response. */
|
|
11396
12058
|
fields?: string;
|
|
12059
|
+
/** Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`. */
|
|
12060
|
+
groundingConfig: string;
|
|
11397
12061
|
/** 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. */
|
|
11398
12062
|
key?: string;
|
|
11399
12063
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -11402,16 +12066,14 @@ declare namespace gapi.client {
|
|
|
11402
12066
|
prettyPrint?: boolean;
|
|
11403
12067
|
/** 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. */
|
|
11404
12068
|
quotaUser?: string;
|
|
11405
|
-
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. */
|
|
11406
|
-
rankingConfig: string;
|
|
11407
12069
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11408
12070
|
upload_protocol?: string;
|
|
11409
12071
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11410
12072
|
uploadType?: string;
|
|
11411
12073
|
/** Request body */
|
|
11412
|
-
resource:
|
|
11413
|
-
}): Request<
|
|
11414
|
-
|
|
12074
|
+
resource: GoogleCloudDiscoveryengineV1betaCheckGroundingRequest;
|
|
12075
|
+
}): Request<GoogleCloudDiscoveryengineV1betaCheckGroundingResponse>;
|
|
12076
|
+
check(
|
|
11415
12077
|
request: {
|
|
11416
12078
|
/** V1 error format. */
|
|
11417
12079
|
'$.xgafv'?: string;
|
|
@@ -11423,6 +12085,8 @@ declare namespace gapi.client {
|
|
|
11423
12085
|
callback?: string;
|
|
11424
12086
|
/** Selector specifying which fields to include in a partial response. */
|
|
11425
12087
|
fields?: string;
|
|
12088
|
+
/** Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`. */
|
|
12089
|
+
groundingConfig: string;
|
|
11426
12090
|
/** 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. */
|
|
11427
12091
|
key?: string;
|
|
11428
12092
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -11431,15 +12095,13 @@ declare namespace gapi.client {
|
|
|
11431
12095
|
prettyPrint?: boolean;
|
|
11432
12096
|
/** 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. */
|
|
11433
12097
|
quotaUser?: string;
|
|
11434
|
-
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. */
|
|
11435
|
-
rankingConfig: string;
|
|
11436
12098
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11437
12099
|
upload_protocol?: string;
|
|
11438
12100
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11439
12101
|
uploadType?: string;
|
|
11440
12102
|
},
|
|
11441
|
-
body:
|
|
11442
|
-
): Request<
|
|
12103
|
+
body: GoogleCloudDiscoveryengineV1betaCheckGroundingRequest
|
|
12104
|
+
): Request<GoogleCloudDiscoveryengineV1betaCheckGroundingResponse>;
|
|
11443
12105
|
}
|
|
11444
12106
|
interface OperationsResource {
|
|
11445
12107
|
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
@@ -11469,9 +12131,610 @@ declare namespace gapi.client {
|
|
|
11469
12131
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11470
12132
|
uploadType?: string;
|
|
11471
12133
|
}): Request<GoogleLongrunningOperation>;
|
|
12134
|
+
/** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
|
|
12135
|
+
list(request?: {
|
|
12136
|
+
/** V1 error format. */
|
|
12137
|
+
'$.xgafv'?: string;
|
|
12138
|
+
/** OAuth access token. */
|
|
12139
|
+
access_token?: string;
|
|
12140
|
+
/** Data format for response. */
|
|
12141
|
+
alt?: string;
|
|
12142
|
+
/** JSONP */
|
|
12143
|
+
callback?: string;
|
|
12144
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12145
|
+
fields?: string;
|
|
12146
|
+
/** The standard list filter. */
|
|
12147
|
+
filter?: string;
|
|
12148
|
+
/** 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. */
|
|
12149
|
+
key?: string;
|
|
12150
|
+
/** The name of the operation's parent resource. */
|
|
12151
|
+
name: string;
|
|
12152
|
+
/** OAuth 2.0 token for the current user. */
|
|
12153
|
+
oauth_token?: string;
|
|
12154
|
+
/** The standard list page size. */
|
|
12155
|
+
pageSize?: number;
|
|
12156
|
+
/** The standard list page token. */
|
|
12157
|
+
pageToken?: string;
|
|
12158
|
+
/** Returns response with indentations and line breaks. */
|
|
12159
|
+
prettyPrint?: boolean;
|
|
12160
|
+
/** 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. */
|
|
12161
|
+
quotaUser?: string;
|
|
12162
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12163
|
+
upload_protocol?: string;
|
|
12164
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12165
|
+
uploadType?: string;
|
|
12166
|
+
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
12167
|
+
}
|
|
12168
|
+
interface RankingConfigsResource {
|
|
12169
|
+
/** Ranks a list of text records based on the given input query. */
|
|
12170
|
+
rank(request: {
|
|
12171
|
+
/** V1 error format. */
|
|
12172
|
+
'$.xgafv'?: string;
|
|
12173
|
+
/** OAuth access token. */
|
|
12174
|
+
access_token?: string;
|
|
12175
|
+
/** Data format for response. */
|
|
12176
|
+
alt?: string;
|
|
12177
|
+
/** JSONP */
|
|
12178
|
+
callback?: string;
|
|
12179
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12180
|
+
fields?: string;
|
|
12181
|
+
/** 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. */
|
|
12182
|
+
key?: string;
|
|
12183
|
+
/** OAuth 2.0 token for the current user. */
|
|
12184
|
+
oauth_token?: string;
|
|
12185
|
+
/** Returns response with indentations and line breaks. */
|
|
12186
|
+
prettyPrint?: boolean;
|
|
12187
|
+
/** 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. */
|
|
12188
|
+
quotaUser?: string;
|
|
12189
|
+
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. */
|
|
12190
|
+
rankingConfig: string;
|
|
12191
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12192
|
+
upload_protocol?: string;
|
|
12193
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12194
|
+
uploadType?: string;
|
|
12195
|
+
/** Request body */
|
|
12196
|
+
resource: GoogleCloudDiscoveryengineV1betaRankRequest;
|
|
12197
|
+
}): Request<GoogleCloudDiscoveryengineV1betaRankResponse>;
|
|
12198
|
+
rank(
|
|
12199
|
+
request: {
|
|
12200
|
+
/** V1 error format. */
|
|
12201
|
+
'$.xgafv'?: string;
|
|
12202
|
+
/** OAuth access token. */
|
|
12203
|
+
access_token?: string;
|
|
12204
|
+
/** Data format for response. */
|
|
12205
|
+
alt?: string;
|
|
12206
|
+
/** JSONP */
|
|
12207
|
+
callback?: string;
|
|
12208
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12209
|
+
fields?: string;
|
|
12210
|
+
/** 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. */
|
|
12211
|
+
key?: string;
|
|
12212
|
+
/** OAuth 2.0 token for the current user. */
|
|
12213
|
+
oauth_token?: string;
|
|
12214
|
+
/** Returns response with indentations and line breaks. */
|
|
12215
|
+
prettyPrint?: boolean;
|
|
12216
|
+
/** 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. */
|
|
12217
|
+
quotaUser?: string;
|
|
12218
|
+
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. */
|
|
12219
|
+
rankingConfig: string;
|
|
12220
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12221
|
+
upload_protocol?: string;
|
|
12222
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12223
|
+
uploadType?: string;
|
|
12224
|
+
},
|
|
12225
|
+
body: GoogleCloudDiscoveryengineV1betaRankRequest
|
|
12226
|
+
): Request<GoogleCloudDiscoveryengineV1betaRankResponse>;
|
|
12227
|
+
}
|
|
12228
|
+
interface OperationsResource {
|
|
12229
|
+
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
12230
|
+
get(request?: {
|
|
12231
|
+
/** V1 error format. */
|
|
12232
|
+
'$.xgafv'?: string;
|
|
12233
|
+
/** OAuth access token. */
|
|
12234
|
+
access_token?: string;
|
|
12235
|
+
/** Data format for response. */
|
|
12236
|
+
alt?: string;
|
|
12237
|
+
/** JSONP */
|
|
12238
|
+
callback?: string;
|
|
12239
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12240
|
+
fields?: string;
|
|
12241
|
+
/** 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. */
|
|
12242
|
+
key?: string;
|
|
12243
|
+
/** The name of the operation resource. */
|
|
12244
|
+
name: string;
|
|
12245
|
+
/** OAuth 2.0 token for the current user. */
|
|
12246
|
+
oauth_token?: string;
|
|
12247
|
+
/** Returns response with indentations and line breaks. */
|
|
12248
|
+
prettyPrint?: boolean;
|
|
12249
|
+
/** 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. */
|
|
12250
|
+
quotaUser?: string;
|
|
12251
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12252
|
+
upload_protocol?: string;
|
|
12253
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12254
|
+
uploadType?: string;
|
|
12255
|
+
}): Request<GoogleLongrunningOperation>;
|
|
12256
|
+
}
|
|
12257
|
+
interface SampleQueriesResource {
|
|
12258
|
+
/** Creates a SampleQuery */
|
|
12259
|
+
create(request: {
|
|
12260
|
+
/** V1 error format. */
|
|
12261
|
+
'$.xgafv'?: string;
|
|
12262
|
+
/** OAuth access token. */
|
|
12263
|
+
access_token?: string;
|
|
12264
|
+
/** Data format for response. */
|
|
12265
|
+
alt?: string;
|
|
12266
|
+
/** JSONP */
|
|
12267
|
+
callback?: string;
|
|
12268
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12269
|
+
fields?: string;
|
|
12270
|
+
/** 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. */
|
|
12271
|
+
key?: string;
|
|
12272
|
+
/** OAuth 2.0 token for the current user. */
|
|
12273
|
+
oauth_token?: string;
|
|
12274
|
+
/** Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. */
|
|
12275
|
+
parent: string;
|
|
12276
|
+
/** Returns response with indentations and line breaks. */
|
|
12277
|
+
prettyPrint?: boolean;
|
|
12278
|
+
/** 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. */
|
|
12279
|
+
quotaUser?: string;
|
|
12280
|
+
/** Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
12281
|
+
sampleQueryId?: string;
|
|
12282
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12283
|
+
upload_protocol?: string;
|
|
12284
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12285
|
+
uploadType?: string;
|
|
12286
|
+
/** Request body */
|
|
12287
|
+
resource: GoogleCloudDiscoveryengineV1betaSampleQuery;
|
|
12288
|
+
}): Request<GoogleCloudDiscoveryengineV1betaSampleQuery>;
|
|
12289
|
+
create(
|
|
12290
|
+
request: {
|
|
12291
|
+
/** V1 error format. */
|
|
12292
|
+
'$.xgafv'?: string;
|
|
12293
|
+
/** OAuth access token. */
|
|
12294
|
+
access_token?: string;
|
|
12295
|
+
/** Data format for response. */
|
|
12296
|
+
alt?: string;
|
|
12297
|
+
/** JSONP */
|
|
12298
|
+
callback?: string;
|
|
12299
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12300
|
+
fields?: string;
|
|
12301
|
+
/** 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. */
|
|
12302
|
+
key?: string;
|
|
12303
|
+
/** OAuth 2.0 token for the current user. */
|
|
12304
|
+
oauth_token?: string;
|
|
12305
|
+
/** Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. */
|
|
12306
|
+
parent: string;
|
|
12307
|
+
/** Returns response with indentations and line breaks. */
|
|
12308
|
+
prettyPrint?: boolean;
|
|
12309
|
+
/** 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. */
|
|
12310
|
+
quotaUser?: string;
|
|
12311
|
+
/** Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
12312
|
+
sampleQueryId?: string;
|
|
12313
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12314
|
+
upload_protocol?: string;
|
|
12315
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12316
|
+
uploadType?: string;
|
|
12317
|
+
},
|
|
12318
|
+
body: GoogleCloudDiscoveryengineV1betaSampleQuery
|
|
12319
|
+
): Request<GoogleCloudDiscoveryengineV1betaSampleQuery>;
|
|
12320
|
+
/** Deletes a SampleQuery. */
|
|
12321
|
+
delete(request?: {
|
|
12322
|
+
/** V1 error format. */
|
|
12323
|
+
'$.xgafv'?: string;
|
|
12324
|
+
/** OAuth access token. */
|
|
12325
|
+
access_token?: string;
|
|
12326
|
+
/** Data format for response. */
|
|
12327
|
+
alt?: string;
|
|
12328
|
+
/** JSONP */
|
|
12329
|
+
callback?: string;
|
|
12330
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12331
|
+
fields?: string;
|
|
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. */
|
|
12333
|
+
key?: string;
|
|
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. */
|
|
12335
|
+
name: string;
|
|
12336
|
+
/** OAuth 2.0 token for the current user. */
|
|
12337
|
+
oauth_token?: string;
|
|
12338
|
+
/** Returns response with indentations and line breaks. */
|
|
12339
|
+
prettyPrint?: boolean;
|
|
12340
|
+
/** 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. */
|
|
12341
|
+
quotaUser?: string;
|
|
12342
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12343
|
+
upload_protocol?: string;
|
|
12344
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12345
|
+
uploadType?: string;
|
|
12346
|
+
}): Request<{}>;
|
|
12347
|
+
/** Gets a SampleQuery. */
|
|
12348
|
+
get(request?: {
|
|
12349
|
+
/** V1 error format. */
|
|
12350
|
+
'$.xgafv'?: string;
|
|
12351
|
+
/** OAuth access token. */
|
|
12352
|
+
access_token?: string;
|
|
12353
|
+
/** Data format for response. */
|
|
12354
|
+
alt?: string;
|
|
12355
|
+
/** JSONP */
|
|
12356
|
+
callback?: string;
|
|
12357
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12358
|
+
fields?: string;
|
|
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. */
|
|
12360
|
+
key?: string;
|
|
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. */
|
|
12362
|
+
name: string;
|
|
12363
|
+
/** OAuth 2.0 token for the current user. */
|
|
12364
|
+
oauth_token?: string;
|
|
12365
|
+
/** Returns response with indentations and line breaks. */
|
|
12366
|
+
prettyPrint?: boolean;
|
|
12367
|
+
/** 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. */
|
|
12368
|
+
quotaUser?: string;
|
|
12369
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12370
|
+
upload_protocol?: string;
|
|
12371
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12372
|
+
uploadType?: string;
|
|
12373
|
+
}): Request<GoogleCloudDiscoveryengineV1betaSampleQuery>;
|
|
12374
|
+
/** Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported. */
|
|
12375
|
+
import(request: {
|
|
12376
|
+
/** V1 error format. */
|
|
12377
|
+
'$.xgafv'?: string;
|
|
12378
|
+
/** OAuth access token. */
|
|
12379
|
+
access_token?: string;
|
|
12380
|
+
/** Data format for response. */
|
|
12381
|
+
alt?: string;
|
|
12382
|
+
/** JSONP */
|
|
12383
|
+
callback?: string;
|
|
12384
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12385
|
+
fields?: string;
|
|
12386
|
+
/** 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. */
|
|
12387
|
+
key?: string;
|
|
12388
|
+
/** OAuth 2.0 token for the current user. */
|
|
12389
|
+
oauth_token?: string;
|
|
12390
|
+
/** Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. */
|
|
12391
|
+
parent: string;
|
|
12392
|
+
/** Returns response with indentations and line breaks. */
|
|
12393
|
+
prettyPrint?: boolean;
|
|
12394
|
+
/** 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. */
|
|
12395
|
+
quotaUser?: string;
|
|
12396
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12397
|
+
upload_protocol?: string;
|
|
12398
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12399
|
+
uploadType?: string;
|
|
12400
|
+
/** Request body */
|
|
12401
|
+
resource: GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest;
|
|
12402
|
+
}): Request<GoogleLongrunningOperation>;
|
|
12403
|
+
import(
|
|
12404
|
+
request: {
|
|
12405
|
+
/** V1 error format. */
|
|
12406
|
+
'$.xgafv'?: string;
|
|
12407
|
+
/** OAuth access token. */
|
|
12408
|
+
access_token?: string;
|
|
12409
|
+
/** Data format for response. */
|
|
12410
|
+
alt?: string;
|
|
12411
|
+
/** JSONP */
|
|
12412
|
+
callback?: string;
|
|
12413
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12414
|
+
fields?: string;
|
|
12415
|
+
/** 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. */
|
|
12416
|
+
key?: string;
|
|
12417
|
+
/** OAuth 2.0 token for the current user. */
|
|
12418
|
+
oauth_token?: string;
|
|
12419
|
+
/** Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. */
|
|
12420
|
+
parent: string;
|
|
12421
|
+
/** Returns response with indentations and line breaks. */
|
|
12422
|
+
prettyPrint?: boolean;
|
|
12423
|
+
/** 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. */
|
|
12424
|
+
quotaUser?: string;
|
|
12425
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12426
|
+
upload_protocol?: string;
|
|
12427
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12428
|
+
uploadType?: string;
|
|
12429
|
+
},
|
|
12430
|
+
body: GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest
|
|
12431
|
+
): Request<GoogleLongrunningOperation>;
|
|
12432
|
+
/** Gets a list of SampleQuerys. */
|
|
12433
|
+
list(request?: {
|
|
12434
|
+
/** V1 error format. */
|
|
12435
|
+
'$.xgafv'?: string;
|
|
12436
|
+
/** OAuth access token. */
|
|
12437
|
+
access_token?: string;
|
|
12438
|
+
/** Data format for response. */
|
|
12439
|
+
alt?: string;
|
|
12440
|
+
/** JSONP */
|
|
12441
|
+
callback?: string;
|
|
12442
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12443
|
+
fields?: string;
|
|
12444
|
+
/** 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. */
|
|
12445
|
+
key?: string;
|
|
12446
|
+
/** OAuth 2.0 token for the current user. */
|
|
12447
|
+
oauth_token?: string;
|
|
12448
|
+
/** Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
|
|
12449
|
+
pageSize?: number;
|
|
12450
|
+
/** A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
12451
|
+
pageToken?: string;
|
|
12452
|
+
/** Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. */
|
|
12453
|
+
parent: string;
|
|
12454
|
+
/** Returns response with indentations and line breaks. */
|
|
12455
|
+
prettyPrint?: boolean;
|
|
12456
|
+
/** 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. */
|
|
12457
|
+
quotaUser?: string;
|
|
12458
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12459
|
+
upload_protocol?: string;
|
|
12460
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12461
|
+
uploadType?: string;
|
|
12462
|
+
}): Request<GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse>;
|
|
12463
|
+
/** Updates a SampleQuery. */
|
|
12464
|
+
patch(request: {
|
|
12465
|
+
/** V1 error format. */
|
|
12466
|
+
'$.xgafv'?: string;
|
|
12467
|
+
/** OAuth access token. */
|
|
12468
|
+
access_token?: string;
|
|
12469
|
+
/** Data format for response. */
|
|
12470
|
+
alt?: string;
|
|
12471
|
+
/** JSONP */
|
|
12472
|
+
callback?: string;
|
|
12473
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12474
|
+
fields?: string;
|
|
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. */
|
|
12476
|
+
key?: string;
|
|
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. */
|
|
12478
|
+
name: string;
|
|
12479
|
+
/** OAuth 2.0 token for the current user. */
|
|
12480
|
+
oauth_token?: string;
|
|
12481
|
+
/** Returns response with indentations and line breaks. */
|
|
12482
|
+
prettyPrint?: boolean;
|
|
12483
|
+
/** 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. */
|
|
12484
|
+
quotaUser?: string;
|
|
12485
|
+
/** Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields. */
|
|
12486
|
+
updateMask?: string;
|
|
12487
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12488
|
+
upload_protocol?: string;
|
|
12489
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12490
|
+
uploadType?: string;
|
|
12491
|
+
/** Request body */
|
|
12492
|
+
resource: GoogleCloudDiscoveryengineV1betaSampleQuery;
|
|
12493
|
+
}): Request<GoogleCloudDiscoveryengineV1betaSampleQuery>;
|
|
12494
|
+
patch(
|
|
12495
|
+
request: {
|
|
12496
|
+
/** V1 error format. */
|
|
12497
|
+
'$.xgafv'?: string;
|
|
12498
|
+
/** OAuth access token. */
|
|
12499
|
+
access_token?: string;
|
|
12500
|
+
/** Data format for response. */
|
|
12501
|
+
alt?: string;
|
|
12502
|
+
/** JSONP */
|
|
12503
|
+
callback?: string;
|
|
12504
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12505
|
+
fields?: string;
|
|
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. */
|
|
12507
|
+
key?: string;
|
|
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. */
|
|
12509
|
+
name: string;
|
|
12510
|
+
/** OAuth 2.0 token for the current user. */
|
|
12511
|
+
oauth_token?: string;
|
|
12512
|
+
/** Returns response with indentations and line breaks. */
|
|
12513
|
+
prettyPrint?: boolean;
|
|
12514
|
+
/** 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. */
|
|
12515
|
+
quotaUser?: string;
|
|
12516
|
+
/** Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields. */
|
|
12517
|
+
updateMask?: string;
|
|
12518
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12519
|
+
upload_protocol?: string;
|
|
12520
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12521
|
+
uploadType?: string;
|
|
12522
|
+
},
|
|
12523
|
+
body: GoogleCloudDiscoveryengineV1betaSampleQuery
|
|
12524
|
+
): Request<GoogleCloudDiscoveryengineV1betaSampleQuery>;
|
|
11472
12525
|
}
|
|
11473
12526
|
interface SampleQuerySetsResource {
|
|
12527
|
+
/** Creates a SampleQuerySet */
|
|
12528
|
+
create(request: {
|
|
12529
|
+
/** V1 error format. */
|
|
12530
|
+
'$.xgafv'?: string;
|
|
12531
|
+
/** OAuth access token. */
|
|
12532
|
+
access_token?: string;
|
|
12533
|
+
/** Data format for response. */
|
|
12534
|
+
alt?: string;
|
|
12535
|
+
/** JSONP */
|
|
12536
|
+
callback?: string;
|
|
12537
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12538
|
+
fields?: string;
|
|
12539
|
+
/** 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. */
|
|
12540
|
+
key?: string;
|
|
12541
|
+
/** OAuth 2.0 token for the current user. */
|
|
12542
|
+
oauth_token?: string;
|
|
12543
|
+
/** Required. The parent resource name, such as `projects/{project}/locations/{location}`. */
|
|
12544
|
+
parent: string;
|
|
12545
|
+
/** Returns response with indentations and line breaks. */
|
|
12546
|
+
prettyPrint?: boolean;
|
|
12547
|
+
/** 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. */
|
|
12548
|
+
quotaUser?: string;
|
|
12549
|
+
/** Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
12550
|
+
sampleQuerySetId?: string;
|
|
12551
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12552
|
+
upload_protocol?: string;
|
|
12553
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12554
|
+
uploadType?: string;
|
|
12555
|
+
/** Request body */
|
|
12556
|
+
resource: GoogleCloudDiscoveryengineV1betaSampleQuerySet;
|
|
12557
|
+
}): Request<GoogleCloudDiscoveryengineV1betaSampleQuerySet>;
|
|
12558
|
+
create(
|
|
12559
|
+
request: {
|
|
12560
|
+
/** V1 error format. */
|
|
12561
|
+
'$.xgafv'?: string;
|
|
12562
|
+
/** OAuth access token. */
|
|
12563
|
+
access_token?: string;
|
|
12564
|
+
/** Data format for response. */
|
|
12565
|
+
alt?: string;
|
|
12566
|
+
/** JSONP */
|
|
12567
|
+
callback?: string;
|
|
12568
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12569
|
+
fields?: string;
|
|
12570
|
+
/** 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. */
|
|
12571
|
+
key?: string;
|
|
12572
|
+
/** OAuth 2.0 token for the current user. */
|
|
12573
|
+
oauth_token?: string;
|
|
12574
|
+
/** Required. The parent resource name, such as `projects/{project}/locations/{location}`. */
|
|
12575
|
+
parent: string;
|
|
12576
|
+
/** Returns response with indentations and line breaks. */
|
|
12577
|
+
prettyPrint?: boolean;
|
|
12578
|
+
/** 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. */
|
|
12579
|
+
quotaUser?: string;
|
|
12580
|
+
/** Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
12581
|
+
sampleQuerySetId?: string;
|
|
12582
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12583
|
+
upload_protocol?: string;
|
|
12584
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12585
|
+
uploadType?: string;
|
|
12586
|
+
},
|
|
12587
|
+
body: GoogleCloudDiscoveryengineV1betaSampleQuerySet
|
|
12588
|
+
): Request<GoogleCloudDiscoveryengineV1betaSampleQuerySet>;
|
|
12589
|
+
/** Deletes a SampleQuerySet. */
|
|
12590
|
+
delete(request?: {
|
|
12591
|
+
/** V1 error format. */
|
|
12592
|
+
'$.xgafv'?: string;
|
|
12593
|
+
/** OAuth access token. */
|
|
12594
|
+
access_token?: string;
|
|
12595
|
+
/** Data format for response. */
|
|
12596
|
+
alt?: string;
|
|
12597
|
+
/** JSONP */
|
|
12598
|
+
callback?: string;
|
|
12599
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12600
|
+
fields?: string;
|
|
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. */
|
|
12602
|
+
key?: string;
|
|
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. */
|
|
12604
|
+
name: string;
|
|
12605
|
+
/** OAuth 2.0 token for the current user. */
|
|
12606
|
+
oauth_token?: string;
|
|
12607
|
+
/** Returns response with indentations and line breaks. */
|
|
12608
|
+
prettyPrint?: boolean;
|
|
12609
|
+
/** 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. */
|
|
12610
|
+
quotaUser?: string;
|
|
12611
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12612
|
+
upload_protocol?: string;
|
|
12613
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12614
|
+
uploadType?: string;
|
|
12615
|
+
}): Request<{}>;
|
|
12616
|
+
/** Gets a SampleQuerySet. */
|
|
12617
|
+
get(request?: {
|
|
12618
|
+
/** V1 error format. */
|
|
12619
|
+
'$.xgafv'?: string;
|
|
12620
|
+
/** OAuth access token. */
|
|
12621
|
+
access_token?: string;
|
|
12622
|
+
/** Data format for response. */
|
|
12623
|
+
alt?: string;
|
|
12624
|
+
/** JSONP */
|
|
12625
|
+
callback?: string;
|
|
12626
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12627
|
+
fields?: string;
|
|
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. */
|
|
12629
|
+
key?: string;
|
|
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. */
|
|
12631
|
+
name: string;
|
|
12632
|
+
/** OAuth 2.0 token for the current user. */
|
|
12633
|
+
oauth_token?: string;
|
|
12634
|
+
/** Returns response with indentations and line breaks. */
|
|
12635
|
+
prettyPrint?: boolean;
|
|
12636
|
+
/** 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. */
|
|
12637
|
+
quotaUser?: string;
|
|
12638
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12639
|
+
upload_protocol?: string;
|
|
12640
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12641
|
+
uploadType?: string;
|
|
12642
|
+
}): Request<GoogleCloudDiscoveryengineV1betaSampleQuerySet>;
|
|
12643
|
+
/** Gets a list of SampleQuerySets. */
|
|
12644
|
+
list(request?: {
|
|
12645
|
+
/** V1 error format. */
|
|
12646
|
+
'$.xgafv'?: string;
|
|
12647
|
+
/** OAuth access token. */
|
|
12648
|
+
access_token?: string;
|
|
12649
|
+
/** Data format for response. */
|
|
12650
|
+
alt?: string;
|
|
12651
|
+
/** JSONP */
|
|
12652
|
+
callback?: string;
|
|
12653
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12654
|
+
fields?: string;
|
|
12655
|
+
/** 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. */
|
|
12656
|
+
key?: string;
|
|
12657
|
+
/** OAuth 2.0 token for the current user. */
|
|
12658
|
+
oauth_token?: string;
|
|
12659
|
+
/** Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
|
|
12660
|
+
pageSize?: number;
|
|
12661
|
+
/** A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
12662
|
+
pageToken?: string;
|
|
12663
|
+
/** Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. */
|
|
12664
|
+
parent: string;
|
|
12665
|
+
/** Returns response with indentations and line breaks. */
|
|
12666
|
+
prettyPrint?: boolean;
|
|
12667
|
+
/** 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. */
|
|
12668
|
+
quotaUser?: string;
|
|
12669
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12670
|
+
upload_protocol?: string;
|
|
12671
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12672
|
+
uploadType?: string;
|
|
12673
|
+
}): Request<GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse>;
|
|
12674
|
+
/** Updates a SampleQuerySet. */
|
|
12675
|
+
patch(request: {
|
|
12676
|
+
/** V1 error format. */
|
|
12677
|
+
'$.xgafv'?: string;
|
|
12678
|
+
/** OAuth access token. */
|
|
12679
|
+
access_token?: string;
|
|
12680
|
+
/** Data format for response. */
|
|
12681
|
+
alt?: string;
|
|
12682
|
+
/** JSONP */
|
|
12683
|
+
callback?: string;
|
|
12684
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12685
|
+
fields?: string;
|
|
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. */
|
|
12687
|
+
key?: string;
|
|
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. */
|
|
12689
|
+
name: string;
|
|
12690
|
+
/** OAuth 2.0 token for the current user. */
|
|
12691
|
+
oauth_token?: string;
|
|
12692
|
+
/** Returns response with indentations and line breaks. */
|
|
12693
|
+
prettyPrint?: boolean;
|
|
12694
|
+
/** 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. */
|
|
12695
|
+
quotaUser?: string;
|
|
12696
|
+
/** Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields. */
|
|
12697
|
+
updateMask?: string;
|
|
12698
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12699
|
+
upload_protocol?: string;
|
|
12700
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12701
|
+
uploadType?: string;
|
|
12702
|
+
/** Request body */
|
|
12703
|
+
resource: GoogleCloudDiscoveryengineV1betaSampleQuerySet;
|
|
12704
|
+
}): Request<GoogleCloudDiscoveryengineV1betaSampleQuerySet>;
|
|
12705
|
+
patch(
|
|
12706
|
+
request: {
|
|
12707
|
+
/** V1 error format. */
|
|
12708
|
+
'$.xgafv'?: string;
|
|
12709
|
+
/** OAuth access token. */
|
|
12710
|
+
access_token?: string;
|
|
12711
|
+
/** Data format for response. */
|
|
12712
|
+
alt?: string;
|
|
12713
|
+
/** JSONP */
|
|
12714
|
+
callback?: string;
|
|
12715
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12716
|
+
fields?: string;
|
|
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. */
|
|
12718
|
+
key?: string;
|
|
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. */
|
|
12720
|
+
name: string;
|
|
12721
|
+
/** OAuth 2.0 token for the current user. */
|
|
12722
|
+
oauth_token?: string;
|
|
12723
|
+
/** Returns response with indentations and line breaks. */
|
|
12724
|
+
prettyPrint?: boolean;
|
|
12725
|
+
/** 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. */
|
|
12726
|
+
quotaUser?: string;
|
|
12727
|
+
/** Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields. */
|
|
12728
|
+
updateMask?: string;
|
|
12729
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12730
|
+
upload_protocol?: string;
|
|
12731
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12732
|
+
uploadType?: string;
|
|
12733
|
+
},
|
|
12734
|
+
body: GoogleCloudDiscoveryengineV1betaSampleQuerySet
|
|
12735
|
+
): Request<GoogleCloudDiscoveryengineV1betaSampleQuerySet>;
|
|
11474
12736
|
operations: OperationsResource;
|
|
12737
|
+
sampleQueries: SampleQueriesResource;
|
|
11475
12738
|
}
|
|
11476
12739
|
interface UserEventsResource {
|
|
11477
12740
|
/** Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly. */
|