@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240305 → 0.0.20240312
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 +233 -62
- 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: 20240312
|
|
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;
|
|
@@ -315,7 +315,6 @@ declare namespace gapi.client {
|
|
|
315
315
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
316
316
|
updateTime?: string;
|
|
317
317
|
}
|
|
318
|
-
interface GoogleCloudDiscoveryengineV1alphaDigitalParsingConfig {}
|
|
319
318
|
interface GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata {
|
|
320
319
|
/** Operation create time. */
|
|
321
320
|
createTime?: string;
|
|
@@ -347,6 +346,7 @@ declare namespace gapi.client {
|
|
|
347
346
|
structData?: {[P in string]: any};
|
|
348
347
|
}
|
|
349
348
|
interface GoogleCloudDiscoveryengineV1alphaDocumentAclInfo {
|
|
349
|
+
/** Readers of the document. */
|
|
350
350
|
readers?: GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction[];
|
|
351
351
|
}
|
|
352
352
|
interface GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction {
|
|
@@ -380,8 +380,6 @@ declare namespace gapi.client {
|
|
|
380
380
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
381
381
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
382
382
|
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
383
|
/** 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
384
|
parsingConfigOverrides?: {
|
|
387
385
|
[P in string]: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
@@ -403,7 +401,15 @@ declare namespace gapi.client {
|
|
|
403
401
|
/** Configurations applied to layout parser. */
|
|
404
402
|
layoutParsingConfig?: any;
|
|
405
403
|
/** Configurations applied to OCR parser. Currently it only applies to PDFs. */
|
|
406
|
-
ocrParsingConfig?:
|
|
404
|
+
ocrParsingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
405
|
+
}
|
|
406
|
+
interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
407
|
+
interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {}
|
|
408
|
+
interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
409
|
+
/** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
|
|
410
|
+
enhancedDocumentElements?: string[];
|
|
411
|
+
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
412
|
+
useNativeText?: boolean;
|
|
407
413
|
}
|
|
408
414
|
interface GoogleCloudDiscoveryengineV1alphaDoubleList {
|
|
409
415
|
/** Double values. */
|
|
@@ -422,8 +428,6 @@ declare namespace gapi.client {
|
|
|
422
428
|
interface GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest {}
|
|
423
429
|
interface GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse {}
|
|
424
430
|
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
431
|
/** Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
428
432
|
chatEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig;
|
|
429
433
|
/** Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
|
|
@@ -704,7 +708,12 @@ declare namespace gapi.client {
|
|
|
704
708
|
/** Inclusive lower bound. */
|
|
705
709
|
minimum?: number;
|
|
706
710
|
}
|
|
707
|
-
interface
|
|
711
|
+
interface GoogleCloudDiscoveryengineV1alphaListChunksResponse {
|
|
712
|
+
/** The Chunks. */
|
|
713
|
+
chunks?: GoogleCloudDiscoveryengineV1alphaChunk[];
|
|
714
|
+
/** 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. */
|
|
715
|
+
nextPageToken?: string;
|
|
716
|
+
}
|
|
708
717
|
interface GoogleCloudDiscoveryengineV1alphaListConversationsResponse {
|
|
709
718
|
/** All the Conversations for a given data store. */
|
|
710
719
|
conversations?: GoogleCloudDiscoveryengineV1alphaConversation[];
|
|
@@ -763,20 +772,6 @@ declare namespace gapi.client {
|
|
|
763
772
|
/** 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
773
|
mediaProgressPercentage?: number;
|
|
765
774
|
}
|
|
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
|
-
interface GoogleCloudDiscoveryengineV1alphaOcrParsingConfig {
|
|
775
|
-
/** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
|
|
776
|
-
enhancedDocumentElements?: string[];
|
|
777
|
-
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
778
|
-
useNativeText?: boolean;
|
|
779
|
-
}
|
|
780
775
|
interface GoogleCloudDiscoveryengineV1alphaPageInfo {
|
|
781
776
|
/** 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, please 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. */
|
|
782
777
|
pageCategory?: 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. */
|
|
@@ -1031,7 +1028,7 @@ declare namespace gapi.client {
|
|
|
1031
1028
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec {
|
|
1032
1029
|
/** Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. */
|
|
1033
1030
|
boost?: number;
|
|
1034
|
-
/** An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue":
|
|
1031
|
+
/** An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` */
|
|
1035
1032
|
condition?: string;
|
|
1036
1033
|
}
|
|
1037
1034
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec {
|
|
@@ -1053,6 +1050,8 @@ declare namespace gapi.client {
|
|
|
1053
1050
|
numNextSegments?: number;
|
|
1054
1051
|
/** Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */
|
|
1055
1052
|
numPreviousSegments?: number;
|
|
1053
|
+
/** Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, please contact your Customer Engineer. The default value is `false`. */
|
|
1054
|
+
returnExtractiveSegmentScore?: boolean;
|
|
1056
1055
|
}
|
|
1057
1056
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec {
|
|
1058
1057
|
/** [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. */
|
|
@@ -1075,7 +1074,7 @@ declare namespace gapi.client {
|
|
|
1075
1074
|
modelPromptSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec;
|
|
1076
1075
|
/** If specified, the spec will be used to modify the model specification provided to the LLM. */
|
|
1077
1076
|
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
|
|
1077
|
+
/** 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
1078
|
summaryResultCount?: number;
|
|
1080
1079
|
}
|
|
1081
1080
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec {
|
|
@@ -1083,9 +1082,13 @@ declare namespace gapi.client {
|
|
|
1083
1082
|
preamble?: string;
|
|
1084
1083
|
}
|
|
1085
1084
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec {
|
|
1086
|
-
/** 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
|
|
1085
|
+
/** The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). */
|
|
1087
1086
|
version?: string;
|
|
1088
1087
|
}
|
|
1088
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
|
|
1089
|
+
/** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
|
|
1090
|
+
dataStore?: string;
|
|
1091
|
+
}
|
|
1089
1092
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec {
|
|
1090
1093
|
/** The embedding vector used for retrieval. Limit to 1. */
|
|
1091
1094
|
embeddingVectors?: GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector[];
|
|
@@ -1288,7 +1291,7 @@ declare namespace gapi.client {
|
|
|
1288
1291
|
mediaConfig?: GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig;
|
|
1289
1292
|
/** 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
1293
|
modelId?: string;
|
|
1291
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
1294
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
1292
1295
|
name?: string;
|
|
1293
1296
|
/** 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
1297
|
onewaySynonymsControlIds?: string[];
|
|
@@ -1312,8 +1315,6 @@ declare namespace gapi.client {
|
|
|
1312
1315
|
interface GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig {
|
|
1313
1316
|
/** Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. */
|
|
1314
1317
|
contentFreshnessCutoffDays?: number;
|
|
1315
|
-
/** Specifies the content watched minutes threshold for demotion. */
|
|
1316
|
-
contentWatchedMinutesThreshold?: number;
|
|
1317
1318
|
/** Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. */
|
|
1318
1319
|
contentWatchedPercentageThreshold?: number;
|
|
1319
1320
|
/** Specifies the content watched minutes threshold for demotion. */
|
|
@@ -1386,13 +1387,13 @@ declare namespace gapi.client {
|
|
|
1386
1387
|
modelType?: string;
|
|
1387
1388
|
}
|
|
1388
1389
|
interface GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput {
|
|
1389
|
-
/** The Cloud Storage corpus data which could be associated in train data. The data path format is gs
|
|
1390
|
+
/** The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}` */
|
|
1390
1391
|
corpusDataPath?: string;
|
|
1391
|
-
/** The gcs query data which could be associated in train data. The data path format is gs
|
|
1392
|
+
/** The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"} */
|
|
1392
1393
|
queryDataPath?: string;
|
|
1393
1394
|
/** Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path. */
|
|
1394
1395
|
testDataPath?: string;
|
|
1395
|
-
/** Cloud Storage training data path whose format should be gs
|
|
1396
|
+
/** Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\tcorpus-id\tscore` * `query1\tdoc1\t1` */
|
|
1396
1397
|
trainDataPath?: string;
|
|
1397
1398
|
}
|
|
1398
1399
|
interface GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse {
|
|
@@ -1504,6 +1505,8 @@ declare namespace gapi.client {
|
|
|
1504
1505
|
allowlistedDomains?: string[];
|
|
1505
1506
|
/** Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server. */
|
|
1506
1507
|
allowPublicAccess?: boolean;
|
|
1508
|
+
/** Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. */
|
|
1509
|
+
collectionComponents?: GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent[];
|
|
1507
1510
|
/** Output only. Unique obfuscated identifier of a WidgetConfig. */
|
|
1508
1511
|
configId?: string;
|
|
1509
1512
|
/** The content search spec that configs the desired behavior of content search. */
|
|
@@ -1512,6 +1515,8 @@ declare namespace gapi.client {
|
|
|
1512
1515
|
createTime?: string;
|
|
1513
1516
|
/** Output only. The type of the parent data store. */
|
|
1514
1517
|
dataStoreType?: string;
|
|
1518
|
+
/** Configurable UI configurations per data store. */
|
|
1519
|
+
dataStoreUiConfigs?: GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig[];
|
|
1515
1520
|
/** Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
1516
1521
|
displayName?: string;
|
|
1517
1522
|
/** Whether or not to enable autocomplete. */
|
|
@@ -1551,6 +1556,36 @@ declare namespace gapi.client {
|
|
|
1551
1556
|
/** Output only. Timestamp the WidgetConfig was updated. */
|
|
1552
1557
|
updateTime?: string;
|
|
1553
1558
|
}
|
|
1559
|
+
interface GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent {
|
|
1560
|
+
/** For the data store collection, list of the children data stores. */
|
|
1561
|
+
dataStoreComponents?: GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent[];
|
|
1562
|
+
/** The display name of the collection. */
|
|
1563
|
+
displayName?: string;
|
|
1564
|
+
/** Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. */
|
|
1565
|
+
id?: string;
|
|
1566
|
+
/** The name of the collection. It should be collection resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection_id}`. For widget service usage, such look up widget config, returned name should be skipped. */
|
|
1567
|
+
name?: string;
|
|
1568
|
+
}
|
|
1569
|
+
interface GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent {
|
|
1570
|
+
/** The display name of the data store. */
|
|
1571
|
+
displayName?: string;
|
|
1572
|
+
/** Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. */
|
|
1573
|
+
id?: string;
|
|
1574
|
+
/** The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For widget service usage, such look up widget config, returned name should be skipped. */
|
|
1575
|
+
name?: string;
|
|
1576
|
+
}
|
|
1577
|
+
interface GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig {
|
|
1578
|
+
/** Facet fields that store the mapping of fields to end user widget appearance. */
|
|
1579
|
+
facetField?: GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[];
|
|
1580
|
+
/** The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed. */
|
|
1581
|
+
fieldsUiComponentsMap?: {
|
|
1582
|
+
[P in string]: GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
|
|
1583
|
+
};
|
|
1584
|
+
/** Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. */
|
|
1585
|
+
id?: string;
|
|
1586
|
+
/** The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For widget service usage, such look up widget config, returned name should be skipped. */
|
|
1587
|
+
name?: string;
|
|
1588
|
+
}
|
|
1554
1589
|
interface GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField {
|
|
1555
1590
|
/** Optional. The field name that end users will see. */
|
|
1556
1591
|
displayName?: string;
|
|
@@ -1685,7 +1720,6 @@ declare namespace gapi.client {
|
|
|
1685
1720
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1686
1721
|
updateTime?: string;
|
|
1687
1722
|
}
|
|
1688
|
-
interface GoogleCloudDiscoveryengineV1betaDigitalParsingConfig {}
|
|
1689
1723
|
interface GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata {
|
|
1690
1724
|
/** Operation create time. */
|
|
1691
1725
|
createTime?: string;
|
|
@@ -1707,7 +1741,14 @@ declare namespace gapi.client {
|
|
|
1707
1741
|
/** Configurations applied to digital parser. */
|
|
1708
1742
|
digitalParsingConfig?: any;
|
|
1709
1743
|
/** Configurations applied to OCR parser. Currently it only applies to PDFs. */
|
|
1710
|
-
ocrParsingConfig?:
|
|
1744
|
+
ocrParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
1745
|
+
}
|
|
1746
|
+
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
1747
|
+
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
1748
|
+
/** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
|
|
1749
|
+
enhancedDocumentElements?: string[];
|
|
1750
|
+
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
1751
|
+
useNativeText?: boolean;
|
|
1711
1752
|
}
|
|
1712
1753
|
interface GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata {
|
|
1713
1754
|
/** Operation create time. */
|
|
@@ -1824,12 +1865,6 @@ declare namespace gapi.client {
|
|
|
1824
1865
|
/** Count of user events imported, but with Document information not found in the existing Branch. */
|
|
1825
1866
|
unjoinedEventsCount?: string;
|
|
1826
1867
|
}
|
|
1827
|
-
interface GoogleCloudDiscoveryengineV1betaOcrParsingConfig {
|
|
1828
|
-
/** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
|
|
1829
|
-
enhancedDocumentElements?: string[];
|
|
1830
|
-
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
1831
|
-
useNativeText?: boolean;
|
|
1832
|
-
}
|
|
1833
1868
|
interface GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata {
|
|
1834
1869
|
/** Operation create time. */
|
|
1835
1870
|
createTime?: string;
|
|
@@ -1902,6 +1937,20 @@ declare namespace gapi.client {
|
|
|
1902
1937
|
/** This number is an estimation on how much total quota this project needs to successfully complete indexing. */
|
|
1903
1938
|
totalRequiredQuota?: string;
|
|
1904
1939
|
}
|
|
1940
|
+
interface GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata {
|
|
1941
|
+
/** Operation create time. */
|
|
1942
|
+
createTime?: string;
|
|
1943
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1944
|
+
updateTime?: string;
|
|
1945
|
+
}
|
|
1946
|
+
interface GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse {
|
|
1947
|
+
/** Echoes the destination for the complete errors in the request if set. */
|
|
1948
|
+
errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
1949
|
+
/** A sample of errors encountered while processing the data. */
|
|
1950
|
+
errorSamples?: GoogleRpcStatus[];
|
|
1951
|
+
/** 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. */
|
|
1952
|
+
modelStatus?: string;
|
|
1953
|
+
}
|
|
1905
1954
|
interface GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata {
|
|
1906
1955
|
/** Operation create time. */
|
|
1907
1956
|
createTime?: string;
|
|
@@ -1982,7 +2031,6 @@ declare namespace gapi.client {
|
|
|
1982
2031
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1983
2032
|
updateTime?: string;
|
|
1984
2033
|
}
|
|
1985
|
-
interface GoogleCloudDiscoveryengineV1DigitalParsingConfig {}
|
|
1986
2034
|
interface GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata {
|
|
1987
2035
|
/** Operation create time. */
|
|
1988
2036
|
createTime?: string;
|
|
@@ -2004,7 +2052,14 @@ declare namespace gapi.client {
|
|
|
2004
2052
|
/** Configurations applied to digital parser. */
|
|
2005
2053
|
digitalParsingConfig?: any;
|
|
2006
2054
|
/** Configurations applied to OCR parser. Currently it only applies to PDFs. */
|
|
2007
|
-
ocrParsingConfig?:
|
|
2055
|
+
ocrParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig;
|
|
2056
|
+
}
|
|
2057
|
+
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
2058
|
+
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
2059
|
+
/** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
|
|
2060
|
+
enhancedDocumentElements?: string[];
|
|
2061
|
+
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
2062
|
+
useNativeText?: boolean;
|
|
2008
2063
|
}
|
|
2009
2064
|
interface GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata {
|
|
2010
2065
|
/** Operation create time. */
|
|
@@ -2121,12 +2176,6 @@ declare namespace gapi.client {
|
|
|
2121
2176
|
/** Count of user events imported, but with Document information not found in the existing Branch. */
|
|
2122
2177
|
unjoinedEventsCount?: string;
|
|
2123
2178
|
}
|
|
2124
|
-
interface GoogleCloudDiscoveryengineV1OcrParsingConfig {
|
|
2125
|
-
/** Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model. */
|
|
2126
|
-
enhancedDocumentElements?: string[];
|
|
2127
|
-
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
2128
|
-
useNativeText?: boolean;
|
|
2129
|
-
}
|
|
2130
2179
|
interface GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata {
|
|
2131
2180
|
/** Operation create time. */
|
|
2132
2181
|
createTime?: string;
|
|
@@ -2545,6 +2594,66 @@ declare namespace gapi.client {
|
|
|
2545
2594
|
interface DataConnectorResource {
|
|
2546
2595
|
operations: OperationsResource;
|
|
2547
2596
|
}
|
|
2597
|
+
interface ChunksResource {
|
|
2598
|
+
/** Gets a Document. */
|
|
2599
|
+
get(request?: {
|
|
2600
|
+
/** V1 error format. */
|
|
2601
|
+
'$.xgafv'?: string;
|
|
2602
|
+
/** OAuth access token. */
|
|
2603
|
+
access_token?: string;
|
|
2604
|
+
/** Data format for response. */
|
|
2605
|
+
alt?: string;
|
|
2606
|
+
/** JSONP */
|
|
2607
|
+
callback?: string;
|
|
2608
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2609
|
+
fields?: string;
|
|
2610
|
+
/** 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. */
|
|
2611
|
+
key?: string;
|
|
2612
|
+
/** 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. */
|
|
2613
|
+
name: string;
|
|
2614
|
+
/** OAuth 2.0 token for the current user. */
|
|
2615
|
+
oauth_token?: string;
|
|
2616
|
+
/** Returns response with indentations and line breaks. */
|
|
2617
|
+
prettyPrint?: boolean;
|
|
2618
|
+
/** 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. */
|
|
2619
|
+
quotaUser?: string;
|
|
2620
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2621
|
+
upload_protocol?: string;
|
|
2622
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2623
|
+
uploadType?: string;
|
|
2624
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaChunk>;
|
|
2625
|
+
/** Gets a list of Chunks. */
|
|
2626
|
+
list(request?: {
|
|
2627
|
+
/** V1 error format. */
|
|
2628
|
+
'$.xgafv'?: string;
|
|
2629
|
+
/** OAuth access token. */
|
|
2630
|
+
access_token?: string;
|
|
2631
|
+
/** Data format for response. */
|
|
2632
|
+
alt?: string;
|
|
2633
|
+
/** JSONP */
|
|
2634
|
+
callback?: string;
|
|
2635
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2636
|
+
fields?: string;
|
|
2637
|
+
/** 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. */
|
|
2638
|
+
key?: string;
|
|
2639
|
+
/** OAuth 2.0 token for the current user. */
|
|
2640
|
+
oauth_token?: string;
|
|
2641
|
+
/** 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. */
|
|
2642
|
+
pageSize?: number;
|
|
2643
|
+
/** 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. */
|
|
2644
|
+
pageToken?: string;
|
|
2645
|
+
/** 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. */
|
|
2646
|
+
parent: string;
|
|
2647
|
+
/** Returns response with indentations and line breaks. */
|
|
2648
|
+
prettyPrint?: boolean;
|
|
2649
|
+
/** 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. */
|
|
2650
|
+
quotaUser?: string;
|
|
2651
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2652
|
+
upload_protocol?: string;
|
|
2653
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2654
|
+
uploadType?: string;
|
|
2655
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaListChunksResponse>;
|
|
2656
|
+
}
|
|
2548
2657
|
interface DocumentsResource {
|
|
2549
2658
|
/** Creates a Document. */
|
|
2550
2659
|
create(request: {
|
|
@@ -2875,6 +2984,7 @@ declare namespace gapi.client {
|
|
|
2875
2984
|
},
|
|
2876
2985
|
body: GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest
|
|
2877
2986
|
): Request<GoogleLongrunningOperation>;
|
|
2987
|
+
chunks: ChunksResource;
|
|
2878
2988
|
}
|
|
2879
2989
|
interface OperationsResource {
|
|
2880
2990
|
/** 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 +3737,7 @@ declare namespace gapi.client {
|
|
|
3627
3737
|
fields?: string;
|
|
3628
3738
|
/** 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
3739
|
key?: string;
|
|
3630
|
-
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/
|
|
3740
|
+
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
3631
3741
|
name: string;
|
|
3632
3742
|
/** OAuth 2.0 token for the current user. */
|
|
3633
3743
|
oauth_token?: string;
|
|
@@ -3660,7 +3770,7 @@ declare namespace gapi.client {
|
|
|
3660
3770
|
pageSize?: number;
|
|
3661
3771
|
/** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
|
|
3662
3772
|
pageToken?: string;
|
|
3663
|
-
/** Required.
|
|
3773
|
+
/** Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
3664
3774
|
parent: string;
|
|
3665
3775
|
/** Returns response with indentations and line breaks. */
|
|
3666
3776
|
prettyPrint?: boolean;
|
|
@@ -3685,7 +3795,7 @@ declare namespace gapi.client {
|
|
|
3685
3795
|
fields?: string;
|
|
3686
3796
|
/** 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
3797
|
key?: string;
|
|
3688
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
3798
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
3689
3799
|
name: string;
|
|
3690
3800
|
/** OAuth 2.0 token for the current user. */
|
|
3691
3801
|
oauth_token?: string;
|
|
@@ -3716,7 +3826,7 @@ declare namespace gapi.client {
|
|
|
3716
3826
|
fields?: string;
|
|
3717
3827
|
/** 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
3828
|
key?: string;
|
|
3719
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
3829
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
3720
3830
|
name: string;
|
|
3721
3831
|
/** OAuth 2.0 token for the current user. */
|
|
3722
3832
|
oauth_token?: string;
|
|
@@ -4855,7 +4965,7 @@ declare namespace gapi.client {
|
|
|
4855
4965
|
prettyPrint?: boolean;
|
|
4856
4966
|
/** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
|
|
4857
4967
|
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.
|
|
4968
|
+
/** 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
4969
|
queryModel?: string;
|
|
4860
4970
|
/** 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
4971
|
quotaUser?: string;
|
|
@@ -5611,7 +5721,7 @@ declare namespace gapi.client {
|
|
|
5611
5721
|
fields?: string;
|
|
5612
5722
|
/** 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
5723
|
key?: string;
|
|
5614
|
-
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/
|
|
5724
|
+
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
5615
5725
|
name: string;
|
|
5616
5726
|
/** OAuth 2.0 token for the current user. */
|
|
5617
5727
|
oauth_token?: string;
|
|
@@ -5644,7 +5754,7 @@ declare namespace gapi.client {
|
|
|
5644
5754
|
pageSize?: number;
|
|
5645
5755
|
/** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
|
|
5646
5756
|
pageToken?: string;
|
|
5647
|
-
/** Required.
|
|
5757
|
+
/** Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
5648
5758
|
parent: string;
|
|
5649
5759
|
/** Returns response with indentations and line breaks. */
|
|
5650
5760
|
prettyPrint?: boolean;
|
|
@@ -5669,7 +5779,7 @@ declare namespace gapi.client {
|
|
|
5669
5779
|
fields?: string;
|
|
5670
5780
|
/** 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
5781
|
key?: string;
|
|
5672
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
5782
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
5673
5783
|
name: string;
|
|
5674
5784
|
/** OAuth 2.0 token for the current user. */
|
|
5675
5785
|
oauth_token?: string;
|
|
@@ -5700,7 +5810,7 @@ declare namespace gapi.client {
|
|
|
5700
5810
|
fields?: string;
|
|
5701
5811
|
/** 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
5812
|
key?: string;
|
|
5703
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
5813
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
5704
5814
|
name: string;
|
|
5705
5815
|
/** OAuth 2.0 token for the current user. */
|
|
5706
5816
|
oauth_token?: string;
|
|
@@ -6292,6 +6402,66 @@ declare namespace gapi.client {
|
|
|
6292
6402
|
engines: EnginesResource;
|
|
6293
6403
|
operations: OperationsResource;
|
|
6294
6404
|
}
|
|
6405
|
+
interface ChunksResource {
|
|
6406
|
+
/** Gets a Document. */
|
|
6407
|
+
get(request?: {
|
|
6408
|
+
/** V1 error format. */
|
|
6409
|
+
'$.xgafv'?: string;
|
|
6410
|
+
/** OAuth access token. */
|
|
6411
|
+
access_token?: string;
|
|
6412
|
+
/** Data format for response. */
|
|
6413
|
+
alt?: string;
|
|
6414
|
+
/** JSONP */
|
|
6415
|
+
callback?: string;
|
|
6416
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6417
|
+
fields?: string;
|
|
6418
|
+
/** 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. */
|
|
6419
|
+
key?: string;
|
|
6420
|
+
/** 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. */
|
|
6421
|
+
name: string;
|
|
6422
|
+
/** OAuth 2.0 token for the current user. */
|
|
6423
|
+
oauth_token?: string;
|
|
6424
|
+
/** Returns response with indentations and line breaks. */
|
|
6425
|
+
prettyPrint?: boolean;
|
|
6426
|
+
/** 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. */
|
|
6427
|
+
quotaUser?: string;
|
|
6428
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6429
|
+
upload_protocol?: string;
|
|
6430
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6431
|
+
uploadType?: string;
|
|
6432
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaChunk>;
|
|
6433
|
+
/** Gets a list of Chunks. */
|
|
6434
|
+
list(request?: {
|
|
6435
|
+
/** V1 error format. */
|
|
6436
|
+
'$.xgafv'?: string;
|
|
6437
|
+
/** OAuth access token. */
|
|
6438
|
+
access_token?: string;
|
|
6439
|
+
/** Data format for response. */
|
|
6440
|
+
alt?: string;
|
|
6441
|
+
/** JSONP */
|
|
6442
|
+
callback?: string;
|
|
6443
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6444
|
+
fields?: string;
|
|
6445
|
+
/** 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. */
|
|
6446
|
+
key?: string;
|
|
6447
|
+
/** OAuth 2.0 token for the current user. */
|
|
6448
|
+
oauth_token?: string;
|
|
6449
|
+
/** 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. */
|
|
6450
|
+
pageSize?: number;
|
|
6451
|
+
/** 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. */
|
|
6452
|
+
pageToken?: string;
|
|
6453
|
+
/** 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. */
|
|
6454
|
+
parent: string;
|
|
6455
|
+
/** Returns response with indentations and line breaks. */
|
|
6456
|
+
prettyPrint?: boolean;
|
|
6457
|
+
/** 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. */
|
|
6458
|
+
quotaUser?: string;
|
|
6459
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6460
|
+
upload_protocol?: string;
|
|
6461
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6462
|
+
uploadType?: string;
|
|
6463
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaListChunksResponse>;
|
|
6464
|
+
}
|
|
6295
6465
|
interface DocumentsResource {
|
|
6296
6466
|
/** Creates a Document. */
|
|
6297
6467
|
create(request: {
|
|
@@ -6622,6 +6792,7 @@ declare namespace gapi.client {
|
|
|
6622
6792
|
},
|
|
6623
6793
|
body: GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest
|
|
6624
6794
|
): Request<GoogleLongrunningOperation>;
|
|
6795
|
+
chunks: ChunksResource;
|
|
6625
6796
|
}
|
|
6626
6797
|
interface OperationsResource {
|
|
6627
6798
|
/** 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 +7482,7 @@ declare namespace gapi.client {
|
|
|
7311
7482
|
fields?: string;
|
|
7312
7483
|
/** 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
7484
|
key?: string;
|
|
7314
|
-
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/
|
|
7485
|
+
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
7315
7486
|
name: string;
|
|
7316
7487
|
/** OAuth 2.0 token for the current user. */
|
|
7317
7488
|
oauth_token?: string;
|
|
@@ -7344,7 +7515,7 @@ declare namespace gapi.client {
|
|
|
7344
7515
|
pageSize?: number;
|
|
7345
7516
|
/** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
|
|
7346
7517
|
pageToken?: string;
|
|
7347
|
-
/** Required.
|
|
7518
|
+
/** Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
7348
7519
|
parent: string;
|
|
7349
7520
|
/** Returns response with indentations and line breaks. */
|
|
7350
7521
|
prettyPrint?: boolean;
|
|
@@ -7369,7 +7540,7 @@ declare namespace gapi.client {
|
|
|
7369
7540
|
fields?: string;
|
|
7370
7541
|
/** 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
7542
|
key?: string;
|
|
7372
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
7543
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
7373
7544
|
name: string;
|
|
7374
7545
|
/** OAuth 2.0 token for the current user. */
|
|
7375
7546
|
oauth_token?: string;
|
|
@@ -7400,7 +7571,7 @@ declare namespace gapi.client {
|
|
|
7400
7571
|
fields?: string;
|
|
7401
7572
|
/** 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
7573
|
key?: string;
|
|
7403
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/
|
|
7574
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
7404
7575
|
name: string;
|
|
7405
7576
|
/** OAuth 2.0 token for the current user. */
|
|
7406
7577
|
oauth_token?: string;
|
|
@@ -8324,7 +8495,7 @@ declare namespace gapi.client {
|
|
|
8324
8495
|
prettyPrint?: boolean;
|
|
8325
8496
|
/** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
|
|
8326
8497
|
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.
|
|
8498
|
+
/** 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
8499
|
queryModel?: string;
|
|
8329
8500
|
/** 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
8501
|
quotaUser?: string;
|