@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20241123 → 0.0.20241205
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 +514 -4
- 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=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20241205
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -196,6 +196,10 @@ declare namespace gapi.client {
|
|
|
196
196
|
completeTime?: string;
|
|
197
197
|
/** Output only. Answer creation timestamp. */
|
|
198
198
|
createTime?: string;
|
|
199
|
+
/** A score in the range of [0, 1] describing how grounded the answer is by the reference chunks. */
|
|
200
|
+
groundingScore?: number;
|
|
201
|
+
/** Optional. Grounding supports. */
|
|
202
|
+
groundingSupports?: GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport[];
|
|
199
203
|
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*` */
|
|
200
204
|
name?: string;
|
|
201
205
|
/** Query understanding information. */
|
|
@@ -221,6 +225,18 @@ declare namespace gapi.client {
|
|
|
221
225
|
/** ID of the citation source. */
|
|
222
226
|
referenceId?: string;
|
|
223
227
|
}
|
|
228
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport {
|
|
229
|
+
/** Required. End of the claim, exclusive. */
|
|
230
|
+
endIndex?: string;
|
|
231
|
+
/** Indicates that this claim required grounding check. When the system decided this claim didn't require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore `grounding_score`, `sources` is not returned. */
|
|
232
|
+
groundingCheckRequired?: boolean;
|
|
233
|
+
/** A score in the range of [0, 1] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks. */
|
|
234
|
+
groundingScore?: number;
|
|
235
|
+
/** Optional. Citation sources for the claim. */
|
|
236
|
+
sources?: GoogleCloudDiscoveryengineV1alphaAnswerCitationSource[];
|
|
237
|
+
/** Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode). */
|
|
238
|
+
startIndex?: string;
|
|
239
|
+
}
|
|
224
240
|
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo {
|
|
225
241
|
/** Query classification information. */
|
|
226
242
|
queryClassificationInfo?: GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo[];
|
|
@@ -574,6 +590,10 @@ declare namespace gapi.client {
|
|
|
574
590
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
575
591
|
updateTime?: string;
|
|
576
592
|
}
|
|
593
|
+
interface GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest {
|
|
594
|
+
/** Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
595
|
+
name?: string;
|
|
596
|
+
}
|
|
577
597
|
interface GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata {
|
|
578
598
|
/** Operation create time. */
|
|
579
599
|
createTime?: string;
|
|
@@ -799,6 +819,12 @@ declare namespace gapi.client {
|
|
|
799
819
|
/** If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. */
|
|
800
820
|
searchableOption?: string;
|
|
801
821
|
}
|
|
822
|
+
interface GoogleCloudDiscoveryengineV1alphaGetSessionRequest {
|
|
823
|
+
/** Optional. If set to true, the full session including all answer details will be returned. */
|
|
824
|
+
includeAnswerDetails?: boolean;
|
|
825
|
+
/** Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
826
|
+
name?: string;
|
|
827
|
+
}
|
|
802
828
|
interface GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse {
|
|
803
829
|
/** Document data keyed by URI pattern. For example: document_data_map = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } } */
|
|
804
830
|
documentDataMap?: {[P in string]: {[P in string]: any}};
|
|
@@ -927,6 +953,24 @@ declare namespace gapi.client {
|
|
|
927
953
|
/** List of custom tuning models. */
|
|
928
954
|
models?: GoogleCloudDiscoveryengineV1alphaCustomTuningModel[];
|
|
929
955
|
}
|
|
956
|
+
interface GoogleCloudDiscoveryengineV1alphaListSessionsRequest {
|
|
957
|
+
/** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
|
|
958
|
+
filter?: string;
|
|
959
|
+
/** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time" */
|
|
960
|
+
orderBy?: string;
|
|
961
|
+
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
962
|
+
pageSize?: number;
|
|
963
|
+
/** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
|
|
964
|
+
pageToken?: string;
|
|
965
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
966
|
+
parent?: string;
|
|
967
|
+
}
|
|
968
|
+
interface GoogleCloudDiscoveryengineV1alphaListSessionsResponse {
|
|
969
|
+
/** Pagination token, if not returned indicates the last page. */
|
|
970
|
+
nextPageToken?: string;
|
|
971
|
+
/** All the Sessions for a given data store. */
|
|
972
|
+
sessions?: GoogleCloudDiscoveryengineV1alphaSession[];
|
|
973
|
+
}
|
|
930
974
|
interface GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig {
|
|
931
975
|
/** Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. */
|
|
932
976
|
mode?: string;
|
|
@@ -1283,6 +1327,8 @@ declare namespace gapi.client {
|
|
|
1283
1327
|
version?: string;
|
|
1284
1328
|
}
|
|
1285
1329
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
|
|
1330
|
+
/** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
|
|
1331
|
+
boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
1286
1332
|
/** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
|
|
1287
1333
|
dataStore?: string;
|
|
1288
1334
|
/** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
|
|
@@ -1359,8 +1405,12 @@ declare namespace gapi.client {
|
|
|
1359
1405
|
mode?: string;
|
|
1360
1406
|
}
|
|
1361
1407
|
interface GoogleCloudDiscoveryengineV1alphaSession {
|
|
1408
|
+
/** Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. */
|
|
1409
|
+
displayName?: string;
|
|
1362
1410
|
/** Output only. The time the session finished. */
|
|
1363
1411
|
endTime?: string;
|
|
1412
|
+
/** Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. */
|
|
1413
|
+
isPinned?: boolean;
|
|
1364
1414
|
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
1365
1415
|
name?: string;
|
|
1366
1416
|
/** Output only. The time the session started. */
|
|
@@ -1466,6 +1516,12 @@ declare namespace gapi.client {
|
|
|
1466
1516
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1467
1517
|
updateTime?: string;
|
|
1468
1518
|
}
|
|
1519
|
+
interface GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest {
|
|
1520
|
+
/** Required. The Session to update. */
|
|
1521
|
+
session?: GoogleCloudDiscoveryengineV1alphaSession;
|
|
1522
|
+
/** Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. */
|
|
1523
|
+
updateMask?: string;
|
|
1524
|
+
}
|
|
1469
1525
|
interface GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata {
|
|
1470
1526
|
/** Operation create time. */
|
|
1471
1527
|
createTime?: string;
|
|
@@ -1499,6 +1555,10 @@ declare namespace gapi.client {
|
|
|
1499
1555
|
completeTime?: string;
|
|
1500
1556
|
/** Output only. Answer creation timestamp. */
|
|
1501
1557
|
createTime?: string;
|
|
1558
|
+
/** A score in the range of [0, 1] describing how grounded the answer is by the reference chunks. */
|
|
1559
|
+
groundingScore?: number;
|
|
1560
|
+
/** Optional. Grounding supports. */
|
|
1561
|
+
groundingSupports?: GoogleCloudDiscoveryengineV1AnswerGroundingSupport[];
|
|
1502
1562
|
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*` */
|
|
1503
1563
|
name?: string;
|
|
1504
1564
|
/** Query understanding information. */
|
|
@@ -1524,6 +1584,18 @@ declare namespace gapi.client {
|
|
|
1524
1584
|
/** ID of the citation source. */
|
|
1525
1585
|
referenceId?: string;
|
|
1526
1586
|
}
|
|
1587
|
+
interface GoogleCloudDiscoveryengineV1AnswerGroundingSupport {
|
|
1588
|
+
/** Required. End of the claim, exclusive. */
|
|
1589
|
+
endIndex?: string;
|
|
1590
|
+
/** Indicates that this claim required grounding check. When the system decided this claim didn't require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore `grounding_score`, `sources` is not returned. */
|
|
1591
|
+
groundingCheckRequired?: boolean;
|
|
1592
|
+
/** A score in the range of [0, 1] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks. */
|
|
1593
|
+
groundingScore?: number;
|
|
1594
|
+
/** Optional. Citation sources for the claim. */
|
|
1595
|
+
sources?: GoogleCloudDiscoveryengineV1AnswerCitationSource[];
|
|
1596
|
+
/** Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode). */
|
|
1597
|
+
startIndex?: string;
|
|
1598
|
+
}
|
|
1527
1599
|
interface GoogleCloudDiscoveryengineV1AnswerQueryRequest {
|
|
1528
1600
|
/** Answer generation specification. */
|
|
1529
1601
|
answerGenerationSpec?: GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec;
|
|
@@ -1595,6 +1667,12 @@ declare namespace gapi.client {
|
|
|
1595
1667
|
disable?: boolean;
|
|
1596
1668
|
/** Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default. */
|
|
1597
1669
|
maxRephraseSteps?: number;
|
|
1670
|
+
/** Optional. Query Rephraser Model specification. */
|
|
1671
|
+
modelSpec?: GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec;
|
|
1672
|
+
}
|
|
1673
|
+
interface GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpecModelSpec {
|
|
1674
|
+
/** Optional. Enabled query rephraser model type. If not set, it will use LARGE by default. */
|
|
1675
|
+
modelType?: string;
|
|
1598
1676
|
}
|
|
1599
1677
|
interface GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec {
|
|
1600
1678
|
/** Enable related questions feature if true. */
|
|
@@ -2593,6 +2671,8 @@ declare namespace gapi.client {
|
|
|
2593
2671
|
version?: string;
|
|
2594
2672
|
}
|
|
2595
2673
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
|
|
2674
|
+
/** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
|
|
2675
|
+
boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
|
|
2596
2676
|
/** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
|
|
2597
2677
|
dataStore?: string;
|
|
2598
2678
|
/** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
|
|
@@ -3396,6 +3476,8 @@ declare namespace gapi.client {
|
|
|
3396
3476
|
gcsStagingDir?: string;
|
|
3397
3477
|
/** The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty. */
|
|
3398
3478
|
resourceTypes?: string[];
|
|
3479
|
+
/** Optional. Whether to update the DataStore schema to the latest predefined schema. If true, the DataStore schema will be updated to include any FHIR fields or resource types that have been added since the last import and corresponding FHIR resources will be imported from the FHIR store. Note this field cannot be used in conjunction with `resource_types`. It should be used after initial import. */
|
|
3480
|
+
updateFromLatestPredefinedSchema?: boolean;
|
|
3399
3481
|
}
|
|
3400
3482
|
interface GoogleCloudDiscoveryengineV1FirestoreSource {
|
|
3401
3483
|
/** Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters. */
|
|
@@ -4009,6 +4091,8 @@ declare namespace gapi.client {
|
|
|
4009
4091
|
version?: string;
|
|
4010
4092
|
}
|
|
4011
4093
|
interface GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec {
|
|
4094
|
+
/** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
|
|
4095
|
+
boostSpec?: GoogleCloudDiscoveryengineV1SearchRequestBoostSpec;
|
|
4012
4096
|
/** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
|
|
4013
4097
|
dataStore?: string;
|
|
4014
4098
|
/** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
|
|
@@ -4180,9 +4264,69 @@ declare namespace gapi.client {
|
|
|
4180
4264
|
/** Summary text with no citation information. */
|
|
4181
4265
|
summary?: string;
|
|
4182
4266
|
}
|
|
4267
|
+
interface GoogleCloudDiscoveryengineV1ServingConfig {
|
|
4268
|
+
/** Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls. */
|
|
4269
|
+
boostControlIds?: string[];
|
|
4270
|
+
/** Output only. ServingConfig created timestamp. */
|
|
4271
|
+
createTime?: string;
|
|
4272
|
+
/** Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
4273
|
+
displayName?: string;
|
|
4274
|
+
/** Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
|
|
4275
|
+
dissociateControlIds?: string[];
|
|
4276
|
+
/** How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
|
|
4277
|
+
diversityLevel?: string;
|
|
4278
|
+
/** Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls. */
|
|
4279
|
+
filterControlIds?: string[];
|
|
4280
|
+
/** The GenericConfig of the serving configuration. */
|
|
4281
|
+
genericConfig?: GoogleCloudDiscoveryengineV1ServingConfigGenericConfig;
|
|
4282
|
+
/** Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100. */
|
|
4283
|
+
ignoreControlIds?: string[];
|
|
4284
|
+
/** The MediaConfig of the serving configuration. */
|
|
4285
|
+
mediaConfig?: GoogleCloudDiscoveryengineV1ServingConfigMediaConfig;
|
|
4286
|
+
/** The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
|
|
4287
|
+
modelId?: string;
|
|
4288
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
4289
|
+
name?: string;
|
|
4290
|
+
/** Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
|
|
4291
|
+
onewaySynonymsControlIds?: string[];
|
|
4292
|
+
/** Condition promote specifications. Maximum number of specifications is 100. */
|
|
4293
|
+
promoteControlIds?: string[];
|
|
4294
|
+
/** The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. */
|
|
4295
|
+
rankingExpression?: string;
|
|
4296
|
+
/** IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
|
|
4297
|
+
redirectControlIds?: string[];
|
|
4298
|
+
/** Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
|
|
4299
|
+
replacementControlIds?: string[];
|
|
4300
|
+
/** Required. Immutable. Specifies the solution type that a serving config can be associated with. */
|
|
4301
|
+
solutionType?: string;
|
|
4302
|
+
/** Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
|
|
4303
|
+
synonymsControlIds?: string[];
|
|
4304
|
+
/** Output only. ServingConfig updated timestamp. */
|
|
4305
|
+
updateTime?: string;
|
|
4306
|
+
}
|
|
4307
|
+
interface GoogleCloudDiscoveryengineV1ServingConfigGenericConfig {
|
|
4308
|
+
/** Specifies the expected behavior of content search. Only valid for content-search enabled data store. */
|
|
4309
|
+
contentSearchSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec;
|
|
4310
|
+
}
|
|
4311
|
+
interface GoogleCloudDiscoveryengineV1ServingConfigMediaConfig {
|
|
4312
|
+
/** Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. */
|
|
4313
|
+
contentFreshnessCutoffDays?: number;
|
|
4314
|
+
/** Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. */
|
|
4315
|
+
contentWatchedPercentageThreshold?: number;
|
|
4316
|
+
/** Specifies the content watched minutes threshold for demotion. */
|
|
4317
|
+
contentWatchedSecondsThreshold?: number;
|
|
4318
|
+
/** Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. */
|
|
4319
|
+
demoteContentWatchedPastDays?: number;
|
|
4320
|
+
/** Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. */
|
|
4321
|
+
demotionEventType?: string;
|
|
4322
|
+
}
|
|
4183
4323
|
interface GoogleCloudDiscoveryengineV1Session {
|
|
4324
|
+
/** Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. */
|
|
4325
|
+
displayName?: string;
|
|
4184
4326
|
/** Output only. The time the session finished. */
|
|
4185
4327
|
endTime?: string;
|
|
4328
|
+
/** Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. */
|
|
4329
|
+
isPinned?: boolean;
|
|
4186
4330
|
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
4187
4331
|
name?: string;
|
|
4188
4332
|
/** Output only. The time the session started. */
|
|
@@ -6116,6 +6260,68 @@ declare namespace gapi.client {
|
|
|
6116
6260
|
},
|
|
6117
6261
|
body: GoogleCloudDiscoveryengineV1AnswerQueryRequest
|
|
6118
6262
|
): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
|
|
6263
|
+
/** Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. */
|
|
6264
|
+
patch(request: {
|
|
6265
|
+
/** V1 error format. */
|
|
6266
|
+
'$.xgafv'?: string;
|
|
6267
|
+
/** OAuth access token. */
|
|
6268
|
+
access_token?: string;
|
|
6269
|
+
/** Data format for response. */
|
|
6270
|
+
alt?: string;
|
|
6271
|
+
/** JSONP */
|
|
6272
|
+
callback?: string;
|
|
6273
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6274
|
+
fields?: string;
|
|
6275
|
+
/** 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. */
|
|
6276
|
+
key?: string;
|
|
6277
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
6278
|
+
name: string;
|
|
6279
|
+
/** OAuth 2.0 token for the current user. */
|
|
6280
|
+
oauth_token?: string;
|
|
6281
|
+
/** Returns response with indentations and line breaks. */
|
|
6282
|
+
prettyPrint?: boolean;
|
|
6283
|
+
/** 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. */
|
|
6284
|
+
quotaUser?: string;
|
|
6285
|
+
/** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
|
|
6286
|
+
updateMask?: string;
|
|
6287
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6288
|
+
upload_protocol?: string;
|
|
6289
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6290
|
+
uploadType?: string;
|
|
6291
|
+
/** Request body */
|
|
6292
|
+
resource: GoogleCloudDiscoveryengineV1ServingConfig;
|
|
6293
|
+
}): Request<GoogleCloudDiscoveryengineV1ServingConfig>;
|
|
6294
|
+
patch(
|
|
6295
|
+
request: {
|
|
6296
|
+
/** V1 error format. */
|
|
6297
|
+
'$.xgafv'?: string;
|
|
6298
|
+
/** OAuth access token. */
|
|
6299
|
+
access_token?: string;
|
|
6300
|
+
/** Data format for response. */
|
|
6301
|
+
alt?: string;
|
|
6302
|
+
/** JSONP */
|
|
6303
|
+
callback?: string;
|
|
6304
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6305
|
+
fields?: string;
|
|
6306
|
+
/** 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. */
|
|
6307
|
+
key?: string;
|
|
6308
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
6309
|
+
name: string;
|
|
6310
|
+
/** OAuth 2.0 token for the current user. */
|
|
6311
|
+
oauth_token?: string;
|
|
6312
|
+
/** Returns response with indentations and line breaks. */
|
|
6313
|
+
prettyPrint?: boolean;
|
|
6314
|
+
/** 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. */
|
|
6315
|
+
quotaUser?: string;
|
|
6316
|
+
/** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
|
|
6317
|
+
updateMask?: string;
|
|
6318
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6319
|
+
upload_protocol?: string;
|
|
6320
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6321
|
+
uploadType?: string;
|
|
6322
|
+
},
|
|
6323
|
+
body: GoogleCloudDiscoveryengineV1ServingConfig
|
|
6324
|
+
): Request<GoogleCloudDiscoveryengineV1ServingConfig>;
|
|
6119
6325
|
/** Makes a recommendation, which requires a contextual user event. */
|
|
6120
6326
|
recommend(request: {
|
|
6121
6327
|
/** V1 error format. */
|
|
@@ -6290,6 +6496,64 @@ declare namespace gapi.client {
|
|
|
6290
6496
|
},
|
|
6291
6497
|
body: GoogleCloudDiscoveryengineV1SearchRequest
|
|
6292
6498
|
): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
|
|
6499
|
+
/** Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream. */
|
|
6500
|
+
streamAnswer(request: {
|
|
6501
|
+
/** V1 error format. */
|
|
6502
|
+
'$.xgafv'?: string;
|
|
6503
|
+
/** OAuth access token. */
|
|
6504
|
+
access_token?: string;
|
|
6505
|
+
/** Data format for response. */
|
|
6506
|
+
alt?: string;
|
|
6507
|
+
/** JSONP */
|
|
6508
|
+
callback?: string;
|
|
6509
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6510
|
+
fields?: string;
|
|
6511
|
+
/** 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. */
|
|
6512
|
+
key?: string;
|
|
6513
|
+
/** OAuth 2.0 token for the current user. */
|
|
6514
|
+
oauth_token?: string;
|
|
6515
|
+
/** Returns response with indentations and line breaks. */
|
|
6516
|
+
prettyPrint?: boolean;
|
|
6517
|
+
/** 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. */
|
|
6518
|
+
quotaUser?: string;
|
|
6519
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
6520
|
+
servingConfig: string;
|
|
6521
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6522
|
+
upload_protocol?: string;
|
|
6523
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6524
|
+
uploadType?: string;
|
|
6525
|
+
/** Request body */
|
|
6526
|
+
resource: GoogleCloudDiscoveryengineV1AnswerQueryRequest;
|
|
6527
|
+
}): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
|
|
6528
|
+
streamAnswer(
|
|
6529
|
+
request: {
|
|
6530
|
+
/** V1 error format. */
|
|
6531
|
+
'$.xgafv'?: string;
|
|
6532
|
+
/** OAuth access token. */
|
|
6533
|
+
access_token?: string;
|
|
6534
|
+
/** Data format for response. */
|
|
6535
|
+
alt?: string;
|
|
6536
|
+
/** JSONP */
|
|
6537
|
+
callback?: string;
|
|
6538
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6539
|
+
fields?: string;
|
|
6540
|
+
/** 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. */
|
|
6541
|
+
key?: string;
|
|
6542
|
+
/** OAuth 2.0 token for the current user. */
|
|
6543
|
+
oauth_token?: string;
|
|
6544
|
+
/** Returns response with indentations and line breaks. */
|
|
6545
|
+
prettyPrint?: boolean;
|
|
6546
|
+
/** 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. */
|
|
6547
|
+
quotaUser?: string;
|
|
6548
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
6549
|
+
servingConfig: string;
|
|
6550
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6551
|
+
upload_protocol?: string;
|
|
6552
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6553
|
+
uploadType?: string;
|
|
6554
|
+
},
|
|
6555
|
+
body: GoogleCloudDiscoveryengineV1AnswerQueryRequest
|
|
6556
|
+
): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
|
|
6293
6557
|
}
|
|
6294
6558
|
interface AnswersResource {
|
|
6295
6559
|
/** Gets a Answer. */
|
|
@@ -6418,6 +6682,8 @@ declare namespace gapi.client {
|
|
|
6418
6682
|
callback?: string;
|
|
6419
6683
|
/** Selector specifying which fields to include in a partial response. */
|
|
6420
6684
|
fields?: string;
|
|
6685
|
+
/** Optional. If set to true, the full session including all answer details will be returned. */
|
|
6686
|
+
includeAnswerDetails?: boolean;
|
|
6421
6687
|
/** 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. */
|
|
6422
6688
|
key?: string;
|
|
6423
6689
|
/** Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
@@ -7322,7 +7588,7 @@ declare namespace gapi.client {
|
|
|
7322
7588
|
key?: string;
|
|
7323
7589
|
/** OAuth 2.0 token for the current user. */
|
|
7324
7590
|
oauth_token?: string;
|
|
7325
|
-
/** Required. The parent
|
|
7591
|
+
/** Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
|
|
7326
7592
|
parent: string;
|
|
7327
7593
|
/** Returns response with indentations and line breaks. */
|
|
7328
7594
|
prettyPrint?: boolean;
|
|
@@ -8481,6 +8747,68 @@ declare namespace gapi.client {
|
|
|
8481
8747
|
},
|
|
8482
8748
|
body: GoogleCloudDiscoveryengineV1AnswerQueryRequest
|
|
8483
8749
|
): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
|
|
8750
|
+
/** Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. */
|
|
8751
|
+
patch(request: {
|
|
8752
|
+
/** V1 error format. */
|
|
8753
|
+
'$.xgafv'?: string;
|
|
8754
|
+
/** OAuth access token. */
|
|
8755
|
+
access_token?: string;
|
|
8756
|
+
/** Data format for response. */
|
|
8757
|
+
alt?: string;
|
|
8758
|
+
/** JSONP */
|
|
8759
|
+
callback?: string;
|
|
8760
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8761
|
+
fields?: string;
|
|
8762
|
+
/** 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. */
|
|
8763
|
+
key?: string;
|
|
8764
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
8765
|
+
name: string;
|
|
8766
|
+
/** OAuth 2.0 token for the current user. */
|
|
8767
|
+
oauth_token?: string;
|
|
8768
|
+
/** Returns response with indentations and line breaks. */
|
|
8769
|
+
prettyPrint?: boolean;
|
|
8770
|
+
/** 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. */
|
|
8771
|
+
quotaUser?: string;
|
|
8772
|
+
/** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
|
|
8773
|
+
updateMask?: string;
|
|
8774
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8775
|
+
upload_protocol?: string;
|
|
8776
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8777
|
+
uploadType?: string;
|
|
8778
|
+
/** Request body */
|
|
8779
|
+
resource: GoogleCloudDiscoveryengineV1ServingConfig;
|
|
8780
|
+
}): Request<GoogleCloudDiscoveryengineV1ServingConfig>;
|
|
8781
|
+
patch(
|
|
8782
|
+
request: {
|
|
8783
|
+
/** V1 error format. */
|
|
8784
|
+
'$.xgafv'?: string;
|
|
8785
|
+
/** OAuth access token. */
|
|
8786
|
+
access_token?: string;
|
|
8787
|
+
/** Data format for response. */
|
|
8788
|
+
alt?: string;
|
|
8789
|
+
/** JSONP */
|
|
8790
|
+
callback?: string;
|
|
8791
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8792
|
+
fields?: string;
|
|
8793
|
+
/** 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. */
|
|
8794
|
+
key?: string;
|
|
8795
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
8796
|
+
name: string;
|
|
8797
|
+
/** OAuth 2.0 token for the current user. */
|
|
8798
|
+
oauth_token?: string;
|
|
8799
|
+
/** Returns response with indentations and line breaks. */
|
|
8800
|
+
prettyPrint?: boolean;
|
|
8801
|
+
/** 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. */
|
|
8802
|
+
quotaUser?: string;
|
|
8803
|
+
/** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
|
|
8804
|
+
updateMask?: string;
|
|
8805
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8806
|
+
upload_protocol?: string;
|
|
8807
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8808
|
+
uploadType?: string;
|
|
8809
|
+
},
|
|
8810
|
+
body: GoogleCloudDiscoveryengineV1ServingConfig
|
|
8811
|
+
): Request<GoogleCloudDiscoveryengineV1ServingConfig>;
|
|
8484
8812
|
/** Makes a recommendation, which requires a contextual user event. */
|
|
8485
8813
|
recommend(request: {
|
|
8486
8814
|
/** V1 error format. */
|
|
@@ -8655,6 +8983,64 @@ declare namespace gapi.client {
|
|
|
8655
8983
|
},
|
|
8656
8984
|
body: GoogleCloudDiscoveryengineV1SearchRequest
|
|
8657
8985
|
): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
|
|
8986
|
+
/** Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream. */
|
|
8987
|
+
streamAnswer(request: {
|
|
8988
|
+
/** V1 error format. */
|
|
8989
|
+
'$.xgafv'?: string;
|
|
8990
|
+
/** OAuth access token. */
|
|
8991
|
+
access_token?: string;
|
|
8992
|
+
/** Data format for response. */
|
|
8993
|
+
alt?: string;
|
|
8994
|
+
/** JSONP */
|
|
8995
|
+
callback?: string;
|
|
8996
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8997
|
+
fields?: string;
|
|
8998
|
+
/** 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. */
|
|
8999
|
+
key?: string;
|
|
9000
|
+
/** OAuth 2.0 token for the current user. */
|
|
9001
|
+
oauth_token?: string;
|
|
9002
|
+
/** Returns response with indentations and line breaks. */
|
|
9003
|
+
prettyPrint?: boolean;
|
|
9004
|
+
/** 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. */
|
|
9005
|
+
quotaUser?: string;
|
|
9006
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
9007
|
+
servingConfig: string;
|
|
9008
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9009
|
+
upload_protocol?: string;
|
|
9010
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9011
|
+
uploadType?: string;
|
|
9012
|
+
/** Request body */
|
|
9013
|
+
resource: GoogleCloudDiscoveryengineV1AnswerQueryRequest;
|
|
9014
|
+
}): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
|
|
9015
|
+
streamAnswer(
|
|
9016
|
+
request: {
|
|
9017
|
+
/** V1 error format. */
|
|
9018
|
+
'$.xgafv'?: string;
|
|
9019
|
+
/** OAuth access token. */
|
|
9020
|
+
access_token?: string;
|
|
9021
|
+
/** Data format for response. */
|
|
9022
|
+
alt?: string;
|
|
9023
|
+
/** JSONP */
|
|
9024
|
+
callback?: string;
|
|
9025
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9026
|
+
fields?: string;
|
|
9027
|
+
/** 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. */
|
|
9028
|
+
key?: string;
|
|
9029
|
+
/** OAuth 2.0 token for the current user. */
|
|
9030
|
+
oauth_token?: string;
|
|
9031
|
+
/** Returns response with indentations and line breaks. */
|
|
9032
|
+
prettyPrint?: boolean;
|
|
9033
|
+
/** 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. */
|
|
9034
|
+
quotaUser?: string;
|
|
9035
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
9036
|
+
servingConfig: string;
|
|
9037
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9038
|
+
upload_protocol?: string;
|
|
9039
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9040
|
+
uploadType?: string;
|
|
9041
|
+
},
|
|
9042
|
+
body: GoogleCloudDiscoveryengineV1AnswerQueryRequest
|
|
9043
|
+
): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
|
|
8658
9044
|
}
|
|
8659
9045
|
interface AnswersResource {
|
|
8660
9046
|
/** Gets a Answer. */
|
|
@@ -8783,6 +9169,8 @@ declare namespace gapi.client {
|
|
|
8783
9169
|
callback?: string;
|
|
8784
9170
|
/** Selector specifying which fields to include in a partial response. */
|
|
8785
9171
|
fields?: string;
|
|
9172
|
+
/** Optional. If set to true, the full session including all answer details will be returned. */
|
|
9173
|
+
includeAnswerDetails?: boolean;
|
|
8786
9174
|
/** 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. */
|
|
8787
9175
|
key?: string;
|
|
8788
9176
|
/** Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
@@ -10666,6 +11054,68 @@ declare namespace gapi.client {
|
|
|
10666
11054
|
},
|
|
10667
11055
|
body: GoogleCloudDiscoveryengineV1AnswerQueryRequest
|
|
10668
11056
|
): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
|
|
11057
|
+
/** Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. */
|
|
11058
|
+
patch(request: {
|
|
11059
|
+
/** V1 error format. */
|
|
11060
|
+
'$.xgafv'?: string;
|
|
11061
|
+
/** OAuth access token. */
|
|
11062
|
+
access_token?: string;
|
|
11063
|
+
/** Data format for response. */
|
|
11064
|
+
alt?: string;
|
|
11065
|
+
/** JSONP */
|
|
11066
|
+
callback?: string;
|
|
11067
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11068
|
+
fields?: string;
|
|
11069
|
+
/** 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. */
|
|
11070
|
+
key?: string;
|
|
11071
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
11072
|
+
name: string;
|
|
11073
|
+
/** OAuth 2.0 token for the current user. */
|
|
11074
|
+
oauth_token?: string;
|
|
11075
|
+
/** Returns response with indentations and line breaks. */
|
|
11076
|
+
prettyPrint?: boolean;
|
|
11077
|
+
/** 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. */
|
|
11078
|
+
quotaUser?: string;
|
|
11079
|
+
/** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
|
|
11080
|
+
updateMask?: string;
|
|
11081
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11082
|
+
upload_protocol?: string;
|
|
11083
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11084
|
+
uploadType?: string;
|
|
11085
|
+
/** Request body */
|
|
11086
|
+
resource: GoogleCloudDiscoveryengineV1ServingConfig;
|
|
11087
|
+
}): Request<GoogleCloudDiscoveryengineV1ServingConfig>;
|
|
11088
|
+
patch(
|
|
11089
|
+
request: {
|
|
11090
|
+
/** V1 error format. */
|
|
11091
|
+
'$.xgafv'?: string;
|
|
11092
|
+
/** OAuth access token. */
|
|
11093
|
+
access_token?: string;
|
|
11094
|
+
/** Data format for response. */
|
|
11095
|
+
alt?: string;
|
|
11096
|
+
/** JSONP */
|
|
11097
|
+
callback?: string;
|
|
11098
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11099
|
+
fields?: string;
|
|
11100
|
+
/** 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. */
|
|
11101
|
+
key?: string;
|
|
11102
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
11103
|
+
name: string;
|
|
11104
|
+
/** OAuth 2.0 token for the current user. */
|
|
11105
|
+
oauth_token?: string;
|
|
11106
|
+
/** Returns response with indentations and line breaks. */
|
|
11107
|
+
prettyPrint?: boolean;
|
|
11108
|
+
/** 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. */
|
|
11109
|
+
quotaUser?: string;
|
|
11110
|
+
/** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
|
|
11111
|
+
updateMask?: string;
|
|
11112
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11113
|
+
upload_protocol?: string;
|
|
11114
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11115
|
+
uploadType?: string;
|
|
11116
|
+
},
|
|
11117
|
+
body: GoogleCloudDiscoveryengineV1ServingConfig
|
|
11118
|
+
): Request<GoogleCloudDiscoveryengineV1ServingConfig>;
|
|
10669
11119
|
/** Makes a recommendation, which requires a contextual user event. */
|
|
10670
11120
|
recommend(request: {
|
|
10671
11121
|
/** V1 error format. */
|
|
@@ -10840,6 +11290,64 @@ declare namespace gapi.client {
|
|
|
10840
11290
|
},
|
|
10841
11291
|
body: GoogleCloudDiscoveryengineV1SearchRequest
|
|
10842
11292
|
): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
|
|
11293
|
+
/** Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream. */
|
|
11294
|
+
streamAnswer(request: {
|
|
11295
|
+
/** V1 error format. */
|
|
11296
|
+
'$.xgafv'?: string;
|
|
11297
|
+
/** OAuth access token. */
|
|
11298
|
+
access_token?: string;
|
|
11299
|
+
/** Data format for response. */
|
|
11300
|
+
alt?: string;
|
|
11301
|
+
/** JSONP */
|
|
11302
|
+
callback?: string;
|
|
11303
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11304
|
+
fields?: string;
|
|
11305
|
+
/** 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. */
|
|
11306
|
+
key?: string;
|
|
11307
|
+
/** OAuth 2.0 token for the current user. */
|
|
11308
|
+
oauth_token?: string;
|
|
11309
|
+
/** Returns response with indentations and line breaks. */
|
|
11310
|
+
prettyPrint?: boolean;
|
|
11311
|
+
/** 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. */
|
|
11312
|
+
quotaUser?: string;
|
|
11313
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
11314
|
+
servingConfig: string;
|
|
11315
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11316
|
+
upload_protocol?: string;
|
|
11317
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11318
|
+
uploadType?: string;
|
|
11319
|
+
/** Request body */
|
|
11320
|
+
resource: GoogleCloudDiscoveryengineV1AnswerQueryRequest;
|
|
11321
|
+
}): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
|
|
11322
|
+
streamAnswer(
|
|
11323
|
+
request: {
|
|
11324
|
+
/** V1 error format. */
|
|
11325
|
+
'$.xgafv'?: string;
|
|
11326
|
+
/** OAuth access token. */
|
|
11327
|
+
access_token?: string;
|
|
11328
|
+
/** Data format for response. */
|
|
11329
|
+
alt?: string;
|
|
11330
|
+
/** JSONP */
|
|
11331
|
+
callback?: string;
|
|
11332
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11333
|
+
fields?: string;
|
|
11334
|
+
/** 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. */
|
|
11335
|
+
key?: string;
|
|
11336
|
+
/** OAuth 2.0 token for the current user. */
|
|
11337
|
+
oauth_token?: string;
|
|
11338
|
+
/** Returns response with indentations and line breaks. */
|
|
11339
|
+
prettyPrint?: boolean;
|
|
11340
|
+
/** 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. */
|
|
11341
|
+
quotaUser?: string;
|
|
11342
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
11343
|
+
servingConfig: string;
|
|
11344
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11345
|
+
upload_protocol?: string;
|
|
11346
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11347
|
+
uploadType?: string;
|
|
11348
|
+
},
|
|
11349
|
+
body: GoogleCloudDiscoveryengineV1AnswerQueryRequest
|
|
11350
|
+
): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
|
|
10843
11351
|
}
|
|
10844
11352
|
interface AnswersResource {
|
|
10845
11353
|
/** Gets a Answer. */
|
|
@@ -10968,6 +11476,8 @@ declare namespace gapi.client {
|
|
|
10968
11476
|
callback?: string;
|
|
10969
11477
|
/** Selector specifying which fields to include in a partial response. */
|
|
10970
11478
|
fields?: string;
|
|
11479
|
+
/** Optional. If set to true, the full session including all answer details will be returned. */
|
|
11480
|
+
includeAnswerDetails?: boolean;
|
|
10971
11481
|
/** 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. */
|
|
10972
11482
|
key?: string;
|
|
10973
11483
|
/** Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
@@ -11657,7 +12167,7 @@ declare namespace gapi.client {
|
|
|
11657
12167
|
key?: string;
|
|
11658
12168
|
/** OAuth 2.0 token for the current user. */
|
|
11659
12169
|
oauth_token?: string;
|
|
11660
|
-
/** Required. The parent
|
|
12170
|
+
/** Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
|
|
11661
12171
|
parent: string;
|
|
11662
12172
|
/** Returns response with indentations and line breaks. */
|
|
11663
12173
|
prettyPrint?: boolean;
|
|
@@ -12420,7 +12930,7 @@ declare namespace gapi.client {
|
|
|
12420
12930
|
key?: string;
|
|
12421
12931
|
/** OAuth 2.0 token for the current user. */
|
|
12422
12932
|
oauth_token?: string;
|
|
12423
|
-
/** Required. The parent
|
|
12933
|
+
/** Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
|
|
12424
12934
|
parent: string;
|
|
12425
12935
|
/** Returns response with indentations and line breaks. */
|
|
12426
12936
|
prettyPrint?: boolean;
|