@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240409 → 0.0.20240415
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 +323 -52
- package/package.json +1 -1
- package/readme.md +17 -0
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: 20240415
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -103,7 +103,7 @@ declare namespace gapi.client {
|
|
|
103
103
|
completeTime?: string;
|
|
104
104
|
/** Output only. Answer creation timestamp. */
|
|
105
105
|
createTime?: string;
|
|
106
|
-
/** Immutable. Fully qualified name `project
|
|
106
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*` */
|
|
107
107
|
name?: string;
|
|
108
108
|
/** Query understanding information. */
|
|
109
109
|
queryUnderstandingInfo?: GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo;
|
|
@@ -183,7 +183,7 @@ declare namespace gapi.client {
|
|
|
183
183
|
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec {
|
|
184
184
|
/** Disable query rephraser. */
|
|
185
185
|
disable?: boolean;
|
|
186
|
-
/** Max rephrase steps. The max number is
|
|
186
|
+
/** Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default. */
|
|
187
187
|
maxRephraseSteps?: number;
|
|
188
188
|
}
|
|
189
189
|
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec {
|
|
@@ -203,6 +203,8 @@ declare namespace gapi.client {
|
|
|
203
203
|
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams {
|
|
204
204
|
/** Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) */
|
|
205
205
|
boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
206
|
+
/** Custom fine tuning configs. */
|
|
207
|
+
customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
206
208
|
/** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
|
|
207
209
|
filter?: string;
|
|
208
210
|
/** Number of search results to return. The default value is 10. */
|
|
@@ -263,6 +265,8 @@ declare namespace gapi.client {
|
|
|
263
265
|
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse {
|
|
264
266
|
/** Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. */
|
|
265
267
|
answer?: GoogleCloudDiscoveryengineV1alphaAnswer;
|
|
268
|
+
/** A global unique ID used for logging. */
|
|
269
|
+
answerQueryToken?: string;
|
|
266
270
|
/** Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request. */
|
|
267
271
|
session?: GoogleCloudDiscoveryengineV1alphaSession;
|
|
268
272
|
}
|
|
@@ -458,7 +462,7 @@ declare namespace gapi.client {
|
|
|
458
462
|
claimText?: string;
|
|
459
463
|
/** Position indicating the end of the claim in the answer candidate, exclusive. */
|
|
460
464
|
endPos?: number;
|
|
461
|
-
/** Position indicating the start of the claim in the answer candidate, measured in bytes
|
|
465
|
+
/** Position indicating the start of the claim in the answer candidate, measured in bytes. */
|
|
462
466
|
startPos?: number;
|
|
463
467
|
}
|
|
464
468
|
interface GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec {
|
|
@@ -488,6 +492,8 @@ declare namespace gapi.client {
|
|
|
488
492
|
previousChunks?: GoogleCloudDiscoveryengineV1alphaChunk[];
|
|
489
493
|
}
|
|
490
494
|
interface GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata {
|
|
495
|
+
/** Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */
|
|
496
|
+
structData?: {[P in string]: any};
|
|
491
497
|
/** Title of the document. */
|
|
492
498
|
title?: string;
|
|
493
499
|
/** Uri of the document. */
|
|
@@ -502,7 +508,7 @@ declare namespace gapi.client {
|
|
|
502
508
|
interface GoogleCloudDiscoveryengineV1alphaCloudSqlSource {
|
|
503
509
|
/** Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. */
|
|
504
510
|
databaseId?: string;
|
|
505
|
-
/** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory.
|
|
511
|
+
/** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
|
|
506
512
|
gcsStagingDir?: string;
|
|
507
513
|
/** Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. */
|
|
508
514
|
instanceId?: string;
|
|
@@ -548,7 +554,7 @@ declare namespace gapi.client {
|
|
|
548
554
|
endTime?: string;
|
|
549
555
|
/** Conversation messages. */
|
|
550
556
|
messages?: GoogleCloudDiscoveryengineV1alphaConversationMessage[];
|
|
551
|
-
/** Immutable. Fully qualified name `project
|
|
557
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. */
|
|
552
558
|
name?: string;
|
|
553
559
|
/** Output only. The time the conversation started. */
|
|
554
560
|
startTime?: string;
|
|
@@ -780,7 +786,7 @@ declare namespace gapi.client {
|
|
|
780
786
|
interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
781
787
|
interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {}
|
|
782
788
|
interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
783
|
-
/**
|
|
789
|
+
/** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
|
|
784
790
|
enhancedDocumentElements?: string[];
|
|
785
791
|
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
786
792
|
useNativeText?: boolean;
|
|
@@ -834,7 +840,7 @@ declare namespace gapi.client {
|
|
|
834
840
|
interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig {
|
|
835
841
|
/** The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. */
|
|
836
842
|
agentCreationConfig?: GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
|
|
837
|
-
/** The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
|
|
843
|
+
/** The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
|
|
838
844
|
dialogflowAgentToLink?: string;
|
|
839
845
|
}
|
|
840
846
|
interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig {
|
|
@@ -884,7 +890,7 @@ declare namespace gapi.client {
|
|
|
884
890
|
interface GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
|
|
885
891
|
/** The add-on that this search engine enables. */
|
|
886
892
|
searchAddOns?: string[];
|
|
887
|
-
/** The search feature tier of this engine. Different tiers might have different pricing. To learn more,
|
|
893
|
+
/** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
|
|
888
894
|
searchTier?: string;
|
|
889
895
|
}
|
|
890
896
|
interface GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig {}
|
|
@@ -945,6 +951,8 @@ declare namespace gapi.client {
|
|
|
945
951
|
gcsStagingDir?: string;
|
|
946
952
|
}
|
|
947
953
|
interface GoogleCloudDiscoveryengineV1alphaFieldConfig {
|
|
954
|
+
/** If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``. */
|
|
955
|
+
advancedSiteSearchDataSources?: string[];
|
|
948
956
|
/** If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error. */
|
|
949
957
|
completableOption?: string;
|
|
950
958
|
/** If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error. */
|
|
@@ -969,7 +977,7 @@ declare namespace gapi.client {
|
|
|
969
977
|
collectionId?: string;
|
|
970
978
|
/** Required. The Firestore database to copy the data from with a length limit of 256 characters. */
|
|
971
979
|
databaseId?: string;
|
|
972
|
-
/** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory.
|
|
980
|
+
/** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
|
|
973
981
|
gcsStagingDir?: string;
|
|
974
982
|
/** The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
|
|
975
983
|
projectId?: string;
|
|
@@ -1004,20 +1012,6 @@ declare namespace gapi.client {
|
|
|
1004
1012
|
/** Workforce pool name. Example: "locations/global/workforcePools/pool_id" */
|
|
1005
1013
|
workforcePoolName?: string;
|
|
1006
1014
|
}
|
|
1007
|
-
interface GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata {
|
|
1008
|
-
/** Operation create time. */
|
|
1009
|
-
createTime?: string;
|
|
1010
|
-
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1011
|
-
updateTime?: string;
|
|
1012
|
-
}
|
|
1013
|
-
interface GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse {
|
|
1014
|
-
/** A sample of errors encountered while processing the request. */
|
|
1015
|
-
errorSamples?: GoogleRpcStatus[];
|
|
1016
|
-
/** Count of CompletionSuggestions that failed to be imported. */
|
|
1017
|
-
failureCount?: string;
|
|
1018
|
-
/** Count of CompletionSuggestions successfully imported. */
|
|
1019
|
-
successCount?: string;
|
|
1020
|
-
}
|
|
1021
1015
|
interface GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata {
|
|
1022
1016
|
/** Operation create time. */
|
|
1023
1017
|
createTime?: string;
|
|
@@ -1211,7 +1205,7 @@ declare namespace gapi.client {
|
|
|
1211
1205
|
mediaProgressPercentage?: number;
|
|
1212
1206
|
}
|
|
1213
1207
|
interface GoogleCloudDiscoveryengineV1alphaPageInfo {
|
|
1214
|
-
/** 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,
|
|
1208
|
+
/** 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. */
|
|
1215
1209
|
pageCategory?: string;
|
|
1216
1210
|
/** A unique ID of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The `pageview_id` property should be kept the same for all these events so that they can be grouped together properly. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. */
|
|
1217
1211
|
pageviewId?: string;
|
|
@@ -1243,6 +1237,37 @@ declare namespace gapi.client {
|
|
|
1243
1237
|
/** The JSON string representation of the processed document. */
|
|
1244
1238
|
jsonData?: string;
|
|
1245
1239
|
}
|
|
1240
|
+
interface GoogleCloudDiscoveryengineV1alphaProject {
|
|
1241
|
+
/** Output only. The timestamp when this project is created. */
|
|
1242
|
+
createTime?: string;
|
|
1243
|
+
/** Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */
|
|
1244
|
+
name?: string;
|
|
1245
|
+
/** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
|
|
1246
|
+
provisionCompletionTime?: string;
|
|
1247
|
+
/** Output only. A map of terms of services. The key is the `id` of ServiceTerms. */
|
|
1248
|
+
serviceTermsMap?: {
|
|
1249
|
+
[P in string]: GoogleCloudDiscoveryengineV1alphaProjectServiceTerms;
|
|
1250
|
+
};
|
|
1251
|
+
}
|
|
1252
|
+
interface GoogleCloudDiscoveryengineV1alphaProjectServiceTerms {
|
|
1253
|
+
/** The last time when the project agreed to the terms of service. */
|
|
1254
|
+
acceptTime?: string;
|
|
1255
|
+
/** The last time when the project declined or revoked the agreement to terms of service. */
|
|
1256
|
+
declineTime?: string;
|
|
1257
|
+
/** The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`. */
|
|
1258
|
+
id?: string;
|
|
1259
|
+
/** Whether the project has accepted/rejected the service terms or it is still pending. */
|
|
1260
|
+
state?: string;
|
|
1261
|
+
/** The version string of the terms of service. For acceptable values, see the comments for id above. */
|
|
1262
|
+
version?: string;
|
|
1263
|
+
}
|
|
1264
|
+
interface GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata {}
|
|
1265
|
+
interface GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest {
|
|
1266
|
+
/** Required. Set to `true` to specify that caller has read and would like to give consent to the [Terms for data use](https://cloud.google.com/retail/data-use-terms). */
|
|
1267
|
+
acceptDataUseTerms?: boolean;
|
|
1268
|
+
/** Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time. */
|
|
1269
|
+
dataUseTermsVersion?: string;
|
|
1270
|
+
}
|
|
1246
1271
|
interface GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata {
|
|
1247
1272
|
/** Operation create time. */
|
|
1248
1273
|
createTime?: string;
|
|
@@ -1331,7 +1356,7 @@ declare namespace gapi.client {
|
|
|
1331
1356
|
model?: string;
|
|
1332
1357
|
/** The query to use. */
|
|
1333
1358
|
query?: string;
|
|
1334
|
-
/** Required. A list of records to rank. At most
|
|
1359
|
+
/** Required. A list of records to rank. At most 200 records to rank. */
|
|
1335
1360
|
records?: GoogleCloudDiscoveryengineV1alphaRankingRecord[];
|
|
1336
1361
|
/** The number of results to return. If this is unset or no bigger than zero, returns all results. */
|
|
1337
1362
|
topN?: number;
|
|
@@ -1428,6 +1453,14 @@ declare namespace gapi.client {
|
|
|
1428
1453
|
/** URI link reference. */
|
|
1429
1454
|
uri?: string;
|
|
1430
1455
|
}
|
|
1456
|
+
interface GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest {
|
|
1457
|
+
/** Required. Whether customer decides to accept or decline service term. At this moment, only accept action is supported. */
|
|
1458
|
+
consentChangeAction?: string;
|
|
1459
|
+
/** Required. The unique identifier of the terms of service to update. Available term ids: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this service term id, the acceptable service_term_version to provide is `2022-11-23`. */
|
|
1460
|
+
serviceTermId?: string;
|
|
1461
|
+
/** Required. The version string of the terms of service to update. */
|
|
1462
|
+
serviceTermVersion?: string;
|
|
1463
|
+
}
|
|
1431
1464
|
interface GoogleCloudDiscoveryengineV1alphaResumeEngineRequest {}
|
|
1432
1465
|
interface GoogleCloudDiscoveryengineV1alphaSchema {
|
|
1433
1466
|
/** Output only. Configurations for fields of the schema. */
|
|
@@ -1552,7 +1585,7 @@ declare namespace gapi.client {
|
|
|
1552
1585
|
numNextSegments?: number;
|
|
1553
1586
|
/** Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */
|
|
1554
1587
|
numPreviousSegments?: number;
|
|
1555
|
-
/** 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,
|
|
1588
|
+
/** 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, contact your Customer Engineer. The default value is `false`. */
|
|
1556
1589
|
returnExtractiveSegmentScore?: boolean;
|
|
1557
1590
|
}
|
|
1558
1591
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec {
|
|
@@ -1576,9 +1609,9 @@ declare namespace gapi.client {
|
|
|
1576
1609
|
modelPromptSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec;
|
|
1577
1610
|
/** If specified, the spec will be used to modify the model specification provided to the LLM. */
|
|
1578
1611
|
modelSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec;
|
|
1579
|
-
/** 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. */
|
|
1612
|
+
/** 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 for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. */
|
|
1580
1613
|
summaryResultCount?: number;
|
|
1581
|
-
/** If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality.
|
|
1614
|
+
/** If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list. */
|
|
1582
1615
|
useSemanticChunks?: boolean;
|
|
1583
1616
|
}
|
|
1584
1617
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec {
|
|
@@ -1837,7 +1870,7 @@ declare namespace gapi.client {
|
|
|
1837
1870
|
interface GoogleCloudDiscoveryengineV1alphaSession {
|
|
1838
1871
|
/** Output only. The time the session finished. */
|
|
1839
1872
|
endTime?: string;
|
|
1840
|
-
/** Immutable. Fully qualified name `project
|
|
1873
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
1841
1874
|
name?: string;
|
|
1842
1875
|
/** Output only. The time the session started. */
|
|
1843
1876
|
startTime?: string;
|
|
@@ -2293,7 +2326,7 @@ declare namespace gapi.client {
|
|
|
2293
2326
|
}
|
|
2294
2327
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
2295
2328
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
2296
|
-
/**
|
|
2329
|
+
/** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
|
|
2297
2330
|
enhancedDocumentElements?: string[];
|
|
2298
2331
|
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
2299
2332
|
useNativeText?: boolean;
|
|
@@ -2332,7 +2365,7 @@ declare namespace gapi.client {
|
|
|
2332
2365
|
interface GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig {
|
|
2333
2366
|
/** The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. */
|
|
2334
2367
|
agentCreationConfig?: GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig;
|
|
2335
|
-
/** The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
|
|
2368
|
+
/** The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
|
|
2336
2369
|
dialogflowAgentToLink?: string;
|
|
2337
2370
|
}
|
|
2338
2371
|
interface GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig {
|
|
@@ -2356,7 +2389,7 @@ declare namespace gapi.client {
|
|
|
2356
2389
|
interface GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
|
|
2357
2390
|
/** The add-on that this search engine enables. */
|
|
2358
2391
|
searchAddOns?: string[];
|
|
2359
|
-
/** The search feature tier of this engine. Different tiers might have different pricing. To learn more,
|
|
2392
|
+
/** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
|
|
2360
2393
|
searchTier?: string;
|
|
2361
2394
|
}
|
|
2362
2395
|
interface GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata {
|
|
@@ -2507,6 +2540,7 @@ declare namespace gapi.client {
|
|
|
2507
2540
|
/** Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
|
|
2508
2541
|
engine?: string;
|
|
2509
2542
|
}
|
|
2543
|
+
interface GoogleCloudDiscoveryengineV1betaTuneEngineResponse {}
|
|
2510
2544
|
interface GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata {
|
|
2511
2545
|
/** Operation create time. */
|
|
2512
2546
|
createTime?: string;
|
|
@@ -2612,7 +2646,7 @@ declare namespace gapi.client {
|
|
|
2612
2646
|
}
|
|
2613
2647
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
2614
2648
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
2615
|
-
/**
|
|
2649
|
+
/** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
|
|
2616
2650
|
enhancedDocumentElements?: string[];
|
|
2617
2651
|
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
2618
2652
|
useNativeText?: boolean;
|
|
@@ -2651,7 +2685,7 @@ declare namespace gapi.client {
|
|
|
2651
2685
|
interface GoogleCloudDiscoveryengineV1EngineChatEngineConfig {
|
|
2652
2686
|
/** The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. */
|
|
2653
2687
|
agentCreationConfig?: GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig;
|
|
2654
|
-
/** The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
|
|
2688
|
+
/** The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
|
|
2655
2689
|
dialogflowAgentToLink?: string;
|
|
2656
2690
|
}
|
|
2657
2691
|
interface GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig {
|
|
@@ -2675,7 +2709,7 @@ declare namespace gapi.client {
|
|
|
2675
2709
|
interface GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
|
|
2676
2710
|
/** The add-on that this search engine enables. */
|
|
2677
2711
|
searchAddOns?: string[];
|
|
2678
|
-
/** The search feature tier of this engine. Different tiers might have different pricing. To learn more,
|
|
2712
|
+
/** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
|
|
2679
2713
|
searchTier?: string;
|
|
2680
2714
|
}
|
|
2681
2715
|
interface GoogleCloudDiscoveryengineV1ImportDocumentsMetadata {
|
|
@@ -3861,7 +3895,7 @@ declare namespace gapi.client {
|
|
|
3861
3895
|
fields?: string;
|
|
3862
3896
|
/** 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. */
|
|
3863
3897
|
key?: string;
|
|
3864
|
-
/** Immutable. Fully qualified name `project
|
|
3898
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. */
|
|
3865
3899
|
name: string;
|
|
3866
3900
|
/** OAuth 2.0 token for the current user. */
|
|
3867
3901
|
oauth_token?: string;
|
|
@@ -3892,7 +3926,7 @@ declare namespace gapi.client {
|
|
|
3892
3926
|
fields?: string;
|
|
3893
3927
|
/** 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. */
|
|
3894
3928
|
key?: string;
|
|
3895
|
-
/** Immutable. Fully qualified name `project
|
|
3929
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. */
|
|
3896
3930
|
name: string;
|
|
3897
3931
|
/** OAuth 2.0 token for the current user. */
|
|
3898
3932
|
oauth_token?: string;
|
|
@@ -4798,7 +4832,7 @@ declare namespace gapi.client {
|
|
|
4798
4832
|
fields?: string;
|
|
4799
4833
|
/** 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. */
|
|
4800
4834
|
key?: string;
|
|
4801
|
-
/** Immutable. Fully qualified name `project
|
|
4835
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
4802
4836
|
name: string;
|
|
4803
4837
|
/** OAuth 2.0 token for the current user. */
|
|
4804
4838
|
oauth_token?: string;
|
|
@@ -4829,7 +4863,7 @@ declare namespace gapi.client {
|
|
|
4829
4863
|
fields?: string;
|
|
4830
4864
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
4831
4865
|
key?: string;
|
|
4832
|
-
/** Immutable. Fully qualified name `project
|
|
4866
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
4833
4867
|
name: string;
|
|
4834
4868
|
/** OAuth 2.0 token for the current user. */
|
|
4835
4869
|
oauth_token?: string;
|
|
@@ -5785,7 +5819,7 @@ declare namespace gapi.client {
|
|
|
5785
5819
|
key?: string;
|
|
5786
5820
|
/** OAuth 2.0 token for the current user. */
|
|
5787
5821
|
oauth_token?: string;
|
|
5788
|
-
/** Required. The parent
|
|
5822
|
+
/** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
|
|
5789
5823
|
parent: string;
|
|
5790
5824
|
/** Returns response with indentations and line breaks. */
|
|
5791
5825
|
prettyPrint?: boolean;
|
|
@@ -5814,7 +5848,7 @@ declare namespace gapi.client {
|
|
|
5814
5848
|
key?: string;
|
|
5815
5849
|
/** OAuth 2.0 token for the current user. */
|
|
5816
5850
|
oauth_token?: string;
|
|
5817
|
-
/** Required. The parent
|
|
5851
|
+
/** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
|
|
5818
5852
|
parent: string;
|
|
5819
5853
|
/** Returns response with indentations and line breaks. */
|
|
5820
5854
|
prettyPrint?: boolean;
|
|
@@ -6484,7 +6518,7 @@ declare namespace gapi.client {
|
|
|
6484
6518
|
fields?: string;
|
|
6485
6519
|
/** 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. */
|
|
6486
6520
|
key?: string;
|
|
6487
|
-
/** Immutable. Fully qualified name `project
|
|
6521
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. */
|
|
6488
6522
|
name: string;
|
|
6489
6523
|
/** OAuth 2.0 token for the current user. */
|
|
6490
6524
|
oauth_token?: string;
|
|
@@ -6515,7 +6549,7 @@ declare namespace gapi.client {
|
|
|
6515
6549
|
fields?: string;
|
|
6516
6550
|
/** 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. */
|
|
6517
6551
|
key?: string;
|
|
6518
|
-
/** Immutable. Fully qualified name `project
|
|
6552
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. */
|
|
6519
6553
|
name: string;
|
|
6520
6554
|
/** OAuth 2.0 token for the current user. */
|
|
6521
6555
|
oauth_token?: string;
|
|
@@ -7082,7 +7116,7 @@ declare namespace gapi.client {
|
|
|
7082
7116
|
fields?: string;
|
|
7083
7117
|
/** 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. */
|
|
7084
7118
|
key?: string;
|
|
7085
|
-
/** Immutable. Fully qualified name `project
|
|
7119
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
7086
7120
|
name: string;
|
|
7087
7121
|
/** OAuth 2.0 token for the current user. */
|
|
7088
7122
|
oauth_token?: string;
|
|
@@ -7113,7 +7147,7 @@ declare namespace gapi.client {
|
|
|
7113
7147
|
fields?: string;
|
|
7114
7148
|
/** 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. */
|
|
7115
7149
|
key?: string;
|
|
7116
|
-
/** Immutable. Fully qualified name `project
|
|
7150
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
7117
7151
|
name: string;
|
|
7118
7152
|
/** OAuth 2.0 token for the current user. */
|
|
7119
7153
|
oauth_token?: string;
|
|
@@ -8300,7 +8334,7 @@ declare namespace gapi.client {
|
|
|
8300
8334
|
fields?: string;
|
|
8301
8335
|
/** 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. */
|
|
8302
8336
|
key?: string;
|
|
8303
|
-
/** Immutable. Fully qualified name `project
|
|
8337
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. */
|
|
8304
8338
|
name: string;
|
|
8305
8339
|
/** OAuth 2.0 token for the current user. */
|
|
8306
8340
|
oauth_token?: string;
|
|
@@ -8331,7 +8365,7 @@ declare namespace gapi.client {
|
|
|
8331
8365
|
fields?: string;
|
|
8332
8366
|
/** 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. */
|
|
8333
8367
|
key?: string;
|
|
8334
|
-
/** Immutable. Fully qualified name `project
|
|
8368
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. */
|
|
8335
8369
|
name: string;
|
|
8336
8370
|
/** OAuth 2.0 token for the current user. */
|
|
8337
8371
|
oauth_token?: string;
|
|
@@ -9174,7 +9208,7 @@ declare namespace gapi.client {
|
|
|
9174
9208
|
fields?: string;
|
|
9175
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. */
|
|
9176
9210
|
key?: string;
|
|
9177
|
-
/** Immutable. Fully qualified name `project
|
|
9211
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
9178
9212
|
name: string;
|
|
9179
9213
|
/** OAuth 2.0 token for the current user. */
|
|
9180
9214
|
oauth_token?: string;
|
|
@@ -9205,7 +9239,7 @@ declare namespace gapi.client {
|
|
|
9205
9239
|
fields?: string;
|
|
9206
9240
|
/** 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. */
|
|
9207
9241
|
key?: string;
|
|
9208
|
-
/** Immutable. Fully qualified name `project
|
|
9242
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
9209
9243
|
name: string;
|
|
9210
9244
|
/** OAuth 2.0 token for the current user. */
|
|
9211
9245
|
oauth_token?: string;
|
|
@@ -9946,7 +9980,7 @@ declare namespace gapi.client {
|
|
|
9946
9980
|
key?: string;
|
|
9947
9981
|
/** OAuth 2.0 token for the current user. */
|
|
9948
9982
|
oauth_token?: string;
|
|
9949
|
-
/** Required. The parent
|
|
9983
|
+
/** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
|
|
9950
9984
|
parent: string;
|
|
9951
9985
|
/** Returns response with indentations and line breaks. */
|
|
9952
9986
|
prettyPrint?: boolean;
|
|
@@ -9975,7 +10009,7 @@ declare namespace gapi.client {
|
|
|
9975
10009
|
key?: string;
|
|
9976
10010
|
/** OAuth 2.0 token for the current user. */
|
|
9977
10011
|
oauth_token?: string;
|
|
9978
|
-
/** Required. The parent
|
|
10012
|
+
/** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
|
|
9979
10013
|
parent: string;
|
|
9980
10014
|
/** Returns response with indentations and line breaks. */
|
|
9981
10015
|
prettyPrint?: boolean;
|
|
@@ -10581,6 +10615,98 @@ declare namespace gapi.client {
|
|
|
10581
10615
|
body: GoogleCloudDiscoveryengineV1alphaRankRequest
|
|
10582
10616
|
): Request<GoogleCloudDiscoveryengineV1alphaRankResponse>;
|
|
10583
10617
|
}
|
|
10618
|
+
interface OperationsResource {
|
|
10619
|
+
/** 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. */
|
|
10620
|
+
get(request?: {
|
|
10621
|
+
/** V1 error format. */
|
|
10622
|
+
'$.xgafv'?: string;
|
|
10623
|
+
/** OAuth access token. */
|
|
10624
|
+
access_token?: string;
|
|
10625
|
+
/** Data format for response. */
|
|
10626
|
+
alt?: string;
|
|
10627
|
+
/** JSONP */
|
|
10628
|
+
callback?: string;
|
|
10629
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10630
|
+
fields?: string;
|
|
10631
|
+
/** 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. */
|
|
10632
|
+
key?: string;
|
|
10633
|
+
/** The name of the operation resource. */
|
|
10634
|
+
name: string;
|
|
10635
|
+
/** OAuth 2.0 token for the current user. */
|
|
10636
|
+
oauth_token?: string;
|
|
10637
|
+
/** Returns response with indentations and line breaks. */
|
|
10638
|
+
prettyPrint?: boolean;
|
|
10639
|
+
/** 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. */
|
|
10640
|
+
quotaUser?: string;
|
|
10641
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10642
|
+
upload_protocol?: string;
|
|
10643
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10644
|
+
uploadType?: string;
|
|
10645
|
+
}): Request<GoogleLongrunningOperation>;
|
|
10646
|
+
}
|
|
10647
|
+
interface SampleQuerySetsResource {
|
|
10648
|
+
operations: OperationsResource;
|
|
10649
|
+
}
|
|
10650
|
+
interface UserEventsResource {
|
|
10651
|
+
/** Writes a single user event. */
|
|
10652
|
+
write(request: {
|
|
10653
|
+
/** V1 error format. */
|
|
10654
|
+
'$.xgafv'?: string;
|
|
10655
|
+
/** OAuth access token. */
|
|
10656
|
+
access_token?: string;
|
|
10657
|
+
/** Data format for response. */
|
|
10658
|
+
alt?: string;
|
|
10659
|
+
/** JSONP */
|
|
10660
|
+
callback?: string;
|
|
10661
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10662
|
+
fields?: string;
|
|
10663
|
+
/** 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. */
|
|
10664
|
+
key?: string;
|
|
10665
|
+
/** OAuth 2.0 token for the current user. */
|
|
10666
|
+
oauth_token?: string;
|
|
10667
|
+
/** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
|
|
10668
|
+
parent: string;
|
|
10669
|
+
/** Returns response with indentations and line breaks. */
|
|
10670
|
+
prettyPrint?: boolean;
|
|
10671
|
+
/** 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. */
|
|
10672
|
+
quotaUser?: string;
|
|
10673
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10674
|
+
upload_protocol?: string;
|
|
10675
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10676
|
+
uploadType?: string;
|
|
10677
|
+
/** Request body */
|
|
10678
|
+
resource: GoogleCloudDiscoveryengineV1alphaUserEvent;
|
|
10679
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
|
|
10680
|
+
write(
|
|
10681
|
+
request: {
|
|
10682
|
+
/** V1 error format. */
|
|
10683
|
+
'$.xgafv'?: string;
|
|
10684
|
+
/** OAuth access token. */
|
|
10685
|
+
access_token?: string;
|
|
10686
|
+
/** Data format for response. */
|
|
10687
|
+
alt?: string;
|
|
10688
|
+
/** JSONP */
|
|
10689
|
+
callback?: string;
|
|
10690
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10691
|
+
fields?: string;
|
|
10692
|
+
/** 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. */
|
|
10693
|
+
key?: string;
|
|
10694
|
+
/** OAuth 2.0 token for the current user. */
|
|
10695
|
+
oauth_token?: string;
|
|
10696
|
+
/** Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
|
|
10697
|
+
parent: string;
|
|
10698
|
+
/** Returns response with indentations and line breaks. */
|
|
10699
|
+
prettyPrint?: boolean;
|
|
10700
|
+
/** 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. */
|
|
10701
|
+
quotaUser?: string;
|
|
10702
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10703
|
+
upload_protocol?: string;
|
|
10704
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10705
|
+
uploadType?: string;
|
|
10706
|
+
},
|
|
10707
|
+
body: GoogleCloudDiscoveryengineV1alphaUserEvent
|
|
10708
|
+
): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
|
|
10709
|
+
}
|
|
10584
10710
|
interface LocationsResource {
|
|
10585
10711
|
/** Estimates the data size to be used by a customer. */
|
|
10586
10712
|
estimateDataSize(request: {
|
|
@@ -10731,6 +10857,8 @@ declare namespace gapi.client {
|
|
|
10731
10857
|
groundingConfigs: GroundingConfigsResource;
|
|
10732
10858
|
operations: OperationsResource;
|
|
10733
10859
|
rankingConfigs: RankingConfigsResource;
|
|
10860
|
+
sampleQuerySets: SampleQuerySetsResource;
|
|
10861
|
+
userEvents: UserEventsResource;
|
|
10734
10862
|
}
|
|
10735
10863
|
interface OperationsResource {
|
|
10736
10864
|
/** 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. */
|
|
@@ -10795,6 +10923,149 @@ declare namespace gapi.client {
|
|
|
10795
10923
|
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
10796
10924
|
}
|
|
10797
10925
|
interface ProjectsResource {
|
|
10926
|
+
/** Gets a Project. Returns NOT_FOUND when the project is not yet created. */
|
|
10927
|
+
get(request?: {
|
|
10928
|
+
/** V1 error format. */
|
|
10929
|
+
'$.xgafv'?: string;
|
|
10930
|
+
/** OAuth access token. */
|
|
10931
|
+
access_token?: string;
|
|
10932
|
+
/** Data format for response. */
|
|
10933
|
+
alt?: string;
|
|
10934
|
+
/** JSONP */
|
|
10935
|
+
callback?: string;
|
|
10936
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10937
|
+
fields?: string;
|
|
10938
|
+
/** 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. */
|
|
10939
|
+
key?: string;
|
|
10940
|
+
/** Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. */
|
|
10941
|
+
name: string;
|
|
10942
|
+
/** OAuth 2.0 token for the current user. */
|
|
10943
|
+
oauth_token?: string;
|
|
10944
|
+
/** Returns response with indentations and line breaks. */
|
|
10945
|
+
prettyPrint?: boolean;
|
|
10946
|
+
/** 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. */
|
|
10947
|
+
quotaUser?: string;
|
|
10948
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10949
|
+
upload_protocol?: string;
|
|
10950
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10951
|
+
uploadType?: string;
|
|
10952
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaProject>;
|
|
10953
|
+
/** Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms. */
|
|
10954
|
+
provision(request: {
|
|
10955
|
+
/** V1 error format. */
|
|
10956
|
+
'$.xgafv'?: string;
|
|
10957
|
+
/** OAuth access token. */
|
|
10958
|
+
access_token?: string;
|
|
10959
|
+
/** Data format for response. */
|
|
10960
|
+
alt?: string;
|
|
10961
|
+
/** JSONP */
|
|
10962
|
+
callback?: string;
|
|
10963
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10964
|
+
fields?: string;
|
|
10965
|
+
/** 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. */
|
|
10966
|
+
key?: string;
|
|
10967
|
+
/** Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. */
|
|
10968
|
+
name: string;
|
|
10969
|
+
/** OAuth 2.0 token for the current user. */
|
|
10970
|
+
oauth_token?: string;
|
|
10971
|
+
/** Returns response with indentations and line breaks. */
|
|
10972
|
+
prettyPrint?: boolean;
|
|
10973
|
+
/** 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. */
|
|
10974
|
+
quotaUser?: string;
|
|
10975
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10976
|
+
upload_protocol?: string;
|
|
10977
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10978
|
+
uploadType?: string;
|
|
10979
|
+
/** Request body */
|
|
10980
|
+
resource: GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest;
|
|
10981
|
+
}): Request<GoogleLongrunningOperation>;
|
|
10982
|
+
provision(
|
|
10983
|
+
request: {
|
|
10984
|
+
/** V1 error format. */
|
|
10985
|
+
'$.xgafv'?: string;
|
|
10986
|
+
/** OAuth access token. */
|
|
10987
|
+
access_token?: string;
|
|
10988
|
+
/** Data format for response. */
|
|
10989
|
+
alt?: string;
|
|
10990
|
+
/** JSONP */
|
|
10991
|
+
callback?: string;
|
|
10992
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10993
|
+
fields?: string;
|
|
10994
|
+
/** 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. */
|
|
10995
|
+
key?: string;
|
|
10996
|
+
/** Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. */
|
|
10997
|
+
name: string;
|
|
10998
|
+
/** OAuth 2.0 token for the current user. */
|
|
10999
|
+
oauth_token?: string;
|
|
11000
|
+
/** Returns response with indentations and line breaks. */
|
|
11001
|
+
prettyPrint?: boolean;
|
|
11002
|
+
/** 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. */
|
|
11003
|
+
quotaUser?: string;
|
|
11004
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11005
|
+
upload_protocol?: string;
|
|
11006
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11007
|
+
uploadType?: string;
|
|
11008
|
+
},
|
|
11009
|
+
body: GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest
|
|
11010
|
+
): Request<GoogleLongrunningOperation>;
|
|
11011
|
+
/** Updates service terms for this project. This method can be used to retroactively accept the latest terms. Terms available for update: * [Terms for data use](https://cloud.google.com/retail/data-use-terms) */
|
|
11012
|
+
reportConsentChange(request: {
|
|
11013
|
+
/** V1 error format. */
|
|
11014
|
+
'$.xgafv'?: string;
|
|
11015
|
+
/** OAuth access token. */
|
|
11016
|
+
access_token?: string;
|
|
11017
|
+
/** Data format for response. */
|
|
11018
|
+
alt?: string;
|
|
11019
|
+
/** JSONP */
|
|
11020
|
+
callback?: string;
|
|
11021
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11022
|
+
fields?: string;
|
|
11023
|
+
/** 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. */
|
|
11024
|
+
key?: string;
|
|
11025
|
+
/** OAuth 2.0 token for the current user. */
|
|
11026
|
+
oauth_token?: string;
|
|
11027
|
+
/** Returns response with indentations and line breaks. */
|
|
11028
|
+
prettyPrint?: boolean;
|
|
11029
|
+
/** Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. */
|
|
11030
|
+
project: string;
|
|
11031
|
+
/** 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. */
|
|
11032
|
+
quotaUser?: string;
|
|
11033
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11034
|
+
upload_protocol?: string;
|
|
11035
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11036
|
+
uploadType?: string;
|
|
11037
|
+
/** Request body */
|
|
11038
|
+
resource: GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest;
|
|
11039
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaProject>;
|
|
11040
|
+
reportConsentChange(
|
|
11041
|
+
request: {
|
|
11042
|
+
/** V1 error format. */
|
|
11043
|
+
'$.xgafv'?: string;
|
|
11044
|
+
/** OAuth access token. */
|
|
11045
|
+
access_token?: string;
|
|
11046
|
+
/** Data format for response. */
|
|
11047
|
+
alt?: string;
|
|
11048
|
+
/** JSONP */
|
|
11049
|
+
callback?: string;
|
|
11050
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11051
|
+
fields?: string;
|
|
11052
|
+
/** 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. */
|
|
11053
|
+
key?: string;
|
|
11054
|
+
/** OAuth 2.0 token for the current user. */
|
|
11055
|
+
oauth_token?: string;
|
|
11056
|
+
/** Returns response with indentations and line breaks. */
|
|
11057
|
+
prettyPrint?: boolean;
|
|
11058
|
+
/** Required. Full resource name of a Project, such as `projects/{project_id_or_number}`. */
|
|
11059
|
+
project: string;
|
|
11060
|
+
/** 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. */
|
|
11061
|
+
quotaUser?: string;
|
|
11062
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11063
|
+
upload_protocol?: string;
|
|
11064
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11065
|
+
uploadType?: string;
|
|
11066
|
+
},
|
|
11067
|
+
body: GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest
|
|
11068
|
+
): Request<GoogleCloudDiscoveryengineV1alphaProject>;
|
|
10798
11069
|
locations: LocationsResource;
|
|
10799
11070
|
operations: OperationsResource;
|
|
10800
11071
|
}
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -96,4 +96,21 @@ Performs a search. Similar to the SearchService.Search method, but a widget vers
|
|
|
96
96
|
await gapi.client.discoveryengine.locations.widgetSearch({
|
|
97
97
|
location: 'location',
|
|
98
98
|
});
|
|
99
|
+
|
|
100
|
+
/*
|
|
101
|
+
Gets a Project. Returns NOT_FOUND when the project is not yet created.
|
|
102
|
+
*/
|
|
103
|
+
await gapi.client.discoveryengine.projects.get({name: 'name'});
|
|
104
|
+
|
|
105
|
+
/*
|
|
106
|
+
Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.
|
|
107
|
+
*/
|
|
108
|
+
await gapi.client.discoveryengine.projects.provision({name: 'name'});
|
|
109
|
+
|
|
110
|
+
/*
|
|
111
|
+
Updates service terms for this project. This method can be used to retroactively accept the latest terms. Terms available for update: * [Terms for data use](https://cloud.google.com/retail/data-use-terms)
|
|
112
|
+
*/
|
|
113
|
+
await gapi.client.discoveryengine.projects.reportConsentChange({
|
|
114
|
+
project: 'project',
|
|
115
|
+
});
|
|
99
116
|
```
|