@maxim_mazurok/gapi.client.discoveryengine-v1beta 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=v1beta
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20241107
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -1968,12 +1968,18 @@ declare namespace gapi.client {
|
|
|
1968
1968
|
}
|
|
1969
1969
|
interface GoogleCloudDiscoveryengineV1betaCheckGroundingResponse {
|
|
1970
1970
|
/** List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. */
|
|
1971
|
-
citedChunks?:
|
|
1971
|
+
citedChunks?: GoogleCloudDiscoveryengineV1betaFactChunk[];
|
|
1972
|
+
/** List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. */
|
|
1973
|
+
citedFacts?: GoogleCloudDiscoveryengineV1betaCheckGroundingResponseCheckGroundingFactChunk[];
|
|
1972
1974
|
/** Claim texts and citation info across all claims in the answer candidate. */
|
|
1973
1975
|
claims?: GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim[];
|
|
1974
1976
|
/** 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. */
|
|
1975
1977
|
supportScore?: number;
|
|
1976
1978
|
}
|
|
1979
|
+
interface GoogleCloudDiscoveryengineV1betaCheckGroundingResponseCheckGroundingFactChunk {
|
|
1980
|
+
/** Text content of the fact chunk. Can be at most 10K characters long. */
|
|
1981
|
+
chunkText?: string;
|
|
1982
|
+
}
|
|
1977
1983
|
interface GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim {
|
|
1978
1984
|
/** 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. */
|
|
1979
1985
|
citationIndices?: number[];
|
|
@@ -1986,12 +1992,6 @@ declare namespace gapi.client {
|
|
|
1986
1992
|
/** Position indicating the start of the claim in the answer candidate, measured in bytes. */
|
|
1987
1993
|
startPos?: number;
|
|
1988
1994
|
}
|
|
1989
|
-
interface GoogleCloudDiscoveryengineV1betaCheckGroundingResponseFactChunk {
|
|
1990
|
-
/** Text content of the fact chunk. Can be at most 10K characters long. */
|
|
1991
|
-
chunkText?: string;
|
|
1992
|
-
/** 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. */
|
|
1993
|
-
source?: string;
|
|
1994
|
-
}
|
|
1995
1995
|
interface GoogleCloudDiscoveryengineV1betaCheckGroundingSpec {
|
|
1996
1996
|
/** 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. */
|
|
1997
1997
|
citationThreshold?: number;
|
|
@@ -2557,6 +2557,34 @@ declare namespace gapi.client {
|
|
|
2557
2557
|
/** Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. */
|
|
2558
2558
|
sampleQuerySet?: string;
|
|
2559
2559
|
}
|
|
2560
|
+
interface GoogleCloudDiscoveryengineV1betaFactChunk {
|
|
2561
|
+
/** Text content of the fact chunk. Can be at most 10K characters long. */
|
|
2562
|
+
chunkText?: string;
|
|
2563
|
+
/** The index of this chunk. Currently, only used for the streaming mode. */
|
|
2564
|
+
index?: number;
|
|
2565
|
+
/** 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. */
|
|
2566
|
+
source?: string;
|
|
2567
|
+
/** More fine-grained information for the source reference. */
|
|
2568
|
+
sourceMetadata?: {[P in string]: string};
|
|
2569
|
+
}
|
|
2570
|
+
interface GoogleCloudDiscoveryengineV1betaFeedback {
|
|
2571
|
+
/** Optional. The additional user comment of the feedback if user gives a thumb down. */
|
|
2572
|
+
comment?: string;
|
|
2573
|
+
/** The related conversation information when user gives feedback. */
|
|
2574
|
+
conversationInfo?: GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo;
|
|
2575
|
+
/** Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details. */
|
|
2576
|
+
feedbackType?: string;
|
|
2577
|
+
/** The version of the LLM model that was used to generate the response. */
|
|
2578
|
+
llmModelVersion?: string;
|
|
2579
|
+
/** Optional. The reason if user gives a thumb down. */
|
|
2580
|
+
reasons?: string[];
|
|
2581
|
+
}
|
|
2582
|
+
interface GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo {
|
|
2583
|
+
/** The index of the user input within the conversation messages. */
|
|
2584
|
+
questionIndex?: number;
|
|
2585
|
+
/** Name of the newly generated or continued session. */
|
|
2586
|
+
session?: string;
|
|
2587
|
+
}
|
|
2560
2588
|
interface GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse {
|
|
2561
2589
|
/** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
2562
2590
|
nextPageToken?: string;
|
|
@@ -2912,6 +2940,8 @@ declare namespace gapi.client {
|
|
|
2912
2940
|
interface GoogleCloudDiscoveryengineV1betaPanelInfo {
|
|
2913
2941
|
/** The display name of the panel. */
|
|
2914
2942
|
displayName?: string;
|
|
2943
|
+
/** Optional. The document IDs associated with this panel. */
|
|
2944
|
+
documents?: GoogleCloudDiscoveryengineV1betaDocumentInfo[];
|
|
2915
2945
|
/** Required. The panel ID. */
|
|
2916
2946
|
panelId?: string;
|
|
2917
2947
|
/** The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set. */
|
|
@@ -3860,6 +3890,8 @@ declare namespace gapi.client {
|
|
|
3860
3890
|
eventTime?: string;
|
|
3861
3891
|
/** 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. */
|
|
3862
3892
|
eventType?: string;
|
|
3893
|
+
/** Optional. This field is optional except for the `add-feedback` event types. */
|
|
3894
|
+
feedback?: GoogleCloudDiscoveryengineV1betaFeedback;
|
|
3863
3895
|
/** 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. */
|
|
3864
3896
|
filter?: string;
|
|
3865
3897
|
/** Media-specific info. */
|
|
@@ -3868,6 +3900,8 @@ declare namespace gapi.client {
|
|
|
3868
3900
|
pageInfo?: GoogleCloudDiscoveryengineV1betaPageInfo;
|
|
3869
3901
|
/** Panel metadata associated with this user event. */
|
|
3870
3902
|
panel?: GoogleCloudDiscoveryengineV1betaPanelInfo;
|
|
3903
|
+
/** Optional. List of panels associated with this event. Used for page-level impression data. */
|
|
3904
|
+
panels?: GoogleCloudDiscoveryengineV1betaPanelInfo[];
|
|
3871
3905
|
/** The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID. */
|
|
3872
3906
|
promotionIds?: string[];
|
|
3873
3907
|
/** SearchService.Search details related to the event. This field should be set for `search` event. */
|