@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20240409 → 0.0.20240502
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 +225 -58
- 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=v1beta
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240502
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -99,7 +99,7 @@ declare namespace gapi.client {
|
|
|
99
99
|
completeTime?: string;
|
|
100
100
|
/** Output only. Answer creation timestamp. */
|
|
101
101
|
createTime?: string;
|
|
102
|
-
/** Immutable. Fully qualified name `project
|
|
102
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*` */
|
|
103
103
|
name?: string;
|
|
104
104
|
/** Query understanding information. */
|
|
105
105
|
queryUnderstandingInfo?: GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo;
|
|
@@ -260,6 +260,19 @@ declare namespace gapi.client {
|
|
|
260
260
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
261
261
|
updateTime?: string;
|
|
262
262
|
}
|
|
263
|
+
interface GoogleCloudDiscoveryengineV1alphaCustomTuningModel {
|
|
264
|
+
/** Timestamp the Model was created at. */
|
|
265
|
+
createTime?: string;
|
|
266
|
+
/** The display name of the model. */
|
|
267
|
+
displayName?: string;
|
|
268
|
+
/** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
|
|
269
|
+
modelState?: string;
|
|
270
|
+
modelVersion?: string;
|
|
271
|
+
/** Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters. */
|
|
272
|
+
name?: string;
|
|
273
|
+
/** Timestamp the model training was initiated. */
|
|
274
|
+
trainingStartTime?: string;
|
|
275
|
+
}
|
|
263
276
|
interface GoogleCloudDiscoveryengineV1alphaDataStore {
|
|
264
277
|
/** Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. */
|
|
265
278
|
aclEnabled?: boolean;
|
|
@@ -348,7 +361,7 @@ declare namespace gapi.client {
|
|
|
348
361
|
interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
349
362
|
interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {}
|
|
350
363
|
interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
351
|
-
/**
|
|
364
|
+
/** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
|
|
352
365
|
enhancedDocumentElements?: string[];
|
|
353
366
|
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
354
367
|
useNativeText?: boolean;
|
|
@@ -393,7 +406,7 @@ declare namespace gapi.client {
|
|
|
393
406
|
interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig {
|
|
394
407
|
/** 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. */
|
|
395
408
|
agentCreationConfig?: GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
|
|
396
|
-
/** 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.
|
|
409
|
+
/** 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. */
|
|
397
410
|
dialogflowAgentToLink?: string;
|
|
398
411
|
}
|
|
399
412
|
interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig {
|
|
@@ -443,7 +456,7 @@ declare namespace gapi.client {
|
|
|
443
456
|
interface GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
|
|
444
457
|
/** The add-on that this search engine enables. */
|
|
445
458
|
searchAddOns?: string[];
|
|
446
|
-
/** The search feature tier of this engine. Different tiers might have different pricing. To learn more,
|
|
459
|
+
/** 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. */
|
|
447
460
|
searchTier?: string;
|
|
448
461
|
}
|
|
449
462
|
interface GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig {}
|
|
@@ -458,6 +471,8 @@ declare namespace gapi.client {
|
|
|
458
471
|
documentCount?: string;
|
|
459
472
|
}
|
|
460
473
|
interface GoogleCloudDiscoveryengineV1alphaFieldConfig {
|
|
474
|
+
/** 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 ``. */
|
|
475
|
+
advancedSiteSearchDataSources?: string[];
|
|
461
476
|
/** 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. */
|
|
462
477
|
completableOption?: string;
|
|
463
478
|
/** 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. */
|
|
@@ -487,20 +502,6 @@ declare namespace gapi.client {
|
|
|
487
502
|
/** Workforce pool name. Example: "locations/global/workforcePools/pool_id" */
|
|
488
503
|
workforcePoolName?: string;
|
|
489
504
|
}
|
|
490
|
-
interface GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata {
|
|
491
|
-
/** Operation create time. */
|
|
492
|
-
createTime?: string;
|
|
493
|
-
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
494
|
-
updateTime?: string;
|
|
495
|
-
}
|
|
496
|
-
interface GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse {
|
|
497
|
-
/** A sample of errors encountered while processing the request. */
|
|
498
|
-
errorSamples?: GoogleRpcStatus[];
|
|
499
|
-
/** Count of CompletionSuggestions that failed to be imported. */
|
|
500
|
-
failureCount?: string;
|
|
501
|
-
/** Count of CompletionSuggestions successfully imported. */
|
|
502
|
-
successCount?: string;
|
|
503
|
-
}
|
|
504
505
|
interface GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata {
|
|
505
506
|
/** Operation create time. */
|
|
506
507
|
createTime?: string;
|
|
@@ -557,6 +558,35 @@ declare namespace gapi.client {
|
|
|
557
558
|
/** Count of user events imported, but with Document information not found in the existing Branch. */
|
|
558
559
|
unjoinedEventsCount?: string;
|
|
559
560
|
}
|
|
561
|
+
interface GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse {
|
|
562
|
+
/** List of custom tuning models. */
|
|
563
|
+
models?: GoogleCloudDiscoveryengineV1alphaCustomTuningModel[];
|
|
564
|
+
}
|
|
565
|
+
interface GoogleCloudDiscoveryengineV1alphaProject {
|
|
566
|
+
/** Output only. The timestamp when this project is created. */
|
|
567
|
+
createTime?: string;
|
|
568
|
+
/** 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. */
|
|
569
|
+
name?: string;
|
|
570
|
+
/** Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */
|
|
571
|
+
provisionCompletionTime?: string;
|
|
572
|
+
/** Output only. A map of terms of services. The key is the `id` of ServiceTerms. */
|
|
573
|
+
serviceTermsMap?: {
|
|
574
|
+
[P in string]: GoogleCloudDiscoveryengineV1alphaProjectServiceTerms;
|
|
575
|
+
};
|
|
576
|
+
}
|
|
577
|
+
interface GoogleCloudDiscoveryengineV1alphaProjectServiceTerms {
|
|
578
|
+
/** The last time when the project agreed to the terms of service. */
|
|
579
|
+
acceptTime?: string;
|
|
580
|
+
/** The last time when the project declined or revoked the agreement to terms of service. */
|
|
581
|
+
declineTime?: string;
|
|
582
|
+
/** 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`. */
|
|
583
|
+
id?: string;
|
|
584
|
+
/** Whether the project has accepted/rejected the service terms or it is still pending. */
|
|
585
|
+
state?: string;
|
|
586
|
+
/** The version string of the terms of service. For acceptable values, see the comments for id above. */
|
|
587
|
+
version?: string;
|
|
588
|
+
}
|
|
589
|
+
interface GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata {}
|
|
560
590
|
interface GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata {
|
|
561
591
|
/** Operation create time. */
|
|
562
592
|
createTime?: string;
|
|
@@ -654,7 +684,7 @@ declare namespace gapi.client {
|
|
|
654
684
|
interface GoogleCloudDiscoveryengineV1alphaSession {
|
|
655
685
|
/** Output only. The time the session finished. */
|
|
656
686
|
endTime?: string;
|
|
657
|
-
/** Immutable. Fully qualified name `project
|
|
687
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
658
688
|
name?: string;
|
|
659
689
|
/** Output only. The time the session started. */
|
|
660
690
|
startTime?: string;
|
|
@@ -690,6 +720,8 @@ declare namespace gapi.client {
|
|
|
690
720
|
name?: string;
|
|
691
721
|
/** Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */
|
|
692
722
|
providedUriPattern?: string;
|
|
723
|
+
/** Output only. Root domain of the provided_uri_pattern. */
|
|
724
|
+
rootDomainUri?: string;
|
|
693
725
|
/** Output only. Site ownership and validity verification status. */
|
|
694
726
|
siteVerificationInfo?: GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo;
|
|
695
727
|
/** The type of the target site, e.g., whether the site is to be included or excluded. */
|
|
@@ -718,6 +750,8 @@ declare namespace gapi.client {
|
|
|
718
750
|
errorSamples?: GoogleRpcStatus[];
|
|
719
751
|
/** The metrics of the trained model. */
|
|
720
752
|
metrics?: {[P in string]: number};
|
|
753
|
+
/** Fully qualified name of the CustomTuningModel. */
|
|
754
|
+
modelName?: string;
|
|
721
755
|
/** 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 job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. */
|
|
722
756
|
modelStatus?: string;
|
|
723
757
|
}
|
|
@@ -759,7 +793,7 @@ declare namespace gapi.client {
|
|
|
759
793
|
completeTime?: string;
|
|
760
794
|
/** Output only. Answer creation timestamp. */
|
|
761
795
|
createTime?: string;
|
|
762
|
-
/** Immutable. Fully qualified name `project
|
|
796
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*` */
|
|
763
797
|
name?: string;
|
|
764
798
|
/** Query understanding information. */
|
|
765
799
|
queryUnderstandingInfo?: GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfo;
|
|
@@ -839,7 +873,7 @@ declare namespace gapi.client {
|
|
|
839
873
|
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec {
|
|
840
874
|
/** Disable query rephraser. */
|
|
841
875
|
disable?: boolean;
|
|
842
|
-
/** Max rephrase steps. The max number is
|
|
876
|
+
/** Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default. */
|
|
843
877
|
maxRephraseSteps?: number;
|
|
844
878
|
}
|
|
845
879
|
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestRelatedQuestionsSpec {
|
|
@@ -917,6 +951,8 @@ declare namespace gapi.client {
|
|
|
917
951
|
interface GoogleCloudDiscoveryengineV1betaAnswerQueryResponse {
|
|
918
952
|
/** Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. */
|
|
919
953
|
answer?: GoogleCloudDiscoveryengineV1betaAnswer;
|
|
954
|
+
/** A global unique ID used for logging. */
|
|
955
|
+
answerQueryToken?: string;
|
|
920
956
|
/** Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request. */
|
|
921
957
|
session?: GoogleCloudDiscoveryengineV1betaSession;
|
|
922
958
|
}
|
|
@@ -1090,12 +1126,14 @@ declare namespace gapi.client {
|
|
|
1090
1126
|
tableId?: string;
|
|
1091
1127
|
}
|
|
1092
1128
|
interface GoogleCloudDiscoveryengineV1betaCheckGroundingRequest {
|
|
1093
|
-
/** Answer candidate to check. */
|
|
1129
|
+
/** Answer candidate to check. Can have a maximum length of 1024 characters. */
|
|
1094
1130
|
answerCandidate?: string;
|
|
1095
1131
|
/** List of facts for the grounding check. We support up to 200 facts. */
|
|
1096
1132
|
facts?: GoogleCloudDiscoveryengineV1betaGroundingFact[];
|
|
1097
1133
|
/** Configuration of the grounding check. */
|
|
1098
1134
|
groundingSpec?: GoogleCloudDiscoveryengineV1betaCheckGroundingSpec;
|
|
1135
|
+
/** The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */
|
|
1136
|
+
userLabels?: {[P in string]: string};
|
|
1099
1137
|
}
|
|
1100
1138
|
interface GoogleCloudDiscoveryengineV1betaCheckGroundingResponse {
|
|
1101
1139
|
/** List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. */
|
|
@@ -1112,7 +1150,9 @@ declare namespace gapi.client {
|
|
|
1112
1150
|
claimText?: string;
|
|
1113
1151
|
/** Position indicating the end of the claim in the answer candidate, exclusive. */
|
|
1114
1152
|
endPos?: number;
|
|
1115
|
-
/**
|
|
1153
|
+
/** Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned. */
|
|
1154
|
+
groundingCheckRequired?: boolean;
|
|
1155
|
+
/** Position indicating the start of the claim in the answer candidate, measured in bytes. */
|
|
1116
1156
|
startPos?: number;
|
|
1117
1157
|
}
|
|
1118
1158
|
interface GoogleCloudDiscoveryengineV1betaCheckGroundingSpec {
|
|
@@ -1122,7 +1162,7 @@ declare namespace gapi.client {
|
|
|
1122
1162
|
interface GoogleCloudDiscoveryengineV1betaCloudSqlSource {
|
|
1123
1163
|
/** Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. */
|
|
1124
1164
|
databaseId?: string;
|
|
1125
|
-
/** 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.
|
|
1165
|
+
/** 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. */
|
|
1126
1166
|
gcsStagingDir?: string;
|
|
1127
1167
|
/** Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. */
|
|
1128
1168
|
instanceId?: string;
|
|
@@ -1156,7 +1196,7 @@ declare namespace gapi.client {
|
|
|
1156
1196
|
endTime?: string;
|
|
1157
1197
|
/** Conversation messages. */
|
|
1158
1198
|
messages?: GoogleCloudDiscoveryengineV1betaConversationMessage[];
|
|
1159
|
-
/** Immutable. Fully qualified name `project
|
|
1199
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. */
|
|
1160
1200
|
name?: string;
|
|
1161
1201
|
/** Output only. The time the conversation started. */
|
|
1162
1202
|
startTime?: string;
|
|
@@ -1243,6 +1283,19 @@ declare namespace gapi.client {
|
|
|
1243
1283
|
/** The textual values of this custom attribute. For example, `["yellow", "green"]` when the key is "color". Empty string is not allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
1244
1284
|
text?: string[];
|
|
1245
1285
|
}
|
|
1286
|
+
interface GoogleCloudDiscoveryengineV1betaCustomTuningModel {
|
|
1287
|
+
/** Timestamp the Model was created at. */
|
|
1288
|
+
createTime?: string;
|
|
1289
|
+
/** The display name of the model. */
|
|
1290
|
+
displayName?: string;
|
|
1291
|
+
/** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
|
|
1292
|
+
modelState?: string;
|
|
1293
|
+
modelVersion?: string;
|
|
1294
|
+
/** Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters. */
|
|
1295
|
+
name?: string;
|
|
1296
|
+
/** Timestamp the model training was initiated. */
|
|
1297
|
+
trainingStartTime?: string;
|
|
1298
|
+
}
|
|
1246
1299
|
interface GoogleCloudDiscoveryengineV1betaDataStore {
|
|
1247
1300
|
/** Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */
|
|
1248
1301
|
contentConfig?: string;
|
|
@@ -1353,7 +1406,7 @@ declare namespace gapi.client {
|
|
|
1353
1406
|
}
|
|
1354
1407
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
1355
1408
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
1356
|
-
/**
|
|
1409
|
+
/** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
|
|
1357
1410
|
enhancedDocumentElements?: string[];
|
|
1358
1411
|
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
1359
1412
|
useNativeText?: boolean;
|
|
@@ -1401,7 +1454,7 @@ declare namespace gapi.client {
|
|
|
1401
1454
|
interface GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig {
|
|
1402
1455
|
/** 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. */
|
|
1403
1456
|
agentCreationConfig?: GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig;
|
|
1404
|
-
/** 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.
|
|
1457
|
+
/** 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. */
|
|
1405
1458
|
dialogflowAgentToLink?: string;
|
|
1406
1459
|
}
|
|
1407
1460
|
interface GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig {
|
|
@@ -1425,12 +1478,14 @@ declare namespace gapi.client {
|
|
|
1425
1478
|
interface GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
|
|
1426
1479
|
/** The add-on that this search engine enables. */
|
|
1427
1480
|
searchAddOns?: string[];
|
|
1428
|
-
/** The search feature tier of this engine. Different tiers might have different pricing. To learn more,
|
|
1481
|
+
/** 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. */
|
|
1429
1482
|
searchTier?: string;
|
|
1430
1483
|
}
|
|
1431
1484
|
interface GoogleCloudDiscoveryengineV1betaFactChunk {
|
|
1432
1485
|
/** Text content of the fact chunk. Can be at most 10K characters long. */
|
|
1433
1486
|
chunkText?: string;
|
|
1487
|
+
/** The index of this chunk. Currently, only used for the streaming mode. */
|
|
1488
|
+
index?: number;
|
|
1434
1489
|
/** Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved. */
|
|
1435
1490
|
source?: string;
|
|
1436
1491
|
/** More fine-grained information for the source reference. */
|
|
@@ -1455,7 +1510,7 @@ declare namespace gapi.client {
|
|
|
1455
1510
|
collectionId?: string;
|
|
1456
1511
|
/** Required. The Firestore database to copy the data from with a length limit of 256 characters. */
|
|
1457
1512
|
databaseId?: string;
|
|
1458
|
-
/** 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.
|
|
1513
|
+
/** 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. */
|
|
1459
1514
|
gcsStagingDir?: string;
|
|
1460
1515
|
/** 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. */
|
|
1461
1516
|
projectId?: string;
|
|
@@ -1600,6 +1655,10 @@ declare namespace gapi.client {
|
|
|
1600
1655
|
/** Pagination token, if not returned indicates the last page. */
|
|
1601
1656
|
nextPageToken?: string;
|
|
1602
1657
|
}
|
|
1658
|
+
interface GoogleCloudDiscoveryengineV1betaListCustomModelsResponse {
|
|
1659
|
+
/** List of custom tuning models. */
|
|
1660
|
+
models?: GoogleCloudDiscoveryengineV1betaCustomTuningModel[];
|
|
1661
|
+
}
|
|
1603
1662
|
interface GoogleCloudDiscoveryengineV1betaListDataStoresResponse {
|
|
1604
1663
|
/** All the customer's DataStores. */
|
|
1605
1664
|
dataStores?: GoogleCloudDiscoveryengineV1betaDataStore[];
|
|
@@ -1651,7 +1710,7 @@ declare namespace gapi.client {
|
|
|
1651
1710
|
mediaProgressPercentage?: number;
|
|
1652
1711
|
}
|
|
1653
1712
|
interface GoogleCloudDiscoveryengineV1betaPageInfo {
|
|
1654
|
-
/** 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,
|
|
1713
|
+
/** 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. */
|
|
1655
1714
|
pageCategory?: string;
|
|
1656
1715
|
/** 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. */
|
|
1657
1716
|
pageviewId?: string;
|
|
@@ -1731,7 +1790,7 @@ declare namespace gapi.client {
|
|
|
1731
1790
|
model?: string;
|
|
1732
1791
|
/** The query to use. */
|
|
1733
1792
|
query?: string;
|
|
1734
|
-
/** Required. A list of records to rank. At most
|
|
1793
|
+
/** Required. A list of records to rank. At most 200 records to rank. */
|
|
1735
1794
|
records?: GoogleCloudDiscoveryengineV1betaRankingRecord[];
|
|
1736
1795
|
/** The number of results to return. If this is unset or no bigger than zero, returns all results. */
|
|
1737
1796
|
topN?: number;
|
|
@@ -1832,7 +1891,7 @@ declare namespace gapi.client {
|
|
|
1832
1891
|
imageQuery?: GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery;
|
|
1833
1892
|
/** A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */
|
|
1834
1893
|
offset?: number;
|
|
1835
|
-
/** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
|
|
1894
|
+
/** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
|
|
1836
1895
|
orderBy?: string;
|
|
1837
1896
|
/** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
|
|
1838
1897
|
pageSize?: number;
|
|
@@ -1902,7 +1961,7 @@ declare namespace gapi.client {
|
|
|
1902
1961
|
numNextSegments?: number;
|
|
1903
1962
|
/** Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */
|
|
1904
1963
|
numPreviousSegments?: number;
|
|
1905
|
-
/** 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,
|
|
1964
|
+
/** 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`. */
|
|
1906
1965
|
returnExtractiveSegmentScore?: boolean;
|
|
1907
1966
|
}
|
|
1908
1967
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec {
|
|
@@ -1926,9 +1985,9 @@ declare namespace gapi.client {
|
|
|
1926
1985
|
modelPromptSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec;
|
|
1927
1986
|
/** If specified, the spec will be used to modify the model specification provided to the LLM. */
|
|
1928
1987
|
modelSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec;
|
|
1929
|
-
/** 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. */
|
|
1988
|
+
/** 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. */
|
|
1930
1989
|
summaryResultCount?: number;
|
|
1931
|
-
/** If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality.
|
|
1990
|
+
/** 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. */
|
|
1932
1991
|
useSemanticChunks?: boolean;
|
|
1933
1992
|
}
|
|
1934
1993
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec {
|
|
@@ -2179,7 +2238,7 @@ declare namespace gapi.client {
|
|
|
2179
2238
|
interface GoogleCloudDiscoveryengineV1betaSession {
|
|
2180
2239
|
/** Output only. The time the session finished. */
|
|
2181
2240
|
endTime?: string;
|
|
2182
|
-
/** Immutable. Fully qualified name `project
|
|
2241
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
2183
2242
|
name?: string;
|
|
2184
2243
|
/** Output only. The time the session started. */
|
|
2185
2244
|
startTime?: string;
|
|
@@ -2237,6 +2296,8 @@ declare namespace gapi.client {
|
|
|
2237
2296
|
name?: string;
|
|
2238
2297
|
/** Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */
|
|
2239
2298
|
providedUriPattern?: string;
|
|
2299
|
+
/** Output only. Root domain of the provided_uri_pattern. */
|
|
2300
|
+
rootDomainUri?: string;
|
|
2240
2301
|
/** Output only. Site ownership and validity verification status. */
|
|
2241
2302
|
siteVerificationInfo?: GoogleCloudDiscoveryengineV1betaSiteVerificationInfo;
|
|
2242
2303
|
/** The type of the target site, e.g., whether the site is to be included or excluded. */
|
|
@@ -2269,6 +2330,8 @@ declare namespace gapi.client {
|
|
|
2269
2330
|
errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
2270
2331
|
/** Cloud Storage training input. */
|
|
2271
2332
|
gcsTrainingInput?: GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput;
|
|
2333
|
+
/** If not provided, a UUID will be generated. */
|
|
2334
|
+
modelId?: string;
|
|
2272
2335
|
/** Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided. */
|
|
2273
2336
|
modelType?: string;
|
|
2274
2337
|
}
|
|
@@ -2289,6 +2352,8 @@ declare namespace gapi.client {
|
|
|
2289
2352
|
errorSamples?: GoogleRpcStatus[];
|
|
2290
2353
|
/** The metrics of the trained model. */
|
|
2291
2354
|
metrics?: {[P in string]: number};
|
|
2355
|
+
/** Fully qualified name of the CustomTuningModel. */
|
|
2356
|
+
modelName?: string;
|
|
2292
2357
|
/** 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 job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. */
|
|
2293
2358
|
modelStatus?: string;
|
|
2294
2359
|
}
|
|
@@ -2311,6 +2376,7 @@ declare namespace gapi.client {
|
|
|
2311
2376
|
engine?: string;
|
|
2312
2377
|
}
|
|
2313
2378
|
interface GoogleCloudDiscoveryengineV1betaTuneEngineRequest {}
|
|
2379
|
+
interface GoogleCloudDiscoveryengineV1betaTuneEngineResponse {}
|
|
2314
2380
|
interface GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata {
|
|
2315
2381
|
/** Operation create time. */
|
|
2316
2382
|
createTime?: string;
|
|
@@ -2462,7 +2528,7 @@ declare namespace gapi.client {
|
|
|
2462
2528
|
}
|
|
2463
2529
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
2464
2530
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig {
|
|
2465
|
-
/**
|
|
2531
|
+
/** [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */
|
|
2466
2532
|
enhancedDocumentElements?: string[];
|
|
2467
2533
|
/** If true, will use native text instead of OCR text on pages containing native text. */
|
|
2468
2534
|
useNativeText?: boolean;
|
|
@@ -2501,7 +2567,7 @@ declare namespace gapi.client {
|
|
|
2501
2567
|
interface GoogleCloudDiscoveryengineV1EngineChatEngineConfig {
|
|
2502
2568
|
/** 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. */
|
|
2503
2569
|
agentCreationConfig?: GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig;
|
|
2504
|
-
/** 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.
|
|
2570
|
+
/** 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. */
|
|
2505
2571
|
dialogflowAgentToLink?: string;
|
|
2506
2572
|
}
|
|
2507
2573
|
interface GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig {
|
|
@@ -2525,7 +2591,7 @@ declare namespace gapi.client {
|
|
|
2525
2591
|
interface GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
|
|
2526
2592
|
/** The add-on that this search engine enables. */
|
|
2527
2593
|
searchAddOns?: string[];
|
|
2528
|
-
/** The search feature tier of this engine. Different tiers might have different pricing. To learn more,
|
|
2594
|
+
/** 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. */
|
|
2529
2595
|
searchTier?: string;
|
|
2530
2596
|
}
|
|
2531
2597
|
interface GoogleCloudDiscoveryengineV1ImportDocumentsMetadata {
|
|
@@ -2641,6 +2707,8 @@ declare namespace gapi.client {
|
|
|
2641
2707
|
name?: string;
|
|
2642
2708
|
/** Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */
|
|
2643
2709
|
providedUriPattern?: string;
|
|
2710
|
+
/** Output only. Root domain of the provided_uri_pattern. */
|
|
2711
|
+
rootDomainUri?: string;
|
|
2644
2712
|
/** Output only. Site ownership and validity verification status. */
|
|
2645
2713
|
siteVerificationInfo?: GoogleCloudDiscoveryengineV1SiteVerificationInfo;
|
|
2646
2714
|
/** The type of the target site, e.g., whether the site is to be included or excluded. */
|
|
@@ -2998,6 +3066,8 @@ declare namespace gapi.client {
|
|
|
2998
3066
|
prettyPrint?: boolean;
|
|
2999
3067
|
/** 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. */
|
|
3000
3068
|
quotaUser?: string;
|
|
3069
|
+
/** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
|
|
3070
|
+
updateMask?: string;
|
|
3001
3071
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3002
3072
|
upload_protocol?: string;
|
|
3003
3073
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -3029,6 +3099,8 @@ declare namespace gapi.client {
|
|
|
3029
3099
|
prettyPrint?: boolean;
|
|
3030
3100
|
/** 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. */
|
|
3031
3101
|
quotaUser?: string;
|
|
3102
|
+
/** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
|
|
3103
|
+
updateMask?: string;
|
|
3032
3104
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3033
3105
|
upload_protocol?: string;
|
|
3034
3106
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -3381,7 +3453,7 @@ declare namespace gapi.client {
|
|
|
3381
3453
|
fields?: string;
|
|
3382
3454
|
/** 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. */
|
|
3383
3455
|
key?: string;
|
|
3384
|
-
/** Immutable. Fully qualified name `project
|
|
3456
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. */
|
|
3385
3457
|
name: string;
|
|
3386
3458
|
/** OAuth 2.0 token for the current user. */
|
|
3387
3459
|
oauth_token?: string;
|
|
@@ -3412,7 +3484,7 @@ declare namespace gapi.client {
|
|
|
3412
3484
|
fields?: string;
|
|
3413
3485
|
/** 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. */
|
|
3414
3486
|
key?: string;
|
|
3415
|
-
/** Immutable. Fully qualified name `project
|
|
3487
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. */
|
|
3416
3488
|
name: string;
|
|
3417
3489
|
/** OAuth 2.0 token for the current user. */
|
|
3418
3490
|
oauth_token?: string;
|
|
@@ -3430,6 +3502,35 @@ declare namespace gapi.client {
|
|
|
3430
3502
|
body: GoogleCloudDiscoveryengineV1betaConversation
|
|
3431
3503
|
): Request<GoogleCloudDiscoveryengineV1betaConversation>;
|
|
3432
3504
|
}
|
|
3505
|
+
interface CustomModelsResource {
|
|
3506
|
+
/** Gets a list of all the custom models. */
|
|
3507
|
+
list(request?: {
|
|
3508
|
+
/** V1 error format. */
|
|
3509
|
+
'$.xgafv'?: string;
|
|
3510
|
+
/** OAuth access token. */
|
|
3511
|
+
access_token?: string;
|
|
3512
|
+
/** Data format for response. */
|
|
3513
|
+
alt?: string;
|
|
3514
|
+
/** JSONP */
|
|
3515
|
+
callback?: string;
|
|
3516
|
+
/** Required. The resource name of the parent Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. */
|
|
3517
|
+
dataStore: string;
|
|
3518
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3519
|
+
fields?: string;
|
|
3520
|
+
/** 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. */
|
|
3521
|
+
key?: string;
|
|
3522
|
+
/** OAuth 2.0 token for the current user. */
|
|
3523
|
+
oauth_token?: string;
|
|
3524
|
+
/** Returns response with indentations and line breaks. */
|
|
3525
|
+
prettyPrint?: boolean;
|
|
3526
|
+
/** 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. */
|
|
3527
|
+
quotaUser?: string;
|
|
3528
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3529
|
+
upload_protocol?: string;
|
|
3530
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3531
|
+
uploadType?: string;
|
|
3532
|
+
}): Request<GoogleCloudDiscoveryengineV1betaListCustomModelsResponse>;
|
|
3533
|
+
}
|
|
3433
3534
|
interface OperationsResource {
|
|
3434
3535
|
/** 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. */
|
|
3435
3536
|
get(request?: {
|
|
@@ -4318,7 +4419,7 @@ declare namespace gapi.client {
|
|
|
4318
4419
|
fields?: string;
|
|
4319
4420
|
/** 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. */
|
|
4320
4421
|
key?: string;
|
|
4321
|
-
/** Immutable. Fully qualified name `project
|
|
4422
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
4322
4423
|
name: string;
|
|
4323
4424
|
/** OAuth 2.0 token for the current user. */
|
|
4324
4425
|
oauth_token?: string;
|
|
@@ -4349,7 +4450,7 @@ declare namespace gapi.client {
|
|
|
4349
4450
|
fields?: string;
|
|
4350
4451
|
/** 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. */
|
|
4351
4452
|
key?: string;
|
|
4352
|
-
/** Immutable. Fully qualified name `project
|
|
4453
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
4353
4454
|
name: string;
|
|
4354
4455
|
/** OAuth 2.0 token for the current user. */
|
|
4355
4456
|
oauth_token?: string;
|
|
@@ -5247,7 +5348,7 @@ declare namespace gapi.client {
|
|
|
5247
5348
|
key?: string;
|
|
5248
5349
|
/** OAuth 2.0 token for the current user. */
|
|
5249
5350
|
oauth_token?: string;
|
|
5250
|
-
/** Required. The parent
|
|
5351
|
+
/** 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}`. */
|
|
5251
5352
|
parent: string;
|
|
5252
5353
|
/** Returns response with indentations and line breaks. */
|
|
5253
5354
|
prettyPrint?: boolean;
|
|
@@ -5276,7 +5377,7 @@ declare namespace gapi.client {
|
|
|
5276
5377
|
key?: string;
|
|
5277
5378
|
/** OAuth 2.0 token for the current user. */
|
|
5278
5379
|
oauth_token?: string;
|
|
5279
|
-
/** Required. The parent
|
|
5380
|
+
/** 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}`. */
|
|
5280
5381
|
parent: string;
|
|
5281
5382
|
/** Returns response with indentations and line breaks. */
|
|
5282
5383
|
prettyPrint?: boolean;
|
|
@@ -5485,7 +5586,7 @@ declare namespace gapi.client {
|
|
|
5485
5586
|
callback?: string;
|
|
5486
5587
|
/** Selector specifying which fields to include in a partial response. */
|
|
5487
5588
|
fields?: string;
|
|
5488
|
-
/** Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
|
|
5589
|
+
/** Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
|
|
5489
5590
|
filter?: string;
|
|
5490
5591
|
/** 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. */
|
|
5491
5592
|
key?: string;
|
|
@@ -5628,6 +5729,7 @@ declare namespace gapi.client {
|
|
|
5628
5729
|
): Request<GoogleLongrunningOperation>;
|
|
5629
5730
|
branches: BranchesResource;
|
|
5630
5731
|
conversations: ConversationsResource;
|
|
5732
|
+
customModels: CustomModelsResource;
|
|
5631
5733
|
models: ModelsResource;
|
|
5632
5734
|
operations: OperationsResource;
|
|
5633
5735
|
schemas: SchemasResource;
|
|
@@ -5857,7 +5959,7 @@ declare namespace gapi.client {
|
|
|
5857
5959
|
fields?: string;
|
|
5858
5960
|
/** 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. */
|
|
5859
5961
|
key?: string;
|
|
5860
|
-
/** Immutable. Fully qualified name `project
|
|
5962
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. */
|
|
5861
5963
|
name: string;
|
|
5862
5964
|
/** OAuth 2.0 token for the current user. */
|
|
5863
5965
|
oauth_token?: string;
|
|
@@ -5888,7 +5990,7 @@ declare namespace gapi.client {
|
|
|
5888
5990
|
fields?: string;
|
|
5889
5991
|
/** 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. */
|
|
5890
5992
|
key?: string;
|
|
5891
|
-
/** Immutable. Fully qualified name `project
|
|
5993
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. */
|
|
5892
5994
|
name: string;
|
|
5893
5995
|
/** OAuth 2.0 token for the current user. */
|
|
5894
5996
|
oauth_token?: string;
|
|
@@ -6455,7 +6557,7 @@ declare namespace gapi.client {
|
|
|
6455
6557
|
fields?: string;
|
|
6456
6558
|
/** 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. */
|
|
6457
6559
|
key?: string;
|
|
6458
|
-
/** Immutable. Fully qualified name `project
|
|
6560
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
6459
6561
|
name: string;
|
|
6460
6562
|
/** OAuth 2.0 token for the current user. */
|
|
6461
6563
|
oauth_token?: string;
|
|
@@ -6486,7 +6588,7 @@ declare namespace gapi.client {
|
|
|
6486
6588
|
fields?: string;
|
|
6487
6589
|
/** 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. */
|
|
6488
6590
|
key?: string;
|
|
6489
|
-
/** Immutable. Fully qualified name `project
|
|
6591
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
6490
6592
|
name: string;
|
|
6491
6593
|
/** OAuth 2.0 token for the current user. */
|
|
6492
6594
|
oauth_token?: string;
|
|
@@ -7194,6 +7296,8 @@ declare namespace gapi.client {
|
|
|
7194
7296
|
prettyPrint?: boolean;
|
|
7195
7297
|
/** 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. */
|
|
7196
7298
|
quotaUser?: string;
|
|
7299
|
+
/** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
|
|
7300
|
+
updateMask?: string;
|
|
7197
7301
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7198
7302
|
upload_protocol?: string;
|
|
7199
7303
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -7225,6 +7329,8 @@ declare namespace gapi.client {
|
|
|
7225
7329
|
prettyPrint?: boolean;
|
|
7226
7330
|
/** 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. */
|
|
7227
7331
|
quotaUser?: string;
|
|
7332
|
+
/** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
|
|
7333
|
+
updateMask?: string;
|
|
7228
7334
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7229
7335
|
upload_protocol?: string;
|
|
7230
7336
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -7577,7 +7683,7 @@ declare namespace gapi.client {
|
|
|
7577
7683
|
fields?: string;
|
|
7578
7684
|
/** 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. */
|
|
7579
7685
|
key?: string;
|
|
7580
|
-
/** Immutable. Fully qualified name `project
|
|
7686
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. */
|
|
7581
7687
|
name: string;
|
|
7582
7688
|
/** OAuth 2.0 token for the current user. */
|
|
7583
7689
|
oauth_token?: string;
|
|
@@ -7608,7 +7714,7 @@ declare namespace gapi.client {
|
|
|
7608
7714
|
fields?: string;
|
|
7609
7715
|
/** 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. */
|
|
7610
7716
|
key?: string;
|
|
7611
|
-
/** Immutable. Fully qualified name `project
|
|
7717
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. */
|
|
7612
7718
|
name: string;
|
|
7613
7719
|
/** OAuth 2.0 token for the current user. */
|
|
7614
7720
|
oauth_token?: string;
|
|
@@ -8451,7 +8557,7 @@ declare namespace gapi.client {
|
|
|
8451
8557
|
fields?: string;
|
|
8452
8558
|
/** 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. */
|
|
8453
8559
|
key?: string;
|
|
8454
|
-
/** Immutable. Fully qualified name `project
|
|
8560
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
8455
8561
|
name: string;
|
|
8456
8562
|
/** OAuth 2.0 token for the current user. */
|
|
8457
8563
|
oauth_token?: string;
|
|
@@ -8482,7 +8588,7 @@ declare namespace gapi.client {
|
|
|
8482
8588
|
fields?: string;
|
|
8483
8589
|
/** 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. */
|
|
8484
8590
|
key?: string;
|
|
8485
|
-
/** Immutable. Fully qualified name `project
|
|
8591
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
8486
8592
|
name: string;
|
|
8487
8593
|
/** OAuth 2.0 token for the current user. */
|
|
8488
8594
|
oauth_token?: string;
|
|
@@ -9165,7 +9271,7 @@ declare namespace gapi.client {
|
|
|
9165
9271
|
key?: string;
|
|
9166
9272
|
/** OAuth 2.0 token for the current user. */
|
|
9167
9273
|
oauth_token?: string;
|
|
9168
|
-
/** Required. The parent
|
|
9274
|
+
/** 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}`. */
|
|
9169
9275
|
parent: string;
|
|
9170
9276
|
/** Returns response with indentations and line breaks. */
|
|
9171
9277
|
prettyPrint?: boolean;
|
|
@@ -9194,7 +9300,7 @@ declare namespace gapi.client {
|
|
|
9194
9300
|
key?: string;
|
|
9195
9301
|
/** OAuth 2.0 token for the current user. */
|
|
9196
9302
|
oauth_token?: string;
|
|
9197
|
-
/** Required. The parent
|
|
9303
|
+
/** 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}`. */
|
|
9198
9304
|
parent: string;
|
|
9199
9305
|
/** Returns response with indentations and line breaks. */
|
|
9200
9306
|
prettyPrint?: boolean;
|
|
@@ -9403,7 +9509,7 @@ declare namespace gapi.client {
|
|
|
9403
9509
|
callback?: string;
|
|
9404
9510
|
/** Selector specifying which fields to include in a partial response. */
|
|
9405
9511
|
fields?: string;
|
|
9406
|
-
/** Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
|
|
9512
|
+
/** Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
|
|
9407
9513
|
filter?: string;
|
|
9408
9514
|
/** 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. */
|
|
9409
9515
|
key?: string;
|
|
@@ -9679,12 +9785,73 @@ declare namespace gapi.client {
|
|
|
9679
9785
|
body: GoogleCloudDiscoveryengineV1betaRankRequest
|
|
9680
9786
|
): Request<GoogleCloudDiscoveryengineV1betaRankResponse>;
|
|
9681
9787
|
}
|
|
9788
|
+
interface UserEventsResource {
|
|
9789
|
+
/** Writes a single user event. */
|
|
9790
|
+
write(request: {
|
|
9791
|
+
/** V1 error format. */
|
|
9792
|
+
'$.xgafv'?: string;
|
|
9793
|
+
/** OAuth access token. */
|
|
9794
|
+
access_token?: string;
|
|
9795
|
+
/** Data format for response. */
|
|
9796
|
+
alt?: string;
|
|
9797
|
+
/** JSONP */
|
|
9798
|
+
callback?: string;
|
|
9799
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9800
|
+
fields?: string;
|
|
9801
|
+
/** 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. */
|
|
9802
|
+
key?: string;
|
|
9803
|
+
/** OAuth 2.0 token for the current user. */
|
|
9804
|
+
oauth_token?: string;
|
|
9805
|
+
/** 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}`. */
|
|
9806
|
+
parent: string;
|
|
9807
|
+
/** Returns response with indentations and line breaks. */
|
|
9808
|
+
prettyPrint?: boolean;
|
|
9809
|
+
/** 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. */
|
|
9810
|
+
quotaUser?: string;
|
|
9811
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9812
|
+
upload_protocol?: string;
|
|
9813
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9814
|
+
uploadType?: string;
|
|
9815
|
+
/** Request body */
|
|
9816
|
+
resource: GoogleCloudDiscoveryengineV1betaUserEvent;
|
|
9817
|
+
}): Request<GoogleCloudDiscoveryengineV1betaUserEvent>;
|
|
9818
|
+
write(
|
|
9819
|
+
request: {
|
|
9820
|
+
/** V1 error format. */
|
|
9821
|
+
'$.xgafv'?: string;
|
|
9822
|
+
/** OAuth access token. */
|
|
9823
|
+
access_token?: string;
|
|
9824
|
+
/** Data format for response. */
|
|
9825
|
+
alt?: string;
|
|
9826
|
+
/** JSONP */
|
|
9827
|
+
callback?: string;
|
|
9828
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9829
|
+
fields?: string;
|
|
9830
|
+
/** 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. */
|
|
9831
|
+
key?: string;
|
|
9832
|
+
/** OAuth 2.0 token for the current user. */
|
|
9833
|
+
oauth_token?: string;
|
|
9834
|
+
/** 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}`. */
|
|
9835
|
+
parent: string;
|
|
9836
|
+
/** Returns response with indentations and line breaks. */
|
|
9837
|
+
prettyPrint?: boolean;
|
|
9838
|
+
/** 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. */
|
|
9839
|
+
quotaUser?: string;
|
|
9840
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9841
|
+
upload_protocol?: string;
|
|
9842
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9843
|
+
uploadType?: string;
|
|
9844
|
+
},
|
|
9845
|
+
body: GoogleCloudDiscoveryengineV1betaUserEvent
|
|
9846
|
+
): Request<GoogleCloudDiscoveryengineV1betaUserEvent>;
|
|
9847
|
+
}
|
|
9682
9848
|
interface LocationsResource {
|
|
9683
9849
|
collections: CollectionsResource;
|
|
9684
9850
|
dataStores: DataStoresResource;
|
|
9685
9851
|
groundingConfigs: GroundingConfigsResource;
|
|
9686
9852
|
operations: OperationsResource;
|
|
9687
9853
|
rankingConfigs: RankingConfigsResource;
|
|
9854
|
+
userEvents: UserEventsResource;
|
|
9688
9855
|
}
|
|
9689
9856
|
interface OperationsResource {
|
|
9690
9857
|
/** 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. */
|