@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20240829 → 0.0.20240906
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 +142 -96
- package/package.json +1 -1
- package/readme.md +1 -1
package/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/* Type definitions for non-npm package Discovery Engine API v1beta 0.0 */
|
|
2
|
-
// Project: https://cloud.google.com/
|
|
2
|
+
// Project: https://cloud.google.com/generative-ai-app-builder/docs/
|
|
3
3
|
// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
|
|
4
4
|
// Nick Amoscato <https://github.com/namoscato>
|
|
5
5
|
// Declan Vong <https://github.com/declanvong>
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1beta
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240906
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -217,7 +217,7 @@ declare namespace gapi.client {
|
|
|
217
217
|
document?: string;
|
|
218
218
|
/** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
|
|
219
219
|
snippetInfo?: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[];
|
|
220
|
-
/** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document
|
|
220
|
+
/** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . */
|
|
221
221
|
structData?: {[P in string]: any};
|
|
222
222
|
/** Title. */
|
|
223
223
|
title?: string;
|
|
@@ -354,7 +354,7 @@ declare namespace gapi.client {
|
|
|
354
354
|
modelState?: string;
|
|
355
355
|
/** The version of the model. */
|
|
356
356
|
modelVersion?: string;
|
|
357
|
-
/** Required. The fully qualified resource name of the model. Format: `projects/{
|
|
357
|
+
/** Required. The fully qualified resource name of the model. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model must be an alpha-numerical string with limit of 40 characters. */
|
|
358
358
|
name?: string;
|
|
359
359
|
/** Timestamp the model training was initiated. */
|
|
360
360
|
trainingStartTime?: string;
|
|
@@ -380,6 +380,10 @@ declare namespace gapi.client {
|
|
|
380
380
|
languageInfo?: GoogleCloudDiscoveryengineV1alphaLanguageInfo;
|
|
381
381
|
/** Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
382
382
|
name?: string;
|
|
383
|
+
/** Optional. Configuration for Natural Language Query Understanding. */
|
|
384
|
+
naturalLanguageQueryUnderstandingConfig?: GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig;
|
|
385
|
+
/** Optional. Stores serving config at DataStore level. */
|
|
386
|
+
servingConfigDataStore?: GoogleCloudDiscoveryengineV1alphaServingConfigDataStore;
|
|
383
387
|
/** The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */
|
|
384
388
|
solutionTypes?: string[];
|
|
385
389
|
/** The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */
|
|
@@ -425,7 +429,7 @@ declare namespace gapi.client {
|
|
|
425
429
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
426
430
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
427
431
|
name?: string;
|
|
428
|
-
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */
|
|
432
|
+
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */
|
|
429
433
|
parsingConfigOverrides?: {
|
|
430
434
|
[P in string]: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
431
435
|
};
|
|
@@ -480,7 +484,7 @@ declare namespace gapi.client {
|
|
|
480
484
|
industryVertical?: string;
|
|
481
485
|
/** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
|
|
482
486
|
mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
|
|
483
|
-
/** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{
|
|
487
|
+
/** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
484
488
|
name?: string;
|
|
485
489
|
/** Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. */
|
|
486
490
|
recommendationMetadata?: GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata;
|
|
@@ -740,10 +744,14 @@ declare namespace gapi.client {
|
|
|
740
744
|
/** List of custom tuning models. */
|
|
741
745
|
models?: GoogleCloudDiscoveryengineV1alphaCustomTuningModel[];
|
|
742
746
|
}
|
|
747
|
+
interface GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig {
|
|
748
|
+
/** Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. */
|
|
749
|
+
mode?: string;
|
|
750
|
+
}
|
|
743
751
|
interface GoogleCloudDiscoveryengineV1alphaProject {
|
|
744
752
|
/** Output only. The timestamp when this project is created. */
|
|
745
753
|
createTime?: string;
|
|
746
|
-
/** Output only. Full resource name of the project, for example `projects/{
|
|
754
|
+
/** Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */
|
|
747
755
|
name?: string;
|
|
748
756
|
/** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
|
|
749
757
|
provisionCompletionTime?: string;
|
|
@@ -1026,6 +1034,8 @@ declare namespace gapi.client {
|
|
|
1026
1034
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec {
|
|
1027
1035
|
/** Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */
|
|
1028
1036
|
ignoreAdversarialQuery?: boolean;
|
|
1037
|
+
/** Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead. */
|
|
1038
|
+
ignoreJailBreakingQuery?: boolean;
|
|
1029
1039
|
/** Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */
|
|
1030
1040
|
ignoreLowRelevantContent?: boolean;
|
|
1031
1041
|
/** 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. */
|
|
@@ -1121,6 +1131,10 @@ declare namespace gapi.client {
|
|
|
1121
1131
|
/** The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */
|
|
1122
1132
|
mode?: string;
|
|
1123
1133
|
}
|
|
1134
|
+
interface GoogleCloudDiscoveryengineV1alphaServingConfigDataStore {
|
|
1135
|
+
/** If set true, the DataStore will not be available for serving search requests. */
|
|
1136
|
+
disabledForServing?: boolean;
|
|
1137
|
+
}
|
|
1124
1138
|
interface GoogleCloudDiscoveryengineV1alphaSession {
|
|
1125
1139
|
/** Output only. The time the session finished. */
|
|
1126
1140
|
endTime?: string;
|
|
@@ -1203,7 +1217,7 @@ declare namespace gapi.client {
|
|
|
1203
1217
|
modelStatus?: string;
|
|
1204
1218
|
}
|
|
1205
1219
|
interface GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata {
|
|
1206
|
-
/** Required. The resource name of the engine that this tune applies to. Format: `projects/{
|
|
1220
|
+
/** Required. The resource name of the engine that this tune applies to. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` */
|
|
1207
1221
|
engine?: string;
|
|
1208
1222
|
}
|
|
1209
1223
|
interface GoogleCloudDiscoveryengineV1alphaTuneEngineResponse {}
|
|
@@ -1294,7 +1308,7 @@ declare namespace gapi.client {
|
|
|
1294
1308
|
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequest {
|
|
1295
1309
|
/** Answer generation specification. */
|
|
1296
1310
|
answerGenerationSpec?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec;
|
|
1297
|
-
/** Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method. */
|
|
1311
|
+
/** Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method. */
|
|
1298
1312
|
asynchronousMode?: boolean;
|
|
1299
1313
|
/** Required. Current user query. */
|
|
1300
1314
|
query?: GoogleCloudDiscoveryengineV1betaQuery;
|
|
@@ -1318,6 +1332,8 @@ declare namespace gapi.client {
|
|
|
1318
1332
|
answerLanguageCode?: string;
|
|
1319
1333
|
/** Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer 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 answers for adversarial queries and return fallback messages instead. */
|
|
1320
1334
|
ignoreAdversarialQuery?: boolean;
|
|
1335
|
+
/** Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead. */
|
|
1336
|
+
ignoreJailBreakingQuery?: boolean;
|
|
1321
1337
|
/** Specifies whether to filter out queries that have low relevance. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service. */
|
|
1322
1338
|
ignoreLowRelevantContent?: boolean;
|
|
1323
1339
|
/** Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead. */
|
|
@@ -1396,6 +1412,14 @@ declare namespace gapi.client {
|
|
|
1396
1412
|
chunk?: string;
|
|
1397
1413
|
/** Chunk textual content. */
|
|
1398
1414
|
content?: string;
|
|
1415
|
+
/** Metadata of the document from the current chunk. */
|
|
1416
|
+
documentMetadata?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata;
|
|
1417
|
+
}
|
|
1418
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata {
|
|
1419
|
+
/** Title of the document. */
|
|
1420
|
+
title?: string;
|
|
1421
|
+
/** Uri of the document. */
|
|
1422
|
+
uri?: string;
|
|
1399
1423
|
}
|
|
1400
1424
|
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo {
|
|
1401
1425
|
/** Document resource name. */
|
|
@@ -1530,7 +1554,7 @@ declare namespace gapi.client {
|
|
|
1530
1554
|
document?: string;
|
|
1531
1555
|
/** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
|
|
1532
1556
|
snippetInfo?: GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo[];
|
|
1533
|
-
/** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document
|
|
1557
|
+
/** 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. . */
|
|
1534
1558
|
structData?: {[P in string]: any};
|
|
1535
1559
|
/** Title. */
|
|
1536
1560
|
title?: string;
|
|
@@ -1580,8 +1604,8 @@ declare namespace gapi.client {
|
|
|
1580
1604
|
lastRefreshedTime?: string;
|
|
1581
1605
|
/** The value of the matcher that was used to match the Document. */
|
|
1582
1606
|
matcherValue?: GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue;
|
|
1583
|
-
/** The
|
|
1584
|
-
|
|
1607
|
+
/** The state of the document. */
|
|
1608
|
+
state?: string;
|
|
1585
1609
|
}
|
|
1586
1610
|
interface GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue {
|
|
1587
1611
|
/** Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} */
|
|
@@ -1863,7 +1887,7 @@ declare namespace gapi.client {
|
|
|
1863
1887
|
query?: GoogleCloudDiscoveryengineV1betaTextInput;
|
|
1864
1888
|
/** Whether to turn on safe search. */
|
|
1865
1889
|
safeSearch?: boolean;
|
|
1866
|
-
/** The resource name of the Serving Config to use. Format: `projects/{
|
|
1890
|
+
/** The resource name of the Serving Config to use. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used. */
|
|
1867
1891
|
servingConfig?: string;
|
|
1868
1892
|
/** A specification for configuring the summary returned in the response. */
|
|
1869
1893
|
summarySpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec;
|
|
@@ -1928,7 +1952,7 @@ declare namespace gapi.client {
|
|
|
1928
1952
|
modelState?: string;
|
|
1929
1953
|
/** The version of the model. */
|
|
1930
1954
|
modelVersion?: string;
|
|
1931
|
-
/** Required. The fully qualified resource name of the model. Format: `projects/{
|
|
1955
|
+
/** Required. The fully qualified resource name of the model. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model must be an alpha-numerical string with limit of 40 characters. */
|
|
1932
1956
|
name?: string;
|
|
1933
1957
|
/** Timestamp the model training was initiated. */
|
|
1934
1958
|
trainingStartTime?: string;
|
|
@@ -1950,6 +1974,10 @@ declare namespace gapi.client {
|
|
|
1950
1974
|
languageInfo?: GoogleCloudDiscoveryengineV1betaLanguageInfo;
|
|
1951
1975
|
/** Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
1952
1976
|
name?: string;
|
|
1977
|
+
/** Optional. Configuration for Natural Language Query Understanding. */
|
|
1978
|
+
naturalLanguageQueryUnderstandingConfig?: GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig;
|
|
1979
|
+
/** Optional. Stores serving config at DataStore level. */
|
|
1980
|
+
servingConfigDataStore?: GoogleCloudDiscoveryengineV1betaServingConfigDataStore;
|
|
1953
1981
|
/** The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */
|
|
1954
1982
|
solutionTypes?: string[];
|
|
1955
1983
|
/** The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */
|
|
@@ -2030,7 +2058,7 @@ declare namespace gapi.client {
|
|
|
2030
2058
|
id?: string;
|
|
2031
2059
|
/** Output only. Whether the referenced Document can be found in the data store. */
|
|
2032
2060
|
joined?: boolean;
|
|
2033
|
-
/** The Document resource full name, of the form: `projects/{
|
|
2061
|
+
/** The Document resource full name, of the form: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}` */
|
|
2034
2062
|
name?: string;
|
|
2035
2063
|
/** The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID. */
|
|
2036
2064
|
promotionIds?: string[];
|
|
@@ -2046,7 +2074,7 @@ declare namespace gapi.client {
|
|
|
2046
2074
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
2047
2075
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
2048
2076
|
name?: string;
|
|
2049
|
-
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */
|
|
2077
|
+
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */
|
|
2050
2078
|
parsingConfigOverrides?: {
|
|
2051
2079
|
[P in string]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
2052
2080
|
};
|
|
@@ -2108,7 +2136,7 @@ declare namespace gapi.client {
|
|
|
2108
2136
|
displayName?: string;
|
|
2109
2137
|
/** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. */
|
|
2110
2138
|
industryVertical?: string;
|
|
2111
|
-
/** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{
|
|
2139
|
+
/** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
2112
2140
|
name?: string;
|
|
2113
2141
|
/** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
2114
2142
|
searchEngineConfig?: GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig;
|
|
@@ -2515,6 +2543,10 @@ declare namespace gapi.client {
|
|
|
2515
2543
|
/** Media progress should be computed using only the media_progress_duration relative to the media total length. This value must be between `[0, 1.0]` inclusive. If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset. */
|
|
2516
2544
|
mediaProgressPercentage?: number;
|
|
2517
2545
|
}
|
|
2546
|
+
interface GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig {
|
|
2547
|
+
/** Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. */
|
|
2548
|
+
mode?: string;
|
|
2549
|
+
}
|
|
2518
2550
|
interface GoogleCloudDiscoveryengineV1betaPageInfo {
|
|
2519
2551
|
/** The most specific category associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: `"pageCategory" : "Sales > 2017 Black Friday Deals"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
2520
2552
|
pageCategory?: string;
|
|
@@ -2539,7 +2571,7 @@ declare namespace gapi.client {
|
|
|
2539
2571
|
interface GoogleCloudDiscoveryengineV1betaProject {
|
|
2540
2572
|
/** Output only. The timestamp when this project is created. */
|
|
2541
2573
|
createTime?: string;
|
|
2542
|
-
/** Output only. Full resource name of the project, for example `projects/{
|
|
2574
|
+
/** Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */
|
|
2543
2575
|
name?: string;
|
|
2544
2576
|
/** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
|
|
2545
2577
|
provisionCompletionTime?: string;
|
|
@@ -2714,6 +2746,8 @@ declare namespace gapi.client {
|
|
|
2714
2746
|
metadata?: {[P in string]: any};
|
|
2715
2747
|
}
|
|
2716
2748
|
interface GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest {
|
|
2749
|
+
/** Optional. Full resource name of the SiteCredential, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`. Only set to crawl private URIs. */
|
|
2750
|
+
siteCredential?: string;
|
|
2717
2751
|
/** Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in `site_search_engine`. */
|
|
2718
2752
|
uris?: string[];
|
|
2719
2753
|
}
|
|
@@ -2915,6 +2949,8 @@ declare namespace gapi.client {
|
|
|
2915
2949
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec {
|
|
2916
2950
|
/** 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. */
|
|
2917
2951
|
ignoreAdversarialQuery?: boolean;
|
|
2952
|
+
/** Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead. */
|
|
2953
|
+
ignoreJailBreakingQuery?: boolean;
|
|
2918
2954
|
/** Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */
|
|
2919
2955
|
ignoreLowRelevantContent?: boolean;
|
|
2920
2956
|
/** 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. */
|
|
@@ -3261,6 +3297,10 @@ declare namespace gapi.client {
|
|
|
3261
3297
|
/** Output only. ServingConfig updated timestamp. */
|
|
3262
3298
|
updateTime?: string;
|
|
3263
3299
|
}
|
|
3300
|
+
interface GoogleCloudDiscoveryengineV1betaServingConfigDataStore {
|
|
3301
|
+
/** If set true, the DataStore will not be available for serving search requests. */
|
|
3302
|
+
disabledForServing?: boolean;
|
|
3303
|
+
}
|
|
3264
3304
|
interface GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig {
|
|
3265
3305
|
/** Specifies the expected behavior of content search. Only valid for content-search enabled data store. */
|
|
3266
3306
|
contentSearchSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
|
|
@@ -3412,7 +3452,7 @@ declare namespace gapi.client {
|
|
|
3412
3452
|
value?: number;
|
|
3413
3453
|
}
|
|
3414
3454
|
interface GoogleCloudDiscoveryengineV1betaTuneEngineMetadata {
|
|
3415
|
-
/** Required. The resource name of the engine that this tune applies to. Format: `projects/{
|
|
3455
|
+
/** Required. The resource name of the engine that this tune applies to. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` */
|
|
3416
3456
|
engine?: string;
|
|
3417
3457
|
}
|
|
3418
3458
|
interface GoogleCloudDiscoveryengineV1betaTuneEngineRequest {}
|
|
@@ -3586,6 +3626,8 @@ declare namespace gapi.client {
|
|
|
3586
3626
|
industryVertical?: string;
|
|
3587
3627
|
/** Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
3588
3628
|
name?: string;
|
|
3629
|
+
/** Optional. Stores serving config at DataStore level. */
|
|
3630
|
+
servingConfigDataStore?: GoogleCloudDiscoveryengineV1ServingConfigDataStore;
|
|
3589
3631
|
/** The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */
|
|
3590
3632
|
solutionTypes?: string[];
|
|
3591
3633
|
/** The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */
|
|
@@ -3631,7 +3673,7 @@ declare namespace gapi.client {
|
|
|
3631
3673
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
3632
3674
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
3633
3675
|
name?: string;
|
|
3634
|
-
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */
|
|
3676
|
+
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */
|
|
3635
3677
|
parsingConfigOverrides?: {
|
|
3636
3678
|
[P in string]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
3637
3679
|
};
|
|
@@ -3684,7 +3726,7 @@ declare namespace gapi.client {
|
|
|
3684
3726
|
displayName?: string;
|
|
3685
3727
|
/** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. */
|
|
3686
3728
|
industryVertical?: string;
|
|
3687
|
-
/** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{
|
|
3729
|
+
/** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
3688
3730
|
name?: string;
|
|
3689
3731
|
/** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
3690
3732
|
searchEngineConfig?: GoogleCloudDiscoveryengineV1EngineSearchEngineConfig;
|
|
@@ -3798,7 +3840,7 @@ declare namespace gapi.client {
|
|
|
3798
3840
|
interface GoogleCloudDiscoveryengineV1Project {
|
|
3799
3841
|
/** Output only. The timestamp when this project is created. */
|
|
3800
3842
|
createTime?: string;
|
|
3801
|
-
/** Output only. Full resource name of the project, for example `projects/{
|
|
3843
|
+
/** Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */
|
|
3802
3844
|
name?: string;
|
|
3803
3845
|
/** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
|
|
3804
3846
|
provisionCompletionTime?: string;
|
|
@@ -3870,6 +3912,10 @@ declare namespace gapi.client {
|
|
|
3870
3912
|
/** The structured representation of the schema. */
|
|
3871
3913
|
structSchema?: {[P in string]: any};
|
|
3872
3914
|
}
|
|
3915
|
+
interface GoogleCloudDiscoveryengineV1ServingConfigDataStore {
|
|
3916
|
+
/** If set true, the DataStore will not be available for serving search requests. */
|
|
3917
|
+
disabledForServing?: boolean;
|
|
3918
|
+
}
|
|
3873
3919
|
interface GoogleCloudDiscoveryengineV1SiteVerificationInfo {
|
|
3874
3920
|
/** Site verification state indicating the ownership and validity. */
|
|
3875
3921
|
siteVerificationState?: string;
|
|
@@ -4666,7 +4712,7 @@ declare namespace gapi.client {
|
|
|
4666
4712
|
key?: string;
|
|
4667
4713
|
/** OAuth 2.0 token for the current user. */
|
|
4668
4714
|
oauth_token?: string;
|
|
4669
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
4715
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. */
|
|
4670
4716
|
parent: string;
|
|
4671
4717
|
/** Returns response with indentations and line breaks. */
|
|
4672
4718
|
prettyPrint?: boolean;
|
|
@@ -4697,7 +4743,7 @@ declare namespace gapi.client {
|
|
|
4697
4743
|
key?: string;
|
|
4698
4744
|
/** OAuth 2.0 token for the current user. */
|
|
4699
4745
|
oauth_token?: string;
|
|
4700
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
4746
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. */
|
|
4701
4747
|
parent: string;
|
|
4702
4748
|
/** Returns response with indentations and line breaks. */
|
|
4703
4749
|
prettyPrint?: boolean;
|
|
@@ -4724,7 +4770,7 @@ declare namespace gapi.client {
|
|
|
4724
4770
|
fields?: string;
|
|
4725
4771
|
/** 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. */
|
|
4726
4772
|
key?: string;
|
|
4727
|
-
/** Required. The resource name of the Control to delete. Format: `projects/{
|
|
4773
|
+
/** Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
4728
4774
|
name: string;
|
|
4729
4775
|
/** OAuth 2.0 token for the current user. */
|
|
4730
4776
|
oauth_token?: string;
|
|
@@ -4751,7 +4797,7 @@ declare namespace gapi.client {
|
|
|
4751
4797
|
fields?: string;
|
|
4752
4798
|
/** 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. */
|
|
4753
4799
|
key?: string;
|
|
4754
|
-
/** Required. The resource name of the Control to get. Format: `projects/{
|
|
4800
|
+
/** Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
4755
4801
|
name: string;
|
|
4756
4802
|
/** OAuth 2.0 token for the current user. */
|
|
4757
4803
|
oauth_token?: string;
|
|
@@ -4786,7 +4832,7 @@ declare namespace gapi.client {
|
|
|
4786
4832
|
pageSize?: number;
|
|
4787
4833
|
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
4788
4834
|
pageToken?: string;
|
|
4789
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
4835
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. */
|
|
4790
4836
|
parent: string;
|
|
4791
4837
|
/** Returns response with indentations and line breaks. */
|
|
4792
4838
|
prettyPrint?: boolean;
|
|
@@ -4875,7 +4921,7 @@ declare namespace gapi.client {
|
|
|
4875
4921
|
fields?: string;
|
|
4876
4922
|
/** 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. */
|
|
4877
4923
|
key?: string;
|
|
4878
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
4924
|
+
/** Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
|
|
4879
4925
|
name: string;
|
|
4880
4926
|
/** OAuth 2.0 token for the current user. */
|
|
4881
4927
|
oauth_token?: string;
|
|
@@ -4904,7 +4950,7 @@ declare namespace gapi.client {
|
|
|
4904
4950
|
fields?: string;
|
|
4905
4951
|
/** 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. */
|
|
4906
4952
|
key?: string;
|
|
4907
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
4953
|
+
/** Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
|
|
4908
4954
|
name: string;
|
|
4909
4955
|
/** OAuth 2.0 token for the current user. */
|
|
4910
4956
|
oauth_token?: string;
|
|
@@ -4935,7 +4981,7 @@ declare namespace gapi.client {
|
|
|
4935
4981
|
key?: string;
|
|
4936
4982
|
/** OAuth 2.0 token for the current user. */
|
|
4937
4983
|
oauth_token?: string;
|
|
4938
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
4984
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
4939
4985
|
parent: string;
|
|
4940
4986
|
/** Returns response with indentations and line breaks. */
|
|
4941
4987
|
prettyPrint?: boolean;
|
|
@@ -4964,7 +5010,7 @@ declare namespace gapi.client {
|
|
|
4964
5010
|
key?: string;
|
|
4965
5011
|
/** OAuth 2.0 token for the current user. */
|
|
4966
5012
|
oauth_token?: string;
|
|
4967
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
5013
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
4968
5014
|
parent: string;
|
|
4969
5015
|
/** Returns response with indentations and line breaks. */
|
|
4970
5016
|
prettyPrint?: boolean;
|
|
@@ -4991,7 +5037,7 @@ declare namespace gapi.client {
|
|
|
4991
5037
|
fields?: string;
|
|
4992
5038
|
/** 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. */
|
|
4993
5039
|
key?: string;
|
|
4994
|
-
/** Required. The resource name of the Conversation to delete. Format: `projects/{
|
|
5040
|
+
/** Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
|
|
4995
5041
|
name: string;
|
|
4996
5042
|
/** OAuth 2.0 token for the current user. */
|
|
4997
5043
|
oauth_token?: string;
|
|
@@ -5018,7 +5064,7 @@ declare namespace gapi.client {
|
|
|
5018
5064
|
fields?: string;
|
|
5019
5065
|
/** 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. */
|
|
5020
5066
|
key?: string;
|
|
5021
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
5067
|
+
/** Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
|
|
5022
5068
|
name: string;
|
|
5023
5069
|
/** OAuth 2.0 token for the current user. */
|
|
5024
5070
|
oauth_token?: string;
|
|
@@ -5055,7 +5101,7 @@ declare namespace gapi.client {
|
|
|
5055
5101
|
pageSize?: number;
|
|
5056
5102
|
/** A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */
|
|
5057
5103
|
pageToken?: string;
|
|
5058
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
5104
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
5059
5105
|
parent: string;
|
|
5060
5106
|
/** Returns response with indentations and line breaks. */
|
|
5061
5107
|
prettyPrint?: boolean;
|
|
@@ -5632,7 +5678,7 @@ declare namespace gapi.client {
|
|
|
5632
5678
|
fields?: string;
|
|
5633
5679
|
/** 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. */
|
|
5634
5680
|
key?: string;
|
|
5635
|
-
/** Required. The resource name of the ServingConfig to get. Format: `projects/{
|
|
5681
|
+
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
5636
5682
|
name: string;
|
|
5637
5683
|
/** OAuth 2.0 token for the current user. */
|
|
5638
5684
|
oauth_token?: string;
|
|
@@ -5665,7 +5711,7 @@ declare namespace gapi.client {
|
|
|
5665
5711
|
pageSize?: number;
|
|
5666
5712
|
/** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
|
|
5667
5713
|
pageToken?: string;
|
|
5668
|
-
/** Required. Full resource name of the parent resource. Format: `projects/{
|
|
5714
|
+
/** Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
5669
5715
|
parent: string;
|
|
5670
5716
|
/** Returns response with indentations and line breaks. */
|
|
5671
5717
|
prettyPrint?: boolean;
|
|
@@ -5870,7 +5916,7 @@ declare namespace gapi.client {
|
|
|
5870
5916
|
fields?: string;
|
|
5871
5917
|
/** 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. */
|
|
5872
5918
|
key?: string;
|
|
5873
|
-
/** Required. The resource name of the Answer to get. Format: `projects/{
|
|
5919
|
+
/** Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` */
|
|
5874
5920
|
name: string;
|
|
5875
5921
|
/** OAuth 2.0 token for the current user. */
|
|
5876
5922
|
oauth_token?: string;
|
|
@@ -5901,7 +5947,7 @@ declare namespace gapi.client {
|
|
|
5901
5947
|
key?: string;
|
|
5902
5948
|
/** OAuth 2.0 token for the current user. */
|
|
5903
5949
|
oauth_token?: string;
|
|
5904
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
5950
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
5905
5951
|
parent: string;
|
|
5906
5952
|
/** Returns response with indentations and line breaks. */
|
|
5907
5953
|
prettyPrint?: boolean;
|
|
@@ -5930,7 +5976,7 @@ declare namespace gapi.client {
|
|
|
5930
5976
|
key?: string;
|
|
5931
5977
|
/** OAuth 2.0 token for the current user. */
|
|
5932
5978
|
oauth_token?: string;
|
|
5933
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
5979
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
5934
5980
|
parent: string;
|
|
5935
5981
|
/** Returns response with indentations and line breaks. */
|
|
5936
5982
|
prettyPrint?: boolean;
|
|
@@ -5957,7 +6003,7 @@ declare namespace gapi.client {
|
|
|
5957
6003
|
fields?: string;
|
|
5958
6004
|
/** 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. */
|
|
5959
6005
|
key?: string;
|
|
5960
|
-
/** Required. The resource name of the Session to delete. Format: `projects/{
|
|
6006
|
+
/** Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
5961
6007
|
name: string;
|
|
5962
6008
|
/** OAuth 2.0 token for the current user. */
|
|
5963
6009
|
oauth_token?: string;
|
|
@@ -5984,7 +6030,7 @@ declare namespace gapi.client {
|
|
|
5984
6030
|
fields?: string;
|
|
5985
6031
|
/** 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. */
|
|
5986
6032
|
key?: string;
|
|
5987
|
-
/** Required. The resource name of the Session to get. Format: `projects/{
|
|
6033
|
+
/** Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
5988
6034
|
name: string;
|
|
5989
6035
|
/** OAuth 2.0 token for the current user. */
|
|
5990
6036
|
oauth_token?: string;
|
|
@@ -6021,7 +6067,7 @@ declare namespace gapi.client {
|
|
|
6021
6067
|
pageSize?: number;
|
|
6022
6068
|
/** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
|
|
6023
6069
|
pageToken?: string;
|
|
6024
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
6070
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
6025
6071
|
parent: string;
|
|
6026
6072
|
/** Returns response with indentations and line breaks. */
|
|
6027
6073
|
prettyPrint?: boolean;
|
|
@@ -6975,7 +7021,7 @@ declare namespace gapi.client {
|
|
|
6975
7021
|
key?: string;
|
|
6976
7022
|
/** OAuth 2.0 token for the current user. */
|
|
6977
7023
|
oauth_token?: string;
|
|
6978
|
-
/** Required. The resource name of the catalog under which the events are created. The format is `projects
|
|
7024
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`. */
|
|
6979
7025
|
parent: string;
|
|
6980
7026
|
/** Returns response with indentations and line breaks. */
|
|
6981
7027
|
prettyPrint?: boolean;
|
|
@@ -7004,7 +7050,7 @@ declare namespace gapi.client {
|
|
|
7004
7050
|
key?: string;
|
|
7005
7051
|
/** OAuth 2.0 token for the current user. */
|
|
7006
7052
|
oauth_token?: string;
|
|
7007
|
-
/** Required. The resource name of the catalog under which the events are created. The format is `projects
|
|
7053
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`. */
|
|
7008
7054
|
parent: string;
|
|
7009
7055
|
/** Returns response with indentations and line breaks. */
|
|
7010
7056
|
prettyPrint?: boolean;
|
|
@@ -7453,7 +7499,7 @@ declare namespace gapi.client {
|
|
|
7453
7499
|
key?: string;
|
|
7454
7500
|
/** OAuth 2.0 token for the current user. */
|
|
7455
7501
|
oauth_token?: string;
|
|
7456
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
7502
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. */
|
|
7457
7503
|
parent: string;
|
|
7458
7504
|
/** Returns response with indentations and line breaks. */
|
|
7459
7505
|
prettyPrint?: boolean;
|
|
@@ -7484,7 +7530,7 @@ declare namespace gapi.client {
|
|
|
7484
7530
|
key?: string;
|
|
7485
7531
|
/** OAuth 2.0 token for the current user. */
|
|
7486
7532
|
oauth_token?: string;
|
|
7487
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
7533
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. */
|
|
7488
7534
|
parent: string;
|
|
7489
7535
|
/** Returns response with indentations and line breaks. */
|
|
7490
7536
|
prettyPrint?: boolean;
|
|
@@ -7511,7 +7557,7 @@ declare namespace gapi.client {
|
|
|
7511
7557
|
fields?: string;
|
|
7512
7558
|
/** 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. */
|
|
7513
7559
|
key?: string;
|
|
7514
|
-
/** Required. The resource name of the Control to delete. Format: `projects/{
|
|
7560
|
+
/** Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
7515
7561
|
name: string;
|
|
7516
7562
|
/** OAuth 2.0 token for the current user. */
|
|
7517
7563
|
oauth_token?: string;
|
|
@@ -7538,7 +7584,7 @@ declare namespace gapi.client {
|
|
|
7538
7584
|
fields?: string;
|
|
7539
7585
|
/** 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. */
|
|
7540
7586
|
key?: string;
|
|
7541
|
-
/** Required. The resource name of the Control to get. Format: `projects/{
|
|
7587
|
+
/** Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
7542
7588
|
name: string;
|
|
7543
7589
|
/** OAuth 2.0 token for the current user. */
|
|
7544
7590
|
oauth_token?: string;
|
|
@@ -7573,7 +7619,7 @@ declare namespace gapi.client {
|
|
|
7573
7619
|
pageSize?: number;
|
|
7574
7620
|
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
7575
7621
|
pageToken?: string;
|
|
7576
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
7622
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. */
|
|
7577
7623
|
parent: string;
|
|
7578
7624
|
/** Returns response with indentations and line breaks. */
|
|
7579
7625
|
prettyPrint?: boolean;
|
|
@@ -7662,7 +7708,7 @@ declare namespace gapi.client {
|
|
|
7662
7708
|
fields?: string;
|
|
7663
7709
|
/** 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. */
|
|
7664
7710
|
key?: string;
|
|
7665
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
7711
|
+
/** Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
|
|
7666
7712
|
name: string;
|
|
7667
7713
|
/** OAuth 2.0 token for the current user. */
|
|
7668
7714
|
oauth_token?: string;
|
|
@@ -7691,7 +7737,7 @@ declare namespace gapi.client {
|
|
|
7691
7737
|
fields?: string;
|
|
7692
7738
|
/** 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. */
|
|
7693
7739
|
key?: string;
|
|
7694
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
7740
|
+
/** Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
|
|
7695
7741
|
name: string;
|
|
7696
7742
|
/** OAuth 2.0 token for the current user. */
|
|
7697
7743
|
oauth_token?: string;
|
|
@@ -7722,7 +7768,7 @@ declare namespace gapi.client {
|
|
|
7722
7768
|
key?: string;
|
|
7723
7769
|
/** OAuth 2.0 token for the current user. */
|
|
7724
7770
|
oauth_token?: string;
|
|
7725
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
7771
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
7726
7772
|
parent: string;
|
|
7727
7773
|
/** Returns response with indentations and line breaks. */
|
|
7728
7774
|
prettyPrint?: boolean;
|
|
@@ -7751,7 +7797,7 @@ declare namespace gapi.client {
|
|
|
7751
7797
|
key?: string;
|
|
7752
7798
|
/** OAuth 2.0 token for the current user. */
|
|
7753
7799
|
oauth_token?: string;
|
|
7754
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
7800
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
7755
7801
|
parent: string;
|
|
7756
7802
|
/** Returns response with indentations and line breaks. */
|
|
7757
7803
|
prettyPrint?: boolean;
|
|
@@ -7778,7 +7824,7 @@ declare namespace gapi.client {
|
|
|
7778
7824
|
fields?: string;
|
|
7779
7825
|
/** 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. */
|
|
7780
7826
|
key?: string;
|
|
7781
|
-
/** Required. The resource name of the Conversation to delete. Format: `projects/{
|
|
7827
|
+
/** Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
|
|
7782
7828
|
name: string;
|
|
7783
7829
|
/** OAuth 2.0 token for the current user. */
|
|
7784
7830
|
oauth_token?: string;
|
|
@@ -7805,7 +7851,7 @@ declare namespace gapi.client {
|
|
|
7805
7851
|
fields?: string;
|
|
7806
7852
|
/** 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. */
|
|
7807
7853
|
key?: string;
|
|
7808
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
7854
|
+
/** Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
|
|
7809
7855
|
name: string;
|
|
7810
7856
|
/** OAuth 2.0 token for the current user. */
|
|
7811
7857
|
oauth_token?: string;
|
|
@@ -7842,7 +7888,7 @@ declare namespace gapi.client {
|
|
|
7842
7888
|
pageSize?: number;
|
|
7843
7889
|
/** A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */
|
|
7844
7890
|
pageToken?: string;
|
|
7845
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
7891
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
7846
7892
|
parent: string;
|
|
7847
7893
|
/** Returns response with indentations and line breaks. */
|
|
7848
7894
|
prettyPrint?: boolean;
|
|
@@ -8051,7 +8097,7 @@ declare namespace gapi.client {
|
|
|
8051
8097
|
fields?: string;
|
|
8052
8098
|
/** 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. */
|
|
8053
8099
|
key?: string;
|
|
8054
|
-
/** Required. The resource name of the ServingConfig to get. Format: `projects/{
|
|
8100
|
+
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
8055
8101
|
name: string;
|
|
8056
8102
|
/** OAuth 2.0 token for the current user. */
|
|
8057
8103
|
oauth_token?: string;
|
|
@@ -8084,7 +8130,7 @@ declare namespace gapi.client {
|
|
|
8084
8130
|
pageSize?: number;
|
|
8085
8131
|
/** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
|
|
8086
8132
|
pageToken?: string;
|
|
8087
|
-
/** Required. Full resource name of the parent resource. Format: `projects/{
|
|
8133
|
+
/** Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
8088
8134
|
parent: string;
|
|
8089
8135
|
/** Returns response with indentations and line breaks. */
|
|
8090
8136
|
prettyPrint?: boolean;
|
|
@@ -8289,7 +8335,7 @@ declare namespace gapi.client {
|
|
|
8289
8335
|
fields?: string;
|
|
8290
8336
|
/** 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. */
|
|
8291
8337
|
key?: string;
|
|
8292
|
-
/** Required. The resource name of the Answer to get. Format: `projects/{
|
|
8338
|
+
/** Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` */
|
|
8293
8339
|
name: string;
|
|
8294
8340
|
/** OAuth 2.0 token for the current user. */
|
|
8295
8341
|
oauth_token?: string;
|
|
@@ -8320,7 +8366,7 @@ declare namespace gapi.client {
|
|
|
8320
8366
|
key?: string;
|
|
8321
8367
|
/** OAuth 2.0 token for the current user. */
|
|
8322
8368
|
oauth_token?: string;
|
|
8323
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
8369
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
8324
8370
|
parent: string;
|
|
8325
8371
|
/** Returns response with indentations and line breaks. */
|
|
8326
8372
|
prettyPrint?: boolean;
|
|
@@ -8349,7 +8395,7 @@ declare namespace gapi.client {
|
|
|
8349
8395
|
key?: string;
|
|
8350
8396
|
/** OAuth 2.0 token for the current user. */
|
|
8351
8397
|
oauth_token?: string;
|
|
8352
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
8398
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
8353
8399
|
parent: string;
|
|
8354
8400
|
/** Returns response with indentations and line breaks. */
|
|
8355
8401
|
prettyPrint?: boolean;
|
|
@@ -8376,7 +8422,7 @@ declare namespace gapi.client {
|
|
|
8376
8422
|
fields?: string;
|
|
8377
8423
|
/** 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. */
|
|
8378
8424
|
key?: string;
|
|
8379
|
-
/** Required. The resource name of the Session to delete. Format: `projects/{
|
|
8425
|
+
/** Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
8380
8426
|
name: string;
|
|
8381
8427
|
/** OAuth 2.0 token for the current user. */
|
|
8382
8428
|
oauth_token?: string;
|
|
@@ -8403,7 +8449,7 @@ declare namespace gapi.client {
|
|
|
8403
8449
|
fields?: string;
|
|
8404
8450
|
/** 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. */
|
|
8405
8451
|
key?: string;
|
|
8406
|
-
/** Required. The resource name of the Session to get. Format: `projects/{
|
|
8452
|
+
/** Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
8407
8453
|
name: string;
|
|
8408
8454
|
/** OAuth 2.0 token for the current user. */
|
|
8409
8455
|
oauth_token?: string;
|
|
@@ -8440,7 +8486,7 @@ declare namespace gapi.client {
|
|
|
8440
8486
|
pageSize?: number;
|
|
8441
8487
|
/** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
|
|
8442
8488
|
pageToken?: string;
|
|
8443
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
8489
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
8444
8490
|
parent: string;
|
|
8445
8491
|
/** Returns response with indentations and line breaks. */
|
|
8446
8492
|
prettyPrint?: boolean;
|
|
@@ -8679,7 +8725,7 @@ declare namespace gapi.client {
|
|
|
8679
8725
|
fields?: string;
|
|
8680
8726
|
/** 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. */
|
|
8681
8727
|
key?: string;
|
|
8682
|
-
/** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{
|
|
8728
|
+
/** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
8683
8729
|
name: string;
|
|
8684
8730
|
/** OAuth 2.0 token for the current user. */
|
|
8685
8731
|
oauth_token?: string;
|
|
@@ -8710,7 +8756,7 @@ declare namespace gapi.client {
|
|
|
8710
8756
|
fields?: string;
|
|
8711
8757
|
/** 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. */
|
|
8712
8758
|
key?: string;
|
|
8713
|
-
/** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{
|
|
8759
|
+
/** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
8714
8760
|
name: string;
|
|
8715
8761
|
/** OAuth 2.0 token for the current user. */
|
|
8716
8762
|
oauth_token?: string;
|
|
@@ -8741,7 +8787,7 @@ declare namespace gapi.client {
|
|
|
8741
8787
|
fields?: string;
|
|
8742
8788
|
/** 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. */
|
|
8743
8789
|
key?: string;
|
|
8744
|
-
/** Required. The name of the engine to pause. Format: `projects/{
|
|
8790
|
+
/** Required. The name of the engine to pause. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` */
|
|
8745
8791
|
name: string;
|
|
8746
8792
|
/** OAuth 2.0 token for the current user. */
|
|
8747
8793
|
oauth_token?: string;
|
|
@@ -8770,7 +8816,7 @@ declare namespace gapi.client {
|
|
|
8770
8816
|
fields?: string;
|
|
8771
8817
|
/** 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. */
|
|
8772
8818
|
key?: string;
|
|
8773
|
-
/** Required. The name of the engine to pause. Format: `projects/{
|
|
8819
|
+
/** Required. The name of the engine to pause. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` */
|
|
8774
8820
|
name: string;
|
|
8775
8821
|
/** OAuth 2.0 token for the current user. */
|
|
8776
8822
|
oauth_token?: string;
|
|
@@ -8799,7 +8845,7 @@ declare namespace gapi.client {
|
|
|
8799
8845
|
fields?: string;
|
|
8800
8846
|
/** 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. */
|
|
8801
8847
|
key?: string;
|
|
8802
|
-
/** Required. The name of the engine to resume. Format: `projects/{
|
|
8848
|
+
/** Required. The name of the engine to resume. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` */
|
|
8803
8849
|
name: string;
|
|
8804
8850
|
/** OAuth 2.0 token for the current user. */
|
|
8805
8851
|
oauth_token?: string;
|
|
@@ -8828,7 +8874,7 @@ declare namespace gapi.client {
|
|
|
8828
8874
|
fields?: string;
|
|
8829
8875
|
/** 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. */
|
|
8830
8876
|
key?: string;
|
|
8831
|
-
/** Required. The name of the engine to resume. Format: `projects/{
|
|
8877
|
+
/** Required. The name of the engine to resume. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` */
|
|
8832
8878
|
name: string;
|
|
8833
8879
|
/** OAuth 2.0 token for the current user. */
|
|
8834
8880
|
oauth_token?: string;
|
|
@@ -8857,7 +8903,7 @@ declare namespace gapi.client {
|
|
|
8857
8903
|
fields?: string;
|
|
8858
8904
|
/** 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. */
|
|
8859
8905
|
key?: string;
|
|
8860
|
-
/** Required. The resource name of the engine to tune. Format: `projects/{
|
|
8906
|
+
/** Required. The resource name of the engine to tune. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` */
|
|
8861
8907
|
name: string;
|
|
8862
8908
|
/** OAuth 2.0 token for the current user. */
|
|
8863
8909
|
oauth_token?: string;
|
|
@@ -8886,7 +8932,7 @@ declare namespace gapi.client {
|
|
|
8886
8932
|
fields?: string;
|
|
8887
8933
|
/** 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. */
|
|
8888
8934
|
key?: string;
|
|
8889
|
-
/** Required. The resource name of the engine to tune. Format: `projects/{
|
|
8935
|
+
/** Required. The resource name of the engine to tune. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` */
|
|
8890
8936
|
name: string;
|
|
8891
8937
|
/** OAuth 2.0 token for the current user. */
|
|
8892
8938
|
oauth_token?: string;
|
|
@@ -9598,7 +9644,7 @@ declare namespace gapi.client {
|
|
|
9598
9644
|
key?: string;
|
|
9599
9645
|
/** OAuth 2.0 token for the current user. */
|
|
9600
9646
|
oauth_token?: string;
|
|
9601
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
9647
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. */
|
|
9602
9648
|
parent: string;
|
|
9603
9649
|
/** Returns response with indentations and line breaks. */
|
|
9604
9650
|
prettyPrint?: boolean;
|
|
@@ -9629,7 +9675,7 @@ declare namespace gapi.client {
|
|
|
9629
9675
|
key?: string;
|
|
9630
9676
|
/** OAuth 2.0 token for the current user. */
|
|
9631
9677
|
oauth_token?: string;
|
|
9632
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
9678
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. */
|
|
9633
9679
|
parent: string;
|
|
9634
9680
|
/** Returns response with indentations and line breaks. */
|
|
9635
9681
|
prettyPrint?: boolean;
|
|
@@ -9656,7 +9702,7 @@ declare namespace gapi.client {
|
|
|
9656
9702
|
fields?: string;
|
|
9657
9703
|
/** 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. */
|
|
9658
9704
|
key?: string;
|
|
9659
|
-
/** Required. The resource name of the Control to delete. Format: `projects/{
|
|
9705
|
+
/** Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
9660
9706
|
name: string;
|
|
9661
9707
|
/** OAuth 2.0 token for the current user. */
|
|
9662
9708
|
oauth_token?: string;
|
|
@@ -9683,7 +9729,7 @@ declare namespace gapi.client {
|
|
|
9683
9729
|
fields?: string;
|
|
9684
9730
|
/** 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. */
|
|
9685
9731
|
key?: string;
|
|
9686
|
-
/** Required. The resource name of the Control to get. Format: `projects/{
|
|
9732
|
+
/** Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
9687
9733
|
name: string;
|
|
9688
9734
|
/** OAuth 2.0 token for the current user. */
|
|
9689
9735
|
oauth_token?: string;
|
|
@@ -9718,7 +9764,7 @@ declare namespace gapi.client {
|
|
|
9718
9764
|
pageSize?: number;
|
|
9719
9765
|
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
9720
9766
|
pageToken?: string;
|
|
9721
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
9767
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. */
|
|
9722
9768
|
parent: string;
|
|
9723
9769
|
/** Returns response with indentations and line breaks. */
|
|
9724
9770
|
prettyPrint?: boolean;
|
|
@@ -9807,7 +9853,7 @@ declare namespace gapi.client {
|
|
|
9807
9853
|
fields?: string;
|
|
9808
9854
|
/** 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. */
|
|
9809
9855
|
key?: string;
|
|
9810
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
9856
|
+
/** Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
|
|
9811
9857
|
name: string;
|
|
9812
9858
|
/** OAuth 2.0 token for the current user. */
|
|
9813
9859
|
oauth_token?: string;
|
|
@@ -9836,7 +9882,7 @@ declare namespace gapi.client {
|
|
|
9836
9882
|
fields?: string;
|
|
9837
9883
|
/** 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. */
|
|
9838
9884
|
key?: string;
|
|
9839
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
9885
|
+
/** Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
|
|
9840
9886
|
name: string;
|
|
9841
9887
|
/** OAuth 2.0 token for the current user. */
|
|
9842
9888
|
oauth_token?: string;
|
|
@@ -9867,7 +9913,7 @@ declare namespace gapi.client {
|
|
|
9867
9913
|
key?: string;
|
|
9868
9914
|
/** OAuth 2.0 token for the current user. */
|
|
9869
9915
|
oauth_token?: string;
|
|
9870
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
9916
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
9871
9917
|
parent: string;
|
|
9872
9918
|
/** Returns response with indentations and line breaks. */
|
|
9873
9919
|
prettyPrint?: boolean;
|
|
@@ -9896,7 +9942,7 @@ declare namespace gapi.client {
|
|
|
9896
9942
|
key?: string;
|
|
9897
9943
|
/** OAuth 2.0 token for the current user. */
|
|
9898
9944
|
oauth_token?: string;
|
|
9899
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
9945
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
9900
9946
|
parent: string;
|
|
9901
9947
|
/** Returns response with indentations and line breaks. */
|
|
9902
9948
|
prettyPrint?: boolean;
|
|
@@ -9923,7 +9969,7 @@ declare namespace gapi.client {
|
|
|
9923
9969
|
fields?: string;
|
|
9924
9970
|
/** 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. */
|
|
9925
9971
|
key?: string;
|
|
9926
|
-
/** Required. The resource name of the Conversation to delete. Format: `projects/{
|
|
9972
|
+
/** Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
|
|
9927
9973
|
name: string;
|
|
9928
9974
|
/** OAuth 2.0 token for the current user. */
|
|
9929
9975
|
oauth_token?: string;
|
|
@@ -9950,7 +9996,7 @@ declare namespace gapi.client {
|
|
|
9950
9996
|
fields?: string;
|
|
9951
9997
|
/** 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. */
|
|
9952
9998
|
key?: string;
|
|
9953
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
9999
|
+
/** Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
|
|
9954
10000
|
name: string;
|
|
9955
10001
|
/** OAuth 2.0 token for the current user. */
|
|
9956
10002
|
oauth_token?: string;
|
|
@@ -9987,7 +10033,7 @@ declare namespace gapi.client {
|
|
|
9987
10033
|
pageSize?: number;
|
|
9988
10034
|
/** A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */
|
|
9989
10035
|
pageToken?: string;
|
|
9990
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
10036
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
9991
10037
|
parent: string;
|
|
9992
10038
|
/** Returns response with indentations and line breaks. */
|
|
9993
10039
|
prettyPrint?: boolean;
|
|
@@ -10472,7 +10518,7 @@ declare namespace gapi.client {
|
|
|
10472
10518
|
fields?: string;
|
|
10473
10519
|
/** 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. */
|
|
10474
10520
|
key?: string;
|
|
10475
|
-
/** Required. The resource name of the ServingConfig to get. Format: `projects/{
|
|
10521
|
+
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
10476
10522
|
name: string;
|
|
10477
10523
|
/** OAuth 2.0 token for the current user. */
|
|
10478
10524
|
oauth_token?: string;
|
|
@@ -10505,7 +10551,7 @@ declare namespace gapi.client {
|
|
|
10505
10551
|
pageSize?: number;
|
|
10506
10552
|
/** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
|
|
10507
10553
|
pageToken?: string;
|
|
10508
|
-
/** Required. Full resource name of the parent resource. Format: `projects/{
|
|
10554
|
+
/** Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
10509
10555
|
parent: string;
|
|
10510
10556
|
/** Returns response with indentations and line breaks. */
|
|
10511
10557
|
prettyPrint?: boolean;
|
|
@@ -10710,7 +10756,7 @@ declare namespace gapi.client {
|
|
|
10710
10756
|
fields?: string;
|
|
10711
10757
|
/** 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. */
|
|
10712
10758
|
key?: string;
|
|
10713
|
-
/** Required. The resource name of the Answer to get. Format: `projects/{
|
|
10759
|
+
/** Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` */
|
|
10714
10760
|
name: string;
|
|
10715
10761
|
/** OAuth 2.0 token for the current user. */
|
|
10716
10762
|
oauth_token?: string;
|
|
@@ -10741,7 +10787,7 @@ declare namespace gapi.client {
|
|
|
10741
10787
|
key?: string;
|
|
10742
10788
|
/** OAuth 2.0 token for the current user. */
|
|
10743
10789
|
oauth_token?: string;
|
|
10744
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
10790
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
10745
10791
|
parent: string;
|
|
10746
10792
|
/** Returns response with indentations and line breaks. */
|
|
10747
10793
|
prettyPrint?: boolean;
|
|
@@ -10770,7 +10816,7 @@ declare namespace gapi.client {
|
|
|
10770
10816
|
key?: string;
|
|
10771
10817
|
/** OAuth 2.0 token for the current user. */
|
|
10772
10818
|
oauth_token?: string;
|
|
10773
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
10819
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
10774
10820
|
parent: string;
|
|
10775
10821
|
/** Returns response with indentations and line breaks. */
|
|
10776
10822
|
prettyPrint?: boolean;
|
|
@@ -10797,7 +10843,7 @@ declare namespace gapi.client {
|
|
|
10797
10843
|
fields?: string;
|
|
10798
10844
|
/** 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. */
|
|
10799
10845
|
key?: string;
|
|
10800
|
-
/** Required. The resource name of the Session to delete. Format: `projects/{
|
|
10846
|
+
/** Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
10801
10847
|
name: string;
|
|
10802
10848
|
/** OAuth 2.0 token for the current user. */
|
|
10803
10849
|
oauth_token?: string;
|
|
@@ -10824,7 +10870,7 @@ declare namespace gapi.client {
|
|
|
10824
10870
|
fields?: string;
|
|
10825
10871
|
/** 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. */
|
|
10826
10872
|
key?: string;
|
|
10827
|
-
/** Required. The resource name of the Session to get. Format: `projects/{
|
|
10873
|
+
/** Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
10828
10874
|
name: string;
|
|
10829
10875
|
/** OAuth 2.0 token for the current user. */
|
|
10830
10876
|
oauth_token?: string;
|
|
@@ -10861,7 +10907,7 @@ declare namespace gapi.client {
|
|
|
10861
10907
|
pageSize?: number;
|
|
10862
10908
|
/** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
|
|
10863
10909
|
pageToken?: string;
|
|
10864
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
10910
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
10865
10911
|
parent: string;
|
|
10866
10912
|
/** Returns response with indentations and line breaks. */
|
|
10867
10913
|
prettyPrint?: boolean;
|
|
@@ -11600,7 +11646,7 @@ declare namespace gapi.client {
|
|
|
11600
11646
|
key?: string;
|
|
11601
11647
|
/** OAuth 2.0 token for the current user. */
|
|
11602
11648
|
oauth_token?: string;
|
|
11603
|
-
/** Required. The resource name of the catalog under which the events are created. The format is `projects
|
|
11649
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`. */
|
|
11604
11650
|
parent: string;
|
|
11605
11651
|
/** Returns response with indentations and line breaks. */
|
|
11606
11652
|
prettyPrint?: boolean;
|
|
@@ -11629,7 +11675,7 @@ declare namespace gapi.client {
|
|
|
11629
11675
|
key?: string;
|
|
11630
11676
|
/** OAuth 2.0 token for the current user. */
|
|
11631
11677
|
oauth_token?: string;
|
|
11632
|
-
/** Required. The resource name of the catalog under which the events are created. The format is `projects
|
|
11678
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`. */
|
|
11633
11679
|
parent: string;
|
|
11634
11680
|
/** Returns response with indentations and line breaks. */
|
|
11635
11681
|
prettyPrint?: boolean;
|
|
@@ -12322,7 +12368,7 @@ declare namespace gapi.client {
|
|
|
12322
12368
|
prettyPrint?: boolean;
|
|
12323
12369
|
/** 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. */
|
|
12324
12370
|
quotaUser?: string;
|
|
12325
|
-
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{
|
|
12371
|
+
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`. */
|
|
12326
12372
|
rankingConfig: string;
|
|
12327
12373
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12328
12374
|
upload_protocol?: string;
|
|
@@ -12351,7 +12397,7 @@ declare namespace gapi.client {
|
|
|
12351
12397
|
prettyPrint?: boolean;
|
|
12352
12398
|
/** 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. */
|
|
12353
12399
|
quotaUser?: string;
|
|
12354
|
-
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{
|
|
12400
|
+
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`. */
|
|
12355
12401
|
rankingConfig: string;
|
|
12356
12402
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12357
12403
|
upload_protocol?: string;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# TypeScript typings for Discovery Engine API v1beta
|
|
2
2
|
|
|
3
3
|
Discovery Engine API.
|
|
4
|
-
For detailed description please check [documentation](https://cloud.google.com/
|
|
4
|
+
For detailed description please check [documentation](https://cloud.google.com/generative-ai-app-builder/docs/).
|
|
5
5
|
|
|
6
6
|
## Installing
|
|
7
7
|
|