@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20241030 → 0.0.20241107
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 +42 -8
- 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: 20241107
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -2783,12 +2783,18 @@ declare namespace gapi.client {
|
|
|
2783
2783
|
}
|
|
2784
2784
|
interface GoogleCloudDiscoveryengineV1CheckGroundingResponse {
|
|
2785
2785
|
/** List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. */
|
|
2786
|
-
citedChunks?:
|
|
2786
|
+
citedChunks?: GoogleCloudDiscoveryengineV1FactChunk[];
|
|
2787
|
+
/** List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. */
|
|
2788
|
+
citedFacts?: GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk[];
|
|
2787
2789
|
/** Claim texts and citation info across all claims in the answer candidate. */
|
|
2788
2790
|
claims?: GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim[];
|
|
2789
2791
|
/** The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned. */
|
|
2790
2792
|
supportScore?: number;
|
|
2791
2793
|
}
|
|
2794
|
+
interface GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk {
|
|
2795
|
+
/** Text content of the fact chunk. Can be at most 10K characters long. */
|
|
2796
|
+
chunkText?: string;
|
|
2797
|
+
}
|
|
2792
2798
|
interface GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim {
|
|
2793
2799
|
/** A list of indices (into 'cited_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited supporting for the claim. A citation to a fact indicates that the claim is supported by the fact. */
|
|
2794
2800
|
citationIndices?: number[];
|
|
@@ -2801,12 +2807,6 @@ declare namespace gapi.client {
|
|
|
2801
2807
|
/** Position indicating the start of the claim in the answer candidate, measured in bytes. */
|
|
2802
2808
|
startPos?: number;
|
|
2803
2809
|
}
|
|
2804
|
-
interface GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk {
|
|
2805
|
-
/** Text content of the fact chunk. Can be at most 10K characters long. */
|
|
2806
|
-
chunkText?: string;
|
|
2807
|
-
/** Source from which this fact chunk was retrieved. For a fact chunk retrieved from inline facts, this field will contain the index of the specific fact from which this chunk was retrieved. */
|
|
2808
|
-
source?: string;
|
|
2809
|
-
}
|
|
2810
2810
|
interface GoogleCloudDiscoveryengineV1CheckGroundingSpec {
|
|
2811
2811
|
/** The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6. */
|
|
2812
2812
|
citationThreshold?: number;
|
|
@@ -3317,6 +3317,34 @@ declare namespace gapi.client {
|
|
|
3317
3317
|
/** 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. */
|
|
3318
3318
|
searchTier?: string;
|
|
3319
3319
|
}
|
|
3320
|
+
interface GoogleCloudDiscoveryengineV1FactChunk {
|
|
3321
|
+
/** Text content of the fact chunk. Can be at most 10K characters long. */
|
|
3322
|
+
chunkText?: string;
|
|
3323
|
+
/** The index of this chunk. Currently, only used for the streaming mode. */
|
|
3324
|
+
index?: number;
|
|
3325
|
+
/** 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. */
|
|
3326
|
+
source?: string;
|
|
3327
|
+
/** More fine-grained information for the source reference. */
|
|
3328
|
+
sourceMetadata?: {[P in string]: string};
|
|
3329
|
+
}
|
|
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
|
+
}
|
|
3320
3348
|
interface GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse {
|
|
3321
3349
|
/** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
3322
3350
|
nextPageToken?: string;
|
|
@@ -3582,6 +3610,8 @@ declare namespace gapi.client {
|
|
|
3582
3610
|
interface GoogleCloudDiscoveryengineV1PanelInfo {
|
|
3583
3611
|
/** The display name of the panel. */
|
|
3584
3612
|
displayName?: string;
|
|
3613
|
+
/** Optional. The document IDs associated with this panel. */
|
|
3614
|
+
documents?: GoogleCloudDiscoveryengineV1DocumentInfo[];
|
|
3585
3615
|
/** Required. The panel ID. */
|
|
3586
3616
|
panelId?: string;
|
|
3587
3617
|
/** The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set. */
|
|
@@ -4273,6 +4303,8 @@ declare namespace gapi.client {
|
|
|
4273
4303
|
eventTime?: string;
|
|
4274
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. */
|
|
4275
4305
|
eventType?: string;
|
|
4306
|
+
/** Optional. This field is optional except for the `add-feedback` event types. */
|
|
4307
|
+
feedback?: GoogleCloudDiscoveryengineV1Feedback;
|
|
4276
4308
|
/** 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. */
|
|
4277
4309
|
filter?: string;
|
|
4278
4310
|
/** Media-specific info. */
|
|
@@ -4281,6 +4313,8 @@ declare namespace gapi.client {
|
|
|
4281
4313
|
pageInfo?: GoogleCloudDiscoveryengineV1PageInfo;
|
|
4282
4314
|
/** Panel metadata associated with this user event. */
|
|
4283
4315
|
panel?: GoogleCloudDiscoveryengineV1PanelInfo;
|
|
4316
|
+
/** Optional. List of panels associated with this event. Used for page-level impression data. */
|
|
4317
|
+
panels?: GoogleCloudDiscoveryengineV1PanelInfo[];
|
|
4284
4318
|
/** The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID. */
|
|
4285
4319
|
promotionIds?: string[];
|
|
4286
4320
|
/** SearchService.Search details related to the event. This field should be set for `search` event. */
|