@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240305 → 0.0.20240307
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 +169 -30
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240307
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -146,7 +146,7 @@ declare namespace gapi.client {
|
|
|
146
146
|
includeTailSuggestions?: boolean;
|
|
147
147
|
/** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
|
|
148
148
|
query?: string;
|
|
149
|
-
/** Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
|
|
149
|
+
/** Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */
|
|
150
150
|
queryModel?: string;
|
|
151
151
|
/** A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
152
152
|
userPseudoId?: string;
|
|
@@ -347,6 +347,7 @@ declare namespace gapi.client {
|
|
|
347
347
|
structData?: {[P in string]: any};
|
|
348
348
|
}
|
|
349
349
|
interface GoogleCloudDiscoveryengineV1alphaDocumentAclInfo {
|
|
350
|
+
/** Readers of the document. */
|
|
350
351
|
readers?: GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction[];
|
|
351
352
|
}
|
|
352
353
|
interface GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction {
|
|
@@ -380,8 +381,6 @@ declare namespace gapi.client {
|
|
|
380
381
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
381
382
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
382
383
|
name?: string;
|
|
383
|
-
/** [DEPRECATED] This field is deprecated. To specify OCR parsing config, please specify `ocr_parsing_config` in `default_parsing_config` field The OCR config. Currently it only applies to PDFs. */
|
|
384
|
-
ocrConfig?: GoogleCloudDiscoveryengineV1alphaOcrConfig;
|
|
385
384
|
/** 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 or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. */
|
|
386
385
|
parsingConfigOverrides?: {
|
|
387
386
|
[P in string]: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
@@ -422,8 +421,6 @@ declare namespace gapi.client {
|
|
|
422
421
|
interface GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest {}
|
|
423
422
|
interface GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse {}
|
|
424
423
|
interface GoogleCloudDiscoveryengineV1alphaEngine {
|
|
425
|
-
/** Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field. */
|
|
426
|
-
allowMultipleDataStoresSearchEngine?: boolean;
|
|
427
424
|
/** Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
428
425
|
chatEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig;
|
|
429
426
|
/** Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
@@ -705,6 +702,12 @@ declare namespace gapi.client {
|
|
|
705
702
|
minimum?: number;
|
|
706
703
|
}
|
|
707
704
|
interface GoogleCloudDiscoveryengineV1alphaLayoutParsingConfig {}
|
|
705
|
+
interface GoogleCloudDiscoveryengineV1alphaListChunksResponse {
|
|
706
|
+
/** The Chunks. */
|
|
707
|
+
chunks?: GoogleCloudDiscoveryengineV1alphaChunk[];
|
|
708
|
+
/** A token that can be sent as ListChunksRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
709
|
+
nextPageToken?: string;
|
|
710
|
+
}
|
|
708
711
|
interface GoogleCloudDiscoveryengineV1alphaListConversationsResponse {
|
|
709
712
|
/** All the Conversations for a given data store. */
|
|
710
713
|
conversations?: GoogleCloudDiscoveryengineV1alphaConversation[];
|
|
@@ -763,14 +766,6 @@ declare namespace gapi.client {
|
|
|
763
766
|
/** 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. */
|
|
764
767
|
mediaProgressPercentage?: number;
|
|
765
768
|
}
|
|
766
|
-
interface GoogleCloudDiscoveryengineV1alphaOcrConfig {
|
|
767
|
-
/** Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig options to apply. We will only perform OCR on the first 80 pages of the PDF files. */
|
|
768
|
-
enabled?: boolean;
|
|
769
|
-
/** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
|
|
770
|
-
enhancedDocumentElements?: string[];
|
|
771
|
-
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
772
|
-
useNativeText?: boolean;
|
|
773
|
-
}
|
|
774
769
|
interface GoogleCloudDiscoveryengineV1alphaOcrParsingConfig {
|
|
775
770
|
/** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
|
|
776
771
|
enhancedDocumentElements?: string[];
|
|
@@ -987,6 +982,8 @@ declare namespace gapi.client {
|
|
|
987
982
|
contentSearchSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
988
983
|
/** Custom fine tuning configs. */
|
|
989
984
|
customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
985
|
+
/** A list of data store specs to apply on a search call. */
|
|
986
|
+
dataStoreSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[];
|
|
990
987
|
/** Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. */
|
|
991
988
|
embeddingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec;
|
|
992
989
|
/** Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
@@ -1075,7 +1072,7 @@ declare namespace gapi.client {
|
|
|
1075
1072
|
modelPromptSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec;
|
|
1076
1073
|
/** If specified, the spec will be used to modify the model specification provided to the LLM. */
|
|
1077
1074
|
modelSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec;
|
|
1078
|
-
/** The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most
|
|
1075
|
+
/** The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results can be used to generate a summary. */
|
|
1079
1076
|
summaryResultCount?: number;
|
|
1080
1077
|
}
|
|
1081
1078
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec {
|
|
@@ -1086,6 +1083,10 @@ declare namespace gapi.client {
|
|
|
1086
1083
|
/** The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned version of the text-bison@001 model. * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English. */
|
|
1087
1084
|
version?: string;
|
|
1088
1085
|
}
|
|
1086
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
|
|
1087
|
+
/** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
|
|
1088
|
+
dataStore?: string;
|
|
1089
|
+
}
|
|
1089
1090
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec {
|
|
1090
1091
|
/** The embedding vector used for retrieval. Limit to 1. */
|
|
1091
1092
|
embeddingVectors?: GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector[];
|
|
@@ -1288,7 +1289,7 @@ declare namespace gapi.client {
|
|
|
1288
1289
|
mediaConfig?: GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig;
|
|
1289
1290
|
/** The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
|
|
1290
1291
|
modelId?: string;
|
|
1291
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
1292
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
1292
1293
|
name?: string;
|
|
1293
1294
|
/** Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
|
|
1294
1295
|
onewaySynonymsControlIds?: string[];
|
|
@@ -1902,6 +1903,20 @@ declare namespace gapi.client {
|
|
|
1902
1903
|
/** This number is an estimation on how much total quota this project needs to successfully complete indexing. */
|
|
1903
1904
|
totalRequiredQuota?: string;
|
|
1904
1905
|
}
|
|
1906
|
+
interface GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata {
|
|
1907
|
+
/** Operation create time. */
|
|
1908
|
+
createTime?: string;
|
|
1909
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1910
|
+
updateTime?: string;
|
|
1911
|
+
}
|
|
1912
|
+
interface GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse {
|
|
1913
|
+
/** Echoes the destination for the complete errors in the request if set. */
|
|
1914
|
+
errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
1915
|
+
/** A sample of errors encountered while processing the data. */
|
|
1916
|
+
errorSamples?: GoogleRpcStatus[];
|
|
1917
|
+
/** The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training is in progress. * **ready**: The model is ready for serving. */
|
|
1918
|
+
modelStatus?: string;
|
|
1919
|
+
}
|
|
1905
1920
|
interface GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata {
|
|
1906
1921
|
/** Operation create time. */
|
|
1907
1922
|
createTime?: string;
|
|
@@ -2545,6 +2560,67 @@ declare namespace gapi.client {
|
|
|
2545
2560
|
interface DataConnectorResource {
|
|
2546
2561
|
operations: OperationsResource;
|
|
2547
2562
|
}
|
|
2563
|
+
interface ChunksResource {
|
|
2564
|
+
/** Gets a Document. */
|
|
2565
|
+
get(request?: {
|
|
2566
|
+
/** V1 error format. */
|
|
2567
|
+
'$.xgafv'?: string;
|
|
2568
|
+
/** OAuth access token. */
|
|
2569
|
+
access_token?: string;
|
|
2570
|
+
/** Data format for response. */
|
|
2571
|
+
alt?: string;
|
|
2572
|
+
/** JSONP */
|
|
2573
|
+
callback?: string;
|
|
2574
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2575
|
+
fields?: string;
|
|
2576
|
+
/** 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. */
|
|
2577
|
+
key?: string;
|
|
2578
|
+
/** Required. Full resource name of Chunk, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned. */
|
|
2579
|
+
name: string;
|
|
2580
|
+
/** OAuth 2.0 token for the current user. */
|
|
2581
|
+
oauth_token?: string;
|
|
2582
|
+
/** Returns response with indentations and line breaks. */
|
|
2583
|
+
prettyPrint?: boolean;
|
|
2584
|
+
/** 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. */
|
|
2585
|
+
quotaUser?: string;
|
|
2586
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2587
|
+
upload_protocol?: string;
|
|
2588
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2589
|
+
uploadType?: string;
|
|
2590
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaChunk>;
|
|
2591
|
+
/** Gets a list of Chunks. */
|
|
2592
|
+
list(request?: {
|
|
2593
|
+
/** V1 error format. */
|
|
2594
|
+
'$.xgafv'?: string;
|
|
2595
|
+
/** OAuth access token. */
|
|
2596
|
+
access_token?: string;
|
|
2597
|
+
/** Data format for response. */
|
|
2598
|
+
alt?: string;
|
|
2599
|
+
/** JSONP */
|
|
2600
|
+
callback?: string;
|
|
2601
|
+
documentsId: string;
|
|
2602
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2603
|
+
fields?: string;
|
|
2604
|
+
/** 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. */
|
|
2605
|
+
key?: string;
|
|
2606
|
+
/** OAuth 2.0 token for the current user. */
|
|
2607
|
+
oauth_token?: string;
|
|
2608
|
+
/** Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
|
|
2609
|
+
pageSize?: number;
|
|
2610
|
+
/** A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
2611
|
+
pageToken?: string;
|
|
2612
|
+
/** Required. The parent document resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned. */
|
|
2613
|
+
parent: string;
|
|
2614
|
+
/** Returns response with indentations and line breaks. */
|
|
2615
|
+
prettyPrint?: boolean;
|
|
2616
|
+
/** 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. */
|
|
2617
|
+
quotaUser?: string;
|
|
2618
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2619
|
+
upload_protocol?: string;
|
|
2620
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2621
|
+
uploadType?: string;
|
|
2622
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaListChunksResponse>;
|
|
2623
|
+
}
|
|
2548
2624
|
interface DocumentsResource {
|
|
2549
2625
|
/** Creates a Document. */
|
|
2550
2626
|
create(request: {
|
|
@@ -2875,6 +2951,7 @@ declare namespace gapi.client {
|
|
|
2875
2951
|
},
|
|
2876
2952
|
body: GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest
|
|
2877
2953
|
): Request<GoogleLongrunningOperation>;
|
|
2954
|
+
chunks: ChunksResource;
|
|
2878
2955
|
}
|
|
2879
2956
|
interface OperationsResource {
|
|
2880
2957
|
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
@@ -3627,7 +3704,7 @@ declare namespace gapi.client {
|
|
|
3627
3704
|
fields?: string;
|
|
3628
3705
|
/** 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. */
|
|
3629
3706
|
key?: string;
|
|
3630
|
-
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/
|
|
3707
|
+
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
3631
3708
|
name: string;
|
|
3632
3709
|
/** OAuth 2.0 token for the current user. */
|
|
3633
3710
|
oauth_token?: string;
|
|
@@ -3660,7 +3737,7 @@ declare namespace gapi.client {
|
|
|
3660
3737
|
pageSize?: number;
|
|
3661
3738
|
/** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
|
|
3662
3739
|
pageToken?: string;
|
|
3663
|
-
/** Required.
|
|
3740
|
+
/** Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
3664
3741
|
parent: string;
|
|
3665
3742
|
/** Returns response with indentations and line breaks. */
|
|
3666
3743
|
prettyPrint?: boolean;
|
|
@@ -3685,7 +3762,7 @@ declare namespace gapi.client {
|
|
|
3685
3762
|
fields?: string;
|
|
3686
3763
|
/** 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. */
|
|
3687
3764
|
key?: string;
|
|
3688
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
3765
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
3689
3766
|
name: string;
|
|
3690
3767
|
/** OAuth 2.0 token for the current user. */
|
|
3691
3768
|
oauth_token?: string;
|
|
@@ -3716,7 +3793,7 @@ declare namespace gapi.client {
|
|
|
3716
3793
|
fields?: string;
|
|
3717
3794
|
/** 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. */
|
|
3718
3795
|
key?: string;
|
|
3719
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
3796
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
3720
3797
|
name: string;
|
|
3721
3798
|
/** OAuth 2.0 token for the current user. */
|
|
3722
3799
|
oauth_token?: string;
|
|
@@ -4855,7 +4932,7 @@ declare namespace gapi.client {
|
|
|
4855
4932
|
prettyPrint?: boolean;
|
|
4856
4933
|
/** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
|
|
4857
4934
|
query?: string;
|
|
4858
|
-
/** Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
|
|
4935
|
+
/** Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */
|
|
4859
4936
|
queryModel?: string;
|
|
4860
4937
|
/** 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. */
|
|
4861
4938
|
quotaUser?: string;
|
|
@@ -5611,7 +5688,7 @@ declare namespace gapi.client {
|
|
|
5611
5688
|
fields?: string;
|
|
5612
5689
|
/** 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. */
|
|
5613
5690
|
key?: string;
|
|
5614
|
-
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/
|
|
5691
|
+
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
5615
5692
|
name: string;
|
|
5616
5693
|
/** OAuth 2.0 token for the current user. */
|
|
5617
5694
|
oauth_token?: string;
|
|
@@ -5644,7 +5721,7 @@ declare namespace gapi.client {
|
|
|
5644
5721
|
pageSize?: number;
|
|
5645
5722
|
/** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
|
|
5646
5723
|
pageToken?: string;
|
|
5647
|
-
/** Required.
|
|
5724
|
+
/** Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
5648
5725
|
parent: string;
|
|
5649
5726
|
/** Returns response with indentations and line breaks. */
|
|
5650
5727
|
prettyPrint?: boolean;
|
|
@@ -5669,7 +5746,7 @@ declare namespace gapi.client {
|
|
|
5669
5746
|
fields?: string;
|
|
5670
5747
|
/** 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. */
|
|
5671
5748
|
key?: string;
|
|
5672
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
5749
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
5673
5750
|
name: string;
|
|
5674
5751
|
/** OAuth 2.0 token for the current user. */
|
|
5675
5752
|
oauth_token?: string;
|
|
@@ -5700,7 +5777,7 @@ declare namespace gapi.client {
|
|
|
5700
5777
|
fields?: string;
|
|
5701
5778
|
/** 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. */
|
|
5702
5779
|
key?: string;
|
|
5703
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
5780
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
5704
5781
|
name: string;
|
|
5705
5782
|
/** OAuth 2.0 token for the current user. */
|
|
5706
5783
|
oauth_token?: string;
|
|
@@ -6292,6 +6369,67 @@ declare namespace gapi.client {
|
|
|
6292
6369
|
engines: EnginesResource;
|
|
6293
6370
|
operations: OperationsResource;
|
|
6294
6371
|
}
|
|
6372
|
+
interface ChunksResource {
|
|
6373
|
+
/** Gets a Document. */
|
|
6374
|
+
get(request?: {
|
|
6375
|
+
/** V1 error format. */
|
|
6376
|
+
'$.xgafv'?: string;
|
|
6377
|
+
/** OAuth access token. */
|
|
6378
|
+
access_token?: string;
|
|
6379
|
+
/** Data format for response. */
|
|
6380
|
+
alt?: string;
|
|
6381
|
+
/** JSONP */
|
|
6382
|
+
callback?: string;
|
|
6383
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6384
|
+
fields?: string;
|
|
6385
|
+
/** 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. */
|
|
6386
|
+
key?: string;
|
|
6387
|
+
/** Required. Full resource name of Chunk, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned. */
|
|
6388
|
+
name: string;
|
|
6389
|
+
/** OAuth 2.0 token for the current user. */
|
|
6390
|
+
oauth_token?: string;
|
|
6391
|
+
/** Returns response with indentations and line breaks. */
|
|
6392
|
+
prettyPrint?: boolean;
|
|
6393
|
+
/** 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. */
|
|
6394
|
+
quotaUser?: string;
|
|
6395
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6396
|
+
upload_protocol?: string;
|
|
6397
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6398
|
+
uploadType?: string;
|
|
6399
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaChunk>;
|
|
6400
|
+
/** Gets a list of Chunks. */
|
|
6401
|
+
list(request?: {
|
|
6402
|
+
/** V1 error format. */
|
|
6403
|
+
'$.xgafv'?: string;
|
|
6404
|
+
/** OAuth access token. */
|
|
6405
|
+
access_token?: string;
|
|
6406
|
+
/** Data format for response. */
|
|
6407
|
+
alt?: string;
|
|
6408
|
+
/** JSONP */
|
|
6409
|
+
callback?: string;
|
|
6410
|
+
documentsId: string;
|
|
6411
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6412
|
+
fields?: string;
|
|
6413
|
+
/** 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. */
|
|
6414
|
+
key?: string;
|
|
6415
|
+
/** OAuth 2.0 token for the current user. */
|
|
6416
|
+
oauth_token?: string;
|
|
6417
|
+
/** Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
|
|
6418
|
+
pageSize?: number;
|
|
6419
|
+
/** A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
6420
|
+
pageToken?: string;
|
|
6421
|
+
/** Required. The parent document resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned. */
|
|
6422
|
+
parent: string;
|
|
6423
|
+
/** Returns response with indentations and line breaks. */
|
|
6424
|
+
prettyPrint?: boolean;
|
|
6425
|
+
/** 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. */
|
|
6426
|
+
quotaUser?: string;
|
|
6427
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6428
|
+
upload_protocol?: string;
|
|
6429
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6430
|
+
uploadType?: string;
|
|
6431
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaListChunksResponse>;
|
|
6432
|
+
}
|
|
6295
6433
|
interface DocumentsResource {
|
|
6296
6434
|
/** Creates a Document. */
|
|
6297
6435
|
create(request: {
|
|
@@ -6622,6 +6760,7 @@ declare namespace gapi.client {
|
|
|
6622
6760
|
},
|
|
6623
6761
|
body: GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest
|
|
6624
6762
|
): Request<GoogleLongrunningOperation>;
|
|
6763
|
+
chunks: ChunksResource;
|
|
6625
6764
|
}
|
|
6626
6765
|
interface OperationsResource {
|
|
6627
6766
|
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
@@ -7311,7 +7450,7 @@ declare namespace gapi.client {
|
|
|
7311
7450
|
fields?: string;
|
|
7312
7451
|
/** 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. */
|
|
7313
7452
|
key?: string;
|
|
7314
|
-
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/
|
|
7453
|
+
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
7315
7454
|
name: string;
|
|
7316
7455
|
/** OAuth 2.0 token for the current user. */
|
|
7317
7456
|
oauth_token?: string;
|
|
@@ -7344,7 +7483,7 @@ declare namespace gapi.client {
|
|
|
7344
7483
|
pageSize?: number;
|
|
7345
7484
|
/** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
|
|
7346
7485
|
pageToken?: string;
|
|
7347
|
-
/** Required.
|
|
7486
|
+
/** Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
7348
7487
|
parent: string;
|
|
7349
7488
|
/** Returns response with indentations and line breaks. */
|
|
7350
7489
|
prettyPrint?: boolean;
|
|
@@ -7369,7 +7508,7 @@ declare namespace gapi.client {
|
|
|
7369
7508
|
fields?: string;
|
|
7370
7509
|
/** 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. */
|
|
7371
7510
|
key?: string;
|
|
7372
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
7511
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
7373
7512
|
name: string;
|
|
7374
7513
|
/** OAuth 2.0 token for the current user. */
|
|
7375
7514
|
oauth_token?: string;
|
|
@@ -7400,7 +7539,7 @@ declare namespace gapi.client {
|
|
|
7400
7539
|
fields?: string;
|
|
7401
7540
|
/** 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. */
|
|
7402
7541
|
key?: string;
|
|
7403
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
7542
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
7404
7543
|
name: string;
|
|
7405
7544
|
/** OAuth 2.0 token for the current user. */
|
|
7406
7545
|
oauth_token?: string;
|
|
@@ -8324,7 +8463,7 @@ declare namespace gapi.client {
|
|
|
8324
8463
|
prettyPrint?: boolean;
|
|
8325
8464
|
/** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
|
|
8326
8465
|
query?: string;
|
|
8327
|
-
/** Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
|
|
8466
|
+
/** Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */
|
|
8328
8467
|
queryModel?: string;
|
|
8329
8468
|
/** 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. */
|
|
8330
8469
|
quotaUser?: string;
|