@maxim_mazurok/gapi.client.discoveryengine-v1alpha 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=v1alpha
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20241107
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -678,12 +678,18 @@ declare namespace gapi.client {
|
|
|
678
678
|
}
|
|
679
679
|
interface GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse {
|
|
680
680
|
/** List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. */
|
|
681
|
-
citedChunks?:
|
|
681
|
+
citedChunks?: GoogleCloudDiscoveryengineV1alphaFactChunk[];
|
|
682
|
+
/** List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. */
|
|
683
|
+
citedFacts?: GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk[];
|
|
682
684
|
/** Claim texts and citation info across all claims in the answer candidate. */
|
|
683
685
|
claims?: GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim[];
|
|
684
686
|
/** 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. */
|
|
685
687
|
supportScore?: number;
|
|
686
688
|
}
|
|
689
|
+
interface GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk {
|
|
690
|
+
/** Text content of the fact chunk. Can be at most 10K characters long. */
|
|
691
|
+
chunkText?: string;
|
|
692
|
+
}
|
|
687
693
|
interface GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim {
|
|
688
694
|
/** 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. */
|
|
689
695
|
citationIndices?: number[];
|
|
@@ -696,12 +702,6 @@ declare namespace gapi.client {
|
|
|
696
702
|
/** Position indicating the start of the claim in the answer candidate, measured in bytes. */
|
|
697
703
|
startPos?: number;
|
|
698
704
|
}
|
|
699
|
-
interface GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseFactChunk {
|
|
700
|
-
/** Text content of the fact chunk. Can be at most 10K characters long. */
|
|
701
|
-
chunkText?: string;
|
|
702
|
-
/** 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. */
|
|
703
|
-
source?: string;
|
|
704
|
-
}
|
|
705
705
|
interface GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec {
|
|
706
706
|
/** 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. */
|
|
707
707
|
citationThreshold?: number;
|
|
@@ -1394,6 +1394,34 @@ declare namespace gapi.client {
|
|
|
1394
1394
|
/** Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. */
|
|
1395
1395
|
sampleQuerySet?: string;
|
|
1396
1396
|
}
|
|
1397
|
+
interface GoogleCloudDiscoveryengineV1alphaFactChunk {
|
|
1398
|
+
/** Text content of the fact chunk. Can be at most 10K characters long. */
|
|
1399
|
+
chunkText?: string;
|
|
1400
|
+
/** The index of this chunk. Currently, only used for the streaming mode. */
|
|
1401
|
+
index?: number;
|
|
1402
|
+
/** 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. */
|
|
1403
|
+
source?: string;
|
|
1404
|
+
/** More fine-grained information for the source reference. */
|
|
1405
|
+
sourceMetadata?: {[P in string]: string};
|
|
1406
|
+
}
|
|
1407
|
+
interface GoogleCloudDiscoveryengineV1alphaFeedback {
|
|
1408
|
+
/** Optional. The additional user comment of the feedback if user gives a thumb down. */
|
|
1409
|
+
comment?: string;
|
|
1410
|
+
/** The related conversation information when user gives feedback. */
|
|
1411
|
+
conversationInfo?: GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo;
|
|
1412
|
+
/** Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details. */
|
|
1413
|
+
feedbackType?: string;
|
|
1414
|
+
/** The version of the LLM model that was used to generate the response. */
|
|
1415
|
+
llmModelVersion?: string;
|
|
1416
|
+
/** Optional. The reason if user gives a thumb down. */
|
|
1417
|
+
reasons?: string[];
|
|
1418
|
+
}
|
|
1419
|
+
interface GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo {
|
|
1420
|
+
/** The index of the user input within the conversation messages. */
|
|
1421
|
+
questionIndex?: number;
|
|
1422
|
+
/** Name of the newly generated or continued session. */
|
|
1423
|
+
session?: string;
|
|
1424
|
+
}
|
|
1397
1425
|
interface GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse {
|
|
1398
1426
|
/** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
1399
1427
|
nextPageToken?: string;
|
|
@@ -1823,6 +1851,8 @@ declare namespace gapi.client {
|
|
|
1823
1851
|
interface GoogleCloudDiscoveryengineV1alphaPanelInfo {
|
|
1824
1852
|
/** The display name of the panel. */
|
|
1825
1853
|
displayName?: string;
|
|
1854
|
+
/** Optional. The document IDs associated with this panel. */
|
|
1855
|
+
documents?: GoogleCloudDiscoveryengineV1alphaDocumentInfo[];
|
|
1826
1856
|
/** Required. The panel ID. */
|
|
1827
1857
|
panelId?: string;
|
|
1828
1858
|
/** The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set. */
|
|
@@ -2934,6 +2964,8 @@ declare namespace gapi.client {
|
|
|
2934
2964
|
eventTime?: string;
|
|
2935
2965
|
/** 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. */
|
|
2936
2966
|
eventType?: string;
|
|
2967
|
+
/** Optional. This field is optional except for the `add-feedback` event types. */
|
|
2968
|
+
feedback?: GoogleCloudDiscoveryengineV1alphaFeedback;
|
|
2937
2969
|
/** 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. */
|
|
2938
2970
|
filter?: string;
|
|
2939
2971
|
/** Media-specific info. */
|
|
@@ -2942,6 +2974,8 @@ declare namespace gapi.client {
|
|
|
2942
2974
|
pageInfo?: GoogleCloudDiscoveryengineV1alphaPageInfo;
|
|
2943
2975
|
/** Panel metadata associated with this user event. */
|
|
2944
2976
|
panel?: GoogleCloudDiscoveryengineV1alphaPanelInfo;
|
|
2977
|
+
/** Optional. List of panels associated with this event. Used for page-level impression data. */
|
|
2978
|
+
panels?: GoogleCloudDiscoveryengineV1alphaPanelInfo[];
|
|
2945
2979
|
/** The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID. */
|
|
2946
2980
|
promotionIds?: string[];
|
|
2947
2981
|
/** SearchService.Search details related to the event. This field should be set for `search` event. */
|