@maxim_mazurok/gapi.client.discoveryengine-v1alpha 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 +143 -97
- 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 v1alpha 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=v1alpha
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240906
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -205,7 +205,7 @@ declare namespace gapi.client {
|
|
|
205
205
|
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest {
|
|
206
206
|
/** Answer generation specification. */
|
|
207
207
|
answerGenerationSpec?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec;
|
|
208
|
-
/** 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. */
|
|
208
|
+
/** 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. */
|
|
209
209
|
asynchronousMode?: boolean;
|
|
210
210
|
/** Required. Current user query. */
|
|
211
211
|
query?: GoogleCloudDiscoveryengineV1alphaQuery;
|
|
@@ -229,6 +229,8 @@ declare namespace gapi.client {
|
|
|
229
229
|
answerLanguageCode?: string;
|
|
230
230
|
/** 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. */
|
|
231
231
|
ignoreAdversarialQuery?: boolean;
|
|
232
|
+
/** 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. */
|
|
233
|
+
ignoreJailBreakingQuery?: boolean;
|
|
232
234
|
/** 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. */
|
|
233
235
|
ignoreLowRelevantContent?: boolean;
|
|
234
236
|
/** 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. */
|
|
@@ -309,6 +311,14 @@ declare namespace gapi.client {
|
|
|
309
311
|
chunk?: string;
|
|
310
312
|
/** Chunk textual content. */
|
|
311
313
|
content?: string;
|
|
314
|
+
/** Metadata of the document from the current chunk. */
|
|
315
|
+
documentMetadata?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata;
|
|
316
|
+
}
|
|
317
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata {
|
|
318
|
+
/** Title of the document. */
|
|
319
|
+
title?: string;
|
|
320
|
+
/** Uri of the document. */
|
|
321
|
+
uri?: string;
|
|
312
322
|
}
|
|
313
323
|
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo {
|
|
314
324
|
/** Document resource name. */
|
|
@@ -443,7 +453,7 @@ declare namespace gapi.client {
|
|
|
443
453
|
document?: string;
|
|
444
454
|
/** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
|
|
445
455
|
snippetInfo?: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[];
|
|
446
|
-
/** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document
|
|
456
|
+
/** 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. . */
|
|
447
457
|
structData?: {[P in string]: any};
|
|
448
458
|
/** Title. */
|
|
449
459
|
title?: string;
|
|
@@ -493,8 +503,8 @@ declare namespace gapi.client {
|
|
|
493
503
|
lastRefreshedTime?: string;
|
|
494
504
|
/** The value of the matcher that was used to match the Document. */
|
|
495
505
|
matcherValue?: GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue;
|
|
496
|
-
/** The
|
|
497
|
-
|
|
506
|
+
/** The state of the document. */
|
|
507
|
+
state?: string;
|
|
498
508
|
}
|
|
499
509
|
interface GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue {
|
|
500
510
|
/** Required. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id} */
|
|
@@ -806,7 +816,7 @@ declare namespace gapi.client {
|
|
|
806
816
|
query?: GoogleCloudDiscoveryengineV1alphaTextInput;
|
|
807
817
|
/** Whether to turn on safe search. */
|
|
808
818
|
safeSearch?: boolean;
|
|
809
|
-
/** The resource name of the Serving Config to use. Format: `projects/{
|
|
819
|
+
/** 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. */
|
|
810
820
|
servingConfig?: string;
|
|
811
821
|
/** A specification for configuring the summary returned in the response. */
|
|
812
822
|
summarySpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec;
|
|
@@ -875,7 +885,7 @@ declare namespace gapi.client {
|
|
|
875
885
|
modelState?: string;
|
|
876
886
|
/** The version of the model. */
|
|
877
887
|
modelVersion?: string;
|
|
878
|
-
/** Required. The fully qualified resource name of the model. Format: `projects/{
|
|
888
|
+
/** 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. */
|
|
879
889
|
name?: string;
|
|
880
890
|
/** Timestamp the model training was initiated. */
|
|
881
891
|
trainingStartTime?: string;
|
|
@@ -901,6 +911,10 @@ declare namespace gapi.client {
|
|
|
901
911
|
languageInfo?: GoogleCloudDiscoveryengineV1alphaLanguageInfo;
|
|
902
912
|
/** 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. */
|
|
903
913
|
name?: string;
|
|
914
|
+
/** Optional. Configuration for Natural Language Query Understanding. */
|
|
915
|
+
naturalLanguageQueryUnderstandingConfig?: GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig;
|
|
916
|
+
/** Optional. Stores serving config at DataStore level. */
|
|
917
|
+
servingConfigDataStore?: GoogleCloudDiscoveryengineV1alphaServingConfigDataStore;
|
|
904
918
|
/** 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. */
|
|
905
919
|
solutionTypes?: string[];
|
|
906
920
|
/** 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). */
|
|
@@ -993,7 +1007,7 @@ declare namespace gapi.client {
|
|
|
993
1007
|
id?: string;
|
|
994
1008
|
/** Output only. Whether the referenced Document can be found in the data store. */
|
|
995
1009
|
joined?: boolean;
|
|
996
|
-
/** The Document resource full name, of the form: `projects/{
|
|
1010
|
+
/** 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}` */
|
|
997
1011
|
name?: string;
|
|
998
1012
|
/** The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID. */
|
|
999
1013
|
promotionIds?: string[];
|
|
@@ -1009,7 +1023,7 @@ declare namespace gapi.client {
|
|
|
1009
1023
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
1010
1024
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
1011
1025
|
name?: string;
|
|
1012
|
-
/** 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. */
|
|
1026
|
+
/** 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. */
|
|
1013
1027
|
parsingConfigOverrides?: {
|
|
1014
1028
|
[P in string]: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
1015
1029
|
};
|
|
@@ -1073,7 +1087,7 @@ declare namespace gapi.client {
|
|
|
1073
1087
|
industryVertical?: string;
|
|
1074
1088
|
/** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
|
|
1075
1089
|
mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
|
|
1076
|
-
/** 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/{
|
|
1090
|
+
/** 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. */
|
|
1077
1091
|
name?: string;
|
|
1078
1092
|
/** Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. */
|
|
1079
1093
|
recommendationMetadata?: GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata;
|
|
@@ -1597,6 +1611,10 @@ declare namespace gapi.client {
|
|
|
1597
1611
|
/** 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. */
|
|
1598
1612
|
mediaProgressPercentage?: number;
|
|
1599
1613
|
}
|
|
1614
|
+
interface GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig {
|
|
1615
|
+
/** Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. */
|
|
1616
|
+
mode?: string;
|
|
1617
|
+
}
|
|
1600
1618
|
interface GoogleCloudDiscoveryengineV1alphaPageInfo {
|
|
1601
1619
|
/** 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. */
|
|
1602
1620
|
pageCategory?: string;
|
|
@@ -1633,7 +1651,7 @@ declare namespace gapi.client {
|
|
|
1633
1651
|
interface GoogleCloudDiscoveryengineV1alphaProject {
|
|
1634
1652
|
/** Output only. The timestamp when this project is created. */
|
|
1635
1653
|
createTime?: string;
|
|
1636
|
-
/** Output only. Full resource name of the project, for example `projects/{
|
|
1654
|
+
/** 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. */
|
|
1637
1655
|
name?: string;
|
|
1638
1656
|
/** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
|
|
1639
1657
|
provisionCompletionTime?: string;
|
|
@@ -1850,6 +1868,8 @@ declare namespace gapi.client {
|
|
|
1850
1868
|
validUrisCount?: number;
|
|
1851
1869
|
}
|
|
1852
1870
|
interface GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest {
|
|
1871
|
+
/** Optional. Full resource name of the SiteCredential, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`. Only set to crawl private URIs. */
|
|
1872
|
+
siteCredential?: string;
|
|
1853
1873
|
/** 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`. */
|
|
1854
1874
|
uris?: string[];
|
|
1855
1875
|
}
|
|
@@ -2127,6 +2147,8 @@ declare namespace gapi.client {
|
|
|
2127
2147
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec {
|
|
2128
2148
|
/** 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. */
|
|
2129
2149
|
ignoreAdversarialQuery?: boolean;
|
|
2150
|
+
/** 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. */
|
|
2151
|
+
ignoreJailBreakingQuery?: boolean;
|
|
2130
2152
|
/** 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. */
|
|
2131
2153
|
ignoreLowRelevantContent?: boolean;
|
|
2132
2154
|
/** 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. */
|
|
@@ -2479,6 +2501,10 @@ declare namespace gapi.client {
|
|
|
2479
2501
|
/** Output only. ServingConfig updated timestamp. */
|
|
2480
2502
|
updateTime?: string;
|
|
2481
2503
|
}
|
|
2504
|
+
interface GoogleCloudDiscoveryengineV1alphaServingConfigDataStore {
|
|
2505
|
+
/** If set true, the DataStore will not be available for serving search requests. */
|
|
2506
|
+
disabledForServing?: boolean;
|
|
2507
|
+
}
|
|
2482
2508
|
interface GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig {
|
|
2483
2509
|
/** Specifies the expected behavior of content search. Only valid for content-search enabled data store. */
|
|
2484
2510
|
contentSearchSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
@@ -2645,7 +2671,7 @@ declare namespace gapi.client {
|
|
|
2645
2671
|
value?: number;
|
|
2646
2672
|
}
|
|
2647
2673
|
interface GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata {
|
|
2648
|
-
/** Required. The resource name of the engine that this tune applies to. Format: `projects/{
|
|
2674
|
+
/** Required. The resource name of the engine that this tune applies to. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` */
|
|
2649
2675
|
engine?: string;
|
|
2650
2676
|
}
|
|
2651
2677
|
interface GoogleCloudDiscoveryengineV1alphaTuneEngineRequest {}
|
|
@@ -2836,7 +2862,7 @@ declare namespace gapi.client {
|
|
|
2836
2862
|
modelState?: string;
|
|
2837
2863
|
/** The version of the model. */
|
|
2838
2864
|
modelVersion?: string;
|
|
2839
|
-
/** Required. The fully qualified resource name of the model. Format: `projects/{
|
|
2865
|
+
/** 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. */
|
|
2840
2866
|
name?: string;
|
|
2841
2867
|
/** Timestamp the model training was initiated. */
|
|
2842
2868
|
trainingStartTime?: string;
|
|
@@ -2858,6 +2884,10 @@ declare namespace gapi.client {
|
|
|
2858
2884
|
languageInfo?: GoogleCloudDiscoveryengineV1betaLanguageInfo;
|
|
2859
2885
|
/** 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. */
|
|
2860
2886
|
name?: string;
|
|
2887
|
+
/** Optional. Configuration for Natural Language Query Understanding. */
|
|
2888
|
+
naturalLanguageQueryUnderstandingConfig?: GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig;
|
|
2889
|
+
/** Optional. Stores serving config at DataStore level. */
|
|
2890
|
+
servingConfigDataStore?: GoogleCloudDiscoveryengineV1betaServingConfigDataStore;
|
|
2861
2891
|
/** 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. */
|
|
2862
2892
|
solutionTypes?: string[];
|
|
2863
2893
|
/** 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). */
|
|
@@ -2903,7 +2933,7 @@ declare namespace gapi.client {
|
|
|
2903
2933
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
2904
2934
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
2905
2935
|
name?: string;
|
|
2906
|
-
/** 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. */
|
|
2936
|
+
/** 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. */
|
|
2907
2937
|
parsingConfigOverrides?: {
|
|
2908
2938
|
[P in string]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
2909
2939
|
};
|
|
@@ -2956,7 +2986,7 @@ declare namespace gapi.client {
|
|
|
2956
2986
|
displayName?: string;
|
|
2957
2987
|
/** 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. */
|
|
2958
2988
|
industryVertical?: string;
|
|
2959
|
-
/** 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/{
|
|
2989
|
+
/** 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. */
|
|
2960
2990
|
name?: string;
|
|
2961
2991
|
/** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
2962
2992
|
searchEngineConfig?: GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig;
|
|
@@ -3137,10 +3167,14 @@ declare namespace gapi.client {
|
|
|
3137
3167
|
/** List of custom tuning models. */
|
|
3138
3168
|
models?: GoogleCloudDiscoveryengineV1betaCustomTuningModel[];
|
|
3139
3169
|
}
|
|
3170
|
+
interface GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig {
|
|
3171
|
+
/** Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. */
|
|
3172
|
+
mode?: string;
|
|
3173
|
+
}
|
|
3140
3174
|
interface GoogleCloudDiscoveryengineV1betaProject {
|
|
3141
3175
|
/** Output only. The timestamp when this project is created. */
|
|
3142
3176
|
createTime?: string;
|
|
3143
|
-
/** Output only. Full resource name of the project, for example `projects/{
|
|
3177
|
+
/** 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. */
|
|
3144
3178
|
name?: string;
|
|
3145
3179
|
/** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
|
|
3146
3180
|
provisionCompletionTime?: string;
|
|
@@ -3353,6 +3387,8 @@ declare namespace gapi.client {
|
|
|
3353
3387
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec {
|
|
3354
3388
|
/** 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. */
|
|
3355
3389
|
ignoreAdversarialQuery?: boolean;
|
|
3390
|
+
/** 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. */
|
|
3391
|
+
ignoreJailBreakingQuery?: boolean;
|
|
3356
3392
|
/** 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. */
|
|
3357
3393
|
ignoreLowRelevantContent?: boolean;
|
|
3358
3394
|
/** 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. */
|
|
@@ -3448,6 +3484,10 @@ declare namespace gapi.client {
|
|
|
3448
3484
|
/** The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */
|
|
3449
3485
|
mode?: string;
|
|
3450
3486
|
}
|
|
3487
|
+
interface GoogleCloudDiscoveryengineV1betaServingConfigDataStore {
|
|
3488
|
+
/** If set true, the DataStore will not be available for serving search requests. */
|
|
3489
|
+
disabledForServing?: boolean;
|
|
3490
|
+
}
|
|
3451
3491
|
interface GoogleCloudDiscoveryengineV1betaSiteVerificationInfo {
|
|
3452
3492
|
/** Site verification state indicating the ownership and validity. */
|
|
3453
3493
|
siteVerificationState?: string;
|
|
@@ -3503,7 +3543,7 @@ declare namespace gapi.client {
|
|
|
3503
3543
|
modelStatus?: string;
|
|
3504
3544
|
}
|
|
3505
3545
|
interface GoogleCloudDiscoveryengineV1betaTuneEngineMetadata {
|
|
3506
|
-
/** Required. The resource name of the engine that this tune applies to. Format: `projects/{
|
|
3546
|
+
/** Required. The resource name of the engine that this tune applies to. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` */
|
|
3507
3547
|
engine?: string;
|
|
3508
3548
|
}
|
|
3509
3549
|
interface GoogleCloudDiscoveryengineV1betaTuneEngineResponse {}
|
|
@@ -3632,6 +3672,8 @@ declare namespace gapi.client {
|
|
|
3632
3672
|
industryVertical?: string;
|
|
3633
3673
|
/** 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. */
|
|
3634
3674
|
name?: string;
|
|
3675
|
+
/** Optional. Stores serving config at DataStore level. */
|
|
3676
|
+
servingConfigDataStore?: GoogleCloudDiscoveryengineV1ServingConfigDataStore;
|
|
3635
3677
|
/** 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. */
|
|
3636
3678
|
solutionTypes?: string[];
|
|
3637
3679
|
/** 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). */
|
|
@@ -3677,7 +3719,7 @@ declare namespace gapi.client {
|
|
|
3677
3719
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
3678
3720
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
3679
3721
|
name?: string;
|
|
3680
|
-
/** 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. */
|
|
3722
|
+
/** 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. */
|
|
3681
3723
|
parsingConfigOverrides?: {
|
|
3682
3724
|
[P in string]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
3683
3725
|
};
|
|
@@ -3730,7 +3772,7 @@ declare namespace gapi.client {
|
|
|
3730
3772
|
displayName?: string;
|
|
3731
3773
|
/** 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. */
|
|
3732
3774
|
industryVertical?: string;
|
|
3733
|
-
/** 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/{
|
|
3775
|
+
/** 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. */
|
|
3734
3776
|
name?: string;
|
|
3735
3777
|
/** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
|
|
3736
3778
|
searchEngineConfig?: GoogleCloudDiscoveryengineV1EngineSearchEngineConfig;
|
|
@@ -3844,7 +3886,7 @@ declare namespace gapi.client {
|
|
|
3844
3886
|
interface GoogleCloudDiscoveryengineV1Project {
|
|
3845
3887
|
/** Output only. The timestamp when this project is created. */
|
|
3846
3888
|
createTime?: string;
|
|
3847
|
-
/** Output only. Full resource name of the project, for example `projects/{
|
|
3889
|
+
/** 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. */
|
|
3848
3890
|
name?: string;
|
|
3849
3891
|
/** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
|
|
3850
3892
|
provisionCompletionTime?: string;
|
|
@@ -3916,6 +3958,10 @@ declare namespace gapi.client {
|
|
|
3916
3958
|
/** The structured representation of the schema. */
|
|
3917
3959
|
structSchema?: {[P in string]: any};
|
|
3918
3960
|
}
|
|
3961
|
+
interface GoogleCloudDiscoveryengineV1ServingConfigDataStore {
|
|
3962
|
+
/** If set true, the DataStore will not be available for serving search requests. */
|
|
3963
|
+
disabledForServing?: boolean;
|
|
3964
|
+
}
|
|
3919
3965
|
interface GoogleCloudDiscoveryengineV1SiteVerificationInfo {
|
|
3920
3966
|
/** Site verification state indicating the ownership and validity. */
|
|
3921
3967
|
siteVerificationState?: string;
|
|
@@ -4826,7 +4872,7 @@ declare namespace gapi.client {
|
|
|
4826
4872
|
key?: string;
|
|
4827
4873
|
/** OAuth 2.0 token for the current user. */
|
|
4828
4874
|
oauth_token?: string;
|
|
4829
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
4875
|
+
/** 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}`. */
|
|
4830
4876
|
parent: string;
|
|
4831
4877
|
/** Returns response with indentations and line breaks. */
|
|
4832
4878
|
prettyPrint?: boolean;
|
|
@@ -4857,7 +4903,7 @@ declare namespace gapi.client {
|
|
|
4857
4903
|
key?: string;
|
|
4858
4904
|
/** OAuth 2.0 token for the current user. */
|
|
4859
4905
|
oauth_token?: string;
|
|
4860
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
4906
|
+
/** 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}`. */
|
|
4861
4907
|
parent: string;
|
|
4862
4908
|
/** Returns response with indentations and line breaks. */
|
|
4863
4909
|
prettyPrint?: boolean;
|
|
@@ -4884,7 +4930,7 @@ declare namespace gapi.client {
|
|
|
4884
4930
|
fields?: string;
|
|
4885
4931
|
/** 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. */
|
|
4886
4932
|
key?: string;
|
|
4887
|
-
/** Required. The resource name of the Control to delete. Format: `projects/{
|
|
4933
|
+
/** Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
4888
4934
|
name: string;
|
|
4889
4935
|
/** OAuth 2.0 token for the current user. */
|
|
4890
4936
|
oauth_token?: string;
|
|
@@ -4911,7 +4957,7 @@ declare namespace gapi.client {
|
|
|
4911
4957
|
fields?: string;
|
|
4912
4958
|
/** 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. */
|
|
4913
4959
|
key?: string;
|
|
4914
|
-
/** Required. The resource name of the Control to get. Format: `projects/{
|
|
4960
|
+
/** Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
4915
4961
|
name: string;
|
|
4916
4962
|
/** OAuth 2.0 token for the current user. */
|
|
4917
4963
|
oauth_token?: string;
|
|
@@ -4946,7 +4992,7 @@ declare namespace gapi.client {
|
|
|
4946
4992
|
pageSize?: number;
|
|
4947
4993
|
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
4948
4994
|
pageToken?: string;
|
|
4949
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
4995
|
+
/** 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}`. */
|
|
4950
4996
|
parent: string;
|
|
4951
4997
|
/** Returns response with indentations and line breaks. */
|
|
4952
4998
|
prettyPrint?: boolean;
|
|
@@ -5035,7 +5081,7 @@ declare namespace gapi.client {
|
|
|
5035
5081
|
fields?: string;
|
|
5036
5082
|
/** 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. */
|
|
5037
5083
|
key?: string;
|
|
5038
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
5084
|
+
/** 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. */
|
|
5039
5085
|
name: string;
|
|
5040
5086
|
/** OAuth 2.0 token for the current user. */
|
|
5041
5087
|
oauth_token?: string;
|
|
@@ -5064,7 +5110,7 @@ declare namespace gapi.client {
|
|
|
5064
5110
|
fields?: string;
|
|
5065
5111
|
/** 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. */
|
|
5066
5112
|
key?: string;
|
|
5067
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
5113
|
+
/** 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. */
|
|
5068
5114
|
name: string;
|
|
5069
5115
|
/** OAuth 2.0 token for the current user. */
|
|
5070
5116
|
oauth_token?: string;
|
|
@@ -5095,7 +5141,7 @@ declare namespace gapi.client {
|
|
|
5095
5141
|
key?: string;
|
|
5096
5142
|
/** OAuth 2.0 token for the current user. */
|
|
5097
5143
|
oauth_token?: string;
|
|
5098
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
5144
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
5099
5145
|
parent: string;
|
|
5100
5146
|
/** Returns response with indentations and line breaks. */
|
|
5101
5147
|
prettyPrint?: boolean;
|
|
@@ -5124,7 +5170,7 @@ declare namespace gapi.client {
|
|
|
5124
5170
|
key?: string;
|
|
5125
5171
|
/** OAuth 2.0 token for the current user. */
|
|
5126
5172
|
oauth_token?: string;
|
|
5127
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
5173
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
5128
5174
|
parent: string;
|
|
5129
5175
|
/** Returns response with indentations and line breaks. */
|
|
5130
5176
|
prettyPrint?: boolean;
|
|
@@ -5151,7 +5197,7 @@ declare namespace gapi.client {
|
|
|
5151
5197
|
fields?: string;
|
|
5152
5198
|
/** 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. */
|
|
5153
5199
|
key?: string;
|
|
5154
|
-
/** Required. The resource name of the Conversation to delete. Format: `projects/{
|
|
5200
|
+
/** Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
|
|
5155
5201
|
name: string;
|
|
5156
5202
|
/** OAuth 2.0 token for the current user. */
|
|
5157
5203
|
oauth_token?: string;
|
|
@@ -5178,7 +5224,7 @@ declare namespace gapi.client {
|
|
|
5178
5224
|
fields?: string;
|
|
5179
5225
|
/** 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. */
|
|
5180
5226
|
key?: string;
|
|
5181
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
5227
|
+
/** Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
|
|
5182
5228
|
name: string;
|
|
5183
5229
|
/** OAuth 2.0 token for the current user. */
|
|
5184
5230
|
oauth_token?: string;
|
|
@@ -5215,7 +5261,7 @@ declare namespace gapi.client {
|
|
|
5215
5261
|
pageSize?: number;
|
|
5216
5262
|
/** A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */
|
|
5217
5263
|
pageToken?: string;
|
|
5218
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
5264
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
5219
5265
|
parent: string;
|
|
5220
5266
|
/** Returns response with indentations and line breaks. */
|
|
5221
5267
|
prettyPrint?: boolean;
|
|
@@ -5792,7 +5838,7 @@ declare namespace gapi.client {
|
|
|
5792
5838
|
fields?: string;
|
|
5793
5839
|
/** 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. */
|
|
5794
5840
|
key?: string;
|
|
5795
|
-
/** Required. The resource name of the ServingConfig to get. Format: `projects/{
|
|
5841
|
+
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
5796
5842
|
name: string;
|
|
5797
5843
|
/** OAuth 2.0 token for the current user. */
|
|
5798
5844
|
oauth_token?: string;
|
|
@@ -5825,7 +5871,7 @@ declare namespace gapi.client {
|
|
|
5825
5871
|
pageSize?: number;
|
|
5826
5872
|
/** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
|
|
5827
5873
|
pageToken?: string;
|
|
5828
|
-
/** Required. Full resource name of the parent resource. Format: `projects/{
|
|
5874
|
+
/** Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
5829
5875
|
parent: string;
|
|
5830
5876
|
/** Returns response with indentations and line breaks. */
|
|
5831
5877
|
prettyPrint?: boolean;
|
|
@@ -6030,7 +6076,7 @@ declare namespace gapi.client {
|
|
|
6030
6076
|
fields?: string;
|
|
6031
6077
|
/** 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. */
|
|
6032
6078
|
key?: string;
|
|
6033
|
-
/** Required. The resource name of the Answer to get. Format: `projects/{
|
|
6079
|
+
/** 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}` */
|
|
6034
6080
|
name: string;
|
|
6035
6081
|
/** OAuth 2.0 token for the current user. */
|
|
6036
6082
|
oauth_token?: string;
|
|
@@ -6061,7 +6107,7 @@ declare namespace gapi.client {
|
|
|
6061
6107
|
key?: string;
|
|
6062
6108
|
/** OAuth 2.0 token for the current user. */
|
|
6063
6109
|
oauth_token?: string;
|
|
6064
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
6110
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
6065
6111
|
parent: string;
|
|
6066
6112
|
/** Returns response with indentations and line breaks. */
|
|
6067
6113
|
prettyPrint?: boolean;
|
|
@@ -6090,7 +6136,7 @@ declare namespace gapi.client {
|
|
|
6090
6136
|
key?: string;
|
|
6091
6137
|
/** OAuth 2.0 token for the current user. */
|
|
6092
6138
|
oauth_token?: string;
|
|
6093
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
6139
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
6094
6140
|
parent: string;
|
|
6095
6141
|
/** Returns response with indentations and line breaks. */
|
|
6096
6142
|
prettyPrint?: boolean;
|
|
@@ -6117,7 +6163,7 @@ declare namespace gapi.client {
|
|
|
6117
6163
|
fields?: string;
|
|
6118
6164
|
/** 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. */
|
|
6119
6165
|
key?: string;
|
|
6120
|
-
/** Required. The resource name of the Session to delete. Format: `projects/{
|
|
6166
|
+
/** Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
6121
6167
|
name: string;
|
|
6122
6168
|
/** OAuth 2.0 token for the current user. */
|
|
6123
6169
|
oauth_token?: string;
|
|
@@ -6144,7 +6190,7 @@ declare namespace gapi.client {
|
|
|
6144
6190
|
fields?: string;
|
|
6145
6191
|
/** 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. */
|
|
6146
6192
|
key?: string;
|
|
6147
|
-
/** Required. The resource name of the Session to get. Format: `projects/{
|
|
6193
|
+
/** Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
6148
6194
|
name: string;
|
|
6149
6195
|
/** OAuth 2.0 token for the current user. */
|
|
6150
6196
|
oauth_token?: string;
|
|
@@ -6181,7 +6227,7 @@ declare namespace gapi.client {
|
|
|
6181
6227
|
pageSize?: number;
|
|
6182
6228
|
/** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
|
|
6183
6229
|
pageToken?: string;
|
|
6184
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
6230
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
6185
6231
|
parent: string;
|
|
6186
6232
|
/** Returns response with indentations and line breaks. */
|
|
6187
6233
|
prettyPrint?: boolean;
|
|
@@ -7220,7 +7266,7 @@ declare namespace gapi.client {
|
|
|
7220
7266
|
key?: string;
|
|
7221
7267
|
/** OAuth 2.0 token for the current user. */
|
|
7222
7268
|
oauth_token?: string;
|
|
7223
|
-
/** Required. The resource name of the catalog under which the events are created. The format is `projects
|
|
7269
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`. */
|
|
7224
7270
|
parent: string;
|
|
7225
7271
|
/** Returns response with indentations and line breaks. */
|
|
7226
7272
|
prettyPrint?: boolean;
|
|
@@ -7249,7 +7295,7 @@ declare namespace gapi.client {
|
|
|
7249
7295
|
key?: string;
|
|
7250
7296
|
/** OAuth 2.0 token for the current user. */
|
|
7251
7297
|
oauth_token?: string;
|
|
7252
|
-
/** Required. The resource name of the catalog under which the events are created. The format is `projects
|
|
7298
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`. */
|
|
7253
7299
|
parent: string;
|
|
7254
7300
|
/** Returns response with indentations and line breaks. */
|
|
7255
7301
|
prettyPrint?: boolean;
|
|
@@ -7499,7 +7545,7 @@ declare namespace gapi.client {
|
|
|
7499
7545
|
fields?: string;
|
|
7500
7546
|
/** 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. */
|
|
7501
7547
|
key?: string;
|
|
7502
|
-
/** Required. Full DocumentProcessingConfig resource name. Format: `projects/{
|
|
7548
|
+
/** Required. Full DocumentProcessingConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig` */
|
|
7503
7549
|
name: string;
|
|
7504
7550
|
/** OAuth 2.0 token for the current user. */
|
|
7505
7551
|
oauth_token?: string;
|
|
@@ -7787,7 +7833,7 @@ declare namespace gapi.client {
|
|
|
7787
7833
|
key?: string;
|
|
7788
7834
|
/** OAuth 2.0 token for the current user. */
|
|
7789
7835
|
oauth_token?: string;
|
|
7790
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
7836
|
+
/** 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}`. */
|
|
7791
7837
|
parent: string;
|
|
7792
7838
|
/** Returns response with indentations and line breaks. */
|
|
7793
7839
|
prettyPrint?: boolean;
|
|
@@ -7818,7 +7864,7 @@ declare namespace gapi.client {
|
|
|
7818
7864
|
key?: string;
|
|
7819
7865
|
/** OAuth 2.0 token for the current user. */
|
|
7820
7866
|
oauth_token?: string;
|
|
7821
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
7867
|
+
/** 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}`. */
|
|
7822
7868
|
parent: string;
|
|
7823
7869
|
/** Returns response with indentations and line breaks. */
|
|
7824
7870
|
prettyPrint?: boolean;
|
|
@@ -7845,7 +7891,7 @@ declare namespace gapi.client {
|
|
|
7845
7891
|
fields?: string;
|
|
7846
7892
|
/** 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. */
|
|
7847
7893
|
key?: string;
|
|
7848
|
-
/** Required. The resource name of the Control to delete. Format: `projects/{
|
|
7894
|
+
/** Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
7849
7895
|
name: string;
|
|
7850
7896
|
/** OAuth 2.0 token for the current user. */
|
|
7851
7897
|
oauth_token?: string;
|
|
@@ -7872,7 +7918,7 @@ declare namespace gapi.client {
|
|
|
7872
7918
|
fields?: string;
|
|
7873
7919
|
/** 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. */
|
|
7874
7920
|
key?: string;
|
|
7875
|
-
/** Required. The resource name of the Control to get. Format: `projects/{
|
|
7921
|
+
/** Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
7876
7922
|
name: string;
|
|
7877
7923
|
/** OAuth 2.0 token for the current user. */
|
|
7878
7924
|
oauth_token?: string;
|
|
@@ -7907,7 +7953,7 @@ declare namespace gapi.client {
|
|
|
7907
7953
|
pageSize?: number;
|
|
7908
7954
|
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
7909
7955
|
pageToken?: string;
|
|
7910
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
7956
|
+
/** 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}`. */
|
|
7911
7957
|
parent: string;
|
|
7912
7958
|
/** Returns response with indentations and line breaks. */
|
|
7913
7959
|
prettyPrint?: boolean;
|
|
@@ -7996,7 +8042,7 @@ declare namespace gapi.client {
|
|
|
7996
8042
|
fields?: string;
|
|
7997
8043
|
/** 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. */
|
|
7998
8044
|
key?: string;
|
|
7999
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
8045
|
+
/** 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. */
|
|
8000
8046
|
name: string;
|
|
8001
8047
|
/** OAuth 2.0 token for the current user. */
|
|
8002
8048
|
oauth_token?: string;
|
|
@@ -8025,7 +8071,7 @@ declare namespace gapi.client {
|
|
|
8025
8071
|
fields?: string;
|
|
8026
8072
|
/** 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. */
|
|
8027
8073
|
key?: string;
|
|
8028
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
8074
|
+
/** 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. */
|
|
8029
8075
|
name: string;
|
|
8030
8076
|
/** OAuth 2.0 token for the current user. */
|
|
8031
8077
|
oauth_token?: string;
|
|
@@ -8056,7 +8102,7 @@ declare namespace gapi.client {
|
|
|
8056
8102
|
key?: string;
|
|
8057
8103
|
/** OAuth 2.0 token for the current user. */
|
|
8058
8104
|
oauth_token?: string;
|
|
8059
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
8105
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
8060
8106
|
parent: string;
|
|
8061
8107
|
/** Returns response with indentations and line breaks. */
|
|
8062
8108
|
prettyPrint?: boolean;
|
|
@@ -8085,7 +8131,7 @@ declare namespace gapi.client {
|
|
|
8085
8131
|
key?: string;
|
|
8086
8132
|
/** OAuth 2.0 token for the current user. */
|
|
8087
8133
|
oauth_token?: string;
|
|
8088
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
8134
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
8089
8135
|
parent: string;
|
|
8090
8136
|
/** Returns response with indentations and line breaks. */
|
|
8091
8137
|
prettyPrint?: boolean;
|
|
@@ -8112,7 +8158,7 @@ declare namespace gapi.client {
|
|
|
8112
8158
|
fields?: string;
|
|
8113
8159
|
/** 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. */
|
|
8114
8160
|
key?: string;
|
|
8115
|
-
/** Required. The resource name of the Conversation to delete. Format: `projects/{
|
|
8161
|
+
/** Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
|
|
8116
8162
|
name: string;
|
|
8117
8163
|
/** OAuth 2.0 token for the current user. */
|
|
8118
8164
|
oauth_token?: string;
|
|
@@ -8139,7 +8185,7 @@ declare namespace gapi.client {
|
|
|
8139
8185
|
fields?: string;
|
|
8140
8186
|
/** 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. */
|
|
8141
8187
|
key?: string;
|
|
8142
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
8188
|
+
/** Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
|
|
8143
8189
|
name: string;
|
|
8144
8190
|
/** OAuth 2.0 token for the current user. */
|
|
8145
8191
|
oauth_token?: string;
|
|
@@ -8176,7 +8222,7 @@ declare namespace gapi.client {
|
|
|
8176
8222
|
pageSize?: number;
|
|
8177
8223
|
/** A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */
|
|
8178
8224
|
pageToken?: string;
|
|
8179
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
8225
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
8180
8226
|
parent: string;
|
|
8181
8227
|
/** Returns response with indentations and line breaks. */
|
|
8182
8228
|
prettyPrint?: boolean;
|
|
@@ -8385,7 +8431,7 @@ declare namespace gapi.client {
|
|
|
8385
8431
|
fields?: string;
|
|
8386
8432
|
/** 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. */
|
|
8387
8433
|
key?: string;
|
|
8388
|
-
/** Required. The resource name of the ServingConfig to get. Format: `projects/{
|
|
8434
|
+
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
8389
8435
|
name: string;
|
|
8390
8436
|
/** OAuth 2.0 token for the current user. */
|
|
8391
8437
|
oauth_token?: string;
|
|
@@ -8418,7 +8464,7 @@ declare namespace gapi.client {
|
|
|
8418
8464
|
pageSize?: number;
|
|
8419
8465
|
/** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
|
|
8420
8466
|
pageToken?: string;
|
|
8421
|
-
/** Required. Full resource name of the parent resource. Format: `projects/{
|
|
8467
|
+
/** Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
8422
8468
|
parent: string;
|
|
8423
8469
|
/** Returns response with indentations and line breaks. */
|
|
8424
8470
|
prettyPrint?: boolean;
|
|
@@ -8623,7 +8669,7 @@ declare namespace gapi.client {
|
|
|
8623
8669
|
fields?: string;
|
|
8624
8670
|
/** 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. */
|
|
8625
8671
|
key?: string;
|
|
8626
|
-
/** Required. The resource name of the Answer to get. Format: `projects/{
|
|
8672
|
+
/** 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}` */
|
|
8627
8673
|
name: string;
|
|
8628
8674
|
/** OAuth 2.0 token for the current user. */
|
|
8629
8675
|
oauth_token?: string;
|
|
@@ -8654,7 +8700,7 @@ declare namespace gapi.client {
|
|
|
8654
8700
|
key?: string;
|
|
8655
8701
|
/** OAuth 2.0 token for the current user. */
|
|
8656
8702
|
oauth_token?: string;
|
|
8657
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
8703
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
8658
8704
|
parent: string;
|
|
8659
8705
|
/** Returns response with indentations and line breaks. */
|
|
8660
8706
|
prettyPrint?: boolean;
|
|
@@ -8683,7 +8729,7 @@ declare namespace gapi.client {
|
|
|
8683
8729
|
key?: string;
|
|
8684
8730
|
/** OAuth 2.0 token for the current user. */
|
|
8685
8731
|
oauth_token?: string;
|
|
8686
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
8732
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
8687
8733
|
parent: string;
|
|
8688
8734
|
/** Returns response with indentations and line breaks. */
|
|
8689
8735
|
prettyPrint?: boolean;
|
|
@@ -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
|
-
/** Required. The resource name of the Session to delete. Format: `projects/{
|
|
8759
|
+
/** Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
8714
8760
|
name: string;
|
|
8715
8761
|
/** OAuth 2.0 token for the current user. */
|
|
8716
8762
|
oauth_token?: string;
|
|
@@ -8737,7 +8783,7 @@ declare namespace gapi.client {
|
|
|
8737
8783
|
fields?: string;
|
|
8738
8784
|
/** 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. */
|
|
8739
8785
|
key?: string;
|
|
8740
|
-
/** Required. The resource name of the Session to get. Format: `projects/{
|
|
8786
|
+
/** Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
8741
8787
|
name: string;
|
|
8742
8788
|
/** OAuth 2.0 token for the current user. */
|
|
8743
8789
|
oauth_token?: string;
|
|
@@ -8774,7 +8820,7 @@ declare namespace gapi.client {
|
|
|
8774
8820
|
pageSize?: number;
|
|
8775
8821
|
/** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
|
|
8776
8822
|
pageToken?: string;
|
|
8777
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
8823
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
8778
8824
|
parent: string;
|
|
8779
8825
|
/** Returns response with indentations and line breaks. */
|
|
8780
8826
|
prettyPrint?: boolean;
|
|
@@ -9013,7 +9059,7 @@ declare namespace gapi.client {
|
|
|
9013
9059
|
fields?: string;
|
|
9014
9060
|
/** 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. */
|
|
9015
9061
|
key?: string;
|
|
9016
|
-
/** 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/{
|
|
9062
|
+
/** 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. */
|
|
9017
9063
|
name: string;
|
|
9018
9064
|
/** OAuth 2.0 token for the current user. */
|
|
9019
9065
|
oauth_token?: string;
|
|
@@ -9044,7 +9090,7 @@ declare namespace gapi.client {
|
|
|
9044
9090
|
fields?: string;
|
|
9045
9091
|
/** 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. */
|
|
9046
9092
|
key?: string;
|
|
9047
|
-
/** 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/{
|
|
9093
|
+
/** 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. */
|
|
9048
9094
|
name: string;
|
|
9049
9095
|
/** OAuth 2.0 token for the current user. */
|
|
9050
9096
|
oauth_token?: string;
|
|
@@ -9075,7 +9121,7 @@ declare namespace gapi.client {
|
|
|
9075
9121
|
fields?: string;
|
|
9076
9122
|
/** 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. */
|
|
9077
9123
|
key?: string;
|
|
9078
|
-
/** Required. The name of the engine to pause. Format: `projects/{
|
|
9124
|
+
/** Required. The name of the engine to pause. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` */
|
|
9079
9125
|
name: string;
|
|
9080
9126
|
/** OAuth 2.0 token for the current user. */
|
|
9081
9127
|
oauth_token?: string;
|
|
@@ -9104,7 +9150,7 @@ declare namespace gapi.client {
|
|
|
9104
9150
|
fields?: string;
|
|
9105
9151
|
/** 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. */
|
|
9106
9152
|
key?: string;
|
|
9107
|
-
/** Required. The name of the engine to pause. Format: `projects/{
|
|
9153
|
+
/** Required. The name of the engine to pause. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` */
|
|
9108
9154
|
name: string;
|
|
9109
9155
|
/** OAuth 2.0 token for the current user. */
|
|
9110
9156
|
oauth_token?: string;
|
|
@@ -9133,7 +9179,7 @@ declare namespace gapi.client {
|
|
|
9133
9179
|
fields?: string;
|
|
9134
9180
|
/** 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. */
|
|
9135
9181
|
key?: string;
|
|
9136
|
-
/** Required. The name of the engine to resume. Format: `projects/{
|
|
9182
|
+
/** Required. The name of the engine to resume. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` */
|
|
9137
9183
|
name: string;
|
|
9138
9184
|
/** OAuth 2.0 token for the current user. */
|
|
9139
9185
|
oauth_token?: string;
|
|
@@ -9162,7 +9208,7 @@ declare namespace gapi.client {
|
|
|
9162
9208
|
fields?: string;
|
|
9163
9209
|
/** 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. */
|
|
9164
9210
|
key?: string;
|
|
9165
|
-
/** Required. The name of the engine to resume. Format: `projects/{
|
|
9211
|
+
/** Required. The name of the engine to resume. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` */
|
|
9166
9212
|
name: string;
|
|
9167
9213
|
/** OAuth 2.0 token for the current user. */
|
|
9168
9214
|
oauth_token?: string;
|
|
@@ -9191,7 +9237,7 @@ declare namespace gapi.client {
|
|
|
9191
9237
|
fields?: string;
|
|
9192
9238
|
/** 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. */
|
|
9193
9239
|
key?: string;
|
|
9194
|
-
/** Required. The resource name of the engine to tune. Format: `projects/{
|
|
9240
|
+
/** Required. The resource name of the engine to tune. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` */
|
|
9195
9241
|
name: string;
|
|
9196
9242
|
/** OAuth 2.0 token for the current user. */
|
|
9197
9243
|
oauth_token?: string;
|
|
@@ -9220,7 +9266,7 @@ declare namespace gapi.client {
|
|
|
9220
9266
|
fields?: string;
|
|
9221
9267
|
/** 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. */
|
|
9222
9268
|
key?: string;
|
|
9223
|
-
/** Required. The resource name of the engine to tune. Format: `projects/{
|
|
9269
|
+
/** Required. The resource name of the engine to tune. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}` */
|
|
9224
9270
|
name: string;
|
|
9225
9271
|
/** OAuth 2.0 token for the current user. */
|
|
9226
9272
|
oauth_token?: string;
|
|
@@ -10024,7 +10070,7 @@ declare namespace gapi.client {
|
|
|
10024
10070
|
key?: string;
|
|
10025
10071
|
/** OAuth 2.0 token for the current user. */
|
|
10026
10072
|
oauth_token?: string;
|
|
10027
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
10073
|
+
/** 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}`. */
|
|
10028
10074
|
parent: string;
|
|
10029
10075
|
/** Returns response with indentations and line breaks. */
|
|
10030
10076
|
prettyPrint?: boolean;
|
|
@@ -10055,7 +10101,7 @@ declare namespace gapi.client {
|
|
|
10055
10101
|
key?: string;
|
|
10056
10102
|
/** OAuth 2.0 token for the current user. */
|
|
10057
10103
|
oauth_token?: string;
|
|
10058
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
10104
|
+
/** 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}`. */
|
|
10059
10105
|
parent: string;
|
|
10060
10106
|
/** Returns response with indentations and line breaks. */
|
|
10061
10107
|
prettyPrint?: boolean;
|
|
@@ -10082,7 +10128,7 @@ declare namespace gapi.client {
|
|
|
10082
10128
|
fields?: string;
|
|
10083
10129
|
/** 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. */
|
|
10084
10130
|
key?: string;
|
|
10085
|
-
/** Required. The resource name of the Control to delete. Format: `projects/{
|
|
10131
|
+
/** Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
10086
10132
|
name: string;
|
|
10087
10133
|
/** OAuth 2.0 token for the current user. */
|
|
10088
10134
|
oauth_token?: string;
|
|
@@ -10109,7 +10155,7 @@ declare namespace gapi.client {
|
|
|
10109
10155
|
fields?: string;
|
|
10110
10156
|
/** 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. */
|
|
10111
10157
|
key?: string;
|
|
10112
|
-
/** Required. The resource name of the Control to get. Format: `projects/{
|
|
10158
|
+
/** Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` */
|
|
10113
10159
|
name: string;
|
|
10114
10160
|
/** OAuth 2.0 token for the current user. */
|
|
10115
10161
|
oauth_token?: string;
|
|
@@ -10144,7 +10190,7 @@ declare namespace gapi.client {
|
|
|
10144
10190
|
pageSize?: number;
|
|
10145
10191
|
/** Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */
|
|
10146
10192
|
pageToken?: string;
|
|
10147
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
10193
|
+
/** 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}`. */
|
|
10148
10194
|
parent: string;
|
|
10149
10195
|
/** Returns response with indentations and line breaks. */
|
|
10150
10196
|
prettyPrint?: boolean;
|
|
@@ -10233,7 +10279,7 @@ declare namespace gapi.client {
|
|
|
10233
10279
|
fields?: string;
|
|
10234
10280
|
/** 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. */
|
|
10235
10281
|
key?: string;
|
|
10236
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
10282
|
+
/** 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. */
|
|
10237
10283
|
name: string;
|
|
10238
10284
|
/** OAuth 2.0 token for the current user. */
|
|
10239
10285
|
oauth_token?: string;
|
|
@@ -10262,7 +10308,7 @@ declare namespace gapi.client {
|
|
|
10262
10308
|
fields?: string;
|
|
10263
10309
|
/** 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. */
|
|
10264
10310
|
key?: string;
|
|
10265
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
10311
|
+
/** 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. */
|
|
10266
10312
|
name: string;
|
|
10267
10313
|
/** OAuth 2.0 token for the current user. */
|
|
10268
10314
|
oauth_token?: string;
|
|
@@ -10293,7 +10339,7 @@ declare namespace gapi.client {
|
|
|
10293
10339
|
key?: string;
|
|
10294
10340
|
/** OAuth 2.0 token for the current user. */
|
|
10295
10341
|
oauth_token?: string;
|
|
10296
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
10342
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
10297
10343
|
parent: string;
|
|
10298
10344
|
/** Returns response with indentations and line breaks. */
|
|
10299
10345
|
prettyPrint?: boolean;
|
|
@@ -10322,7 +10368,7 @@ declare namespace gapi.client {
|
|
|
10322
10368
|
key?: string;
|
|
10323
10369
|
/** OAuth 2.0 token for the current user. */
|
|
10324
10370
|
oauth_token?: string;
|
|
10325
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
10371
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
10326
10372
|
parent: string;
|
|
10327
10373
|
/** Returns response with indentations and line breaks. */
|
|
10328
10374
|
prettyPrint?: boolean;
|
|
@@ -10349,7 +10395,7 @@ declare namespace gapi.client {
|
|
|
10349
10395
|
fields?: string;
|
|
10350
10396
|
/** 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. */
|
|
10351
10397
|
key?: string;
|
|
10352
|
-
/** Required. The resource name of the Conversation to delete. Format: `projects/{
|
|
10398
|
+
/** Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
|
|
10353
10399
|
name: string;
|
|
10354
10400
|
/** OAuth 2.0 token for the current user. */
|
|
10355
10401
|
oauth_token?: string;
|
|
@@ -10376,7 +10422,7 @@ declare namespace gapi.client {
|
|
|
10376
10422
|
fields?: string;
|
|
10377
10423
|
/** 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. */
|
|
10378
10424
|
key?: string;
|
|
10379
|
-
/** Required. The resource name of the Conversation to get. Format: `projects/{
|
|
10425
|
+
/** Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
|
|
10380
10426
|
name: string;
|
|
10381
10427
|
/** OAuth 2.0 token for the current user. */
|
|
10382
10428
|
oauth_token?: string;
|
|
@@ -10413,7 +10459,7 @@ declare namespace gapi.client {
|
|
|
10413
10459
|
pageSize?: number;
|
|
10414
10460
|
/** A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */
|
|
10415
10461
|
pageToken?: string;
|
|
10416
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
10462
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
10417
10463
|
parent: string;
|
|
10418
10464
|
/** Returns response with indentations and line breaks. */
|
|
10419
10465
|
prettyPrint?: boolean;
|
|
@@ -10898,7 +10944,7 @@ declare namespace gapi.client {
|
|
|
10898
10944
|
fields?: string;
|
|
10899
10945
|
/** 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. */
|
|
10900
10946
|
key?: string;
|
|
10901
|
-
/** Required. The resource name of the ServingConfig to get. Format: `projects/{
|
|
10947
|
+
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
10902
10948
|
name: string;
|
|
10903
10949
|
/** OAuth 2.0 token for the current user. */
|
|
10904
10950
|
oauth_token?: string;
|
|
@@ -10931,7 +10977,7 @@ declare namespace gapi.client {
|
|
|
10931
10977
|
pageSize?: number;
|
|
10932
10978
|
/** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
|
|
10933
10979
|
pageToken?: string;
|
|
10934
|
-
/** Required. Full resource name of the parent resource. Format: `projects/{
|
|
10980
|
+
/** Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
10935
10981
|
parent: string;
|
|
10936
10982
|
/** Returns response with indentations and line breaks. */
|
|
10937
10983
|
prettyPrint?: boolean;
|
|
@@ -11136,7 +11182,7 @@ declare namespace gapi.client {
|
|
|
11136
11182
|
fields?: string;
|
|
11137
11183
|
/** 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. */
|
|
11138
11184
|
key?: string;
|
|
11139
|
-
/** Required. The resource name of the Answer to get. Format: `projects/{
|
|
11185
|
+
/** 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}` */
|
|
11140
11186
|
name: string;
|
|
11141
11187
|
/** OAuth 2.0 token for the current user. */
|
|
11142
11188
|
oauth_token?: string;
|
|
@@ -11167,7 +11213,7 @@ declare namespace gapi.client {
|
|
|
11167
11213
|
key?: string;
|
|
11168
11214
|
/** OAuth 2.0 token for the current user. */
|
|
11169
11215
|
oauth_token?: string;
|
|
11170
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
11216
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
11171
11217
|
parent: string;
|
|
11172
11218
|
/** Returns response with indentations and line breaks. */
|
|
11173
11219
|
prettyPrint?: boolean;
|
|
@@ -11196,7 +11242,7 @@ declare namespace gapi.client {
|
|
|
11196
11242
|
key?: string;
|
|
11197
11243
|
/** OAuth 2.0 token for the current user. */
|
|
11198
11244
|
oauth_token?: string;
|
|
11199
|
-
/** Required. Full resource name of parent data store. Format: `projects/{
|
|
11245
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
11200
11246
|
parent: string;
|
|
11201
11247
|
/** Returns response with indentations and line breaks. */
|
|
11202
11248
|
prettyPrint?: boolean;
|
|
@@ -11223,7 +11269,7 @@ declare namespace gapi.client {
|
|
|
11223
11269
|
fields?: string;
|
|
11224
11270
|
/** 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. */
|
|
11225
11271
|
key?: string;
|
|
11226
|
-
/** Required. The resource name of the Session to delete. Format: `projects/{
|
|
11272
|
+
/** Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
11227
11273
|
name: string;
|
|
11228
11274
|
/** OAuth 2.0 token for the current user. */
|
|
11229
11275
|
oauth_token?: string;
|
|
@@ -11250,7 +11296,7 @@ declare namespace gapi.client {
|
|
|
11250
11296
|
fields?: string;
|
|
11251
11297
|
/** 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. */
|
|
11252
11298
|
key?: string;
|
|
11253
|
-
/** Required. The resource name of the Session to get. Format: `projects/{
|
|
11299
|
+
/** Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
11254
11300
|
name: string;
|
|
11255
11301
|
/** OAuth 2.0 token for the current user. */
|
|
11256
11302
|
oauth_token?: string;
|
|
@@ -11287,7 +11333,7 @@ declare namespace gapi.client {
|
|
|
11287
11333
|
pageSize?: number;
|
|
11288
11334
|
/** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
|
|
11289
11335
|
pageToken?: string;
|
|
11290
|
-
/** Required. The data store resource name. Format: `projects/{
|
|
11336
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
11291
11337
|
parent: string;
|
|
11292
11338
|
/** Returns response with indentations and line breaks. */
|
|
11293
11339
|
prettyPrint?: boolean;
|
|
@@ -12026,7 +12072,7 @@ declare namespace gapi.client {
|
|
|
12026
12072
|
key?: string;
|
|
12027
12073
|
/** OAuth 2.0 token for the current user. */
|
|
12028
12074
|
oauth_token?: string;
|
|
12029
|
-
/** Required. The resource name of the catalog under which the events are created. The format is `projects
|
|
12075
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`. */
|
|
12030
12076
|
parent: string;
|
|
12031
12077
|
/** Returns response with indentations and line breaks. */
|
|
12032
12078
|
prettyPrint?: boolean;
|
|
@@ -12055,7 +12101,7 @@ declare namespace gapi.client {
|
|
|
12055
12101
|
key?: string;
|
|
12056
12102
|
/** OAuth 2.0 token for the current user. */
|
|
12057
12103
|
oauth_token?: string;
|
|
12058
|
-
/** Required. The resource name of the catalog under which the events are created. The format is `projects
|
|
12104
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`. */
|
|
12059
12105
|
parent: string;
|
|
12060
12106
|
/** Returns response with indentations and line breaks. */
|
|
12061
12107
|
prettyPrint?: boolean;
|
|
@@ -12305,7 +12351,7 @@ declare namespace gapi.client {
|
|
|
12305
12351
|
fields?: string;
|
|
12306
12352
|
/** 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. */
|
|
12307
12353
|
key?: string;
|
|
12308
|
-
/** Required. Full DocumentProcessingConfig resource name. Format: `projects/{
|
|
12354
|
+
/** Required. Full DocumentProcessingConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig` */
|
|
12309
12355
|
name: string;
|
|
12310
12356
|
/** OAuth 2.0 token for the current user. */
|
|
12311
12357
|
oauth_token?: string;
|
|
@@ -12902,7 +12948,7 @@ declare namespace gapi.client {
|
|
|
12902
12948
|
prettyPrint?: boolean;
|
|
12903
12949
|
/** 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. */
|
|
12904
12950
|
quotaUser?: string;
|
|
12905
|
-
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{
|
|
12951
|
+
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`. */
|
|
12906
12952
|
rankingConfig: string;
|
|
12907
12953
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12908
12954
|
upload_protocol?: string;
|
|
@@ -12931,7 +12977,7 @@ declare namespace gapi.client {
|
|
|
12931
12977
|
prettyPrint?: boolean;
|
|
12932
12978
|
/** 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. */
|
|
12933
12979
|
quotaUser?: string;
|
|
12934
|
-
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{
|
|
12980
|
+
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`. */
|
|
12935
12981
|
rankingConfig: string;
|
|
12936
12982
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12937
12983
|
upload_protocol?: string;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# TypeScript typings for Discovery Engine API v1alpha
|
|
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
|
|