@maxim_mazurok/gapi.client.discoveryengine-v1 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 +151 -85
- 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 v1 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=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240906
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -231,7 +231,7 @@ declare namespace gapi.client {
|
|
|
231
231
|
document?: string;
|
|
232
232
|
/** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
|
|
233
233
|
snippetInfo?: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[];
|
|
234
|
-
/** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document
|
|
234
|
+
/** 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. . */
|
|
235
235
|
structData?: {[P in string]: any};
|
|
236
236
|
/** Title. */
|
|
237
237
|
title?: string;
|
|
@@ -368,7 +368,7 @@ declare namespace gapi.client {
|
|
|
368
368
|
modelState?: string;
|
|
369
369
|
/** The version of the model. */
|
|
370
370
|
modelVersion?: string;
|
|
371
|
-
/** Required. The fully qualified resource name of the model. Format: `projects/{
|
|
371
|
+
/** 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. */
|
|
372
372
|
name?: string;
|
|
373
373
|
/** Timestamp the model training was initiated. */
|
|
374
374
|
trainingStartTime?: string;
|
|
@@ -394,6 +394,10 @@ declare namespace gapi.client {
|
|
|
394
394
|
languageInfo?: GoogleCloudDiscoveryengineV1alphaLanguageInfo;
|
|
395
395
|
/** 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. */
|
|
396
396
|
name?: string;
|
|
397
|
+
/** Optional. Configuration for Natural Language Query Understanding. */
|
|
398
|
+
naturalLanguageQueryUnderstandingConfig?: GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig;
|
|
399
|
+
/** Optional. Stores serving config at DataStore level. */
|
|
400
|
+
servingConfigDataStore?: GoogleCloudDiscoveryengineV1alphaServingConfigDataStore;
|
|
397
401
|
/** 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. */
|
|
398
402
|
solutionTypes?: string[];
|
|
399
403
|
/** 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). */
|
|
@@ -439,7 +443,7 @@ declare namespace gapi.client {
|
|
|
439
443
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
440
444
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
441
445
|
name?: string;
|
|
442
|
-
/** 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. */
|
|
446
|
+
/** 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. */
|
|
443
447
|
parsingConfigOverrides?: {
|
|
444
448
|
[P in string]: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
445
449
|
};
|
|
@@ -494,7 +498,7 @@ declare namespace gapi.client {
|
|
|
494
498
|
industryVertical?: string;
|
|
495
499
|
/** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
|
|
496
500
|
mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
|
|
497
|
-
/** 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/{
|
|
501
|
+
/** 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. */
|
|
498
502
|
name?: string;
|
|
499
503
|
/** Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. */
|
|
500
504
|
recommendationMetadata?: GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata;
|
|
@@ -754,10 +758,14 @@ declare namespace gapi.client {
|
|
|
754
758
|
/** List of custom tuning models. */
|
|
755
759
|
models?: GoogleCloudDiscoveryengineV1alphaCustomTuningModel[];
|
|
756
760
|
}
|
|
761
|
+
interface GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig {
|
|
762
|
+
/** Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. */
|
|
763
|
+
mode?: string;
|
|
764
|
+
}
|
|
757
765
|
interface GoogleCloudDiscoveryengineV1alphaProject {
|
|
758
766
|
/** Output only. The timestamp when this project is created. */
|
|
759
767
|
createTime?: string;
|
|
760
|
-
/** Output only. Full resource name of the project, for example `projects/{
|
|
768
|
+
/** 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. */
|
|
761
769
|
name?: string;
|
|
762
770
|
/** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
|
|
763
771
|
provisionCompletionTime?: string;
|
|
@@ -1040,6 +1048,8 @@ declare namespace gapi.client {
|
|
|
1040
1048
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec {
|
|
1041
1049
|
/** 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. */
|
|
1042
1050
|
ignoreAdversarialQuery?: boolean;
|
|
1051
|
+
/** 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. */
|
|
1052
|
+
ignoreJailBreakingQuery?: boolean;
|
|
1043
1053
|
/** 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. */
|
|
1044
1054
|
ignoreLowRelevantContent?: boolean;
|
|
1045
1055
|
/** 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. */
|
|
@@ -1135,6 +1145,10 @@ declare namespace gapi.client {
|
|
|
1135
1145
|
/** The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */
|
|
1136
1146
|
mode?: string;
|
|
1137
1147
|
}
|
|
1148
|
+
interface GoogleCloudDiscoveryengineV1alphaServingConfigDataStore {
|
|
1149
|
+
/** If set true, the DataStore will not be available for serving search requests. */
|
|
1150
|
+
disabledForServing?: boolean;
|
|
1151
|
+
}
|
|
1138
1152
|
interface GoogleCloudDiscoveryengineV1alphaSession {
|
|
1139
1153
|
/** Output only. The time the session finished. */
|
|
1140
1154
|
endTime?: string;
|
|
@@ -1217,7 +1231,7 @@ declare namespace gapi.client {
|
|
|
1217
1231
|
modelStatus?: string;
|
|
1218
1232
|
}
|
|
1219
1233
|
interface GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata {
|
|
1220
|
-
/** Required. The resource name of the engine that this tune applies to. Format: `projects/{
|
|
1234
|
+
/** Required. The resource name of the engine that this tune applies to. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` */
|
|
1221
1235
|
engine?: string;
|
|
1222
1236
|
}
|
|
1223
1237
|
interface GoogleCloudDiscoveryengineV1alphaTuneEngineResponse {}
|
|
@@ -1284,7 +1298,7 @@ declare namespace gapi.client {
|
|
|
1284
1298
|
interface GoogleCloudDiscoveryengineV1AnswerQueryRequest {
|
|
1285
1299
|
/** Answer generation specification. */
|
|
1286
1300
|
answerGenerationSpec?: GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec;
|
|
1287
|
-
/** 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. */
|
|
1301
|
+
/** 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. */
|
|
1288
1302
|
asynchronousMode?: boolean;
|
|
1289
1303
|
/** Required. Current user query. */
|
|
1290
1304
|
query?: GoogleCloudDiscoveryengineV1Query;
|
|
@@ -1308,6 +1322,8 @@ declare namespace gapi.client {
|
|
|
1308
1322
|
answerLanguageCode?: string;
|
|
1309
1323
|
/** 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. */
|
|
1310
1324
|
ignoreAdversarialQuery?: boolean;
|
|
1325
|
+
/** 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. */
|
|
1326
|
+
ignoreJailBreakingQuery?: boolean;
|
|
1311
1327
|
/** 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. */
|
|
1312
1328
|
ignoreLowRelevantContent?: boolean;
|
|
1313
1329
|
/** 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. */
|
|
@@ -1386,6 +1402,14 @@ declare namespace gapi.client {
|
|
|
1386
1402
|
chunk?: string;
|
|
1387
1403
|
/** Chunk textual content. */
|
|
1388
1404
|
content?: string;
|
|
1405
|
+
/** Metadata of the document from the current chunk. */
|
|
1406
|
+
documentMetadata?: GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata;
|
|
1407
|
+
}
|
|
1408
|
+
interface GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata {
|
|
1409
|
+
/** Title of the document. */
|
|
1410
|
+
title?: string;
|
|
1411
|
+
/** Uri of the document. */
|
|
1412
|
+
uri?: string;
|
|
1389
1413
|
}
|
|
1390
1414
|
interface GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo {
|
|
1391
1415
|
/** Document resource name. */
|
|
@@ -1520,7 +1544,7 @@ declare namespace gapi.client {
|
|
|
1520
1544
|
document?: string;
|
|
1521
1545
|
/** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
|
|
1522
1546
|
snippetInfo?: GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo[];
|
|
1523
|
-
/** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document
|
|
1547
|
+
/** 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. . */
|
|
1524
1548
|
structData?: {[P in string]: any};
|
|
1525
1549
|
/** Title. */
|
|
1526
1550
|
title?: string;
|
|
@@ -1570,8 +1594,8 @@ declare namespace gapi.client {
|
|
|
1570
1594
|
lastRefreshedTime?: string;
|
|
1571
1595
|
/** The value of the matcher that was used to match the Document. */
|
|
1572
1596
|
matcherValue?: GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue;
|
|
1573
|
-
/** The
|
|
1574
|
-
|
|
1597
|
+
/** The state of the document. */
|
|
1598
|
+
state?: string;
|
|
1575
1599
|
}
|
|
1576
1600
|
interface GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue {
|
|
1577
1601
|
/** Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} */
|
|
@@ -1688,7 +1712,7 @@ declare namespace gapi.client {
|
|
|
1688
1712
|
modelState?: string;
|
|
1689
1713
|
/** The version of the model. */
|
|
1690
1714
|
modelVersion?: string;
|
|
1691
|
-
/** Required. The fully qualified resource name of the model. Format: `projects/{
|
|
1715
|
+
/** 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. */
|
|
1692
1716
|
name?: string;
|
|
1693
1717
|
/** Timestamp the model training was initiated. */
|
|
1694
1718
|
trainingStartTime?: string;
|
|
@@ -1710,6 +1734,10 @@ declare namespace gapi.client {
|
|
|
1710
1734
|
languageInfo?: GoogleCloudDiscoveryengineV1betaLanguageInfo;
|
|
1711
1735
|
/** 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. */
|
|
1712
1736
|
name?: string;
|
|
1737
|
+
/** Optional. Configuration for Natural Language Query Understanding. */
|
|
1738
|
+
naturalLanguageQueryUnderstandingConfig?: GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig;
|
|
1739
|
+
/** Optional. Stores serving config at DataStore level. */
|
|
1740
|
+
servingConfigDataStore?: GoogleCloudDiscoveryengineV1betaServingConfigDataStore;
|
|
1713
1741
|
/** 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. */
|
|
1714
1742
|
solutionTypes?: string[];
|
|
1715
1743
|
/** 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). */
|
|
@@ -1755,7 +1783,7 @@ declare namespace gapi.client {
|
|
|
1755
1783
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
1756
1784
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
1757
1785
|
name?: string;
|
|
1758
|
-
/** 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. */
|
|
1786
|
+
/** 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. */
|
|
1759
1787
|
parsingConfigOverrides?: {
|
|
1760
1788
|
[P in string]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
1761
1789
|
};
|
|
@@ -1808,7 +1836,7 @@ declare namespace gapi.client {
|
|
|
1808
1836
|
displayName?: string;
|
|
1809
1837
|
/** 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. */
|
|
1810
1838
|
industryVertical?: string;
|
|
1811
|
-
/** 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/{
|
|
1839
|
+
/** 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. */
|
|
1812
1840
|
name?: string;
|
|
1813
1841
|
/** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
1814
1842
|
searchEngineConfig?: GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig;
|
|
@@ -1989,10 +2017,14 @@ declare namespace gapi.client {
|
|
|
1989
2017
|
/** List of custom tuning models. */
|
|
1990
2018
|
models?: GoogleCloudDiscoveryengineV1betaCustomTuningModel[];
|
|
1991
2019
|
}
|
|
2020
|
+
interface GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig {
|
|
2021
|
+
/** Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. */
|
|
2022
|
+
mode?: string;
|
|
2023
|
+
}
|
|
1992
2024
|
interface GoogleCloudDiscoveryengineV1betaProject {
|
|
1993
2025
|
/** Output only. The timestamp when this project is created. */
|
|
1994
2026
|
createTime?: string;
|
|
1995
|
-
/** Output only. Full resource name of the project, for example `projects/{
|
|
2027
|
+
/** 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. */
|
|
1996
2028
|
name?: string;
|
|
1997
2029
|
/** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
|
|
1998
2030
|
provisionCompletionTime?: string;
|
|
@@ -2205,6 +2237,8 @@ declare namespace gapi.client {
|
|
|
2205
2237
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec {
|
|
2206
2238
|
/** 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. */
|
|
2207
2239
|
ignoreAdversarialQuery?: boolean;
|
|
2240
|
+
/** 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. */
|
|
2241
|
+
ignoreJailBreakingQuery?: boolean;
|
|
2208
2242
|
/** 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. */
|
|
2209
2243
|
ignoreLowRelevantContent?: boolean;
|
|
2210
2244
|
/** 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. */
|
|
@@ -2300,6 +2334,10 @@ declare namespace gapi.client {
|
|
|
2300
2334
|
/** The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */
|
|
2301
2335
|
mode?: string;
|
|
2302
2336
|
}
|
|
2337
|
+
interface GoogleCloudDiscoveryengineV1betaServingConfigDataStore {
|
|
2338
|
+
/** If set true, the DataStore will not be available for serving search requests. */
|
|
2339
|
+
disabledForServing?: boolean;
|
|
2340
|
+
}
|
|
2303
2341
|
interface GoogleCloudDiscoveryengineV1betaSiteVerificationInfo {
|
|
2304
2342
|
/** Site verification state indicating the ownership and validity. */
|
|
2305
2343
|
siteVerificationState?: string;
|
|
@@ -2355,7 +2393,7 @@ declare namespace gapi.client {
|
|
|
2355
2393
|
modelStatus?: string;
|
|
2356
2394
|
}
|
|
2357
2395
|
interface GoogleCloudDiscoveryengineV1betaTuneEngineMetadata {
|
|
2358
|
-
/** Required. The resource name of the engine that this tune applies to. Format: `projects/{
|
|
2396
|
+
/** Required. The resource name of the engine that this tune applies to. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` */
|
|
2359
2397
|
engine?: string;
|
|
2360
2398
|
}
|
|
2361
2399
|
interface GoogleCloudDiscoveryengineV1betaTuneEngineResponse {}
|
|
@@ -2656,7 +2694,7 @@ declare namespace gapi.client {
|
|
|
2656
2694
|
query?: GoogleCloudDiscoveryengineV1TextInput;
|
|
2657
2695
|
/** Whether to turn on safe search. */
|
|
2658
2696
|
safeSearch?: boolean;
|
|
2659
|
-
/** The resource name of the Serving Config to use. Format: `projects/{
|
|
2697
|
+
/** 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. */
|
|
2660
2698
|
servingConfig?: string;
|
|
2661
2699
|
/** A specification for configuring the summary returned in the response. */
|
|
2662
2700
|
summarySpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec;
|
|
@@ -2718,7 +2756,7 @@ declare namespace gapi.client {
|
|
|
2718
2756
|
modelState?: string;
|
|
2719
2757
|
/** The version of the model. */
|
|
2720
2758
|
modelVersion?: string;
|
|
2721
|
-
/** Required. The fully qualified resource name of the model. Format: `projects/{
|
|
2759
|
+
/** 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. */
|
|
2722
2760
|
name?: string;
|
|
2723
2761
|
/** Timestamp the model training was initiated. */
|
|
2724
2762
|
trainingStartTime?: string;
|
|
@@ -2738,6 +2776,8 @@ declare namespace gapi.client {
|
|
|
2738
2776
|
industryVertical?: string;
|
|
2739
2777
|
/** 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. */
|
|
2740
2778
|
name?: string;
|
|
2779
|
+
/** Optional. Stores serving config at DataStore level. */
|
|
2780
|
+
servingConfigDataStore?: GoogleCloudDiscoveryengineV1ServingConfigDataStore;
|
|
2741
2781
|
/** 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. */
|
|
2742
2782
|
solutionTypes?: string[];
|
|
2743
2783
|
/** 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). */
|
|
@@ -2818,7 +2858,7 @@ declare namespace gapi.client {
|
|
|
2818
2858
|
id?: string;
|
|
2819
2859
|
/** Output only. Whether the referenced Document can be found in the data store. */
|
|
2820
2860
|
joined?: boolean;
|
|
2821
|
-
/** The Document resource full name, of the form: `projects/{
|
|
2861
|
+
/** 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}` */
|
|
2822
2862
|
name?: string;
|
|
2823
2863
|
/** The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID. */
|
|
2824
2864
|
promotionIds?: string[];
|
|
@@ -2834,7 +2874,7 @@ declare namespace gapi.client {
|
|
|
2834
2874
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
2835
2875
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
2836
2876
|
name?: string;
|
|
2837
|
-
/** 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. */
|
|
2877
|
+
/** 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. */
|
|
2838
2878
|
parsingConfigOverrides?: {
|
|
2839
2879
|
[P in string]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
2840
2880
|
};
|
|
@@ -2888,7 +2928,7 @@ declare namespace gapi.client {
|
|
|
2888
2928
|
displayName?: string;
|
|
2889
2929
|
/** 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. */
|
|
2890
2930
|
industryVertical?: string;
|
|
2891
|
-
/** 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/{
|
|
2931
|
+
/** 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. */
|
|
2892
2932
|
name?: string;
|
|
2893
2933
|
/** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
2894
2934
|
searchEngineConfig?: GoogleCloudDiscoveryengineV1EngineSearchEngineConfig;
|
|
@@ -3212,7 +3252,7 @@ declare namespace gapi.client {
|
|
|
3212
3252
|
interface GoogleCloudDiscoveryengineV1Project {
|
|
3213
3253
|
/** Output only. The timestamp when this project is created. */
|
|
3214
3254
|
createTime?: string;
|
|
3215
|
-
/** Output only. Full resource name of the project, for example `projects/{
|
|
3255
|
+
/** 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. */
|
|
3216
3256
|
name?: string;
|
|
3217
3257
|
/** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
|
|
3218
3258
|
provisionCompletionTime?: string;
|
|
@@ -3377,6 +3417,8 @@ declare namespace gapi.client {
|
|
|
3377
3417
|
metadata?: {[P in string]: any};
|
|
3378
3418
|
}
|
|
3379
3419
|
interface GoogleCloudDiscoveryengineV1RecrawlUrisRequest {
|
|
3420
|
+
/** Optional. Full resource name of the SiteCredential, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`. Only set to crawl private URIs. */
|
|
3421
|
+
siteCredential?: string;
|
|
3380
3422
|
/** 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`. */
|
|
3381
3423
|
uris?: string[];
|
|
3382
3424
|
}
|
|
@@ -3457,9 +3499,27 @@ declare namespace gapi.client {
|
|
|
3457
3499
|
interface GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpec {
|
|
3458
3500
|
/** 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. */
|
|
3459
3501
|
boost?: number;
|
|
3502
|
+
/** Complex specification for custom ranking based on customer defined attribute value. */
|
|
3503
|
+
boostControlSpec?: GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec;
|
|
3460
3504
|
/** 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"))` */
|
|
3461
3505
|
condition?: string;
|
|
3462
3506
|
}
|
|
3507
|
+
interface GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec {
|
|
3508
|
+
/** 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). */
|
|
3509
|
+
attributeType?: string;
|
|
3510
|
+
/** The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. */
|
|
3511
|
+
controlPoints?: GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint[];
|
|
3512
|
+
/** The name of the field whose value will be used to determine the boost amount. */
|
|
3513
|
+
fieldName?: string;
|
|
3514
|
+
/** The interpolation type to be applied to connect the control points listed below. */
|
|
3515
|
+
interpolationType?: string;
|
|
3516
|
+
}
|
|
3517
|
+
interface GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint {
|
|
3518
|
+
/** 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]`. */
|
|
3519
|
+
attributeValue?: string;
|
|
3520
|
+
/** The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. */
|
|
3521
|
+
boostAmount?: number;
|
|
3522
|
+
}
|
|
3463
3523
|
interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec {
|
|
3464
3524
|
/** Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */
|
|
3465
3525
|
chunkSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec;
|
|
@@ -3501,6 +3561,8 @@ declare namespace gapi.client {
|
|
|
3501
3561
|
interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec {
|
|
3502
3562
|
/** 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. */
|
|
3503
3563
|
ignoreAdversarialQuery?: boolean;
|
|
3564
|
+
/** 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. */
|
|
3565
|
+
ignoreJailBreakingQuery?: boolean;
|
|
3504
3566
|
/** 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. */
|
|
3505
3567
|
ignoreLowRelevantContent?: boolean;
|
|
3506
3568
|
/** 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. */
|
|
@@ -3694,6 +3756,10 @@ declare namespace gapi.client {
|
|
|
3694
3756
|
/** Summary text with no citation information. */
|
|
3695
3757
|
summary?: string;
|
|
3696
3758
|
}
|
|
3759
|
+
interface GoogleCloudDiscoveryengineV1ServingConfigDataStore {
|
|
3760
|
+
/** If set true, the DataStore will not be available for serving search requests. */
|
|
3761
|
+
disabledForServing?: boolean;
|
|
3762
|
+
}
|
|
3697
3763
|
interface GoogleCloudDiscoveryengineV1Session {
|
|
3698
3764
|
/** Output only. The time the session finished. */
|
|
3699
3765
|
endTime?: string;
|
|
@@ -4620,7 +4686,7 @@ declare namespace gapi.client {
|
|
|
4620
4686
|
key?: string;
|
|
4621
4687
|
/** OAuth 2.0 token for the current user. */
|
|
4622
4688
|
oauth_token?: string;
|
|
4623
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
4689
|
+
/** 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}`. */
|
|
4624
4690
|
parent: string;
|
|
4625
4691
|
/** Returns response with indentations and line breaks. */
|
|
4626
4692
|
prettyPrint?: boolean;
|
|
@@ -4651,7 +4717,7 @@ declare namespace gapi.client {
|
|
|
4651
4717
|
key?: string;
|
|
4652
4718
|
/** OAuth 2.0 token for the current user. */
|
|
4653
4719
|
oauth_token?: string;
|
|
4654
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
4720
|
+
/** 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}`. */
|
|
4655
4721
|
parent: string;
|
|
4656
4722
|
/** Returns response with indentations and line breaks. */
|
|
4657
4723
|
prettyPrint?: boolean;
|
|
@@ -4678,7 +4744,7 @@ declare namespace gapi.client {
|
|
|
4678
4744
|
fields?: string;
|
|
4679
4745
|
/** 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. */
|
|
4680
4746
|
key?: string;
|
|
4681
|
-
/** Required. The resource name of the Control to delete. Format: `projects/{
|
|
4747
|
+
/** Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
4682
4748
|
name: string;
|
|
4683
4749
|
/** OAuth 2.0 token for the current user. */
|
|
4684
4750
|
oauth_token?: string;
|
|
@@ -4705,7 +4771,7 @@ declare namespace gapi.client {
|
|
|
4705
4771
|
fields?: string;
|
|
4706
4772
|
/** 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. */
|
|
4707
4773
|
key?: string;
|
|
4708
|
-
/** Required. The resource name of the Control to get. Format: `projects/{
|
|
4774
|
+
/** Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
4709
4775
|
name: string;
|
|
4710
4776
|
/** OAuth 2.0 token for the current user. */
|
|
4711
4777
|
oauth_token?: string;
|
|
@@ -4740,7 +4806,7 @@ declare namespace gapi.client {
|
|
|
4740
4806
|
pageSize?: number;
|
|
4741
4807
|
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
4742
4808
|
pageToken?: string;
|
|
4743
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
4809
|
+
/** 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}`. */
|
|
4744
4810
|
parent: string;
|
|
4745
4811
|
/** Returns response with indentations and line breaks. */
|
|
4746
4812
|
prettyPrint?: boolean;
|
|
@@ -4829,7 +4895,7 @@ declare namespace gapi.client {
|
|
|
4829
4895
|
fields?: string;
|
|
4830
4896
|
/** 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. */
|
|
4831
4897
|
key?: string;
|
|
4832
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
4898
|
+
/** 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. */
|
|
4833
4899
|
name: string;
|
|
4834
4900
|
/** OAuth 2.0 token for the current user. */
|
|
4835
4901
|
oauth_token?: string;
|
|
@@ -4858,7 +4924,7 @@ declare namespace gapi.client {
|
|
|
4858
4924
|
fields?: string;
|
|
4859
4925
|
/** 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. */
|
|
4860
4926
|
key?: string;
|
|
4861
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
4927
|
+
/** 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. */
|
|
4862
4928
|
name: string;
|
|
4863
4929
|
/** OAuth 2.0 token for the current user. */
|
|
4864
4930
|
oauth_token?: string;
|
|
@@ -4889,7 +4955,7 @@ declare namespace gapi.client {
|
|
|
4889
4955
|
key?: string;
|
|
4890
4956
|
/** OAuth 2.0 token for the current user. */
|
|
4891
4957
|
oauth_token?: string;
|
|
4892
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
4958
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
4893
4959
|
parent: string;
|
|
4894
4960
|
/** Returns response with indentations and line breaks. */
|
|
4895
4961
|
prettyPrint?: boolean;
|
|
@@ -4918,7 +4984,7 @@ declare namespace gapi.client {
|
|
|
4918
4984
|
key?: string;
|
|
4919
4985
|
/** OAuth 2.0 token for the current user. */
|
|
4920
4986
|
oauth_token?: string;
|
|
4921
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
4987
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
4922
4988
|
parent: string;
|
|
4923
4989
|
/** Returns response with indentations and line breaks. */
|
|
4924
4990
|
prettyPrint?: boolean;
|
|
@@ -4945,7 +5011,7 @@ declare namespace gapi.client {
|
|
|
4945
5011
|
fields?: string;
|
|
4946
5012
|
/** 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. */
|
|
4947
5013
|
key?: string;
|
|
4948
|
-
/** Required. The resource name of the Conversation to delete. Format: `projects/{
|
|
5014
|
+
/** Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
|
|
4949
5015
|
name: string;
|
|
4950
5016
|
/** OAuth 2.0 token for the current user. */
|
|
4951
5017
|
oauth_token?: string;
|
|
@@ -4972,7 +5038,7 @@ declare namespace gapi.client {
|
|
|
4972
5038
|
fields?: string;
|
|
4973
5039
|
/** 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. */
|
|
4974
5040
|
key?: string;
|
|
4975
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
5041
|
+
/** Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
|
|
4976
5042
|
name: string;
|
|
4977
5043
|
/** OAuth 2.0 token for the current user. */
|
|
4978
5044
|
oauth_token?: string;
|
|
@@ -5009,7 +5075,7 @@ declare namespace gapi.client {
|
|
|
5009
5075
|
pageSize?: number;
|
|
5010
5076
|
/** A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */
|
|
5011
5077
|
pageToken?: string;
|
|
5012
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
5078
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
5013
5079
|
parent: string;
|
|
5014
5080
|
/** Returns response with indentations and line breaks. */
|
|
5015
5081
|
prettyPrint?: boolean;
|
|
@@ -5704,7 +5770,7 @@ declare namespace gapi.client {
|
|
|
5704
5770
|
fields?: string;
|
|
5705
5771
|
/** 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. */
|
|
5706
5772
|
key?: string;
|
|
5707
|
-
/** Required. The resource name of the Answer to get. Format: `projects/{
|
|
5773
|
+
/** 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}` */
|
|
5708
5774
|
name: string;
|
|
5709
5775
|
/** OAuth 2.0 token for the current user. */
|
|
5710
5776
|
oauth_token?: string;
|
|
@@ -5735,7 +5801,7 @@ declare namespace gapi.client {
|
|
|
5735
5801
|
key?: string;
|
|
5736
5802
|
/** OAuth 2.0 token for the current user. */
|
|
5737
5803
|
oauth_token?: string;
|
|
5738
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
5804
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
5739
5805
|
parent: string;
|
|
5740
5806
|
/** Returns response with indentations and line breaks. */
|
|
5741
5807
|
prettyPrint?: boolean;
|
|
@@ -5764,7 +5830,7 @@ declare namespace gapi.client {
|
|
|
5764
5830
|
key?: string;
|
|
5765
5831
|
/** OAuth 2.0 token for the current user. */
|
|
5766
5832
|
oauth_token?: string;
|
|
5767
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
5833
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
5768
5834
|
parent: string;
|
|
5769
5835
|
/** Returns response with indentations and line breaks. */
|
|
5770
5836
|
prettyPrint?: boolean;
|
|
@@ -5791,7 +5857,7 @@ declare namespace gapi.client {
|
|
|
5791
5857
|
fields?: string;
|
|
5792
5858
|
/** 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. */
|
|
5793
5859
|
key?: string;
|
|
5794
|
-
/** Required. The resource name of the Session to delete. Format: `projects/{
|
|
5860
|
+
/** Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
5795
5861
|
name: string;
|
|
5796
5862
|
/** OAuth 2.0 token for the current user. */
|
|
5797
5863
|
oauth_token?: string;
|
|
@@ -5818,7 +5884,7 @@ declare namespace gapi.client {
|
|
|
5818
5884
|
fields?: string;
|
|
5819
5885
|
/** 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. */
|
|
5820
5886
|
key?: string;
|
|
5821
|
-
/** Required. The resource name of the Session to get. Format: `projects/{
|
|
5887
|
+
/** Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
5822
5888
|
name: string;
|
|
5823
5889
|
/** OAuth 2.0 token for the current user. */
|
|
5824
5890
|
oauth_token?: string;
|
|
@@ -5855,7 +5921,7 @@ declare namespace gapi.client {
|
|
|
5855
5921
|
pageSize?: number;
|
|
5856
5922
|
/** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
|
|
5857
5923
|
pageToken?: string;
|
|
5858
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
5924
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
5859
5925
|
parent: string;
|
|
5860
5926
|
/** Returns response with indentations and line breaks. */
|
|
5861
5927
|
prettyPrint?: boolean;
|
|
@@ -6809,7 +6875,7 @@ declare namespace gapi.client {
|
|
|
6809
6875
|
key?: string;
|
|
6810
6876
|
/** OAuth 2.0 token for the current user. */
|
|
6811
6877
|
oauth_token?: string;
|
|
6812
|
-
/** Required. The resource name of the catalog under which the events are created. The format is `projects
|
|
6878
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`. */
|
|
6813
6879
|
parent: string;
|
|
6814
6880
|
/** Returns response with indentations and line breaks. */
|
|
6815
6881
|
prettyPrint?: boolean;
|
|
@@ -6838,7 +6904,7 @@ declare namespace gapi.client {
|
|
|
6838
6904
|
key?: string;
|
|
6839
6905
|
/** OAuth 2.0 token for the current user. */
|
|
6840
6906
|
oauth_token?: string;
|
|
6841
|
-
/** Required. The resource name of the catalog under which the events are created. The format is `projects
|
|
6907
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`. */
|
|
6842
6908
|
parent: string;
|
|
6843
6909
|
/** Returns response with indentations and line breaks. */
|
|
6844
6910
|
prettyPrint?: boolean;
|
|
@@ -7287,7 +7353,7 @@ declare namespace gapi.client {
|
|
|
7287
7353
|
key?: string;
|
|
7288
7354
|
/** OAuth 2.0 token for the current user. */
|
|
7289
7355
|
oauth_token?: string;
|
|
7290
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
7356
|
+
/** 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}`. */
|
|
7291
7357
|
parent: string;
|
|
7292
7358
|
/** Returns response with indentations and line breaks. */
|
|
7293
7359
|
prettyPrint?: boolean;
|
|
@@ -7318,7 +7384,7 @@ declare namespace gapi.client {
|
|
|
7318
7384
|
key?: string;
|
|
7319
7385
|
/** OAuth 2.0 token for the current user. */
|
|
7320
7386
|
oauth_token?: string;
|
|
7321
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
7387
|
+
/** 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}`. */
|
|
7322
7388
|
parent: string;
|
|
7323
7389
|
/** Returns response with indentations and line breaks. */
|
|
7324
7390
|
prettyPrint?: boolean;
|
|
@@ -7345,7 +7411,7 @@ declare namespace gapi.client {
|
|
|
7345
7411
|
fields?: string;
|
|
7346
7412
|
/** 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. */
|
|
7347
7413
|
key?: string;
|
|
7348
|
-
/** Required. The resource name of the Control to delete. Format: `projects/{
|
|
7414
|
+
/** Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
7349
7415
|
name: string;
|
|
7350
7416
|
/** OAuth 2.0 token for the current user. */
|
|
7351
7417
|
oauth_token?: string;
|
|
@@ -7372,7 +7438,7 @@ declare namespace gapi.client {
|
|
|
7372
7438
|
fields?: string;
|
|
7373
7439
|
/** 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. */
|
|
7374
7440
|
key?: string;
|
|
7375
|
-
/** Required. The resource name of the Control to get. Format: `projects/{
|
|
7441
|
+
/** Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
7376
7442
|
name: string;
|
|
7377
7443
|
/** OAuth 2.0 token for the current user. */
|
|
7378
7444
|
oauth_token?: string;
|
|
@@ -7407,7 +7473,7 @@ declare namespace gapi.client {
|
|
|
7407
7473
|
pageSize?: number;
|
|
7408
7474
|
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
7409
7475
|
pageToken?: string;
|
|
7410
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
7476
|
+
/** 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}`. */
|
|
7411
7477
|
parent: string;
|
|
7412
7478
|
/** Returns response with indentations and line breaks. */
|
|
7413
7479
|
prettyPrint?: boolean;
|
|
@@ -7496,7 +7562,7 @@ declare namespace gapi.client {
|
|
|
7496
7562
|
fields?: string;
|
|
7497
7563
|
/** 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. */
|
|
7498
7564
|
key?: string;
|
|
7499
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
7565
|
+
/** 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. */
|
|
7500
7566
|
name: string;
|
|
7501
7567
|
/** OAuth 2.0 token for the current user. */
|
|
7502
7568
|
oauth_token?: string;
|
|
@@ -7525,7 +7591,7 @@ declare namespace gapi.client {
|
|
|
7525
7591
|
fields?: string;
|
|
7526
7592
|
/** 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. */
|
|
7527
7593
|
key?: string;
|
|
7528
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
7594
|
+
/** 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. */
|
|
7529
7595
|
name: string;
|
|
7530
7596
|
/** OAuth 2.0 token for the current user. */
|
|
7531
7597
|
oauth_token?: string;
|
|
@@ -7556,7 +7622,7 @@ declare namespace gapi.client {
|
|
|
7556
7622
|
key?: string;
|
|
7557
7623
|
/** OAuth 2.0 token for the current user. */
|
|
7558
7624
|
oauth_token?: string;
|
|
7559
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
7625
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
7560
7626
|
parent: string;
|
|
7561
7627
|
/** Returns response with indentations and line breaks. */
|
|
7562
7628
|
prettyPrint?: boolean;
|
|
@@ -7585,7 +7651,7 @@ declare namespace gapi.client {
|
|
|
7585
7651
|
key?: string;
|
|
7586
7652
|
/** OAuth 2.0 token for the current user. */
|
|
7587
7653
|
oauth_token?: string;
|
|
7588
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
7654
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
7589
7655
|
parent: string;
|
|
7590
7656
|
/** Returns response with indentations and line breaks. */
|
|
7591
7657
|
prettyPrint?: boolean;
|
|
@@ -7612,7 +7678,7 @@ declare namespace gapi.client {
|
|
|
7612
7678
|
fields?: string;
|
|
7613
7679
|
/** 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. */
|
|
7614
7680
|
key?: string;
|
|
7615
|
-
/** Required. The resource name of the Conversation to delete. Format: `projects/{
|
|
7681
|
+
/** Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
|
|
7616
7682
|
name: string;
|
|
7617
7683
|
/** OAuth 2.0 token for the current user. */
|
|
7618
7684
|
oauth_token?: string;
|
|
@@ -7639,7 +7705,7 @@ declare namespace gapi.client {
|
|
|
7639
7705
|
fields?: string;
|
|
7640
7706
|
/** 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. */
|
|
7641
7707
|
key?: string;
|
|
7642
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
7708
|
+
/** Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
|
|
7643
7709
|
name: string;
|
|
7644
7710
|
/** OAuth 2.0 token for the current user. */
|
|
7645
7711
|
oauth_token?: string;
|
|
@@ -7676,7 +7742,7 @@ declare namespace gapi.client {
|
|
|
7676
7742
|
pageSize?: number;
|
|
7677
7743
|
/** A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */
|
|
7678
7744
|
pageToken?: string;
|
|
7679
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
7745
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
7680
7746
|
parent: string;
|
|
7681
7747
|
/** Returns response with indentations and line breaks. */
|
|
7682
7748
|
prettyPrint?: boolean;
|
|
@@ -8003,7 +8069,7 @@ declare namespace gapi.client {
|
|
|
8003
8069
|
fields?: string;
|
|
8004
8070
|
/** 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. */
|
|
8005
8071
|
key?: string;
|
|
8006
|
-
/** Required. The resource name of the Answer to get. Format: `projects/{
|
|
8072
|
+
/** 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}` */
|
|
8007
8073
|
name: string;
|
|
8008
8074
|
/** OAuth 2.0 token for the current user. */
|
|
8009
8075
|
oauth_token?: string;
|
|
@@ -8034,7 +8100,7 @@ declare namespace gapi.client {
|
|
|
8034
8100
|
key?: string;
|
|
8035
8101
|
/** OAuth 2.0 token for the current user. */
|
|
8036
8102
|
oauth_token?: string;
|
|
8037
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
8103
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
8038
8104
|
parent: string;
|
|
8039
8105
|
/** Returns response with indentations and line breaks. */
|
|
8040
8106
|
prettyPrint?: boolean;
|
|
@@ -8063,7 +8129,7 @@ declare namespace gapi.client {
|
|
|
8063
8129
|
key?: string;
|
|
8064
8130
|
/** OAuth 2.0 token for the current user. */
|
|
8065
8131
|
oauth_token?: string;
|
|
8066
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
8132
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
8067
8133
|
parent: string;
|
|
8068
8134
|
/** Returns response with indentations and line breaks. */
|
|
8069
8135
|
prettyPrint?: boolean;
|
|
@@ -8090,7 +8156,7 @@ declare namespace gapi.client {
|
|
|
8090
8156
|
fields?: string;
|
|
8091
8157
|
/** 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. */
|
|
8092
8158
|
key?: string;
|
|
8093
|
-
/** Required. The resource name of the Session to delete. Format: `projects/{
|
|
8159
|
+
/** Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
8094
8160
|
name: string;
|
|
8095
8161
|
/** OAuth 2.0 token for the current user. */
|
|
8096
8162
|
oauth_token?: string;
|
|
@@ -8117,7 +8183,7 @@ declare namespace gapi.client {
|
|
|
8117
8183
|
fields?: string;
|
|
8118
8184
|
/** 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. */
|
|
8119
8185
|
key?: string;
|
|
8120
|
-
/** Required. The resource name of the Session to get. Format: `projects/{
|
|
8186
|
+
/** Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
8121
8187
|
name: string;
|
|
8122
8188
|
/** OAuth 2.0 token for the current user. */
|
|
8123
8189
|
oauth_token?: string;
|
|
@@ -8154,7 +8220,7 @@ declare namespace gapi.client {
|
|
|
8154
8220
|
pageSize?: number;
|
|
8155
8221
|
/** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
|
|
8156
8222
|
pageToken?: string;
|
|
8157
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
8223
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
8158
8224
|
parent: string;
|
|
8159
8225
|
/** Returns response with indentations and line breaks. */
|
|
8160
8226
|
prettyPrint?: boolean;
|
|
@@ -8393,7 +8459,7 @@ declare namespace gapi.client {
|
|
|
8393
8459
|
fields?: string;
|
|
8394
8460
|
/** 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. */
|
|
8395
8461
|
key?: string;
|
|
8396
|
-
/** 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/{
|
|
8462
|
+
/** 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. */
|
|
8397
8463
|
name: string;
|
|
8398
8464
|
/** OAuth 2.0 token for the current user. */
|
|
8399
8465
|
oauth_token?: string;
|
|
@@ -8424,7 +8490,7 @@ declare namespace gapi.client {
|
|
|
8424
8490
|
fields?: string;
|
|
8425
8491
|
/** 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. */
|
|
8426
8492
|
key?: string;
|
|
8427
|
-
/** 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/{
|
|
8493
|
+
/** 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. */
|
|
8428
8494
|
name: string;
|
|
8429
8495
|
/** OAuth 2.0 token for the current user. */
|
|
8430
8496
|
oauth_token?: string;
|
|
@@ -9138,7 +9204,7 @@ declare namespace gapi.client {
|
|
|
9138
9204
|
key?: string;
|
|
9139
9205
|
/** OAuth 2.0 token for the current user. */
|
|
9140
9206
|
oauth_token?: string;
|
|
9141
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
9207
|
+
/** 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}`. */
|
|
9142
9208
|
parent: string;
|
|
9143
9209
|
/** Returns response with indentations and line breaks. */
|
|
9144
9210
|
prettyPrint?: boolean;
|
|
@@ -9169,7 +9235,7 @@ declare namespace gapi.client {
|
|
|
9169
9235
|
key?: string;
|
|
9170
9236
|
/** OAuth 2.0 token for the current user. */
|
|
9171
9237
|
oauth_token?: string;
|
|
9172
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
9238
|
+
/** 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}`. */
|
|
9173
9239
|
parent: string;
|
|
9174
9240
|
/** Returns response with indentations and line breaks. */
|
|
9175
9241
|
prettyPrint?: boolean;
|
|
@@ -9196,7 +9262,7 @@ declare namespace gapi.client {
|
|
|
9196
9262
|
fields?: string;
|
|
9197
9263
|
/** 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. */
|
|
9198
9264
|
key?: string;
|
|
9199
|
-
/** Required. The resource name of the Control to delete. Format: `projects/{
|
|
9265
|
+
/** Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
9200
9266
|
name: string;
|
|
9201
9267
|
/** OAuth 2.0 token for the current user. */
|
|
9202
9268
|
oauth_token?: string;
|
|
@@ -9223,7 +9289,7 @@ declare namespace gapi.client {
|
|
|
9223
9289
|
fields?: string;
|
|
9224
9290
|
/** 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. */
|
|
9225
9291
|
key?: string;
|
|
9226
|
-
/** Required. The resource name of the Control to get. Format: `projects/{
|
|
9292
|
+
/** Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
9227
9293
|
name: string;
|
|
9228
9294
|
/** OAuth 2.0 token for the current user. */
|
|
9229
9295
|
oauth_token?: string;
|
|
@@ -9258,7 +9324,7 @@ declare namespace gapi.client {
|
|
|
9258
9324
|
pageSize?: number;
|
|
9259
9325
|
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
9260
9326
|
pageToken?: string;
|
|
9261
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
9327
|
+
/** 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}`. */
|
|
9262
9328
|
parent: string;
|
|
9263
9329
|
/** Returns response with indentations and line breaks. */
|
|
9264
9330
|
prettyPrint?: boolean;
|
|
@@ -9347,7 +9413,7 @@ declare namespace gapi.client {
|
|
|
9347
9413
|
fields?: string;
|
|
9348
9414
|
/** 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. */
|
|
9349
9415
|
key?: string;
|
|
9350
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
9416
|
+
/** 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. */
|
|
9351
9417
|
name: string;
|
|
9352
9418
|
/** OAuth 2.0 token for the current user. */
|
|
9353
9419
|
oauth_token?: string;
|
|
@@ -9376,7 +9442,7 @@ declare namespace gapi.client {
|
|
|
9376
9442
|
fields?: string;
|
|
9377
9443
|
/** 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. */
|
|
9378
9444
|
key?: string;
|
|
9379
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
9445
|
+
/** 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. */
|
|
9380
9446
|
name: string;
|
|
9381
9447
|
/** OAuth 2.0 token for the current user. */
|
|
9382
9448
|
oauth_token?: string;
|
|
@@ -9407,7 +9473,7 @@ declare namespace gapi.client {
|
|
|
9407
9473
|
key?: string;
|
|
9408
9474
|
/** OAuth 2.0 token for the current user. */
|
|
9409
9475
|
oauth_token?: string;
|
|
9410
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
9476
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
9411
9477
|
parent: string;
|
|
9412
9478
|
/** Returns response with indentations and line breaks. */
|
|
9413
9479
|
prettyPrint?: boolean;
|
|
@@ -9436,7 +9502,7 @@ declare namespace gapi.client {
|
|
|
9436
9502
|
key?: string;
|
|
9437
9503
|
/** OAuth 2.0 token for the current user. */
|
|
9438
9504
|
oauth_token?: string;
|
|
9439
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
9505
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
9440
9506
|
parent: string;
|
|
9441
9507
|
/** Returns response with indentations and line breaks. */
|
|
9442
9508
|
prettyPrint?: boolean;
|
|
@@ -9463,7 +9529,7 @@ declare namespace gapi.client {
|
|
|
9463
9529
|
fields?: string;
|
|
9464
9530
|
/** 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. */
|
|
9465
9531
|
key?: string;
|
|
9466
|
-
/** Required. The resource name of the Conversation to delete. Format: `projects/{
|
|
9532
|
+
/** Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
|
|
9467
9533
|
name: string;
|
|
9468
9534
|
/** OAuth 2.0 token for the current user. */
|
|
9469
9535
|
oauth_token?: string;
|
|
@@ -9490,7 +9556,7 @@ declare namespace gapi.client {
|
|
|
9490
9556
|
fields?: string;
|
|
9491
9557
|
/** 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. */
|
|
9492
9558
|
key?: string;
|
|
9493
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
9559
|
+
/** Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
|
|
9494
9560
|
name: string;
|
|
9495
9561
|
/** OAuth 2.0 token for the current user. */
|
|
9496
9562
|
oauth_token?: string;
|
|
@@ -9527,7 +9593,7 @@ declare namespace gapi.client {
|
|
|
9527
9593
|
pageSize?: number;
|
|
9528
9594
|
/** A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */
|
|
9529
9595
|
pageToken?: string;
|
|
9530
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
9596
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
9531
9597
|
parent: string;
|
|
9532
9598
|
/** Returns response with indentations and line breaks. */
|
|
9533
9599
|
prettyPrint?: boolean;
|
|
@@ -10130,7 +10196,7 @@ declare namespace gapi.client {
|
|
|
10130
10196
|
fields?: string;
|
|
10131
10197
|
/** 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. */
|
|
10132
10198
|
key?: string;
|
|
10133
|
-
/** Required. The resource name of the Answer to get. Format: `projects/{
|
|
10199
|
+
/** 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}` */
|
|
10134
10200
|
name: string;
|
|
10135
10201
|
/** OAuth 2.0 token for the current user. */
|
|
10136
10202
|
oauth_token?: string;
|
|
@@ -10161,7 +10227,7 @@ declare namespace gapi.client {
|
|
|
10161
10227
|
key?: string;
|
|
10162
10228
|
/** OAuth 2.0 token for the current user. */
|
|
10163
10229
|
oauth_token?: string;
|
|
10164
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
10230
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
10165
10231
|
parent: string;
|
|
10166
10232
|
/** Returns response with indentations and line breaks. */
|
|
10167
10233
|
prettyPrint?: boolean;
|
|
@@ -10190,7 +10256,7 @@ declare namespace gapi.client {
|
|
|
10190
10256
|
key?: string;
|
|
10191
10257
|
/** OAuth 2.0 token for the current user. */
|
|
10192
10258
|
oauth_token?: string;
|
|
10193
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
10259
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
10194
10260
|
parent: string;
|
|
10195
10261
|
/** Returns response with indentations and line breaks. */
|
|
10196
10262
|
prettyPrint?: boolean;
|
|
@@ -10217,7 +10283,7 @@ declare namespace gapi.client {
|
|
|
10217
10283
|
fields?: string;
|
|
10218
10284
|
/** 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. */
|
|
10219
10285
|
key?: string;
|
|
10220
|
-
/** Required. The resource name of the Session to delete. Format: `projects/{
|
|
10286
|
+
/** Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
10221
10287
|
name: string;
|
|
10222
10288
|
/** OAuth 2.0 token for the current user. */
|
|
10223
10289
|
oauth_token?: string;
|
|
@@ -10244,7 +10310,7 @@ declare namespace gapi.client {
|
|
|
10244
10310
|
fields?: string;
|
|
10245
10311
|
/** 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. */
|
|
10246
10312
|
key?: string;
|
|
10247
|
-
/** Required. The resource name of the Session to get. Format: `projects/{
|
|
10313
|
+
/** Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
10248
10314
|
name: string;
|
|
10249
10315
|
/** OAuth 2.0 token for the current user. */
|
|
10250
10316
|
oauth_token?: string;
|
|
@@ -10281,7 +10347,7 @@ declare namespace gapi.client {
|
|
|
10281
10347
|
pageSize?: number;
|
|
10282
10348
|
/** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
|
|
10283
10349
|
pageToken?: string;
|
|
10284
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
10350
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
10285
10351
|
parent: string;
|
|
10286
10352
|
/** Returns response with indentations and line breaks. */
|
|
10287
10353
|
prettyPrint?: boolean;
|
|
@@ -11020,7 +11086,7 @@ declare namespace gapi.client {
|
|
|
11020
11086
|
key?: string;
|
|
11021
11087
|
/** OAuth 2.0 token for the current user. */
|
|
11022
11088
|
oauth_token?: string;
|
|
11023
|
-
/** Required. The resource name of the catalog under which the events are created. The format is `projects
|
|
11089
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`. */
|
|
11024
11090
|
parent: string;
|
|
11025
11091
|
/** Returns response with indentations and line breaks. */
|
|
11026
11092
|
prettyPrint?: boolean;
|
|
@@ -11049,7 +11115,7 @@ declare namespace gapi.client {
|
|
|
11049
11115
|
key?: string;
|
|
11050
11116
|
/** OAuth 2.0 token for the current user. */
|
|
11051
11117
|
oauth_token?: string;
|
|
11052
|
-
/** Required. The resource name of the catalog under which the events are created. The format is `projects
|
|
11118
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`. */
|
|
11053
11119
|
parent: string;
|
|
11054
11120
|
/** Returns response with indentations and line breaks. */
|
|
11055
11121
|
prettyPrint?: boolean;
|
|
@@ -11628,7 +11694,7 @@ declare namespace gapi.client {
|
|
|
11628
11694
|
prettyPrint?: boolean;
|
|
11629
11695
|
/** 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. */
|
|
11630
11696
|
quotaUser?: string;
|
|
11631
|
-
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{
|
|
11697
|
+
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`. */
|
|
11632
11698
|
rankingConfig: string;
|
|
11633
11699
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11634
11700
|
upload_protocol?: string;
|
|
@@ -11657,7 +11723,7 @@ declare namespace gapi.client {
|
|
|
11657
11723
|
prettyPrint?: boolean;
|
|
11658
11724
|
/** 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. */
|
|
11659
11725
|
quotaUser?: string;
|
|
11660
|
-
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{
|
|
11726
|
+
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`. */
|
|
11661
11727
|
rankingConfig: string;
|
|
11662
11728
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11663
11729
|
upload_protocol?: string;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# TypeScript typings for Discovery Engine API v1
|
|
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
|
|