@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20241107 → 0.0.20241110
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 +73 -25
- 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: 20241110
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -1355,6 +1355,8 @@ declare namespace gapi.client {
|
|
|
1355
1355
|
interface GoogleCloudDiscoveryengineV1alphaSessionTurn {
|
|
1356
1356
|
/** The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. */
|
|
1357
1357
|
answer?: string;
|
|
1358
|
+
/** Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. */
|
|
1359
|
+
detailedAnswer?: GoogleCloudDiscoveryengineV1alphaAnswer;
|
|
1358
1360
|
/** The user query. */
|
|
1359
1361
|
query?: GoogleCloudDiscoveryengineV1alphaQuery;
|
|
1360
1362
|
}
|
|
@@ -1553,6 +1555,8 @@ declare namespace gapi.client {
|
|
|
1553
1555
|
preamble?: string;
|
|
1554
1556
|
}
|
|
1555
1557
|
interface GoogleCloudDiscoveryengineV1AnswerQueryRequestGroundingSpec {
|
|
1558
|
+
/** Optional. Specifies whether to enable the filtering based on grounding score and at what level. */
|
|
1559
|
+
filteringLevel?: string;
|
|
1556
1560
|
/** Optional. Specifies whether to include grounding_supports in the answer. The default value is `false`. When this field is set to `true`, returned answer will have `grounding_score` and will contain GroundingSupports for each claim. */
|
|
1557
1561
|
includeGroundingSupports?: boolean;
|
|
1558
1562
|
}
|
|
@@ -2802,7 +2806,7 @@ declare namespace gapi.client {
|
|
|
2802
2806
|
claimText?: string;
|
|
2803
2807
|
/** Position indicating the end of the claim in the answer candidate, exclusive. */
|
|
2804
2808
|
endPos?: number;
|
|
2805
|
-
/** 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
|
|
2809
|
+
/** 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 should not be returned. */
|
|
2806
2810
|
groundingCheckRequired?: boolean;
|
|
2807
2811
|
/** Position indicating the start of the claim in the answer candidate, measured in bytes. */
|
|
2808
2812
|
startPos?: number;
|
|
@@ -2826,7 +2830,7 @@ declare namespace gapi.client {
|
|
|
2826
2830
|
name?: string;
|
|
2827
2831
|
/** Page span of the chunk. */
|
|
2828
2832
|
pageSpan?: GoogleCloudDiscoveryengineV1ChunkPageSpan;
|
|
2829
|
-
/** Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on
|
|
2833
|
+
/** Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchResponse. */
|
|
2830
2834
|
relevanceScore?: number;
|
|
2831
2835
|
}
|
|
2832
2836
|
interface GoogleCloudDiscoveryengineV1ChunkChunkMetadata {
|
|
@@ -3202,6 +3206,8 @@ declare namespace gapi.client {
|
|
|
3202
3206
|
indexTime?: string;
|
|
3203
3207
|
}
|
|
3204
3208
|
interface GoogleCloudDiscoveryengineV1DocumentInfo {
|
|
3209
|
+
/** Optional. The conversion value associated with this Document. Must be set if UserEvent.event_type is "conversion". For example, a value of 1000 signifies that 1000 seconds were spent viewing a Document for the `watch` conversion type. */
|
|
3210
|
+
conversionValue?: number;
|
|
3205
3211
|
/** The Document resource ID. */
|
|
3206
3212
|
id?: string;
|
|
3207
3213
|
/** Output only. Whether the referenced Document can be found in the data store. */
|
|
@@ -3327,24 +3333,6 @@ declare namespace gapi.client {
|
|
|
3327
3333
|
/** More fine-grained information for the source reference. */
|
|
3328
3334
|
sourceMetadata?: {[P in string]: string};
|
|
3329
3335
|
}
|
|
3330
|
-
interface GoogleCloudDiscoveryengineV1Feedback {
|
|
3331
|
-
/** Optional. The additional user comment of the feedback if user gives a thumb down. */
|
|
3332
|
-
comment?: string;
|
|
3333
|
-
/** The related conversation information when user gives feedback. */
|
|
3334
|
-
conversationInfo?: GoogleCloudDiscoveryengineV1FeedbackConversationInfo;
|
|
3335
|
-
/** Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details. */
|
|
3336
|
-
feedbackType?: string;
|
|
3337
|
-
/** The version of the LLM model that was used to generate the response. */
|
|
3338
|
-
llmModelVersion?: string;
|
|
3339
|
-
/** Optional. The reason if user gives a thumb down. */
|
|
3340
|
-
reasons?: string[];
|
|
3341
|
-
}
|
|
3342
|
-
interface GoogleCloudDiscoveryengineV1FeedbackConversationInfo {
|
|
3343
|
-
/** The index of the user input within the conversation messages. */
|
|
3344
|
-
questionIndex?: number;
|
|
3345
|
-
/** Name of the newly generated or continued session. */
|
|
3346
|
-
session?: string;
|
|
3347
|
-
}
|
|
3348
3336
|
interface GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse {
|
|
3349
3337
|
/** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
3350
3338
|
nextPageToken?: string;
|
|
@@ -3731,7 +3719,7 @@ declare namespace gapi.client {
|
|
|
3731
3719
|
content?: string;
|
|
3732
3720
|
/** The unique ID to represent the record. */
|
|
3733
3721
|
id?: string;
|
|
3734
|
-
/** The score of this record based on the given query and selected model. */
|
|
3722
|
+
/** The score of this record based on the given query and selected model. The score will be rounded to 2 decimal places. If the score is close to 0, it will be rounded to 0.0001 to avoid returning unset. */
|
|
3735
3723
|
score?: number;
|
|
3736
3724
|
/** The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown. */
|
|
3737
3725
|
title?: string;
|
|
@@ -4147,6 +4135,8 @@ declare namespace gapi.client {
|
|
|
4147
4135
|
interface GoogleCloudDiscoveryengineV1SessionTurn {
|
|
4148
4136
|
/** The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. */
|
|
4149
4137
|
answer?: string;
|
|
4138
|
+
/** Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. */
|
|
4139
|
+
detailedAnswer?: GoogleCloudDiscoveryengineV1Answer;
|
|
4150
4140
|
/** The user query. */
|
|
4151
4141
|
query?: GoogleCloudDiscoveryengineV1Query;
|
|
4152
4142
|
}
|
|
@@ -4291,6 +4281,8 @@ declare namespace gapi.client {
|
|
|
4291
4281
|
attributionToken?: string;
|
|
4292
4282
|
/** CompletionService.CompleteQuery details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for search. */
|
|
4293
4283
|
completionInfo?: GoogleCloudDiscoveryengineV1CompletionInfo;
|
|
4284
|
+
/** Optional. Conversion type. Required if UserEvent.event_type is `conversion`. This is a customer-defined conversion name in lowercase letters or numbers separated by "-", such as "watch", "good-visit" etc. Do not set the field if UserEvent.event_type is not `conversion`. This mixes the custom conversion event with predefined events like `search`, `view-item` etc. */
|
|
4285
|
+
conversionType?: string;
|
|
4294
4286
|
/** The DataStore resource full name, of the form `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Optional. Only required for user events whose data store can't by determined by UserEvent.engine or UserEvent.documents. If data store is set in the parent of write/import/collect user event requests, this field can be omitted. */
|
|
4295
4287
|
dataStore?: string;
|
|
4296
4288
|
/** Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent. */
|
|
@@ -4301,10 +4293,8 @@ declare namespace gapi.client {
|
|
|
4301
4293
|
engine?: string;
|
|
4302
4294
|
/** Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. */
|
|
4303
4295
|
eventTime?: string;
|
|
4304
|
-
/** Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. */
|
|
4296
|
+
/** Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. */
|
|
4305
4297
|
eventType?: string;
|
|
4306
|
-
/** Optional. This field is optional except for the `add-feedback` event types. */
|
|
4307
|
-
feedback?: GoogleCloudDiscoveryengineV1Feedback;
|
|
4308
4298
|
/** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
4309
4299
|
filter?: string;
|
|
4310
4300
|
/** Media-specific info. */
|
|
@@ -12383,6 +12373,64 @@ declare namespace gapi.client {
|
|
|
12383
12373
|
/** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
|
|
12384
12374
|
userEvent?: string;
|
|
12385
12375
|
}): Request<GoogleApiHttpBody>;
|
|
12376
|
+
/** Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. */
|
|
12377
|
+
import(request: {
|
|
12378
|
+
/** V1 error format. */
|
|
12379
|
+
'$.xgafv'?: string;
|
|
12380
|
+
/** OAuth access token. */
|
|
12381
|
+
access_token?: string;
|
|
12382
|
+
/** Data format for response. */
|
|
12383
|
+
alt?: string;
|
|
12384
|
+
/** JSONP */
|
|
12385
|
+
callback?: string;
|
|
12386
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12387
|
+
fields?: string;
|
|
12388
|
+
/** 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. */
|
|
12389
|
+
key?: string;
|
|
12390
|
+
/** OAuth 2.0 token for the current user. */
|
|
12391
|
+
oauth_token?: string;
|
|
12392
|
+
/** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` */
|
|
12393
|
+
parent: string;
|
|
12394
|
+
/** Returns response with indentations and line breaks. */
|
|
12395
|
+
prettyPrint?: boolean;
|
|
12396
|
+
/** 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. */
|
|
12397
|
+
quotaUser?: string;
|
|
12398
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12399
|
+
upload_protocol?: string;
|
|
12400
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12401
|
+
uploadType?: string;
|
|
12402
|
+
/** Request body */
|
|
12403
|
+
resource: GoogleCloudDiscoveryengineV1ImportUserEventsRequest;
|
|
12404
|
+
}): Request<GoogleLongrunningOperation>;
|
|
12405
|
+
import(
|
|
12406
|
+
request: {
|
|
12407
|
+
/** V1 error format. */
|
|
12408
|
+
'$.xgafv'?: string;
|
|
12409
|
+
/** OAuth access token. */
|
|
12410
|
+
access_token?: string;
|
|
12411
|
+
/** Data format for response. */
|
|
12412
|
+
alt?: string;
|
|
12413
|
+
/** JSONP */
|
|
12414
|
+
callback?: string;
|
|
12415
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12416
|
+
fields?: string;
|
|
12417
|
+
/** 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. */
|
|
12418
|
+
key?: string;
|
|
12419
|
+
/** OAuth 2.0 token for the current user. */
|
|
12420
|
+
oauth_token?: string;
|
|
12421
|
+
/** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` */
|
|
12422
|
+
parent: string;
|
|
12423
|
+
/** Returns response with indentations and line breaks. */
|
|
12424
|
+
prettyPrint?: boolean;
|
|
12425
|
+
/** 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. */
|
|
12426
|
+
quotaUser?: string;
|
|
12427
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12428
|
+
upload_protocol?: string;
|
|
12429
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12430
|
+
uploadType?: string;
|
|
12431
|
+
},
|
|
12432
|
+
body: GoogleCloudDiscoveryengineV1ImportUserEventsRequest
|
|
12433
|
+
): Request<GoogleLongrunningOperation>;
|
|
12386
12434
|
/** Writes a single user event. */
|
|
12387
12435
|
write(request: {
|
|
12388
12436
|
/** V1 error format. */
|