@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240704 → 0.0.20240715
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 +1344 -94
- 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=v1alpha
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240715
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -291,7 +291,7 @@ declare namespace gapi.client {
|
|
|
291
291
|
maxReturnResults?: number;
|
|
292
292
|
/** 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. */
|
|
293
293
|
orderBy?: string;
|
|
294
|
-
/** Specifies the search result mode. If unspecified, the search result mode
|
|
294
|
+
/** 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) */
|
|
295
295
|
searchResultMode?: string;
|
|
296
296
|
}
|
|
297
297
|
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList {
|
|
@@ -343,7 +343,7 @@ declare namespace gapi.client {
|
|
|
343
343
|
pageIdentifier?: string;
|
|
344
344
|
}
|
|
345
345
|
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse {
|
|
346
|
-
/** Answer resource object. If AnswerQueryRequest.
|
|
346
|
+
/** 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. */
|
|
347
347
|
answer?: GoogleCloudDiscoveryengineV1alphaAnswer;
|
|
348
348
|
/** A global unique ID used for logging. */
|
|
349
349
|
answerQueryToken?: string;
|
|
@@ -433,7 +433,7 @@ declare namespace gapi.client {
|
|
|
433
433
|
document?: string;
|
|
434
434
|
/** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
|
|
435
435
|
snippetInfo?: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[];
|
|
436
|
-
/** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document
|
|
436
|
+
/** 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 . */
|
|
437
437
|
structData?: {[P in string]: any};
|
|
438
438
|
/** Title. */
|
|
439
439
|
title?: string;
|
|
@@ -805,6 +805,7 @@ declare namespace gapi.client {
|
|
|
805
805
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
806
806
|
updateTime?: string;
|
|
807
807
|
}
|
|
808
|
+
interface GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata {}
|
|
808
809
|
interface GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata {
|
|
809
810
|
/** Operation create time. */
|
|
810
811
|
createTime?: string;
|
|
@@ -1132,6 +1133,34 @@ declare namespace gapi.client {
|
|
|
1132
1133
|
/** Total number of documents. */
|
|
1133
1134
|
documentCount?: string;
|
|
1134
1135
|
}
|
|
1136
|
+
interface GoogleCloudDiscoveryengineV1alphaEvaluation {
|
|
1137
|
+
/** Output only. Timestamp the Evaluation was created at. */
|
|
1138
|
+
createTime?: string;
|
|
1139
|
+
/** Output only. Timestamp the Evaluation was completed at. */
|
|
1140
|
+
endTime?: string;
|
|
1141
|
+
/** Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED. */
|
|
1142
|
+
error?: GoogleRpcStatus;
|
|
1143
|
+
/** Output only. A sample of errors encountered while processing the request. */
|
|
1144
|
+
errorSamples?: GoogleRpcStatus[];
|
|
1145
|
+
/** Required. The specification of the evaluation. */
|
|
1146
|
+
evaluationSpec?: GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec;
|
|
1147
|
+
/** Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
1148
|
+
name?: string;
|
|
1149
|
+
/** Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. */
|
|
1150
|
+
qualityMetrics?: GoogleCloudDiscoveryengineV1alphaQualityMetrics;
|
|
1151
|
+
/** Output only. The state of the evaluation. */
|
|
1152
|
+
state?: string;
|
|
1153
|
+
}
|
|
1154
|
+
interface GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec {
|
|
1155
|
+
/** Required. The specification of the query set. */
|
|
1156
|
+
querySetSpec?: GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec;
|
|
1157
|
+
/** 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 */
|
|
1158
|
+
searchRequest?: GoogleCloudDiscoveryengineV1alphaSearchRequest;
|
|
1159
|
+
}
|
|
1160
|
+
interface GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec {
|
|
1161
|
+
/** Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. */
|
|
1162
|
+
sampleQuerySet?: string;
|
|
1163
|
+
}
|
|
1135
1164
|
interface GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata {
|
|
1136
1165
|
/** Operation create time. */
|
|
1137
1166
|
createTime?: string;
|
|
@@ -1208,6 +1237,10 @@ declare namespace gapi.client {
|
|
|
1208
1237
|
/** Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). */
|
|
1209
1238
|
inputUris?: string[];
|
|
1210
1239
|
}
|
|
1240
|
+
interface GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse {
|
|
1241
|
+
/** Document data keyed by URI pattern. For example: document_data_map = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } } */
|
|
1242
|
+
documentDataMap?: {[P in string]: {[P in string]: any}};
|
|
1243
|
+
}
|
|
1211
1244
|
interface GoogleCloudDiscoveryengineV1alphaGroundingFact {
|
|
1212
1245
|
/** Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on. */
|
|
1213
1246
|
attributes?: {[P in string]: string};
|
|
@@ -1318,6 +1351,38 @@ declare namespace gapi.client {
|
|
|
1318
1351
|
/** 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. */
|
|
1319
1352
|
gcsPrefix?: string;
|
|
1320
1353
|
}
|
|
1354
|
+
interface GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata {
|
|
1355
|
+
/** ImportSampleQueries operation create time. */
|
|
1356
|
+
createTime?: string;
|
|
1357
|
+
/** Count of SampleQuerys that failed to be imported. */
|
|
1358
|
+
failureCount?: string;
|
|
1359
|
+
/** Count of SampleQuerys successfully imported. */
|
|
1360
|
+
successCount?: string;
|
|
1361
|
+
/** Total count of SampleQuerys that were processed. */
|
|
1362
|
+
totalCount?: string;
|
|
1363
|
+
/** ImportSampleQueries operation last update time. If the operation is done, this is also the finish time. */
|
|
1364
|
+
updateTime?: string;
|
|
1365
|
+
}
|
|
1366
|
+
interface GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest {
|
|
1367
|
+
/** BigQuery input source. */
|
|
1368
|
+
bigquerySource?: GoogleCloudDiscoveryengineV1alphaBigQuerySource;
|
|
1369
|
+
/** The desired location of errors incurred during the Import. */
|
|
1370
|
+
errorConfig?: GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
|
|
1371
|
+
/** Cloud Storage location for the input content. */
|
|
1372
|
+
gcsSource?: GoogleCloudDiscoveryengineV1alphaGcsSource;
|
|
1373
|
+
/** The Inline source for sample query entries. */
|
|
1374
|
+
inlineSource?: GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource;
|
|
1375
|
+
}
|
|
1376
|
+
interface GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource {
|
|
1377
|
+
/** Required. A list of SampleQuerys to import. Max of 1000 items. */
|
|
1378
|
+
sampleQueries?: GoogleCloudDiscoveryengineV1alphaSampleQuery[];
|
|
1379
|
+
}
|
|
1380
|
+
interface GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse {
|
|
1381
|
+
/** The desired location of errors incurred during the Import. */
|
|
1382
|
+
errorConfig?: GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
|
|
1383
|
+
/** A sample of errors encountered while processing the request. */
|
|
1384
|
+
errorSamples?: GoogleRpcStatus[];
|
|
1385
|
+
}
|
|
1321
1386
|
interface GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata {
|
|
1322
1387
|
/** Operation create time. */
|
|
1323
1388
|
createTime?: string;
|
|
@@ -1436,6 +1501,36 @@ declare namespace gapi.client {
|
|
|
1436
1501
|
/** Not supported. */
|
|
1437
1502
|
nextPageToken?: string;
|
|
1438
1503
|
}
|
|
1504
|
+
interface GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse {
|
|
1505
|
+
/** The EvaluationResults. */
|
|
1506
|
+
evaluationResults?: GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult[];
|
|
1507
|
+
/** 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. */
|
|
1508
|
+
nextPageToken?: string;
|
|
1509
|
+
}
|
|
1510
|
+
interface GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult {
|
|
1511
|
+
/** Output only. The metrics produced by the evaluation, for a given SampleQuery. */
|
|
1512
|
+
qualityMetrics?: GoogleCloudDiscoveryengineV1alphaQualityMetrics;
|
|
1513
|
+
/** Output only. The SampleQuery that was evaluated. */
|
|
1514
|
+
sampleQuery?: GoogleCloudDiscoveryengineV1alphaSampleQuery;
|
|
1515
|
+
}
|
|
1516
|
+
interface GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse {
|
|
1517
|
+
/** The Evaluations. */
|
|
1518
|
+
evaluations?: GoogleCloudDiscoveryengineV1alphaEvaluation[];
|
|
1519
|
+
/** 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. */
|
|
1520
|
+
nextPageToken?: string;
|
|
1521
|
+
}
|
|
1522
|
+
interface GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse {
|
|
1523
|
+
/** 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. */
|
|
1524
|
+
nextPageToken?: string;
|
|
1525
|
+
/** The SampleQuerys. */
|
|
1526
|
+
sampleQueries?: GoogleCloudDiscoveryengineV1alphaSampleQuery[];
|
|
1527
|
+
}
|
|
1528
|
+
interface GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse {
|
|
1529
|
+
/** 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. */
|
|
1530
|
+
nextPageToken?: string;
|
|
1531
|
+
/** The SampleQuerySets. */
|
|
1532
|
+
sampleQuerySets?: GoogleCloudDiscoveryengineV1alphaSampleQuerySet[];
|
|
1533
|
+
}
|
|
1439
1534
|
interface GoogleCloudDiscoveryengineV1alphaListSchemasResponse {
|
|
1440
1535
|
/** 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. */
|
|
1441
1536
|
nextPageToken?: string;
|
|
@@ -1620,6 +1715,28 @@ declare namespace gapi.client {
|
|
|
1620
1715
|
/** The total count of events purged as a result of the operation. */
|
|
1621
1716
|
purgeCount?: string;
|
|
1622
1717
|
}
|
|
1718
|
+
interface GoogleCloudDiscoveryengineV1alphaQualityMetrics {
|
|
1719
|
+
/** 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 */
|
|
1720
|
+
docNdcg?: GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics;
|
|
1721
|
+
/** 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 */
|
|
1722
|
+
docPrecision?: GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics;
|
|
1723
|
+
/** 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 */
|
|
1724
|
+
docRecall?: GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics;
|
|
1725
|
+
/** 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 */
|
|
1726
|
+
pageNdcg?: GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics;
|
|
1727
|
+
/** 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 */
|
|
1728
|
+
pageRecall?: GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics;
|
|
1729
|
+
}
|
|
1730
|
+
interface GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics {
|
|
1731
|
+
/** The top-1 value. */
|
|
1732
|
+
top1?: number;
|
|
1733
|
+
/** The top-10 value. */
|
|
1734
|
+
top10?: number;
|
|
1735
|
+
/** The top-3 value. */
|
|
1736
|
+
top3?: number;
|
|
1737
|
+
/** The top-5 value. */
|
|
1738
|
+
top5?: number;
|
|
1739
|
+
}
|
|
1623
1740
|
interface GoogleCloudDiscoveryengineV1alphaQuery {
|
|
1624
1741
|
/** Unique Id for the query. */
|
|
1625
1742
|
queryId?: string;
|
|
@@ -1797,6 +1914,38 @@ declare namespace gapi.client {
|
|
|
1797
1914
|
variableId?: string;
|
|
1798
1915
|
}
|
|
1799
1916
|
interface GoogleCloudDiscoveryengineV1alphaResumeEngineRequest {}
|
|
1917
|
+
interface GoogleCloudDiscoveryengineV1alphaSampleQuery {
|
|
1918
|
+
/** Output only. Timestamp the SampleQuery was created at. */
|
|
1919
|
+
createTime?: string;
|
|
1920
|
+
/** Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
1921
|
+
name?: string;
|
|
1922
|
+
/** The query entry. */
|
|
1923
|
+
queryEntry?: GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry;
|
|
1924
|
+
}
|
|
1925
|
+
interface GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry {
|
|
1926
|
+
/** Required. The query. */
|
|
1927
|
+
query?: string;
|
|
1928
|
+
/** List of targets for the query. */
|
|
1929
|
+
targets?: GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget[];
|
|
1930
|
+
}
|
|
1931
|
+
interface GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget {
|
|
1932
|
+
/** Expected page numbers of the target. Each page number must be non negative. */
|
|
1933
|
+
pageNumbers?: number[];
|
|
1934
|
+
/** Relevance score of the target. */
|
|
1935
|
+
score?: number;
|
|
1936
|
+
/** 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`. */
|
|
1937
|
+
uri?: string;
|
|
1938
|
+
}
|
|
1939
|
+
interface GoogleCloudDiscoveryengineV1alphaSampleQuerySet {
|
|
1940
|
+
/** Output only. Timestamp the SampleQuerySet was created at. */
|
|
1941
|
+
createTime?: string;
|
|
1942
|
+
/** The description of the SampleQuerySet. */
|
|
1943
|
+
description?: string;
|
|
1944
|
+
/** Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. */
|
|
1945
|
+
displayName?: string;
|
|
1946
|
+
/** Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
1947
|
+
name?: string;
|
|
1948
|
+
}
|
|
1800
1949
|
interface GoogleCloudDiscoveryengineV1alphaSchema {
|
|
1801
1950
|
/** Output only. Configurations for fields of the schema. */
|
|
1802
1951
|
fieldConfigs?: GoogleCloudDiscoveryengineV1alphaFieldConfig[];
|
|
@@ -1864,6 +2013,8 @@ declare namespace gapi.client {
|
|
|
1864
2013
|
safeSearch?: boolean;
|
|
1865
2014
|
/** Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */
|
|
1866
2015
|
searchAsYouTypeSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec;
|
|
2016
|
+
/** 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. */
|
|
2017
|
+
servingConfig?: string;
|
|
1867
2018
|
/** 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. */
|
|
1868
2019
|
session?: string;
|
|
1869
2020
|
/** Session specification. Can be used only when `session` is set. */
|
|
@@ -1910,7 +2061,7 @@ declare namespace gapi.client {
|
|
|
1910
2061
|
chunkSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec;
|
|
1911
2062
|
/** If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */
|
|
1912
2063
|
extractiveContentSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
1913
|
-
/** Specifies the search result mode. If unspecified, the search result mode
|
|
2064
|
+
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
|
|
1914
2065
|
searchResultMode?: string;
|
|
1915
2066
|
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
1916
2067
|
snippetSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec;
|
|
@@ -2016,7 +2167,7 @@ declare namespace gapi.client {
|
|
|
2016
2167
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec {
|
|
2017
2168
|
/** The condition under which filter extraction should occur. Default to Condition.DISABLED. */
|
|
2018
2169
|
filterExtractionCondition?: string;
|
|
2019
|
-
/** 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
|
|
2170
|
+
/** 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. */
|
|
2020
2171
|
geoSearchQueryDetectionFieldNames?: string[];
|
|
2021
2172
|
}
|
|
2022
2173
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec {
|
|
@@ -2314,6 +2465,21 @@ declare namespace gapi.client {
|
|
|
2314
2465
|
/** The user query. */
|
|
2315
2466
|
query?: GoogleCloudDiscoveryengineV1alphaQuery;
|
|
2316
2467
|
}
|
|
2468
|
+
interface GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata {
|
|
2469
|
+
/** Operation create time. */
|
|
2470
|
+
createTime?: string;
|
|
2471
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
2472
|
+
updateTime?: string;
|
|
2473
|
+
}
|
|
2474
|
+
interface GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest {
|
|
2475
|
+
/** Document data keyed by URI pattern. Each entry must be consistent with the Schema. For example: Schema = { "type": "object", "properties": { "Categories": { "type": "array", "items": { "retrievable": true, "type": "string" } } } document_data_map = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } } */
|
|
2476
|
+
documentDataMap?: {[P in string]: {[P in string]: any}};
|
|
2477
|
+
/** If true, clears the document data map. If true, SetUriPatternDocumentDataRequest.document_data_map must be empty. */
|
|
2478
|
+
emptyDocumentDataMap?: boolean;
|
|
2479
|
+
/** Optional. If not provided, the current Schema is used. If provided, validates and updates the Schema. If validation fails, an error is returned. */
|
|
2480
|
+
schema?: {[P in string]: any};
|
|
2481
|
+
}
|
|
2482
|
+
interface GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse {}
|
|
2317
2483
|
interface GoogleCloudDiscoveryengineV1alphaSiteSearchEngine {
|
|
2318
2484
|
/** The fully qualified resource name of the site search engine. Format: `projects/*/locations/*/dataStores/*/siteSearchEngine` */
|
|
2319
2485
|
name?: string;
|
|
@@ -2592,6 +2758,7 @@ declare namespace gapi.client {
|
|
|
2592
2758
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
2593
2759
|
updateTime?: string;
|
|
2594
2760
|
}
|
|
2761
|
+
interface GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata {}
|
|
2595
2762
|
interface GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata {
|
|
2596
2763
|
/** Operation create time. */
|
|
2597
2764
|
createTime?: string;
|
|
@@ -2772,6 +2939,34 @@ declare namespace gapi.client {
|
|
|
2772
2939
|
/** 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. */
|
|
2773
2940
|
searchTier?: string;
|
|
2774
2941
|
}
|
|
2942
|
+
interface GoogleCloudDiscoveryengineV1betaEvaluation {
|
|
2943
|
+
/** Output only. Timestamp the Evaluation was created at. */
|
|
2944
|
+
createTime?: string;
|
|
2945
|
+
/** Output only. Timestamp the Evaluation was completed at. */
|
|
2946
|
+
endTime?: string;
|
|
2947
|
+
/** Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED. */
|
|
2948
|
+
error?: GoogleRpcStatus;
|
|
2949
|
+
/** Output only. A sample of errors encountered while processing the request. */
|
|
2950
|
+
errorSamples?: GoogleRpcStatus[];
|
|
2951
|
+
/** Required. The specification of the evaluation. */
|
|
2952
|
+
evaluationSpec?: GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec;
|
|
2953
|
+
/** Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
2954
|
+
name?: string;
|
|
2955
|
+
/** Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. */
|
|
2956
|
+
qualityMetrics?: GoogleCloudDiscoveryengineV1betaQualityMetrics;
|
|
2957
|
+
/** Output only. The state of the evaluation. */
|
|
2958
|
+
state?: string;
|
|
2959
|
+
}
|
|
2960
|
+
interface GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec {
|
|
2961
|
+
/** Required. The specification of the query set. */
|
|
2962
|
+
querySetSpec?: GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec;
|
|
2963
|
+
/** 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 */
|
|
2964
|
+
searchRequest?: GoogleCloudDiscoveryengineV1betaSearchRequest;
|
|
2965
|
+
}
|
|
2966
|
+
interface GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec {
|
|
2967
|
+
/** Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. */
|
|
2968
|
+
sampleQuerySet?: string;
|
|
2969
|
+
}
|
|
2775
2970
|
interface GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata {
|
|
2776
2971
|
/** Operation create time. */
|
|
2777
2972
|
createTime?: string;
|
|
@@ -2810,6 +3005,24 @@ declare namespace gapi.client {
|
|
|
2810
3005
|
/** 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. */
|
|
2811
3006
|
gcsPrefix?: string;
|
|
2812
3007
|
}
|
|
3008
|
+
interface GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata {
|
|
3009
|
+
/** ImportSampleQueries operation create time. */
|
|
3010
|
+
createTime?: string;
|
|
3011
|
+
/** Count of SampleQuerys that failed to be imported. */
|
|
3012
|
+
failureCount?: string;
|
|
3013
|
+
/** Count of SampleQuerys successfully imported. */
|
|
3014
|
+
successCount?: string;
|
|
3015
|
+
/** Total count of SampleQuerys that were processed. */
|
|
3016
|
+
totalCount?: string;
|
|
3017
|
+
/** ImportSampleQueries operation last update time. If the operation is done, this is also the finish time. */
|
|
3018
|
+
updateTime?: string;
|
|
3019
|
+
}
|
|
3020
|
+
interface GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse {
|
|
3021
|
+
/** The desired location of errors incurred during the Import. */
|
|
3022
|
+
errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
3023
|
+
/** A sample of errors encountered while processing the request. */
|
|
3024
|
+
errorSamples?: GoogleRpcStatus[];
|
|
3025
|
+
}
|
|
2813
3026
|
interface GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata {
|
|
2814
3027
|
/** Operation create time. */
|
|
2815
3028
|
createTime?: string;
|
|
@@ -2844,6 +3057,16 @@ declare namespace gapi.client {
|
|
|
2844
3057
|
/** Count of user events imported, but with Document information not found in the existing Branch. */
|
|
2845
3058
|
unjoinedEventsCount?: string;
|
|
2846
3059
|
}
|
|
3060
|
+
interface GoogleCloudDiscoveryengineV1betaInterval {
|
|
3061
|
+
/** Exclusive upper bound. */
|
|
3062
|
+
exclusiveMaximum?: number;
|
|
3063
|
+
/** Exclusive lower bound. */
|
|
3064
|
+
exclusiveMinimum?: number;
|
|
3065
|
+
/** Inclusive upper bound. */
|
|
3066
|
+
maximum?: number;
|
|
3067
|
+
/** Inclusive lower bound. */
|
|
3068
|
+
minimum?: number;
|
|
3069
|
+
}
|
|
2847
3070
|
interface GoogleCloudDiscoveryengineV1betaLanguageInfo {
|
|
2848
3071
|
/** Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`. */
|
|
2849
3072
|
language?: string;
|
|
@@ -2913,6 +3136,28 @@ declare namespace gapi.client {
|
|
|
2913
3136
|
/** Number of suggestion deny list entries purged. */
|
|
2914
3137
|
purgeCount?: string;
|
|
2915
3138
|
}
|
|
3139
|
+
interface GoogleCloudDiscoveryengineV1betaQualityMetrics {
|
|
3140
|
+
/** 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 */
|
|
3141
|
+
docNdcg?: GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics;
|
|
3142
|
+
/** 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 */
|
|
3143
|
+
docPrecision?: GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics;
|
|
3144
|
+
/** 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 */
|
|
3145
|
+
docRecall?: GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics;
|
|
3146
|
+
/** 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 */
|
|
3147
|
+
pageNdcg?: GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics;
|
|
3148
|
+
/** 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 */
|
|
3149
|
+
pageRecall?: GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics;
|
|
3150
|
+
}
|
|
3151
|
+
interface GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics {
|
|
3152
|
+
/** The top-1 value. */
|
|
3153
|
+
top1?: number;
|
|
3154
|
+
/** The top-10 value. */
|
|
3155
|
+
top10?: number;
|
|
3156
|
+
/** The top-3 value. */
|
|
3157
|
+
top3?: number;
|
|
3158
|
+
/** The top-5 value. */
|
|
3159
|
+
top5?: number;
|
|
3160
|
+
}
|
|
2916
3161
|
interface GoogleCloudDiscoveryengineV1betaSchema {
|
|
2917
3162
|
/** The JSON representation of the schema. */
|
|
2918
3163
|
jsonSchema?: string;
|
|
@@ -2921,94 +3166,322 @@ declare namespace gapi.client {
|
|
|
2921
3166
|
/** The structured representation of the schema. */
|
|
2922
3167
|
structSchema?: {[P in string]: any};
|
|
2923
3168
|
}
|
|
2924
|
-
interface
|
|
2925
|
-
/**
|
|
2926
|
-
|
|
2927
|
-
/**
|
|
2928
|
-
|
|
2929
|
-
|
|
2930
|
-
|
|
2931
|
-
/**
|
|
2932
|
-
|
|
2933
|
-
/**
|
|
2934
|
-
|
|
2935
|
-
/**
|
|
2936
|
-
|
|
2937
|
-
/**
|
|
2938
|
-
|
|
2939
|
-
/**
|
|
2940
|
-
|
|
2941
|
-
/**
|
|
2942
|
-
|
|
2943
|
-
/**
|
|
2944
|
-
|
|
2945
|
-
/**
|
|
2946
|
-
|
|
2947
|
-
/**
|
|
2948
|
-
|
|
2949
|
-
/**
|
|
2950
|
-
|
|
2951
|
-
|
|
2952
|
-
|
|
2953
|
-
/**
|
|
2954
|
-
|
|
2955
|
-
|
|
2956
|
-
|
|
2957
|
-
/**
|
|
2958
|
-
|
|
3169
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequest {
|
|
3170
|
+
/** 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) */
|
|
3171
|
+
boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
|
|
3172
|
+
/** 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. */
|
|
3173
|
+
branch?: string;
|
|
3174
|
+
/** 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. */
|
|
3175
|
+
canonicalFilter?: string;
|
|
3176
|
+
/** A specification for configuring the behavior of content search. */
|
|
3177
|
+
contentSearchSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
|
|
3178
|
+
/** 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. */
|
|
3179
|
+
dataStoreSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[];
|
|
3180
|
+
/** 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. */
|
|
3181
|
+
embeddingSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec;
|
|
3182
|
+
/** 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. */
|
|
3183
|
+
facetSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec[];
|
|
3184
|
+
/** 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) */
|
|
3185
|
+
filter?: string;
|
|
3186
|
+
/** Raw image query. */
|
|
3187
|
+
imageQuery?: GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery;
|
|
3188
|
+
/** 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. */
|
|
3189
|
+
languageCode?: string;
|
|
3190
|
+
/** If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */
|
|
3191
|
+
naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec;
|
|
3192
|
+
/** 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. */
|
|
3193
|
+
offset?: number;
|
|
3194
|
+
/** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
|
|
3195
|
+
orderBy?: string;
|
|
3196
|
+
/** 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. */
|
|
3197
|
+
pageSize?: number;
|
|
3198
|
+
/** 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. */
|
|
3199
|
+
pageToken?: string;
|
|
3200
|
+
/** 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` */
|
|
3201
|
+
params?: {[P in string]: any};
|
|
3202
|
+
/** Raw search query. */
|
|
3203
|
+
query?: string;
|
|
3204
|
+
/** The query expansion specification that specifies the conditions under which query expansion occurs. */
|
|
3205
|
+
queryExpansionSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec;
|
|
3206
|
+
/** 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)`. */
|
|
3207
|
+
rankingExpression?: string;
|
|
3208
|
+
/** 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. */
|
|
3209
|
+
regionCode?: string;
|
|
3210
|
+
/** Whether to turn on safe search. This is only supported for website search. */
|
|
3211
|
+
safeSearch?: boolean;
|
|
3212
|
+
/** Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */
|
|
3213
|
+
searchAsYouTypeSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec;
|
|
3214
|
+
/** 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. */
|
|
3215
|
+
servingConfig?: string;
|
|
3216
|
+
/** 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. */
|
|
3217
|
+
session?: string;
|
|
3218
|
+
/** Session specification. Can be used only when `session` is set. */
|
|
3219
|
+
sessionSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec;
|
|
3220
|
+
/** The spell correction specification that specifies the mode under which spell correction takes effect. */
|
|
3221
|
+
spellCorrectionSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec;
|
|
3222
|
+
/** Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. */
|
|
3223
|
+
userInfo?: GoogleCloudDiscoveryengineV1betaUserInfo;
|
|
3224
|
+
/** 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. */
|
|
3225
|
+
userLabels?: {[P in string]: string};
|
|
3226
|
+
/** 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. */
|
|
3227
|
+
userPseudoId?: string;
|
|
2959
3228
|
}
|
|
2960
|
-
interface
|
|
2961
|
-
/**
|
|
2962
|
-
|
|
2963
|
-
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
2964
|
-
updateTime?: string;
|
|
3229
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec {
|
|
3230
|
+
/** 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. */
|
|
3231
|
+
conditionBoostSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec[];
|
|
2965
3232
|
}
|
|
2966
|
-
interface
|
|
2967
|
-
/**
|
|
2968
|
-
|
|
2969
|
-
/**
|
|
2970
|
-
|
|
2971
|
-
/** The
|
|
2972
|
-
|
|
2973
|
-
/** Fully qualified name of the CustomTuningModel. */
|
|
2974
|
-
modelName?: string;
|
|
2975
|
-
/** The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. */
|
|
2976
|
-
modelStatus?: string;
|
|
3233
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec {
|
|
3234
|
+
/** 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. */
|
|
3235
|
+
boost?: number;
|
|
3236
|
+
/** Complex specification for custom ranking based on customer defined attribute value. */
|
|
3237
|
+
boostControlSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec;
|
|
3238
|
+
/** 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"))` */
|
|
3239
|
+
condition?: string;
|
|
2977
3240
|
}
|
|
2978
|
-
interface
|
|
2979
|
-
/**
|
|
2980
|
-
|
|
3241
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec {
|
|
3242
|
+
/** 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). */
|
|
3243
|
+
attributeType?: string;
|
|
3244
|
+
/** The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. */
|
|
3245
|
+
controlPoints?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint[];
|
|
3246
|
+
/** The name of the field whose value will be used to determine the boost amount. */
|
|
3247
|
+
fieldName?: string;
|
|
3248
|
+
/** The interpolation type to be applied to connect the control points listed below. */
|
|
3249
|
+
interpolationType?: string;
|
|
2981
3250
|
}
|
|
2982
|
-
interface
|
|
2983
|
-
|
|
2984
|
-
|
|
2985
|
-
|
|
2986
|
-
|
|
2987
|
-
updateTime?: string;
|
|
3251
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint {
|
|
3252
|
+
/** 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]`. */
|
|
3253
|
+
attributeValue?: string;
|
|
3254
|
+
/** The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. */
|
|
3255
|
+
boostAmount?: number;
|
|
2988
3256
|
}
|
|
2989
|
-
interface
|
|
2990
|
-
/**
|
|
2991
|
-
|
|
2992
|
-
/**
|
|
2993
|
-
|
|
3257
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec {
|
|
3258
|
+
/** Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */
|
|
3259
|
+
chunkSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec;
|
|
3260
|
+
/** If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */
|
|
3261
|
+
extractiveContentSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
3262
|
+
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
|
|
3263
|
+
searchResultMode?: string;
|
|
3264
|
+
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
3265
|
+
snippetSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec;
|
|
3266
|
+
/** If `summarySpec` is not specified, summaries are not included in the search response. */
|
|
3267
|
+
summarySpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec;
|
|
2994
3268
|
}
|
|
2995
|
-
interface
|
|
2996
|
-
/**
|
|
2997
|
-
|
|
2998
|
-
/**
|
|
2999
|
-
|
|
3269
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec {
|
|
3270
|
+
/** 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. */
|
|
3271
|
+
numNextChunks?: number;
|
|
3272
|
+
/** 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. */
|
|
3273
|
+
numPreviousChunks?: number;
|
|
3000
3274
|
}
|
|
3001
|
-
interface
|
|
3002
|
-
/**
|
|
3003
|
-
|
|
3004
|
-
/** The
|
|
3005
|
-
|
|
3275
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec {
|
|
3276
|
+
/** 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. */
|
|
3277
|
+
maxExtractiveAnswerCount?: number;
|
|
3278
|
+
/** 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`. */
|
|
3279
|
+
maxExtractiveSegmentCount?: number;
|
|
3280
|
+
/** Return at most `num_next_segments` segments after each selected segments. */
|
|
3281
|
+
numNextSegments?: number;
|
|
3282
|
+
/** Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */
|
|
3283
|
+
numPreviousSegments?: number;
|
|
3284
|
+
/** 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`. */
|
|
3285
|
+
returnExtractiveSegmentScore?: boolean;
|
|
3006
3286
|
}
|
|
3007
|
-
interface
|
|
3008
|
-
/**
|
|
3009
|
-
|
|
3010
|
-
/**
|
|
3011
|
-
|
|
3287
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec {
|
|
3288
|
+
/** [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. */
|
|
3289
|
+
maxSnippetCount?: number;
|
|
3290
|
+
/** [DEPRECATED] This field is deprecated and will have no affect on the snippet. */
|
|
3291
|
+
referenceOnly?: boolean;
|
|
3292
|
+
/** 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. */
|
|
3293
|
+
returnSnippet?: boolean;
|
|
3294
|
+
}
|
|
3295
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec {
|
|
3296
|
+
/** 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. */
|
|
3297
|
+
ignoreAdversarialQuery?: boolean;
|
|
3298
|
+
/** 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. */
|
|
3299
|
+
ignoreNonSummarySeekingQuery?: boolean;
|
|
3300
|
+
/** 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. */
|
|
3301
|
+
includeCitations?: boolean;
|
|
3302
|
+
/** 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. */
|
|
3303
|
+
languageCode?: string;
|
|
3304
|
+
/** If specified, the spec will be used to modify the prompt provided to the LLM. */
|
|
3305
|
+
modelPromptSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec;
|
|
3306
|
+
/** If specified, the spec will be used to modify the model specification provided to the LLM. */
|
|
3307
|
+
modelSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec;
|
|
3308
|
+
/** 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. */
|
|
3309
|
+
summaryResultCount?: number;
|
|
3310
|
+
/** 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. */
|
|
3311
|
+
useSemanticChunks?: boolean;
|
|
3312
|
+
}
|
|
3313
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec {
|
|
3314
|
+
/** Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. */
|
|
3315
|
+
preamble?: string;
|
|
3316
|
+
}
|
|
3317
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec {
|
|
3318
|
+
/** 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). */
|
|
3319
|
+
version?: string;
|
|
3320
|
+
}
|
|
3321
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
|
|
3322
|
+
/** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
|
|
3323
|
+
dataStore?: string;
|
|
3324
|
+
}
|
|
3325
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec {
|
|
3326
|
+
/** The embedding vector used for retrieval. Limit to 1. */
|
|
3327
|
+
embeddingVectors?: GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector[];
|
|
3328
|
+
}
|
|
3329
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector {
|
|
3330
|
+
/** Embedding field path in schema. */
|
|
3331
|
+
fieldPath?: string;
|
|
3332
|
+
/** Query embedding vector. */
|
|
3333
|
+
vector?: number[];
|
|
3334
|
+
}
|
|
3335
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec {
|
|
3336
|
+
/** 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. */
|
|
3337
|
+
enableDynamicPosition?: boolean;
|
|
3338
|
+
/** 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. */
|
|
3339
|
+
excludedFilterKeys?: string[];
|
|
3340
|
+
/** Required. The facet key specification. */
|
|
3341
|
+
facetKey?: GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey;
|
|
3342
|
+
/** 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. */
|
|
3343
|
+
limit?: number;
|
|
3344
|
+
}
|
|
3345
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey {
|
|
3346
|
+
/** True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. */
|
|
3347
|
+
caseInsensitive?: boolean;
|
|
3348
|
+
/** 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. */
|
|
3349
|
+
contains?: string[];
|
|
3350
|
+
/** 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. */
|
|
3351
|
+
intervals?: GoogleCloudDiscoveryengineV1betaInterval[];
|
|
3352
|
+
/** Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive. */
|
|
3353
|
+
key?: string;
|
|
3354
|
+
/** 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. */
|
|
3355
|
+
orderBy?: string;
|
|
3356
|
+
/** 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. */
|
|
3357
|
+
prefixes?: string[];
|
|
3358
|
+
/** 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. */
|
|
3359
|
+
restrictedValues?: string[];
|
|
3360
|
+
}
|
|
3361
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery {
|
|
3362
|
+
/** Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. */
|
|
3363
|
+
imageBytes?: string;
|
|
3364
|
+
}
|
|
3365
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec {
|
|
3366
|
+
/** The condition under which filter extraction should occur. Default to Condition.DISABLED. */
|
|
3367
|
+
filterExtractionCondition?: string;
|
|
3368
|
+
/** 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. */
|
|
3369
|
+
geoSearchQueryDetectionFieldNames?: string[];
|
|
3370
|
+
}
|
|
3371
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec {
|
|
3372
|
+
/** The condition under which query expansion should occur. Default to Condition.DISABLED. */
|
|
3373
|
+
condition?: string;
|
|
3374
|
+
/** 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. */
|
|
3375
|
+
pinUnexpandedResults?: boolean;
|
|
3376
|
+
}
|
|
3377
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec {
|
|
3378
|
+
/** The condition under which search as you type should occur. Default to Condition.DISABLED. */
|
|
3379
|
+
condition?: string;
|
|
3380
|
+
}
|
|
3381
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec {
|
|
3382
|
+
/** 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. */
|
|
3383
|
+
queryId?: string;
|
|
3384
|
+
/** 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. */
|
|
3385
|
+
searchResultPersistenceCount?: number;
|
|
3386
|
+
}
|
|
3387
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec {
|
|
3388
|
+
/** The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */
|
|
3389
|
+
mode?: string;
|
|
3390
|
+
}
|
|
3391
|
+
interface GoogleCloudDiscoveryengineV1betaSiteVerificationInfo {
|
|
3392
|
+
/** Site verification state indicating the ownership and validity. */
|
|
3393
|
+
siteVerificationState?: string;
|
|
3394
|
+
/** Latest site verification time. */
|
|
3395
|
+
verifyTime?: string;
|
|
3396
|
+
}
|
|
3397
|
+
interface GoogleCloudDiscoveryengineV1betaTargetSite {
|
|
3398
|
+
/** Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine. */
|
|
3399
|
+
exactMatch?: boolean;
|
|
3400
|
+
/** Output only. Failure reason. */
|
|
3401
|
+
failureReason?: GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason;
|
|
3402
|
+
/** Output only. This is system-generated based on the provided_uri_pattern. */
|
|
3403
|
+
generatedUriPattern?: string;
|
|
3404
|
+
/** Output only. Indexing status. */
|
|
3405
|
+
indexingStatus?: string;
|
|
3406
|
+
/** Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated. */
|
|
3407
|
+
name?: string;
|
|
3408
|
+
/** Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */
|
|
3409
|
+
providedUriPattern?: string;
|
|
3410
|
+
/** Output only. Root domain of the provided_uri_pattern. */
|
|
3411
|
+
rootDomainUri?: string;
|
|
3412
|
+
/** Output only. Site ownership and validity verification status. */
|
|
3413
|
+
siteVerificationInfo?: GoogleCloudDiscoveryengineV1betaSiteVerificationInfo;
|
|
3414
|
+
/** The type of the target site, e.g., whether the site is to be included or excluded. */
|
|
3415
|
+
type?: string;
|
|
3416
|
+
/** Output only. The target site's last updated time. */
|
|
3417
|
+
updateTime?: string;
|
|
3418
|
+
}
|
|
3419
|
+
interface GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason {
|
|
3420
|
+
/** Failed due to insufficient quota. */
|
|
3421
|
+
quotaFailure?: GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure;
|
|
3422
|
+
}
|
|
3423
|
+
interface GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure {
|
|
3424
|
+
/** This number is an estimation on how much total quota this project needs to successfully complete indexing. */
|
|
3425
|
+
totalRequiredQuota?: string;
|
|
3426
|
+
}
|
|
3427
|
+
interface GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata {
|
|
3428
|
+
/** Operation create time. */
|
|
3429
|
+
createTime?: string;
|
|
3430
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
3431
|
+
updateTime?: string;
|
|
3432
|
+
}
|
|
3433
|
+
interface GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse {
|
|
3434
|
+
/** Echoes the destination for the complete errors in the request if set. */
|
|
3435
|
+
errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
3436
|
+
/** A sample of errors encountered while processing the data. */
|
|
3437
|
+
errorSamples?: GoogleRpcStatus[];
|
|
3438
|
+
/** The metrics of the trained model. */
|
|
3439
|
+
metrics?: {[P in string]: number};
|
|
3440
|
+
/** Fully qualified name of the CustomTuningModel. */
|
|
3441
|
+
modelName?: string;
|
|
3442
|
+
/** The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. */
|
|
3443
|
+
modelStatus?: string;
|
|
3444
|
+
}
|
|
3445
|
+
interface GoogleCloudDiscoveryengineV1betaTuneEngineMetadata {
|
|
3446
|
+
/** Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
|
|
3447
|
+
engine?: string;
|
|
3448
|
+
}
|
|
3449
|
+
interface GoogleCloudDiscoveryengineV1betaTuneEngineResponse {}
|
|
3450
|
+
interface GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata {
|
|
3451
|
+
/** Operation create time. */
|
|
3452
|
+
createTime?: string;
|
|
3453
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
3454
|
+
updateTime?: string;
|
|
3455
|
+
}
|
|
3456
|
+
interface GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata {
|
|
3457
|
+
/** Operation create time. */
|
|
3458
|
+
createTime?: string;
|
|
3459
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
3460
|
+
updateTime?: string;
|
|
3461
|
+
}
|
|
3462
|
+
interface GoogleCloudDiscoveryengineV1betaUserInfo {
|
|
3463
|
+
/** 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. */
|
|
3464
|
+
userAgent?: string;
|
|
3465
|
+
/** 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. */
|
|
3466
|
+
userId?: string;
|
|
3467
|
+
}
|
|
3468
|
+
interface GoogleCloudDiscoveryengineV1Condition {
|
|
3469
|
+
/** Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */
|
|
3470
|
+
activeTimeRange?: GoogleCloudDiscoveryengineV1ConditionTimeRange[];
|
|
3471
|
+
/** Search only A list of terms to match the query on. Maximum of 10 query terms. */
|
|
3472
|
+
queryTerms?: GoogleCloudDiscoveryengineV1ConditionQueryTerm[];
|
|
3473
|
+
}
|
|
3474
|
+
interface GoogleCloudDiscoveryengineV1ConditionQueryTerm {
|
|
3475
|
+
/** Whether the search query needs to exactly match the query term. */
|
|
3476
|
+
fullMatch?: boolean;
|
|
3477
|
+
/** The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. */
|
|
3478
|
+
value?: string;
|
|
3479
|
+
}
|
|
3480
|
+
interface GoogleCloudDiscoveryengineV1ConditionTimeRange {
|
|
3481
|
+
/** End of time range. Range is inclusive. Must be in the future. */
|
|
3482
|
+
endTime?: string;
|
|
3483
|
+
/** Start of time range. Range is inclusive. */
|
|
3484
|
+
startTime?: string;
|
|
3012
3485
|
}
|
|
3013
3486
|
interface GoogleCloudDiscoveryengineV1Control {
|
|
3014
3487
|
/** Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. */
|
|
@@ -6252,6 +6725,33 @@ declare namespace gapi.client {
|
|
|
6252
6725
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6253
6726
|
uploadType?: string;
|
|
6254
6727
|
}): Request<GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse>;
|
|
6728
|
+
/** Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore. */
|
|
6729
|
+
getUriPatternDocumentData(request?: {
|
|
6730
|
+
/** V1 error format. */
|
|
6731
|
+
'$.xgafv'?: string;
|
|
6732
|
+
/** OAuth access token. */
|
|
6733
|
+
access_token?: string;
|
|
6734
|
+
/** Data format for response. */
|
|
6735
|
+
alt?: string;
|
|
6736
|
+
/** JSONP */
|
|
6737
|
+
callback?: string;
|
|
6738
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6739
|
+
fields?: string;
|
|
6740
|
+
/** 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. */
|
|
6741
|
+
key?: string;
|
|
6742
|
+
/** OAuth 2.0 token for the current user. */
|
|
6743
|
+
oauth_token?: string;
|
|
6744
|
+
/** Returns response with indentations and line breaks. */
|
|
6745
|
+
prettyPrint?: boolean;
|
|
6746
|
+
/** 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. */
|
|
6747
|
+
quotaUser?: string;
|
|
6748
|
+
/** Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. */
|
|
6749
|
+
siteSearchEngine: string;
|
|
6750
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6751
|
+
upload_protocol?: string;
|
|
6752
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6753
|
+
uploadType?: string;
|
|
6754
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse>;
|
|
6255
6755
|
/** Request on-demand recrawl for a list of URIs. */
|
|
6256
6756
|
recrawlUris(request: {
|
|
6257
6757
|
/** V1 error format. */
|
|
@@ -6310,6 +6810,64 @@ declare namespace gapi.client {
|
|
|
6310
6810
|
},
|
|
6311
6811
|
body: GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest
|
|
6312
6812
|
): Request<GoogleLongrunningOperation>;
|
|
6813
|
+
/** Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore. */
|
|
6814
|
+
setUriPatternDocumentData(request: {
|
|
6815
|
+
/** V1 error format. */
|
|
6816
|
+
'$.xgafv'?: string;
|
|
6817
|
+
/** OAuth access token. */
|
|
6818
|
+
access_token?: string;
|
|
6819
|
+
/** Data format for response. */
|
|
6820
|
+
alt?: string;
|
|
6821
|
+
/** JSONP */
|
|
6822
|
+
callback?: string;
|
|
6823
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6824
|
+
fields?: string;
|
|
6825
|
+
/** 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. */
|
|
6826
|
+
key?: string;
|
|
6827
|
+
/** OAuth 2.0 token for the current user. */
|
|
6828
|
+
oauth_token?: string;
|
|
6829
|
+
/** Returns response with indentations and line breaks. */
|
|
6830
|
+
prettyPrint?: boolean;
|
|
6831
|
+
/** 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. */
|
|
6832
|
+
quotaUser?: string;
|
|
6833
|
+
/** Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. */
|
|
6834
|
+
siteSearchEngine: string;
|
|
6835
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6836
|
+
upload_protocol?: string;
|
|
6837
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6838
|
+
uploadType?: string;
|
|
6839
|
+
/** Request body */
|
|
6840
|
+
resource: GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest;
|
|
6841
|
+
}): Request<GoogleLongrunningOperation>;
|
|
6842
|
+
setUriPatternDocumentData(
|
|
6843
|
+
request: {
|
|
6844
|
+
/** V1 error format. */
|
|
6845
|
+
'$.xgafv'?: string;
|
|
6846
|
+
/** OAuth access token. */
|
|
6847
|
+
access_token?: string;
|
|
6848
|
+
/** Data format for response. */
|
|
6849
|
+
alt?: string;
|
|
6850
|
+
/** JSONP */
|
|
6851
|
+
callback?: string;
|
|
6852
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6853
|
+
fields?: string;
|
|
6854
|
+
/** 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. */
|
|
6855
|
+
key?: string;
|
|
6856
|
+
/** OAuth 2.0 token for the current user. */
|
|
6857
|
+
oauth_token?: string;
|
|
6858
|
+
/** Returns response with indentations and line breaks. */
|
|
6859
|
+
prettyPrint?: boolean;
|
|
6860
|
+
/** 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. */
|
|
6861
|
+
quotaUser?: string;
|
|
6862
|
+
/** Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. */
|
|
6863
|
+
siteSearchEngine: string;
|
|
6864
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6865
|
+
upload_protocol?: string;
|
|
6866
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6867
|
+
uploadType?: string;
|
|
6868
|
+
},
|
|
6869
|
+
body: GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest
|
|
6870
|
+
): Request<GoogleLongrunningOperation>;
|
|
6313
6871
|
operations: OperationsResource;
|
|
6314
6872
|
targetSites: TargetSitesResource;
|
|
6315
6873
|
}
|
|
@@ -11825,11 +12383,8 @@ declare namespace gapi.client {
|
|
|
11825
12383
|
}): Request<GoogleLongrunningOperation>;
|
|
11826
12384
|
}
|
|
11827
12385
|
interface EvaluationsResource {
|
|
11828
|
-
|
|
11829
|
-
|
|
11830
|
-
interface GroundingConfigsResource {
|
|
11831
|
-
/** Performs a grounding check. */
|
|
11832
|
-
check(request: {
|
|
12386
|
+
/** Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution. */
|
|
12387
|
+
create(request: {
|
|
11833
12388
|
/** V1 error format. */
|
|
11834
12389
|
'$.xgafv'?: string;
|
|
11835
12390
|
/** OAuth access token. */
|
|
@@ -11840,8 +12395,158 @@ declare namespace gapi.client {
|
|
|
11840
12395
|
callback?: string;
|
|
11841
12396
|
/** Selector specifying which fields to include in a partial response. */
|
|
11842
12397
|
fields?: string;
|
|
11843
|
-
/**
|
|
11844
|
-
|
|
12398
|
+
/** 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. */
|
|
12399
|
+
key?: string;
|
|
12400
|
+
/** OAuth 2.0 token for the current user. */
|
|
12401
|
+
oauth_token?: string;
|
|
12402
|
+
/** Required. The parent resource name, such as `projects/{project}/locations/{location}`. */
|
|
12403
|
+
parent: string;
|
|
12404
|
+
/** Returns response with indentations and line breaks. */
|
|
12405
|
+
prettyPrint?: boolean;
|
|
12406
|
+
/** 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. */
|
|
12407
|
+
quotaUser?: string;
|
|
12408
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12409
|
+
upload_protocol?: string;
|
|
12410
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12411
|
+
uploadType?: string;
|
|
12412
|
+
/** Request body */
|
|
12413
|
+
resource: GoogleCloudDiscoveryengineV1alphaEvaluation;
|
|
12414
|
+
}): Request<GoogleLongrunningOperation>;
|
|
12415
|
+
create(
|
|
12416
|
+
request: {
|
|
12417
|
+
/** V1 error format. */
|
|
12418
|
+
'$.xgafv'?: string;
|
|
12419
|
+
/** OAuth access token. */
|
|
12420
|
+
access_token?: string;
|
|
12421
|
+
/** Data format for response. */
|
|
12422
|
+
alt?: string;
|
|
12423
|
+
/** JSONP */
|
|
12424
|
+
callback?: string;
|
|
12425
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12426
|
+
fields?: string;
|
|
12427
|
+
/** 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. */
|
|
12428
|
+
key?: string;
|
|
12429
|
+
/** OAuth 2.0 token for the current user. */
|
|
12430
|
+
oauth_token?: string;
|
|
12431
|
+
/** Required. The parent resource name, such as `projects/{project}/locations/{location}`. */
|
|
12432
|
+
parent: string;
|
|
12433
|
+
/** Returns response with indentations and line breaks. */
|
|
12434
|
+
prettyPrint?: boolean;
|
|
12435
|
+
/** 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. */
|
|
12436
|
+
quotaUser?: string;
|
|
12437
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12438
|
+
upload_protocol?: string;
|
|
12439
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12440
|
+
uploadType?: string;
|
|
12441
|
+
},
|
|
12442
|
+
body: GoogleCloudDiscoveryengineV1alphaEvaluation
|
|
12443
|
+
): Request<GoogleLongrunningOperation>;
|
|
12444
|
+
/** Gets a Evaluation. */
|
|
12445
|
+
get(request?: {
|
|
12446
|
+
/** V1 error format. */
|
|
12447
|
+
'$.xgafv'?: string;
|
|
12448
|
+
/** OAuth access token. */
|
|
12449
|
+
access_token?: string;
|
|
12450
|
+
/** Data format for response. */
|
|
12451
|
+
alt?: string;
|
|
12452
|
+
/** JSONP */
|
|
12453
|
+
callback?: string;
|
|
12454
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12455
|
+
fields?: string;
|
|
12456
|
+
/** 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. */
|
|
12457
|
+
key?: string;
|
|
12458
|
+
/** 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. */
|
|
12459
|
+
name: string;
|
|
12460
|
+
/** OAuth 2.0 token for the current user. */
|
|
12461
|
+
oauth_token?: string;
|
|
12462
|
+
/** Returns response with indentations and line breaks. */
|
|
12463
|
+
prettyPrint?: boolean;
|
|
12464
|
+
/** 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. */
|
|
12465
|
+
quotaUser?: string;
|
|
12466
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12467
|
+
upload_protocol?: string;
|
|
12468
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12469
|
+
uploadType?: string;
|
|
12470
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaEvaluation>;
|
|
12471
|
+
/** Gets a list of Evaluations. */
|
|
12472
|
+
list(request?: {
|
|
12473
|
+
/** V1 error format. */
|
|
12474
|
+
'$.xgafv'?: string;
|
|
12475
|
+
/** OAuth access token. */
|
|
12476
|
+
access_token?: string;
|
|
12477
|
+
/** Data format for response. */
|
|
12478
|
+
alt?: string;
|
|
12479
|
+
/** JSONP */
|
|
12480
|
+
callback?: string;
|
|
12481
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12482
|
+
fields?: string;
|
|
12483
|
+
/** 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. */
|
|
12484
|
+
key?: string;
|
|
12485
|
+
/** OAuth 2.0 token for the current user. */
|
|
12486
|
+
oauth_token?: string;
|
|
12487
|
+
/** 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. */
|
|
12488
|
+
pageSize?: number;
|
|
12489
|
+
/** 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. */
|
|
12490
|
+
pageToken?: string;
|
|
12491
|
+
/** 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. */
|
|
12492
|
+
parent: string;
|
|
12493
|
+
/** Returns response with indentations and line breaks. */
|
|
12494
|
+
prettyPrint?: boolean;
|
|
12495
|
+
/** 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. */
|
|
12496
|
+
quotaUser?: string;
|
|
12497
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12498
|
+
upload_protocol?: string;
|
|
12499
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12500
|
+
uploadType?: string;
|
|
12501
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse>;
|
|
12502
|
+
/** Gets a list of results for a given a Evaluation. */
|
|
12503
|
+
listResults(request?: {
|
|
12504
|
+
/** V1 error format. */
|
|
12505
|
+
'$.xgafv'?: string;
|
|
12506
|
+
/** OAuth access token. */
|
|
12507
|
+
access_token?: string;
|
|
12508
|
+
/** Data format for response. */
|
|
12509
|
+
alt?: string;
|
|
12510
|
+
/** JSONP */
|
|
12511
|
+
callback?: string;
|
|
12512
|
+
/** 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. */
|
|
12513
|
+
evaluation: string;
|
|
12514
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12515
|
+
fields?: string;
|
|
12516
|
+
/** 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. */
|
|
12517
|
+
key?: string;
|
|
12518
|
+
/** OAuth 2.0 token for the current user. */
|
|
12519
|
+
oauth_token?: string;
|
|
12520
|
+
/** 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. */
|
|
12521
|
+
pageSize?: number;
|
|
12522
|
+
/** 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. */
|
|
12523
|
+
pageToken?: string;
|
|
12524
|
+
/** Returns response with indentations and line breaks. */
|
|
12525
|
+
prettyPrint?: boolean;
|
|
12526
|
+
/** 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. */
|
|
12527
|
+
quotaUser?: string;
|
|
12528
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12529
|
+
upload_protocol?: string;
|
|
12530
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12531
|
+
uploadType?: string;
|
|
12532
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse>;
|
|
12533
|
+
operations: OperationsResource;
|
|
12534
|
+
}
|
|
12535
|
+
interface GroundingConfigsResource {
|
|
12536
|
+
/** Performs a grounding check. */
|
|
12537
|
+
check(request: {
|
|
12538
|
+
/** V1 error format. */
|
|
12539
|
+
'$.xgafv'?: string;
|
|
12540
|
+
/** OAuth access token. */
|
|
12541
|
+
access_token?: string;
|
|
12542
|
+
/** Data format for response. */
|
|
12543
|
+
alt?: string;
|
|
12544
|
+
/** JSONP */
|
|
12545
|
+
callback?: string;
|
|
12546
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12547
|
+
fields?: string;
|
|
12548
|
+
/** Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`. */
|
|
12549
|
+
groundingConfig: string;
|
|
11845
12550
|
/** 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. */
|
|
11846
12551
|
key?: string;
|
|
11847
12552
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -11949,6 +12654,71 @@ declare namespace gapi.client {
|
|
|
11949
12654
|
uploadType?: string;
|
|
11950
12655
|
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
11951
12656
|
}
|
|
12657
|
+
interface Identity_mapping_storesResource {
|
|
12658
|
+
operations: OperationsResource;
|
|
12659
|
+
}
|
|
12660
|
+
interface OperationsResource {
|
|
12661
|
+
/** 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. */
|
|
12662
|
+
get(request?: {
|
|
12663
|
+
/** V1 error format. */
|
|
12664
|
+
'$.xgafv'?: string;
|
|
12665
|
+
/** OAuth access token. */
|
|
12666
|
+
access_token?: string;
|
|
12667
|
+
/** Data format for response. */
|
|
12668
|
+
alt?: string;
|
|
12669
|
+
/** JSONP */
|
|
12670
|
+
callback?: string;
|
|
12671
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12672
|
+
fields?: string;
|
|
12673
|
+
/** 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. */
|
|
12674
|
+
key?: string;
|
|
12675
|
+
/** The name of the operation resource. */
|
|
12676
|
+
name: string;
|
|
12677
|
+
/** OAuth 2.0 token for the current user. */
|
|
12678
|
+
oauth_token?: string;
|
|
12679
|
+
/** Returns response with indentations and line breaks. */
|
|
12680
|
+
prettyPrint?: boolean;
|
|
12681
|
+
/** 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. */
|
|
12682
|
+
quotaUser?: string;
|
|
12683
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12684
|
+
upload_protocol?: string;
|
|
12685
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12686
|
+
uploadType?: string;
|
|
12687
|
+
}): Request<GoogleLongrunningOperation>;
|
|
12688
|
+
/** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
|
|
12689
|
+
list(request?: {
|
|
12690
|
+
/** V1 error format. */
|
|
12691
|
+
'$.xgafv'?: string;
|
|
12692
|
+
/** OAuth access token. */
|
|
12693
|
+
access_token?: string;
|
|
12694
|
+
/** Data format for response. */
|
|
12695
|
+
alt?: string;
|
|
12696
|
+
/** JSONP */
|
|
12697
|
+
callback?: string;
|
|
12698
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12699
|
+
fields?: string;
|
|
12700
|
+
/** The standard list filter. */
|
|
12701
|
+
filter?: string;
|
|
12702
|
+
/** 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. */
|
|
12703
|
+
key?: string;
|
|
12704
|
+
/** The name of the operation's parent resource. */
|
|
12705
|
+
name: string;
|
|
12706
|
+
/** OAuth 2.0 token for the current user. */
|
|
12707
|
+
oauth_token?: string;
|
|
12708
|
+
/** The standard list page size. */
|
|
12709
|
+
pageSize?: number;
|
|
12710
|
+
/** The standard list page token. */
|
|
12711
|
+
pageToken?: string;
|
|
12712
|
+
/** Returns response with indentations and line breaks. */
|
|
12713
|
+
prettyPrint?: boolean;
|
|
12714
|
+
/** 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. */
|
|
12715
|
+
quotaUser?: string;
|
|
12716
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12717
|
+
upload_protocol?: string;
|
|
12718
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12719
|
+
uploadType?: string;
|
|
12720
|
+
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
12721
|
+
}
|
|
11952
12722
|
interface RankingConfigsResource {
|
|
11953
12723
|
/** Ranks a list of text records based on the given input query. */
|
|
11954
12724
|
rank(request: {
|
|
@@ -12098,8 +12868,487 @@ declare namespace gapi.client {
|
|
|
12098
12868
|
uploadType?: string;
|
|
12099
12869
|
}): Request<GoogleLongrunningOperation>;
|
|
12100
12870
|
}
|
|
12101
|
-
interface
|
|
12871
|
+
interface SampleQueriesResource {
|
|
12872
|
+
/** Creates a SampleQuery */
|
|
12873
|
+
create(request: {
|
|
12874
|
+
/** V1 error format. */
|
|
12875
|
+
'$.xgafv'?: string;
|
|
12876
|
+
/** OAuth access token. */
|
|
12877
|
+
access_token?: string;
|
|
12878
|
+
/** Data format for response. */
|
|
12879
|
+
alt?: string;
|
|
12880
|
+
/** JSONP */
|
|
12881
|
+
callback?: string;
|
|
12882
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12883
|
+
fields?: string;
|
|
12884
|
+
/** 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. */
|
|
12885
|
+
key?: string;
|
|
12886
|
+
/** OAuth 2.0 token for the current user. */
|
|
12887
|
+
oauth_token?: string;
|
|
12888
|
+
/** Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. */
|
|
12889
|
+
parent: string;
|
|
12890
|
+
/** Returns response with indentations and line breaks. */
|
|
12891
|
+
prettyPrint?: boolean;
|
|
12892
|
+
/** 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. */
|
|
12893
|
+
quotaUser?: string;
|
|
12894
|
+
/** 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. */
|
|
12895
|
+
sampleQueryId?: string;
|
|
12896
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12897
|
+
upload_protocol?: string;
|
|
12898
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12899
|
+
uploadType?: string;
|
|
12900
|
+
/** Request body */
|
|
12901
|
+
resource: GoogleCloudDiscoveryengineV1alphaSampleQuery;
|
|
12902
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaSampleQuery>;
|
|
12903
|
+
create(
|
|
12904
|
+
request: {
|
|
12905
|
+
/** V1 error format. */
|
|
12906
|
+
'$.xgafv'?: string;
|
|
12907
|
+
/** OAuth access token. */
|
|
12908
|
+
access_token?: string;
|
|
12909
|
+
/** Data format for response. */
|
|
12910
|
+
alt?: string;
|
|
12911
|
+
/** JSONP */
|
|
12912
|
+
callback?: string;
|
|
12913
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12914
|
+
fields?: string;
|
|
12915
|
+
/** 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. */
|
|
12916
|
+
key?: string;
|
|
12917
|
+
/** OAuth 2.0 token for the current user. */
|
|
12918
|
+
oauth_token?: string;
|
|
12919
|
+
/** Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. */
|
|
12920
|
+
parent: string;
|
|
12921
|
+
/** Returns response with indentations and line breaks. */
|
|
12922
|
+
prettyPrint?: boolean;
|
|
12923
|
+
/** 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. */
|
|
12924
|
+
quotaUser?: string;
|
|
12925
|
+
/** 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. */
|
|
12926
|
+
sampleQueryId?: string;
|
|
12927
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12928
|
+
upload_protocol?: string;
|
|
12929
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12930
|
+
uploadType?: string;
|
|
12931
|
+
},
|
|
12932
|
+
body: GoogleCloudDiscoveryengineV1alphaSampleQuery
|
|
12933
|
+
): Request<GoogleCloudDiscoveryengineV1alphaSampleQuery>;
|
|
12934
|
+
/** Deletes a SampleQuery. */
|
|
12935
|
+
delete(request?: {
|
|
12936
|
+
/** V1 error format. */
|
|
12937
|
+
'$.xgafv'?: string;
|
|
12938
|
+
/** OAuth access token. */
|
|
12939
|
+
access_token?: string;
|
|
12940
|
+
/** Data format for response. */
|
|
12941
|
+
alt?: string;
|
|
12942
|
+
/** JSONP */
|
|
12943
|
+
callback?: string;
|
|
12944
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12945
|
+
fields?: string;
|
|
12946
|
+
/** 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. */
|
|
12947
|
+
key?: string;
|
|
12948
|
+
/** Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned. */
|
|
12949
|
+
name: string;
|
|
12950
|
+
/** OAuth 2.0 token for the current user. */
|
|
12951
|
+
oauth_token?: string;
|
|
12952
|
+
/** Returns response with indentations and line breaks. */
|
|
12953
|
+
prettyPrint?: boolean;
|
|
12954
|
+
/** 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. */
|
|
12955
|
+
quotaUser?: string;
|
|
12956
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12957
|
+
upload_protocol?: string;
|
|
12958
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12959
|
+
uploadType?: string;
|
|
12960
|
+
}): Request<{}>;
|
|
12961
|
+
/** Gets a SampleQuery. */
|
|
12962
|
+
get(request?: {
|
|
12963
|
+
/** V1 error format. */
|
|
12964
|
+
'$.xgafv'?: string;
|
|
12965
|
+
/** OAuth access token. */
|
|
12966
|
+
access_token?: string;
|
|
12967
|
+
/** Data format for response. */
|
|
12968
|
+
alt?: string;
|
|
12969
|
+
/** JSONP */
|
|
12970
|
+
callback?: string;
|
|
12971
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12972
|
+
fields?: string;
|
|
12973
|
+
/** 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. */
|
|
12974
|
+
key?: string;
|
|
12975
|
+
/** Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned. */
|
|
12976
|
+
name: string;
|
|
12977
|
+
/** OAuth 2.0 token for the current user. */
|
|
12978
|
+
oauth_token?: string;
|
|
12979
|
+
/** Returns response with indentations and line breaks. */
|
|
12980
|
+
prettyPrint?: boolean;
|
|
12981
|
+
/** 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. */
|
|
12982
|
+
quotaUser?: string;
|
|
12983
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12984
|
+
upload_protocol?: string;
|
|
12985
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12986
|
+
uploadType?: string;
|
|
12987
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaSampleQuery>;
|
|
12988
|
+
/** 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. */
|
|
12989
|
+
import(request: {
|
|
12990
|
+
/** V1 error format. */
|
|
12991
|
+
'$.xgafv'?: string;
|
|
12992
|
+
/** OAuth access token. */
|
|
12993
|
+
access_token?: string;
|
|
12994
|
+
/** Data format for response. */
|
|
12995
|
+
alt?: string;
|
|
12996
|
+
/** JSONP */
|
|
12997
|
+
callback?: string;
|
|
12998
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12999
|
+
fields?: string;
|
|
13000
|
+
/** 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. */
|
|
13001
|
+
key?: string;
|
|
13002
|
+
/** OAuth 2.0 token for the current user. */
|
|
13003
|
+
oauth_token?: string;
|
|
13004
|
+
/** 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. */
|
|
13005
|
+
parent: string;
|
|
13006
|
+
/** Returns response with indentations and line breaks. */
|
|
13007
|
+
prettyPrint?: boolean;
|
|
13008
|
+
/** 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. */
|
|
13009
|
+
quotaUser?: string;
|
|
13010
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
13011
|
+
upload_protocol?: string;
|
|
13012
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
13013
|
+
uploadType?: string;
|
|
13014
|
+
/** Request body */
|
|
13015
|
+
resource: GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest;
|
|
13016
|
+
}): Request<GoogleLongrunningOperation>;
|
|
13017
|
+
import(
|
|
13018
|
+
request: {
|
|
13019
|
+
/** V1 error format. */
|
|
13020
|
+
'$.xgafv'?: string;
|
|
13021
|
+
/** OAuth access token. */
|
|
13022
|
+
access_token?: string;
|
|
13023
|
+
/** Data format for response. */
|
|
13024
|
+
alt?: string;
|
|
13025
|
+
/** JSONP */
|
|
13026
|
+
callback?: string;
|
|
13027
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
13028
|
+
fields?: string;
|
|
13029
|
+
/** 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. */
|
|
13030
|
+
key?: string;
|
|
13031
|
+
/** OAuth 2.0 token for the current user. */
|
|
13032
|
+
oauth_token?: string;
|
|
13033
|
+
/** 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. */
|
|
13034
|
+
parent: string;
|
|
13035
|
+
/** Returns response with indentations and line breaks. */
|
|
13036
|
+
prettyPrint?: boolean;
|
|
13037
|
+
/** 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. */
|
|
13038
|
+
quotaUser?: string;
|
|
13039
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
13040
|
+
upload_protocol?: string;
|
|
13041
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
13042
|
+
uploadType?: string;
|
|
13043
|
+
},
|
|
13044
|
+
body: GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest
|
|
13045
|
+
): Request<GoogleLongrunningOperation>;
|
|
13046
|
+
/** Gets a list of SampleQuerys. */
|
|
13047
|
+
list(request?: {
|
|
13048
|
+
/** V1 error format. */
|
|
13049
|
+
'$.xgafv'?: string;
|
|
13050
|
+
/** OAuth access token. */
|
|
13051
|
+
access_token?: string;
|
|
13052
|
+
/** Data format for response. */
|
|
13053
|
+
alt?: string;
|
|
13054
|
+
/** JSONP */
|
|
13055
|
+
callback?: string;
|
|
13056
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
13057
|
+
fields?: string;
|
|
13058
|
+
/** 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. */
|
|
13059
|
+
key?: string;
|
|
13060
|
+
/** OAuth 2.0 token for the current user. */
|
|
13061
|
+
oauth_token?: string;
|
|
13062
|
+
/** 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. */
|
|
13063
|
+
pageSize?: number;
|
|
13064
|
+
/** 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. */
|
|
13065
|
+
pageToken?: string;
|
|
13066
|
+
/** 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. */
|
|
13067
|
+
parent: string;
|
|
13068
|
+
/** Returns response with indentations and line breaks. */
|
|
13069
|
+
prettyPrint?: boolean;
|
|
13070
|
+
/** 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. */
|
|
13071
|
+
quotaUser?: string;
|
|
13072
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
13073
|
+
upload_protocol?: string;
|
|
13074
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
13075
|
+
uploadType?: string;
|
|
13076
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse>;
|
|
13077
|
+
/** Updates a SampleQuery. */
|
|
13078
|
+
patch(request: {
|
|
13079
|
+
/** V1 error format. */
|
|
13080
|
+
'$.xgafv'?: string;
|
|
13081
|
+
/** OAuth access token. */
|
|
13082
|
+
access_token?: string;
|
|
13083
|
+
/** Data format for response. */
|
|
13084
|
+
alt?: string;
|
|
13085
|
+
/** JSONP */
|
|
13086
|
+
callback?: string;
|
|
13087
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
13088
|
+
fields?: string;
|
|
13089
|
+
/** 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. */
|
|
13090
|
+
key?: string;
|
|
13091
|
+
/** Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
13092
|
+
name: string;
|
|
13093
|
+
/** OAuth 2.0 token for the current user. */
|
|
13094
|
+
oauth_token?: string;
|
|
13095
|
+
/** Returns response with indentations and line breaks. */
|
|
13096
|
+
prettyPrint?: boolean;
|
|
13097
|
+
/** 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. */
|
|
13098
|
+
quotaUser?: string;
|
|
13099
|
+
/** Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields. */
|
|
13100
|
+
updateMask?: string;
|
|
13101
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
13102
|
+
upload_protocol?: string;
|
|
13103
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
13104
|
+
uploadType?: string;
|
|
13105
|
+
/** Request body */
|
|
13106
|
+
resource: GoogleCloudDiscoveryengineV1alphaSampleQuery;
|
|
13107
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaSampleQuery>;
|
|
13108
|
+
patch(
|
|
13109
|
+
request: {
|
|
13110
|
+
/** V1 error format. */
|
|
13111
|
+
'$.xgafv'?: string;
|
|
13112
|
+
/** OAuth access token. */
|
|
13113
|
+
access_token?: string;
|
|
13114
|
+
/** Data format for response. */
|
|
13115
|
+
alt?: string;
|
|
13116
|
+
/** JSONP */
|
|
13117
|
+
callback?: string;
|
|
13118
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
13119
|
+
fields?: string;
|
|
13120
|
+
/** 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. */
|
|
13121
|
+
key?: string;
|
|
13122
|
+
/** Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
13123
|
+
name: string;
|
|
13124
|
+
/** OAuth 2.0 token for the current user. */
|
|
13125
|
+
oauth_token?: string;
|
|
13126
|
+
/** Returns response with indentations and line breaks. */
|
|
13127
|
+
prettyPrint?: boolean;
|
|
13128
|
+
/** 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. */
|
|
13129
|
+
quotaUser?: string;
|
|
13130
|
+
/** Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields. */
|
|
13131
|
+
updateMask?: string;
|
|
13132
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
13133
|
+
upload_protocol?: string;
|
|
13134
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
13135
|
+
uploadType?: string;
|
|
13136
|
+
},
|
|
13137
|
+
body: GoogleCloudDiscoveryengineV1alphaSampleQuery
|
|
13138
|
+
): Request<GoogleCloudDiscoveryengineV1alphaSampleQuery>;
|
|
13139
|
+
}
|
|
13140
|
+
interface SampleQuerySetsResource {
|
|
13141
|
+
/** Creates a SampleQuerySet */
|
|
13142
|
+
create(request: {
|
|
13143
|
+
/** V1 error format. */
|
|
13144
|
+
'$.xgafv'?: string;
|
|
13145
|
+
/** OAuth access token. */
|
|
13146
|
+
access_token?: string;
|
|
13147
|
+
/** Data format for response. */
|
|
13148
|
+
alt?: string;
|
|
13149
|
+
/** JSONP */
|
|
13150
|
+
callback?: string;
|
|
13151
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
13152
|
+
fields?: string;
|
|
13153
|
+
/** 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. */
|
|
13154
|
+
key?: string;
|
|
13155
|
+
/** OAuth 2.0 token for the current user. */
|
|
13156
|
+
oauth_token?: string;
|
|
13157
|
+
/** Required. The parent resource name, such as `projects/{project}/locations/{location}`. */
|
|
13158
|
+
parent: string;
|
|
13159
|
+
/** Returns response with indentations and line breaks. */
|
|
13160
|
+
prettyPrint?: boolean;
|
|
13161
|
+
/** 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. */
|
|
13162
|
+
quotaUser?: string;
|
|
13163
|
+
/** 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. */
|
|
13164
|
+
sampleQuerySetId?: string;
|
|
13165
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
13166
|
+
upload_protocol?: string;
|
|
13167
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
13168
|
+
uploadType?: string;
|
|
13169
|
+
/** Request body */
|
|
13170
|
+
resource: GoogleCloudDiscoveryengineV1alphaSampleQuerySet;
|
|
13171
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaSampleQuerySet>;
|
|
13172
|
+
create(
|
|
13173
|
+
request: {
|
|
13174
|
+
/** V1 error format. */
|
|
13175
|
+
'$.xgafv'?: string;
|
|
13176
|
+
/** OAuth access token. */
|
|
13177
|
+
access_token?: string;
|
|
13178
|
+
/** Data format for response. */
|
|
13179
|
+
alt?: string;
|
|
13180
|
+
/** JSONP */
|
|
13181
|
+
callback?: string;
|
|
13182
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
13183
|
+
fields?: string;
|
|
13184
|
+
/** 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. */
|
|
13185
|
+
key?: string;
|
|
13186
|
+
/** OAuth 2.0 token for the current user. */
|
|
13187
|
+
oauth_token?: string;
|
|
13188
|
+
/** Required. The parent resource name, such as `projects/{project}/locations/{location}`. */
|
|
13189
|
+
parent: string;
|
|
13190
|
+
/** Returns response with indentations and line breaks. */
|
|
13191
|
+
prettyPrint?: boolean;
|
|
13192
|
+
/** 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. */
|
|
13193
|
+
quotaUser?: string;
|
|
13194
|
+
/** 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. */
|
|
13195
|
+
sampleQuerySetId?: string;
|
|
13196
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
13197
|
+
upload_protocol?: string;
|
|
13198
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
13199
|
+
uploadType?: string;
|
|
13200
|
+
},
|
|
13201
|
+
body: GoogleCloudDiscoveryengineV1alphaSampleQuerySet
|
|
13202
|
+
): Request<GoogleCloudDiscoveryengineV1alphaSampleQuerySet>;
|
|
13203
|
+
/** Deletes a SampleQuerySet. */
|
|
13204
|
+
delete(request?: {
|
|
13205
|
+
/** V1 error format. */
|
|
13206
|
+
'$.xgafv'?: string;
|
|
13207
|
+
/** OAuth access token. */
|
|
13208
|
+
access_token?: string;
|
|
13209
|
+
/** Data format for response. */
|
|
13210
|
+
alt?: string;
|
|
13211
|
+
/** JSONP */
|
|
13212
|
+
callback?: string;
|
|
13213
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
13214
|
+
fields?: string;
|
|
13215
|
+
/** 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. */
|
|
13216
|
+
key?: string;
|
|
13217
|
+
/** Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned. */
|
|
13218
|
+
name: string;
|
|
13219
|
+
/** OAuth 2.0 token for the current user. */
|
|
13220
|
+
oauth_token?: string;
|
|
13221
|
+
/** Returns response with indentations and line breaks. */
|
|
13222
|
+
prettyPrint?: boolean;
|
|
13223
|
+
/** 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. */
|
|
13224
|
+
quotaUser?: string;
|
|
13225
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
13226
|
+
upload_protocol?: string;
|
|
13227
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
13228
|
+
uploadType?: string;
|
|
13229
|
+
}): Request<{}>;
|
|
13230
|
+
/** Gets a SampleQuerySet. */
|
|
13231
|
+
get(request?: {
|
|
13232
|
+
/** V1 error format. */
|
|
13233
|
+
'$.xgafv'?: string;
|
|
13234
|
+
/** OAuth access token. */
|
|
13235
|
+
access_token?: string;
|
|
13236
|
+
/** Data format for response. */
|
|
13237
|
+
alt?: string;
|
|
13238
|
+
/** JSONP */
|
|
13239
|
+
callback?: string;
|
|
13240
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
13241
|
+
fields?: string;
|
|
13242
|
+
/** 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. */
|
|
13243
|
+
key?: string;
|
|
13244
|
+
/** Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned. */
|
|
13245
|
+
name: string;
|
|
13246
|
+
/** OAuth 2.0 token for the current user. */
|
|
13247
|
+
oauth_token?: string;
|
|
13248
|
+
/** Returns response with indentations and line breaks. */
|
|
13249
|
+
prettyPrint?: boolean;
|
|
13250
|
+
/** 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. */
|
|
13251
|
+
quotaUser?: string;
|
|
13252
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
13253
|
+
upload_protocol?: string;
|
|
13254
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
13255
|
+
uploadType?: string;
|
|
13256
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaSampleQuerySet>;
|
|
13257
|
+
/** Gets a list of SampleQuerySets. */
|
|
13258
|
+
list(request?: {
|
|
13259
|
+
/** V1 error format. */
|
|
13260
|
+
'$.xgafv'?: string;
|
|
13261
|
+
/** OAuth access token. */
|
|
13262
|
+
access_token?: string;
|
|
13263
|
+
/** Data format for response. */
|
|
13264
|
+
alt?: string;
|
|
13265
|
+
/** JSONP */
|
|
13266
|
+
callback?: string;
|
|
13267
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
13268
|
+
fields?: string;
|
|
13269
|
+
/** 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. */
|
|
13270
|
+
key?: string;
|
|
13271
|
+
/** OAuth 2.0 token for the current user. */
|
|
13272
|
+
oauth_token?: string;
|
|
13273
|
+
/** 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. */
|
|
13274
|
+
pageSize?: number;
|
|
13275
|
+
/** 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. */
|
|
13276
|
+
pageToken?: string;
|
|
13277
|
+
/** 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. */
|
|
13278
|
+
parent: string;
|
|
13279
|
+
/** Returns response with indentations and line breaks. */
|
|
13280
|
+
prettyPrint?: boolean;
|
|
13281
|
+
/** 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. */
|
|
13282
|
+
quotaUser?: string;
|
|
13283
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
13284
|
+
upload_protocol?: string;
|
|
13285
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
13286
|
+
uploadType?: string;
|
|
13287
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse>;
|
|
13288
|
+
/** Updates a SampleQuerySet. */
|
|
13289
|
+
patch(request: {
|
|
13290
|
+
/** V1 error format. */
|
|
13291
|
+
'$.xgafv'?: string;
|
|
13292
|
+
/** OAuth access token. */
|
|
13293
|
+
access_token?: string;
|
|
13294
|
+
/** Data format for response. */
|
|
13295
|
+
alt?: string;
|
|
13296
|
+
/** JSONP */
|
|
13297
|
+
callback?: string;
|
|
13298
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
13299
|
+
fields?: string;
|
|
13300
|
+
/** 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. */
|
|
13301
|
+
key?: string;
|
|
13302
|
+
/** Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
13303
|
+
name: string;
|
|
13304
|
+
/** OAuth 2.0 token for the current user. */
|
|
13305
|
+
oauth_token?: string;
|
|
13306
|
+
/** Returns response with indentations and line breaks. */
|
|
13307
|
+
prettyPrint?: boolean;
|
|
13308
|
+
/** 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. */
|
|
13309
|
+
quotaUser?: string;
|
|
13310
|
+
/** Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields. */
|
|
13311
|
+
updateMask?: string;
|
|
13312
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
13313
|
+
upload_protocol?: string;
|
|
13314
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
13315
|
+
uploadType?: string;
|
|
13316
|
+
/** Request body */
|
|
13317
|
+
resource: GoogleCloudDiscoveryengineV1alphaSampleQuerySet;
|
|
13318
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaSampleQuerySet>;
|
|
13319
|
+
patch(
|
|
13320
|
+
request: {
|
|
13321
|
+
/** V1 error format. */
|
|
13322
|
+
'$.xgafv'?: string;
|
|
13323
|
+
/** OAuth access token. */
|
|
13324
|
+
access_token?: string;
|
|
13325
|
+
/** Data format for response. */
|
|
13326
|
+
alt?: string;
|
|
13327
|
+
/** JSONP */
|
|
13328
|
+
callback?: string;
|
|
13329
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
13330
|
+
fields?: string;
|
|
13331
|
+
/** 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. */
|
|
13332
|
+
key?: string;
|
|
13333
|
+
/** Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
13334
|
+
name: string;
|
|
13335
|
+
/** OAuth 2.0 token for the current user. */
|
|
13336
|
+
oauth_token?: string;
|
|
13337
|
+
/** Returns response with indentations and line breaks. */
|
|
13338
|
+
prettyPrint?: boolean;
|
|
13339
|
+
/** 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. */
|
|
13340
|
+
quotaUser?: string;
|
|
13341
|
+
/** Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields. */
|
|
13342
|
+
updateMask?: string;
|
|
13343
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
13344
|
+
upload_protocol?: string;
|
|
13345
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
13346
|
+
uploadType?: string;
|
|
13347
|
+
},
|
|
13348
|
+
body: GoogleCloudDiscoveryengineV1alphaSampleQuerySet
|
|
13349
|
+
): Request<GoogleCloudDiscoveryengineV1alphaSampleQuerySet>;
|
|
12102
13350
|
operations: OperationsResource;
|
|
13351
|
+
sampleQueries: SampleQueriesResource;
|
|
12103
13352
|
}
|
|
12104
13353
|
interface UserEventsResource {
|
|
12105
13354
|
/** 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. */
|
|
@@ -12346,6 +13595,7 @@ declare namespace gapi.client {
|
|
|
12346
13595
|
dataStores: DataStoresResource;
|
|
12347
13596
|
evaluations: EvaluationsResource;
|
|
12348
13597
|
groundingConfigs: GroundingConfigsResource;
|
|
13598
|
+
identity_mapping_stores: Identity_mapping_storesResource;
|
|
12349
13599
|
operations: OperationsResource;
|
|
12350
13600
|
rankingConfigs: RankingConfigsResource;
|
|
12351
13601
|
requirements: RequirementsResource;
|