@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20240329 → 0.0.20240409
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 +1673 -180
- 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: 20240409
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -88,6 +88,144 @@ declare namespace gapi.client {
|
|
|
88
88
|
/** Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
89
89
|
name?: string;
|
|
90
90
|
}
|
|
91
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswer {
|
|
92
|
+
/** Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. */
|
|
93
|
+
answerSkippedReasons?: string[];
|
|
94
|
+
/** The textual answer. */
|
|
95
|
+
answerText?: string;
|
|
96
|
+
/** Citations. */
|
|
97
|
+
citations?: GoogleCloudDiscoveryengineV1alphaAnswerCitation[];
|
|
98
|
+
/** Output only. Answer completed timestamp. */
|
|
99
|
+
completeTime?: string;
|
|
100
|
+
/** Output only. Answer creation timestamp. */
|
|
101
|
+
createTime?: string;
|
|
102
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*` */
|
|
103
|
+
name?: string;
|
|
104
|
+
/** Query understanding information. */
|
|
105
|
+
queryUnderstandingInfo?: GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo;
|
|
106
|
+
/** References. */
|
|
107
|
+
references?: GoogleCloudDiscoveryengineV1alphaAnswerReference[];
|
|
108
|
+
/** Suggested related questions. */
|
|
109
|
+
relatedQuestions?: string[];
|
|
110
|
+
/** The state of the answer generation. */
|
|
111
|
+
state?: string;
|
|
112
|
+
/** Answer generation steps. */
|
|
113
|
+
steps?: GoogleCloudDiscoveryengineV1alphaAnswerStep[];
|
|
114
|
+
}
|
|
115
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerCitation {
|
|
116
|
+
/** End of the attributed segment, exclusive. */
|
|
117
|
+
endIndex?: string;
|
|
118
|
+
/** Citation sources for the attributed segment. */
|
|
119
|
+
sources?: GoogleCloudDiscoveryengineV1alphaAnswerCitationSource[];
|
|
120
|
+
/** Index indicates the start of the segment, measured in bytes (UTF-8 unicode). */
|
|
121
|
+
startIndex?: string;
|
|
122
|
+
}
|
|
123
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerCitationSource {
|
|
124
|
+
/** ID of the citation source. */
|
|
125
|
+
referenceId?: string;
|
|
126
|
+
}
|
|
127
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo {
|
|
128
|
+
/** Query classification information. */
|
|
129
|
+
queryClassificationInfo?: GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo[];
|
|
130
|
+
}
|
|
131
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo {
|
|
132
|
+
/** Classification output. */
|
|
133
|
+
positive?: boolean;
|
|
134
|
+
/** Query classification type. */
|
|
135
|
+
type?: string;
|
|
136
|
+
}
|
|
137
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerReference {
|
|
138
|
+
/** Chunk information. */
|
|
139
|
+
chunkInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo;
|
|
140
|
+
/** Unstructured document information. */
|
|
141
|
+
unstructuredDocumentInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo;
|
|
142
|
+
}
|
|
143
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo {
|
|
144
|
+
/** Chunk resource name. */
|
|
145
|
+
chunk?: string;
|
|
146
|
+
/** Chunk textual content. */
|
|
147
|
+
content?: string;
|
|
148
|
+
/** Document metadata. */
|
|
149
|
+
documentMetadata?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata;
|
|
150
|
+
/** Relevance score. */
|
|
151
|
+
relevanceScore?: number;
|
|
152
|
+
}
|
|
153
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata {
|
|
154
|
+
/** Document resource name. */
|
|
155
|
+
document?: string;
|
|
156
|
+
/** Page identifier. */
|
|
157
|
+
pageIdentifier?: string;
|
|
158
|
+
/** Title. */
|
|
159
|
+
title?: string;
|
|
160
|
+
/** URI for the document. */
|
|
161
|
+
uri?: string;
|
|
162
|
+
}
|
|
163
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo {
|
|
164
|
+
/** List of cited chunk contents derived from document content. */
|
|
165
|
+
chunkContents?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
|
|
166
|
+
/** Document resource name. */
|
|
167
|
+
document?: string;
|
|
168
|
+
/** Title. */
|
|
169
|
+
title?: string;
|
|
170
|
+
/** URI for the document. */
|
|
171
|
+
uri?: string;
|
|
172
|
+
}
|
|
173
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent {
|
|
174
|
+
/** Chunk textual content. */
|
|
175
|
+
content?: string;
|
|
176
|
+
/** Page identifier. */
|
|
177
|
+
pageIdentifier?: string;
|
|
178
|
+
}
|
|
179
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerStep {
|
|
180
|
+
/** Actions. */
|
|
181
|
+
actions?: GoogleCloudDiscoveryengineV1alphaAnswerStepAction[];
|
|
182
|
+
/** The description of the step. */
|
|
183
|
+
description?: string;
|
|
184
|
+
/** The state of the step. */
|
|
185
|
+
state?: string;
|
|
186
|
+
/** The thought of the step. */
|
|
187
|
+
thought?: string;
|
|
188
|
+
}
|
|
189
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerStepAction {
|
|
190
|
+
/** Observation. */
|
|
191
|
+
observation?: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation;
|
|
192
|
+
/** Search action. */
|
|
193
|
+
searchAction?: GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction;
|
|
194
|
+
}
|
|
195
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation {
|
|
196
|
+
/** Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user. */
|
|
197
|
+
searchResults?: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult[];
|
|
198
|
+
}
|
|
199
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult {
|
|
200
|
+
/** If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info. */
|
|
201
|
+
chunkInfo?: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo[];
|
|
202
|
+
/** Document resource name. */
|
|
203
|
+
document?: string;
|
|
204
|
+
/** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
|
|
205
|
+
snippetInfo?: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[];
|
|
206
|
+
/** Title. */
|
|
207
|
+
title?: string;
|
|
208
|
+
/** URI for the document. */
|
|
209
|
+
uri?: string;
|
|
210
|
+
}
|
|
211
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo {
|
|
212
|
+
/** Chunk resource name. */
|
|
213
|
+
chunk?: string;
|
|
214
|
+
/** Chunk textual content. */
|
|
215
|
+
content?: string;
|
|
216
|
+
/** Relevance score. */
|
|
217
|
+
relevanceScore?: number;
|
|
218
|
+
}
|
|
219
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo {
|
|
220
|
+
/** Snippet content. */
|
|
221
|
+
snippet?: string;
|
|
222
|
+
/** Status of the snippet defined by the search team. */
|
|
223
|
+
snippetStatus?: string;
|
|
224
|
+
}
|
|
225
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction {
|
|
226
|
+
/** The query to search. */
|
|
227
|
+
query?: string;
|
|
228
|
+
}
|
|
91
229
|
interface GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata {
|
|
92
230
|
/** Operation create time. */
|
|
93
231
|
createTime?: string;
|
|
@@ -339,10 +477,6 @@ declare namespace gapi.client {
|
|
|
339
477
|
/** 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. */
|
|
340
478
|
searchableOption?: string;
|
|
341
479
|
}
|
|
342
|
-
interface GoogleCloudDiscoveryengineV1alphaGroundingConfig {
|
|
343
|
-
/** Required. Name of the GroundingConfig, of the form `projects/{project}/locations/{location}/groundingConfig`. */
|
|
344
|
-
name?: string;
|
|
345
|
-
}
|
|
346
480
|
interface GoogleCloudDiscoveryengineV1alphaIdpConfig {
|
|
347
481
|
/** External Identity provider config. */
|
|
348
482
|
externalIdpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig;
|
|
@@ -374,6 +508,8 @@ declare namespace gapi.client {
|
|
|
374
508
|
failureCount?: string;
|
|
375
509
|
/** Count of entries that were processed successfully. */
|
|
376
510
|
successCount?: string;
|
|
511
|
+
/** Total count of entries that were processed. */
|
|
512
|
+
totalCount?: string;
|
|
377
513
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
378
514
|
updateTime?: string;
|
|
379
515
|
}
|
|
@@ -465,6 +601,12 @@ declare namespace gapi.client {
|
|
|
465
601
|
/** The total count of events purged as a result of the operation. */
|
|
466
602
|
purgeCount?: string;
|
|
467
603
|
}
|
|
604
|
+
interface GoogleCloudDiscoveryengineV1alphaQuery {
|
|
605
|
+
/** Unique Id for the query. */
|
|
606
|
+
queryId?: string;
|
|
607
|
+
/** Plain text. */
|
|
608
|
+
text?: string;
|
|
609
|
+
}
|
|
468
610
|
interface GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata {
|
|
469
611
|
/** Operation create time. */
|
|
470
612
|
createTime?: string;
|
|
@@ -509,6 +651,26 @@ declare namespace gapi.client {
|
|
|
509
651
|
/** The structured representation of the schema. */
|
|
510
652
|
structSchema?: {[P in string]: any};
|
|
511
653
|
}
|
|
654
|
+
interface GoogleCloudDiscoveryengineV1alphaSession {
|
|
655
|
+
/** Output only. The time the session finished. */
|
|
656
|
+
endTime?: string;
|
|
657
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
658
|
+
name?: string;
|
|
659
|
+
/** Output only. The time the session started. */
|
|
660
|
+
startTime?: string;
|
|
661
|
+
/** The state of the session. */
|
|
662
|
+
state?: string;
|
|
663
|
+
/** Turns. */
|
|
664
|
+
turns?: GoogleCloudDiscoveryengineV1alphaSessionTurn[];
|
|
665
|
+
/** A unique identifier for tracking users. */
|
|
666
|
+
userPseudoId?: string;
|
|
667
|
+
}
|
|
668
|
+
interface GoogleCloudDiscoveryengineV1alphaSessionTurn {
|
|
669
|
+
/** The resource name of the answer to the user query. */
|
|
670
|
+
answer?: string;
|
|
671
|
+
/** The user query. */
|
|
672
|
+
query?: GoogleCloudDiscoveryengineV1alphaQuery;
|
|
673
|
+
}
|
|
512
674
|
interface GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo {
|
|
513
675
|
/** Site verification state indicating the ownership and validity. */
|
|
514
676
|
siteVerificationState?: string;
|
|
@@ -556,7 +718,7 @@ declare namespace gapi.client {
|
|
|
556
718
|
errorSamples?: GoogleRpcStatus[];
|
|
557
719
|
/** The metrics of the trained model. */
|
|
558
720
|
metrics?: {[P in string]: number};
|
|
559
|
-
/** The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training is in progress. * **ready**: The model is ready for serving. */
|
|
721
|
+
/** The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. */
|
|
560
722
|
modelStatus?: string;
|
|
561
723
|
}
|
|
562
724
|
interface GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata {
|
|
@@ -586,6 +748,280 @@ declare namespace gapi.client {
|
|
|
586
748
|
/** TargetSites created. */
|
|
587
749
|
targetSites?: GoogleCloudDiscoveryengineV1TargetSite[];
|
|
588
750
|
}
|
|
751
|
+
interface GoogleCloudDiscoveryengineV1betaAnswer {
|
|
752
|
+
/** Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. */
|
|
753
|
+
answerSkippedReasons?: string[];
|
|
754
|
+
/** The textual answer. */
|
|
755
|
+
answerText?: string;
|
|
756
|
+
/** Citations. */
|
|
757
|
+
citations?: GoogleCloudDiscoveryengineV1betaAnswerCitation[];
|
|
758
|
+
/** Output only. Answer completed timestamp. */
|
|
759
|
+
completeTime?: string;
|
|
760
|
+
/** Output only. Answer creation timestamp. */
|
|
761
|
+
createTime?: string;
|
|
762
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*` */
|
|
763
|
+
name?: string;
|
|
764
|
+
/** Query understanding information. */
|
|
765
|
+
queryUnderstandingInfo?: GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfo;
|
|
766
|
+
/** References. */
|
|
767
|
+
references?: GoogleCloudDiscoveryengineV1betaAnswerReference[];
|
|
768
|
+
/** Suggested related questions. */
|
|
769
|
+
relatedQuestions?: string[];
|
|
770
|
+
/** The state of the answer generation. */
|
|
771
|
+
state?: string;
|
|
772
|
+
/** Answer generation steps. */
|
|
773
|
+
steps?: GoogleCloudDiscoveryengineV1betaAnswerStep[];
|
|
774
|
+
}
|
|
775
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerCitation {
|
|
776
|
+
/** End of the attributed segment, exclusive. */
|
|
777
|
+
endIndex?: string;
|
|
778
|
+
/** Citation sources for the attributed segment. */
|
|
779
|
+
sources?: GoogleCloudDiscoveryengineV1betaAnswerCitationSource[];
|
|
780
|
+
/** Index indicates the start of the segment, measured in bytes (UTF-8 unicode). */
|
|
781
|
+
startIndex?: string;
|
|
782
|
+
}
|
|
783
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerCitationSource {
|
|
784
|
+
/** ID of the citation source. */
|
|
785
|
+
referenceId?: string;
|
|
786
|
+
}
|
|
787
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequest {
|
|
788
|
+
/** Answer generation specification. */
|
|
789
|
+
answerGenerationSpec?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec;
|
|
790
|
+
/** Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method. */
|
|
791
|
+
asynchronousMode?: boolean;
|
|
792
|
+
/** Required. Current user query. */
|
|
793
|
+
query?: GoogleCloudDiscoveryengineV1betaQuery;
|
|
794
|
+
/** Query understanding specification. */
|
|
795
|
+
queryUnderstandingSpec?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec;
|
|
796
|
+
/** Related questions specification. */
|
|
797
|
+
relatedQuestionsSpec?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestRelatedQuestionsSpec;
|
|
798
|
+
/** Model specification. */
|
|
799
|
+
safetySpec?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec;
|
|
800
|
+
/** Search specification. */
|
|
801
|
+
searchSpec?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec;
|
|
802
|
+
/** The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol “-” as session id. A new id will be automatically generated and assigned. */
|
|
803
|
+
session?: string;
|
|
804
|
+
/** A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
805
|
+
userPseudoId?: string;
|
|
806
|
+
}
|
|
807
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec {
|
|
808
|
+
/** Language code for Answer. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature. */
|
|
809
|
+
answerLanguageCode?: string;
|
|
810
|
+
/** Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead. */
|
|
811
|
+
ignoreAdversarialQuery?: boolean;
|
|
812
|
+
/** Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead. */
|
|
813
|
+
ignoreNonAnswerSeekingQuery?: boolean;
|
|
814
|
+
/** Specifies whether to include citation metadata in the answer. The default value is `false`. */
|
|
815
|
+
includeCitations?: boolean;
|
|
816
|
+
/** Answer generation model specification. */
|
|
817
|
+
modelSpec?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec;
|
|
818
|
+
/** Answer generation prompt specification. */
|
|
819
|
+
promptSpec?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec;
|
|
820
|
+
}
|
|
821
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec {
|
|
822
|
+
/** Model version. If not set, it will use the default stable model. Allowed values are: stable, preview. */
|
|
823
|
+
modelVersion?: string;
|
|
824
|
+
}
|
|
825
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec {
|
|
826
|
+
/** Customized preamble. */
|
|
827
|
+
preamble?: string;
|
|
828
|
+
}
|
|
829
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec {
|
|
830
|
+
/** Query classification specification. */
|
|
831
|
+
queryClassificationSpec?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec;
|
|
832
|
+
/** Query rephraser specification. */
|
|
833
|
+
queryRephraserSpec?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec;
|
|
834
|
+
}
|
|
835
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec {
|
|
836
|
+
/** Enabled query classification types. */
|
|
837
|
+
types?: string[];
|
|
838
|
+
}
|
|
839
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec {
|
|
840
|
+
/** Disable query rephraser. */
|
|
841
|
+
disable?: boolean;
|
|
842
|
+
/** Max rephrase steps. The max number is 10 steps. If not set or set to < 1, it will be set to 1 by default. */
|
|
843
|
+
maxRephraseSteps?: number;
|
|
844
|
+
}
|
|
845
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestRelatedQuestionsSpec {
|
|
846
|
+
/** Enable related questions feature if true. */
|
|
847
|
+
enable?: boolean;
|
|
848
|
+
}
|
|
849
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec {
|
|
850
|
+
/** Enable the safety filtering on the answer response. It is false by default. */
|
|
851
|
+
enable?: boolean;
|
|
852
|
+
}
|
|
853
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec {
|
|
854
|
+
/** Search parameters. */
|
|
855
|
+
searchParams?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams;
|
|
856
|
+
/** Search result list. */
|
|
857
|
+
searchResultList?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultList;
|
|
858
|
+
}
|
|
859
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams {
|
|
860
|
+
/** Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) */
|
|
861
|
+
boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
|
|
862
|
+
/** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
|
|
863
|
+
filter?: string;
|
|
864
|
+
/** Number of search results to return. The default value is 10. */
|
|
865
|
+
maxReturnResults?: number;
|
|
866
|
+
/** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
|
|
867
|
+
orderBy?: string;
|
|
868
|
+
}
|
|
869
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultList {
|
|
870
|
+
/** Search results. */
|
|
871
|
+
searchResults?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResult[];
|
|
872
|
+
}
|
|
873
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResult {
|
|
874
|
+
/** Chunk information. */
|
|
875
|
+
chunkInfo?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo;
|
|
876
|
+
/** Unstructured document information. */
|
|
877
|
+
unstructuredDocumentInfo?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo;
|
|
878
|
+
}
|
|
879
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo {
|
|
880
|
+
/** Chunk resource name. */
|
|
881
|
+
chunk?: string;
|
|
882
|
+
/** Chunk textual content. */
|
|
883
|
+
content?: string;
|
|
884
|
+
}
|
|
885
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo {
|
|
886
|
+
/** Document resource name. */
|
|
887
|
+
document?: string;
|
|
888
|
+
/** List of document contexts. */
|
|
889
|
+
documentContexts?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext[];
|
|
890
|
+
/** List of extractive answers. */
|
|
891
|
+
extractiveAnswers?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer[];
|
|
892
|
+
/** List of extractive segments. */
|
|
893
|
+
extractiveSegments?: GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment[];
|
|
894
|
+
/** Title. */
|
|
895
|
+
title?: string;
|
|
896
|
+
/** URI for the document. */
|
|
897
|
+
uri?: string;
|
|
898
|
+
}
|
|
899
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext {
|
|
900
|
+
/** Document content. */
|
|
901
|
+
content?: string;
|
|
902
|
+
/** Page identifier. */
|
|
903
|
+
pageIdentifier?: string;
|
|
904
|
+
}
|
|
905
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer {
|
|
906
|
+
/** Extractive answer content. */
|
|
907
|
+
content?: string;
|
|
908
|
+
/** Page identifier. */
|
|
909
|
+
pageIdentifier?: string;
|
|
910
|
+
}
|
|
911
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment {
|
|
912
|
+
/** Extractive segment content. */
|
|
913
|
+
content?: string;
|
|
914
|
+
/** Page identifier. */
|
|
915
|
+
pageIdentifier?: string;
|
|
916
|
+
}
|
|
917
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryResponse {
|
|
918
|
+
/** Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. */
|
|
919
|
+
answer?: GoogleCloudDiscoveryengineV1betaAnswer;
|
|
920
|
+
/** Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request. */
|
|
921
|
+
session?: GoogleCloudDiscoveryengineV1betaSession;
|
|
922
|
+
}
|
|
923
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfo {
|
|
924
|
+
/** Query classification information. */
|
|
925
|
+
queryClassificationInfo?: GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfoQueryClassificationInfo[];
|
|
926
|
+
}
|
|
927
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfoQueryClassificationInfo {
|
|
928
|
+
/** Classification output. */
|
|
929
|
+
positive?: boolean;
|
|
930
|
+
/** Query classification type. */
|
|
931
|
+
type?: string;
|
|
932
|
+
}
|
|
933
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerReference {
|
|
934
|
+
/** Chunk information. */
|
|
935
|
+
chunkInfo?: GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo;
|
|
936
|
+
/** Unstructured document information. */
|
|
937
|
+
unstructuredDocumentInfo?: GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo;
|
|
938
|
+
}
|
|
939
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo {
|
|
940
|
+
/** Chunk resource name. */
|
|
941
|
+
chunk?: string;
|
|
942
|
+
/** Chunk textual content. */
|
|
943
|
+
content?: string;
|
|
944
|
+
/** Document metadata. */
|
|
945
|
+
documentMetadata?: GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata;
|
|
946
|
+
/** Relevance score. */
|
|
947
|
+
relevanceScore?: number;
|
|
948
|
+
}
|
|
949
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata {
|
|
950
|
+
/** Document resource name. */
|
|
951
|
+
document?: string;
|
|
952
|
+
/** Page identifier. */
|
|
953
|
+
pageIdentifier?: string;
|
|
954
|
+
/** Title. */
|
|
955
|
+
title?: string;
|
|
956
|
+
/** URI for the document. */
|
|
957
|
+
uri?: string;
|
|
958
|
+
}
|
|
959
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo {
|
|
960
|
+
/** List of cited chunk contents derived from document content. */
|
|
961
|
+
chunkContents?: GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
|
|
962
|
+
/** Document resource name. */
|
|
963
|
+
document?: string;
|
|
964
|
+
/** Title. */
|
|
965
|
+
title?: string;
|
|
966
|
+
/** URI for the document. */
|
|
967
|
+
uri?: string;
|
|
968
|
+
}
|
|
969
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent {
|
|
970
|
+
/** Chunk textual content. */
|
|
971
|
+
content?: string;
|
|
972
|
+
/** Page identifier. */
|
|
973
|
+
pageIdentifier?: string;
|
|
974
|
+
}
|
|
975
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerStep {
|
|
976
|
+
/** Actions. */
|
|
977
|
+
actions?: GoogleCloudDiscoveryengineV1betaAnswerStepAction[];
|
|
978
|
+
/** The description of the step. */
|
|
979
|
+
description?: string;
|
|
980
|
+
/** The state of the step. */
|
|
981
|
+
state?: string;
|
|
982
|
+
/** The thought of the step. */
|
|
983
|
+
thought?: string;
|
|
984
|
+
}
|
|
985
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerStepAction {
|
|
986
|
+
/** Observation. */
|
|
987
|
+
observation?: GoogleCloudDiscoveryengineV1betaAnswerStepActionObservation;
|
|
988
|
+
/** Search action. */
|
|
989
|
+
searchAction?: GoogleCloudDiscoveryengineV1betaAnswerStepActionSearchAction;
|
|
990
|
+
}
|
|
991
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerStepActionObservation {
|
|
992
|
+
/** Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user. */
|
|
993
|
+
searchResults?: GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResult[];
|
|
994
|
+
}
|
|
995
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResult {
|
|
996
|
+
/** If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info. */
|
|
997
|
+
chunkInfo?: GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultChunkInfo[];
|
|
998
|
+
/** Document resource name. */
|
|
999
|
+
document?: string;
|
|
1000
|
+
/** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
|
|
1001
|
+
snippetInfo?: GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo[];
|
|
1002
|
+
/** Title. */
|
|
1003
|
+
title?: string;
|
|
1004
|
+
/** URI for the document. */
|
|
1005
|
+
uri?: string;
|
|
1006
|
+
}
|
|
1007
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultChunkInfo {
|
|
1008
|
+
/** Chunk resource name. */
|
|
1009
|
+
chunk?: string;
|
|
1010
|
+
/** Chunk textual content. */
|
|
1011
|
+
content?: string;
|
|
1012
|
+
/** Relevance score. */
|
|
1013
|
+
relevanceScore?: number;
|
|
1014
|
+
}
|
|
1015
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo {
|
|
1016
|
+
/** Snippet content. */
|
|
1017
|
+
snippet?: string;
|
|
1018
|
+
/** Status of the snippet defined by the search team. */
|
|
1019
|
+
snippetStatus?: string;
|
|
1020
|
+
}
|
|
1021
|
+
interface GoogleCloudDiscoveryengineV1betaAnswerStepActionSearchAction {
|
|
1022
|
+
/** The query to search. */
|
|
1023
|
+
query?: string;
|
|
1024
|
+
}
|
|
589
1025
|
interface GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata {
|
|
590
1026
|
/** Operation create time. */
|
|
591
1027
|
createTime?: string;
|
|
@@ -602,7 +1038,7 @@ declare namespace gapi.client {
|
|
|
602
1038
|
}
|
|
603
1039
|
interface GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest {}
|
|
604
1040
|
interface GoogleCloudDiscoveryengineV1betaBigQuerySource {
|
|
605
|
-
/** The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by
|
|
1041
|
+
/** The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. */
|
|
606
1042
|
dataSchema?: string;
|
|
607
1043
|
/** Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. */
|
|
608
1044
|
datasetId?: string;
|
|
@@ -620,49 +1056,79 @@ declare namespace gapi.client {
|
|
|
620
1056
|
families?: {
|
|
621
1057
|
[P in string]: GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily;
|
|
622
1058
|
};
|
|
623
|
-
/** The field name used for saving row key value in the
|
|
1059
|
+
/** The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`. */
|
|
624
1060
|
keyFieldName?: string;
|
|
625
1061
|
}
|
|
626
1062
|
interface GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumn {
|
|
627
|
-
/**
|
|
1063
|
+
/** The encoding mode of the values when the type is not `STRING`. Acceptable encoding values are: * `TEXT`: indicates values are alphanumeric text strings. * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it. */
|
|
628
1064
|
encoding?: string;
|
|
629
|
-
/** The field name to use for this column in the
|
|
1065
|
+
/** The field name to use for this column in the document. The name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the qualifier bytes with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined. */
|
|
630
1066
|
fieldName?: string;
|
|
631
|
-
/** Required. Qualifier of the column. If cannot
|
|
1067
|
+
/** Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead. */
|
|
632
1068
|
qualifier?: string;
|
|
633
|
-
/**
|
|
1069
|
+
/** The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`. */
|
|
634
1070
|
type?: string;
|
|
635
1071
|
}
|
|
636
1072
|
interface GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily {
|
|
637
1073
|
/** The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored. */
|
|
638
1074
|
columns?: GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumn[];
|
|
639
|
-
/**
|
|
1075
|
+
/** The encoding mode of the values when the type is not STRING. Acceptable encoding values are: * `TEXT`: indicates values are alphanumeric text strings. * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it. */
|
|
640
1076
|
encoding?: string;
|
|
641
|
-
/** The field name to use for this column family in the
|
|
1077
|
+
/** The field name to use for this column family in the document. The name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the family name with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined. */
|
|
642
1078
|
fieldName?: string;
|
|
643
|
-
/**
|
|
1079
|
+
/** The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`. */
|
|
644
1080
|
type?: string;
|
|
645
1081
|
}
|
|
646
1082
|
interface GoogleCloudDiscoveryengineV1betaBigtableSource {
|
|
647
1083
|
/** Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations. */
|
|
648
1084
|
bigtableOptions?: GoogleCloudDiscoveryengineV1betaBigtableOptions;
|
|
649
|
-
/** Required. The instance ID of the Cloud Bigtable that needs to be
|
|
1085
|
+
/** Required. The instance ID of the Cloud Bigtable that needs to be imported. */
|
|
650
1086
|
instanceId?: string;
|
|
651
|
-
/** The project ID
|
|
1087
|
+
/** The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
|
|
652
1088
|
projectId?: string;
|
|
653
|
-
/** Required. The table ID of the Cloud Bigtable that needs to be
|
|
1089
|
+
/** Required. The table ID of the Cloud Bigtable that needs to be imported. */
|
|
654
1090
|
tableId?: string;
|
|
655
1091
|
}
|
|
1092
|
+
interface GoogleCloudDiscoveryengineV1betaCheckGroundingRequest {
|
|
1093
|
+
/** Answer candidate to check. */
|
|
1094
|
+
answerCandidate?: string;
|
|
1095
|
+
/** List of facts for the grounding check. We support up to 200 facts. */
|
|
1096
|
+
facts?: GoogleCloudDiscoveryengineV1betaGroundingFact[];
|
|
1097
|
+
/** Configuration of the grounding check. */
|
|
1098
|
+
groundingSpec?: GoogleCloudDiscoveryengineV1betaCheckGroundingSpec;
|
|
1099
|
+
}
|
|
1100
|
+
interface GoogleCloudDiscoveryengineV1betaCheckGroundingResponse {
|
|
1101
|
+
/** List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. */
|
|
1102
|
+
citedChunks?: GoogleCloudDiscoveryengineV1betaFactChunk[];
|
|
1103
|
+
/** Claim texts and citation info across all claims in the answer candidate. */
|
|
1104
|
+
claims?: GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim[];
|
|
1105
|
+
/** 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. */
|
|
1106
|
+
supportScore?: number;
|
|
1107
|
+
}
|
|
1108
|
+
interface GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim {
|
|
1109
|
+
/** 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. */
|
|
1110
|
+
citationIndices?: number[];
|
|
1111
|
+
/** Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found. */
|
|
1112
|
+
claimText?: string;
|
|
1113
|
+
/** Position indicating the end of the claim in the answer candidate, exclusive. */
|
|
1114
|
+
endPos?: number;
|
|
1115
|
+
/** Position indicating the start of the claim in the answer candidate, measured in bytes/unicode. */
|
|
1116
|
+
startPos?: number;
|
|
1117
|
+
}
|
|
1118
|
+
interface GoogleCloudDiscoveryengineV1betaCheckGroundingSpec {
|
|
1119
|
+
/** 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. */
|
|
1120
|
+
citationThreshold?: number;
|
|
1121
|
+
}
|
|
656
1122
|
interface GoogleCloudDiscoveryengineV1betaCloudSqlSource {
|
|
657
1123
|
/** Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. */
|
|
658
1124
|
databaseId?: string;
|
|
659
|
-
/**
|
|
1125
|
+
/** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Please ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
|
|
660
1126
|
gcsStagingDir?: string;
|
|
661
1127
|
/** Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. */
|
|
662
1128
|
instanceId?: string;
|
|
663
|
-
/**
|
|
1129
|
+
/** Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless). */
|
|
664
1130
|
offload?: boolean;
|
|
665
|
-
/**
|
|
1131
|
+
/** The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
|
|
666
1132
|
projectId?: string;
|
|
667
1133
|
/** Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. */
|
|
668
1134
|
tableId?: string;
|
|
@@ -962,6 +1428,14 @@ declare namespace gapi.client {
|
|
|
962
1428
|
/** The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
|
|
963
1429
|
searchTier?: string;
|
|
964
1430
|
}
|
|
1431
|
+
interface GoogleCloudDiscoveryengineV1betaFactChunk {
|
|
1432
|
+
/** Text content of the fact chunk. Can be at most 10K characters long. */
|
|
1433
|
+
chunkText?: string;
|
|
1434
|
+
/** 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. */
|
|
1435
|
+
source?: string;
|
|
1436
|
+
/** More fine-grained information for the source reference. */
|
|
1437
|
+
sourceMetadata?: {[P in string]: string};
|
|
1438
|
+
}
|
|
965
1439
|
interface GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse {
|
|
966
1440
|
/** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
967
1441
|
nextPageToken?: string;
|
|
@@ -977,24 +1451,26 @@ declare namespace gapi.client {
|
|
|
977
1451
|
gcsStagingDir?: string;
|
|
978
1452
|
}
|
|
979
1453
|
interface GoogleCloudDiscoveryengineV1betaFirestoreSource {
|
|
980
|
-
/** Required. The Firestore collection to copy the data from with a length limit of
|
|
1454
|
+
/** Required. The Firestore collection to copy the data from with a length limit of 1,500 characters. */
|
|
981
1455
|
collectionId?: string;
|
|
982
1456
|
/** Required. The Firestore database to copy the data from with a length limit of 256 characters. */
|
|
983
1457
|
databaseId?: string;
|
|
984
|
-
/**
|
|
1458
|
+
/** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Please ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */
|
|
985
1459
|
gcsStagingDir?: string;
|
|
986
|
-
/**
|
|
1460
|
+
/** The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
|
|
987
1461
|
projectId?: string;
|
|
988
1462
|
}
|
|
989
1463
|
interface GoogleCloudDiscoveryengineV1betaGcsSource {
|
|
990
|
-
/** The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by
|
|
1464
|
+
/** The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. */
|
|
991
1465
|
dataSchema?: string;
|
|
992
1466
|
/** Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). */
|
|
993
1467
|
inputUris?: string[];
|
|
994
1468
|
}
|
|
995
|
-
interface
|
|
996
|
-
/**
|
|
997
|
-
|
|
1469
|
+
interface GoogleCloudDiscoveryengineV1betaGroundingFact {
|
|
1470
|
+
/** Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on. */
|
|
1471
|
+
attributes?: {[P in string]: string};
|
|
1472
|
+
/** Text content of the fact. Can be at most 10K characters long. */
|
|
1473
|
+
factText?: string;
|
|
998
1474
|
}
|
|
999
1475
|
interface GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata {
|
|
1000
1476
|
/** Operation create time. */
|
|
@@ -1003,11 +1479,13 @@ declare namespace gapi.client {
|
|
|
1003
1479
|
failureCount?: string;
|
|
1004
1480
|
/** Count of entries that were processed successfully. */
|
|
1005
1481
|
successCount?: string;
|
|
1482
|
+
/** Total count of entries that were processed. */
|
|
1483
|
+
totalCount?: string;
|
|
1006
1484
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1007
1485
|
updateTime?: string;
|
|
1008
1486
|
}
|
|
1009
1487
|
interface GoogleCloudDiscoveryengineV1betaImportDocumentsRequest {
|
|
1010
|
-
/** Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource * CloudSqlSource * FirestoreSource * BigtableSource */
|
|
1488
|
+
/** Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. */
|
|
1011
1489
|
autoGenerateIds?: boolean;
|
|
1012
1490
|
/** BigQuery input source. */
|
|
1013
1491
|
bigquerySource?: GoogleCloudDiscoveryengineV1betaBigQuerySource;
|
|
@@ -1023,7 +1501,7 @@ declare namespace gapi.client {
|
|
|
1023
1501
|
firestoreSource?: GoogleCloudDiscoveryengineV1betaFirestoreSource;
|
|
1024
1502
|
/** Cloud Storage location for the input content. */
|
|
1025
1503
|
gcsSource?: GoogleCloudDiscoveryengineV1betaGcsSource;
|
|
1026
|
-
/** The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource * CloudSqlSource * FirestoreSource * BigtableSource */
|
|
1504
|
+
/** The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. */
|
|
1027
1505
|
idField?: string;
|
|
1028
1506
|
/** The Inline source for the input content for documents. */
|
|
1029
1507
|
inlineSource?: GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource;
|
|
@@ -1031,6 +1509,8 @@ declare namespace gapi.client {
|
|
|
1031
1509
|
reconciliationMode?: string;
|
|
1032
1510
|
/** Spanner input source. */
|
|
1033
1511
|
spannerSource?: GoogleCloudDiscoveryengineV1betaSpannerSource;
|
|
1512
|
+
/** Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. */
|
|
1513
|
+
updateMask?: string;
|
|
1034
1514
|
}
|
|
1035
1515
|
interface GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource {
|
|
1036
1516
|
/** Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. */
|
|
@@ -1150,6 +1630,12 @@ declare namespace gapi.client {
|
|
|
1150
1630
|
/** All the ServingConfigs for a given dataStore. */
|
|
1151
1631
|
servingConfigs?: GoogleCloudDiscoveryengineV1betaServingConfig[];
|
|
1152
1632
|
}
|
|
1633
|
+
interface GoogleCloudDiscoveryengineV1betaListSessionsResponse {
|
|
1634
|
+
/** Pagination token, if not returned indicates the last page. */
|
|
1635
|
+
nextPageToken?: string;
|
|
1636
|
+
/** All the Sessions for a given data store. */
|
|
1637
|
+
sessions?: GoogleCloudDiscoveryengineV1betaSession[];
|
|
1638
|
+
}
|
|
1153
1639
|
interface GoogleCloudDiscoveryengineV1betaListTargetSitesResponse {
|
|
1154
1640
|
/** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
1155
1641
|
nextPageToken?: string;
|
|
@@ -1222,6 +1708,12 @@ declare namespace gapi.client {
|
|
|
1222
1708
|
/** Number of suggestion deny list entries purged. */
|
|
1223
1709
|
purgeCount?: string;
|
|
1224
1710
|
}
|
|
1711
|
+
interface GoogleCloudDiscoveryengineV1betaQuery {
|
|
1712
|
+
/** Unique Id for the query. */
|
|
1713
|
+
queryId?: string;
|
|
1714
|
+
/** Plain text. */
|
|
1715
|
+
text?: string;
|
|
1716
|
+
}
|
|
1225
1717
|
interface GoogleCloudDiscoveryengineV1betaRankingRecord {
|
|
1226
1718
|
/** The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown. */
|
|
1227
1719
|
content?: string;
|
|
@@ -1239,7 +1731,7 @@ declare namespace gapi.client {
|
|
|
1239
1731
|
model?: string;
|
|
1240
1732
|
/** The query to use. */
|
|
1241
1733
|
query?: string;
|
|
1242
|
-
/** Required. A list of records to rank. */
|
|
1734
|
+
/** Required. A list of records to rank. At most 100 records to rank. */
|
|
1243
1735
|
records?: GoogleCloudDiscoveryengineV1betaRankingRecord[];
|
|
1244
1736
|
/** The number of results to return. If this is unset or no bigger than zero, returns all results. */
|
|
1245
1737
|
topN?: number;
|
|
@@ -1342,7 +1834,7 @@ declare namespace gapi.client {
|
|
|
1342
1834
|
offset?: number;
|
|
1343
1835
|
/** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
|
|
1344
1836
|
orderBy?: string;
|
|
1345
|
-
/** Maximum number of Documents to return.
|
|
1837
|
+
/** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
|
|
1346
1838
|
pageSize?: number;
|
|
1347
1839
|
/** A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
1348
1840
|
pageToken?: string;
|
|
@@ -1372,9 +1864,27 @@ declare namespace gapi.client {
|
|
|
1372
1864
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec {
|
|
1373
1865
|
/** Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied. */
|
|
1374
1866
|
boost?: number;
|
|
1867
|
+
/** Complex specification for custom ranking based on customer defined attribute value. */
|
|
1868
|
+
boostControlSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec;
|
|
1375
1869
|
/** An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` */
|
|
1376
1870
|
condition?: string;
|
|
1377
1871
|
}
|
|
1872
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec {
|
|
1873
|
+
/** The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). */
|
|
1874
|
+
attributeType?: string;
|
|
1875
|
+
/** The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. */
|
|
1876
|
+
controlPoints?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint[];
|
|
1877
|
+
/** The name of the field whose value will be used to determine the boost amount. */
|
|
1878
|
+
fieldName?: string;
|
|
1879
|
+
/** The interpolation type to be applied to connect the control points listed below. */
|
|
1880
|
+
interpolationType?: string;
|
|
1881
|
+
}
|
|
1882
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint {
|
|
1883
|
+
/** Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. */
|
|
1884
|
+
attributeValue?: string;
|
|
1885
|
+
/** The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. */
|
|
1886
|
+
boostAmount?: number;
|
|
1887
|
+
}
|
|
1378
1888
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec {
|
|
1379
1889
|
/** If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */
|
|
1380
1890
|
extractiveContentSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec;
|
|
@@ -1666,6 +2176,26 @@ declare namespace gapi.client {
|
|
|
1666
2176
|
/** 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. */
|
|
1667
2177
|
demotionEventType?: string;
|
|
1668
2178
|
}
|
|
2179
|
+
interface GoogleCloudDiscoveryengineV1betaSession {
|
|
2180
|
+
/** Output only. The time the session finished. */
|
|
2181
|
+
endTime?: string;
|
|
2182
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
2183
|
+
name?: string;
|
|
2184
|
+
/** Output only. The time the session started. */
|
|
2185
|
+
startTime?: string;
|
|
2186
|
+
/** The state of the session. */
|
|
2187
|
+
state?: string;
|
|
2188
|
+
/** Turns. */
|
|
2189
|
+
turns?: GoogleCloudDiscoveryengineV1betaSessionTurn[];
|
|
2190
|
+
/** A unique identifier for tracking users. */
|
|
2191
|
+
userPseudoId?: string;
|
|
2192
|
+
}
|
|
2193
|
+
interface GoogleCloudDiscoveryengineV1betaSessionTurn {
|
|
2194
|
+
/** The resource name of the answer to the user query. */
|
|
2195
|
+
answer?: string;
|
|
2196
|
+
/** The user query. */
|
|
2197
|
+
query?: GoogleCloudDiscoveryengineV1betaQuery;
|
|
2198
|
+
}
|
|
1669
2199
|
interface GoogleCloudDiscoveryengineV1betaSiteSearchEngine {
|
|
1670
2200
|
/** The fully qualified resource name of the site search engine. Format: `projects/*/locations/*/dataStores/*/siteSearchEngine` */
|
|
1671
2201
|
name?: string;
|
|
@@ -1679,7 +2209,7 @@ declare namespace gapi.client {
|
|
|
1679
2209
|
interface GoogleCloudDiscoveryengineV1betaSpannerSource {
|
|
1680
2210
|
/** Required. The database ID of the source Spanner table. */
|
|
1681
2211
|
databaseId?: string;
|
|
1682
|
-
/**
|
|
2212
|
+
/** Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas). */
|
|
1683
2213
|
enableDataBoost?: boolean;
|
|
1684
2214
|
/** Required. The instance ID of the source Spanner table. */
|
|
1685
2215
|
instanceId?: string;
|
|
@@ -1759,7 +2289,7 @@ declare namespace gapi.client {
|
|
|
1759
2289
|
errorSamples?: GoogleRpcStatus[];
|
|
1760
2290
|
/** The metrics of the trained model. */
|
|
1761
2291
|
metrics?: {[P in string]: number};
|
|
1762
|
-
/** The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training is in progress. * **ready**: The model is ready for serving. */
|
|
2292
|
+
/** The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. */
|
|
1763
2293
|
modelStatus?: string;
|
|
1764
2294
|
}
|
|
1765
2295
|
interface GoogleCloudDiscoveryengineV1betaTransactionInfo {
|
|
@@ -2005,6 +2535,8 @@ declare namespace gapi.client {
|
|
|
2005
2535
|
failureCount?: string;
|
|
2006
2536
|
/** Count of entries that were processed successfully. */
|
|
2007
2537
|
successCount?: string;
|
|
2538
|
+
/** Total count of entries that were processed. */
|
|
2539
|
+
totalCount?: string;
|
|
2008
2540
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
2009
2541
|
updateTime?: string;
|
|
2010
2542
|
}
|
|
@@ -3300,6 +3832,64 @@ declare namespace gapi.client {
|
|
|
3300
3832
|
operations: OperationsResource;
|
|
3301
3833
|
}
|
|
3302
3834
|
interface ServingConfigsResource {
|
|
3835
|
+
/** Answer query method. */
|
|
3836
|
+
answer(request: {
|
|
3837
|
+
/** V1 error format. */
|
|
3838
|
+
'$.xgafv'?: string;
|
|
3839
|
+
/** OAuth access token. */
|
|
3840
|
+
access_token?: string;
|
|
3841
|
+
/** Data format for response. */
|
|
3842
|
+
alt?: string;
|
|
3843
|
+
/** JSONP */
|
|
3844
|
+
callback?: string;
|
|
3845
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3846
|
+
fields?: string;
|
|
3847
|
+
/** 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. */
|
|
3848
|
+
key?: string;
|
|
3849
|
+
/** OAuth 2.0 token for the current user. */
|
|
3850
|
+
oauth_token?: string;
|
|
3851
|
+
/** Returns response with indentations and line breaks. */
|
|
3852
|
+
prettyPrint?: boolean;
|
|
3853
|
+
/** 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. */
|
|
3854
|
+
quotaUser?: string;
|
|
3855
|
+
/** 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. */
|
|
3856
|
+
servingConfig: string;
|
|
3857
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3858
|
+
upload_protocol?: string;
|
|
3859
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3860
|
+
uploadType?: string;
|
|
3861
|
+
/** Request body */
|
|
3862
|
+
resource: GoogleCloudDiscoveryengineV1betaAnswerQueryRequest;
|
|
3863
|
+
}): Request<GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>;
|
|
3864
|
+
answer(
|
|
3865
|
+
request: {
|
|
3866
|
+
/** V1 error format. */
|
|
3867
|
+
'$.xgafv'?: string;
|
|
3868
|
+
/** OAuth access token. */
|
|
3869
|
+
access_token?: string;
|
|
3870
|
+
/** Data format for response. */
|
|
3871
|
+
alt?: string;
|
|
3872
|
+
/** JSONP */
|
|
3873
|
+
callback?: string;
|
|
3874
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3875
|
+
fields?: string;
|
|
3876
|
+
/** 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. */
|
|
3877
|
+
key?: string;
|
|
3878
|
+
/** OAuth 2.0 token for the current user. */
|
|
3879
|
+
oauth_token?: string;
|
|
3880
|
+
/** Returns response with indentations and line breaks. */
|
|
3881
|
+
prettyPrint?: boolean;
|
|
3882
|
+
/** 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. */
|
|
3883
|
+
quotaUser?: string;
|
|
3884
|
+
/** 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. */
|
|
3885
|
+
servingConfig: string;
|
|
3886
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3887
|
+
upload_protocol?: string;
|
|
3888
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3889
|
+
uploadType?: string;
|
|
3890
|
+
},
|
|
3891
|
+
body: GoogleCloudDiscoveryengineV1betaAnswerQueryRequest
|
|
3892
|
+
): Request<GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>;
|
|
3303
3893
|
/** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
|
|
3304
3894
|
get(request?: {
|
|
3305
3895
|
/** V1 error format. */
|
|
@@ -3537,8 +4127,8 @@ declare namespace gapi.client {
|
|
|
3537
4127
|
body: GoogleCloudDiscoveryengineV1betaSearchRequest
|
|
3538
4128
|
): Request<GoogleCloudDiscoveryengineV1betaSearchResponse>;
|
|
3539
4129
|
}
|
|
3540
|
-
interface
|
|
3541
|
-
/** Gets
|
|
4130
|
+
interface AnswersResource {
|
|
4131
|
+
/** Gets a Answer. */
|
|
3542
4132
|
get(request?: {
|
|
3543
4133
|
/** V1 error format. */
|
|
3544
4134
|
'$.xgafv'?: string;
|
|
@@ -3552,43 +4142,10 @@ declare namespace gapi.client {
|
|
|
3552
4142
|
fields?: string;
|
|
3553
4143
|
/** 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. */
|
|
3554
4144
|
key?: string;
|
|
3555
|
-
/** The name of the
|
|
3556
|
-
name: string;
|
|
3557
|
-
/** OAuth 2.0 token for the current user. */
|
|
3558
|
-
oauth_token?: string;
|
|
3559
|
-
/** Returns response with indentations and line breaks. */
|
|
3560
|
-
prettyPrint?: boolean;
|
|
3561
|
-
/** 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. */
|
|
3562
|
-
quotaUser?: string;
|
|
3563
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3564
|
-
upload_protocol?: string;
|
|
3565
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3566
|
-
uploadType?: string;
|
|
3567
|
-
}): Request<GoogleLongrunningOperation>;
|
|
3568
|
-
/** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
|
|
3569
|
-
list(request?: {
|
|
3570
|
-
/** V1 error format. */
|
|
3571
|
-
'$.xgafv'?: string;
|
|
3572
|
-
/** OAuth access token. */
|
|
3573
|
-
access_token?: string;
|
|
3574
|
-
/** Data format for response. */
|
|
3575
|
-
alt?: string;
|
|
3576
|
-
/** JSONP */
|
|
3577
|
-
callback?: string;
|
|
3578
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
3579
|
-
fields?: string;
|
|
3580
|
-
/** The standard list filter. */
|
|
3581
|
-
filter?: string;
|
|
3582
|
-
/** 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. */
|
|
3583
|
-
key?: string;
|
|
3584
|
-
/** The name of the operation's parent resource. */
|
|
4145
|
+
/** Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` */
|
|
3585
4146
|
name: string;
|
|
3586
4147
|
/** OAuth 2.0 token for the current user. */
|
|
3587
4148
|
oauth_token?: string;
|
|
3588
|
-
/** The standard list page size. */
|
|
3589
|
-
pageSize?: number;
|
|
3590
|
-
/** The standard list page token. */
|
|
3591
|
-
pageToken?: string;
|
|
3592
4149
|
/** Returns response with indentations and line breaks. */
|
|
3593
4150
|
prettyPrint?: boolean;
|
|
3594
4151
|
/** 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. */
|
|
@@ -3597,11 +4154,11 @@ declare namespace gapi.client {
|
|
|
3597
4154
|
upload_protocol?: string;
|
|
3598
4155
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3599
4156
|
uploadType?: string;
|
|
3600
|
-
}): Request<
|
|
4157
|
+
}): Request<GoogleCloudDiscoveryengineV1betaAnswer>;
|
|
3601
4158
|
}
|
|
3602
|
-
interface
|
|
3603
|
-
/**
|
|
3604
|
-
|
|
4159
|
+
interface SessionsResource {
|
|
4160
|
+
/** Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. */
|
|
4161
|
+
create(request: {
|
|
3605
4162
|
/** V1 error format. */
|
|
3606
4163
|
'$.xgafv'?: string;
|
|
3607
4164
|
/** OAuth access token. */
|
|
@@ -3614,10 +4171,10 @@ declare namespace gapi.client {
|
|
|
3614
4171
|
fields?: string;
|
|
3615
4172
|
/** 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. */
|
|
3616
4173
|
key?: string;
|
|
3617
|
-
/** The name of the operation resource. */
|
|
3618
|
-
name: string;
|
|
3619
4174
|
/** OAuth 2.0 token for the current user. */
|
|
3620
4175
|
oauth_token?: string;
|
|
4176
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
4177
|
+
parent: string;
|
|
3621
4178
|
/** Returns response with indentations and line breaks. */
|
|
3622
4179
|
prettyPrint?: boolean;
|
|
3623
4180
|
/** 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. */
|
|
@@ -3626,12 +4183,286 @@ declare namespace gapi.client {
|
|
|
3626
4183
|
upload_protocol?: string;
|
|
3627
4184
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3628
4185
|
uploadType?: string;
|
|
3629
|
-
|
|
3630
|
-
|
|
3631
|
-
|
|
3632
|
-
|
|
3633
|
-
|
|
3634
|
-
|
|
4186
|
+
/** Request body */
|
|
4187
|
+
resource: GoogleCloudDiscoveryengineV1betaSession;
|
|
4188
|
+
}): Request<GoogleCloudDiscoveryengineV1betaSession>;
|
|
4189
|
+
create(
|
|
4190
|
+
request: {
|
|
4191
|
+
/** V1 error format. */
|
|
4192
|
+
'$.xgafv'?: string;
|
|
4193
|
+
/** OAuth access token. */
|
|
4194
|
+
access_token?: string;
|
|
4195
|
+
/** Data format for response. */
|
|
4196
|
+
alt?: string;
|
|
4197
|
+
/** JSONP */
|
|
4198
|
+
callback?: string;
|
|
4199
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4200
|
+
fields?: string;
|
|
4201
|
+
/** 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. */
|
|
4202
|
+
key?: string;
|
|
4203
|
+
/** OAuth 2.0 token for the current user. */
|
|
4204
|
+
oauth_token?: string;
|
|
4205
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
4206
|
+
parent: string;
|
|
4207
|
+
/** Returns response with indentations and line breaks. */
|
|
4208
|
+
prettyPrint?: boolean;
|
|
4209
|
+
/** 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. */
|
|
4210
|
+
quotaUser?: string;
|
|
4211
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4212
|
+
upload_protocol?: string;
|
|
4213
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4214
|
+
uploadType?: string;
|
|
4215
|
+
},
|
|
4216
|
+
body: GoogleCloudDiscoveryengineV1betaSession
|
|
4217
|
+
): Request<GoogleCloudDiscoveryengineV1betaSession>;
|
|
4218
|
+
/** Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. */
|
|
4219
|
+
delete(request?: {
|
|
4220
|
+
/** V1 error format. */
|
|
4221
|
+
'$.xgafv'?: string;
|
|
4222
|
+
/** OAuth access token. */
|
|
4223
|
+
access_token?: string;
|
|
4224
|
+
/** Data format for response. */
|
|
4225
|
+
alt?: string;
|
|
4226
|
+
/** JSONP */
|
|
4227
|
+
callback?: string;
|
|
4228
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4229
|
+
fields?: string;
|
|
4230
|
+
/** 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. */
|
|
4231
|
+
key?: string;
|
|
4232
|
+
/** Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
4233
|
+
name: string;
|
|
4234
|
+
/** OAuth 2.0 token for the current user. */
|
|
4235
|
+
oauth_token?: string;
|
|
4236
|
+
/** Returns response with indentations and line breaks. */
|
|
4237
|
+
prettyPrint?: boolean;
|
|
4238
|
+
/** 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. */
|
|
4239
|
+
quotaUser?: string;
|
|
4240
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4241
|
+
upload_protocol?: string;
|
|
4242
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4243
|
+
uploadType?: string;
|
|
4244
|
+
}): Request<{}>;
|
|
4245
|
+
/** Gets a Session. */
|
|
4246
|
+
get(request?: {
|
|
4247
|
+
/** V1 error format. */
|
|
4248
|
+
'$.xgafv'?: string;
|
|
4249
|
+
/** OAuth access token. */
|
|
4250
|
+
access_token?: string;
|
|
4251
|
+
/** Data format for response. */
|
|
4252
|
+
alt?: string;
|
|
4253
|
+
/** JSONP */
|
|
4254
|
+
callback?: string;
|
|
4255
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4256
|
+
fields?: string;
|
|
4257
|
+
/** 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. */
|
|
4258
|
+
key?: string;
|
|
4259
|
+
/** Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
4260
|
+
name: string;
|
|
4261
|
+
/** OAuth 2.0 token for the current user. */
|
|
4262
|
+
oauth_token?: string;
|
|
4263
|
+
/** Returns response with indentations and line breaks. */
|
|
4264
|
+
prettyPrint?: boolean;
|
|
4265
|
+
/** 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. */
|
|
4266
|
+
quotaUser?: string;
|
|
4267
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4268
|
+
upload_protocol?: string;
|
|
4269
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4270
|
+
uploadType?: string;
|
|
4271
|
+
}): Request<GoogleCloudDiscoveryengineV1betaSession>;
|
|
4272
|
+
/** Lists all Sessions by their parent DataStore. */
|
|
4273
|
+
list(request?: {
|
|
4274
|
+
/** V1 error format. */
|
|
4275
|
+
'$.xgafv'?: string;
|
|
4276
|
+
/** OAuth access token. */
|
|
4277
|
+
access_token?: string;
|
|
4278
|
+
/** Data format for response. */
|
|
4279
|
+
alt?: string;
|
|
4280
|
+
/** JSONP */
|
|
4281
|
+
callback?: string;
|
|
4282
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4283
|
+
fields?: string;
|
|
4284
|
+
/** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
|
|
4285
|
+
filter?: string;
|
|
4286
|
+
/** 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. */
|
|
4287
|
+
key?: string;
|
|
4288
|
+
/** OAuth 2.0 token for the current user. */
|
|
4289
|
+
oauth_token?: string;
|
|
4290
|
+
/** 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" */
|
|
4291
|
+
orderBy?: string;
|
|
4292
|
+
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
4293
|
+
pageSize?: number;
|
|
4294
|
+
/** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
|
|
4295
|
+
pageToken?: string;
|
|
4296
|
+
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
4297
|
+
parent: string;
|
|
4298
|
+
/** Returns response with indentations and line breaks. */
|
|
4299
|
+
prettyPrint?: boolean;
|
|
4300
|
+
/** 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. */
|
|
4301
|
+
quotaUser?: string;
|
|
4302
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4303
|
+
upload_protocol?: string;
|
|
4304
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4305
|
+
uploadType?: string;
|
|
4306
|
+
}): Request<GoogleCloudDiscoveryengineV1betaListSessionsResponse>;
|
|
4307
|
+
/** Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. */
|
|
4308
|
+
patch(request: {
|
|
4309
|
+
/** V1 error format. */
|
|
4310
|
+
'$.xgafv'?: string;
|
|
4311
|
+
/** OAuth access token. */
|
|
4312
|
+
access_token?: string;
|
|
4313
|
+
/** Data format for response. */
|
|
4314
|
+
alt?: string;
|
|
4315
|
+
/** JSONP */
|
|
4316
|
+
callback?: string;
|
|
4317
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4318
|
+
fields?: string;
|
|
4319
|
+
/** 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. */
|
|
4320
|
+
key?: string;
|
|
4321
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
4322
|
+
name: string;
|
|
4323
|
+
/** OAuth 2.0 token for the current user. */
|
|
4324
|
+
oauth_token?: string;
|
|
4325
|
+
/** Returns response with indentations and line breaks. */
|
|
4326
|
+
prettyPrint?: boolean;
|
|
4327
|
+
/** 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. */
|
|
4328
|
+
quotaUser?: string;
|
|
4329
|
+
/** 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. */
|
|
4330
|
+
updateMask?: string;
|
|
4331
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4332
|
+
upload_protocol?: string;
|
|
4333
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4334
|
+
uploadType?: string;
|
|
4335
|
+
/** Request body */
|
|
4336
|
+
resource: GoogleCloudDiscoveryengineV1betaSession;
|
|
4337
|
+
}): Request<GoogleCloudDiscoveryengineV1betaSession>;
|
|
4338
|
+
patch(
|
|
4339
|
+
request: {
|
|
4340
|
+
/** V1 error format. */
|
|
4341
|
+
'$.xgafv'?: string;
|
|
4342
|
+
/** OAuth access token. */
|
|
4343
|
+
access_token?: string;
|
|
4344
|
+
/** Data format for response. */
|
|
4345
|
+
alt?: string;
|
|
4346
|
+
/** JSONP */
|
|
4347
|
+
callback?: string;
|
|
4348
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4349
|
+
fields?: string;
|
|
4350
|
+
/** 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. */
|
|
4351
|
+
key?: string;
|
|
4352
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
4353
|
+
name: string;
|
|
4354
|
+
/** OAuth 2.0 token for the current user. */
|
|
4355
|
+
oauth_token?: string;
|
|
4356
|
+
/** Returns response with indentations and line breaks. */
|
|
4357
|
+
prettyPrint?: boolean;
|
|
4358
|
+
/** 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. */
|
|
4359
|
+
quotaUser?: string;
|
|
4360
|
+
/** 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. */
|
|
4361
|
+
updateMask?: string;
|
|
4362
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4363
|
+
upload_protocol?: string;
|
|
4364
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4365
|
+
uploadType?: string;
|
|
4366
|
+
},
|
|
4367
|
+
body: GoogleCloudDiscoveryengineV1betaSession
|
|
4368
|
+
): Request<GoogleCloudDiscoveryengineV1betaSession>;
|
|
4369
|
+
answers: AnswersResource;
|
|
4370
|
+
}
|
|
4371
|
+
interface OperationsResource {
|
|
4372
|
+
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
4373
|
+
get(request?: {
|
|
4374
|
+
/** V1 error format. */
|
|
4375
|
+
'$.xgafv'?: string;
|
|
4376
|
+
/** OAuth access token. */
|
|
4377
|
+
access_token?: string;
|
|
4378
|
+
/** Data format for response. */
|
|
4379
|
+
alt?: string;
|
|
4380
|
+
/** JSONP */
|
|
4381
|
+
callback?: string;
|
|
4382
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4383
|
+
fields?: string;
|
|
4384
|
+
/** 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. */
|
|
4385
|
+
key?: string;
|
|
4386
|
+
/** The name of the operation resource. */
|
|
4387
|
+
name: string;
|
|
4388
|
+
/** OAuth 2.0 token for the current user. */
|
|
4389
|
+
oauth_token?: string;
|
|
4390
|
+
/** Returns response with indentations and line breaks. */
|
|
4391
|
+
prettyPrint?: boolean;
|
|
4392
|
+
/** 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. */
|
|
4393
|
+
quotaUser?: string;
|
|
4394
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4395
|
+
upload_protocol?: string;
|
|
4396
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4397
|
+
uploadType?: string;
|
|
4398
|
+
}): Request<GoogleLongrunningOperation>;
|
|
4399
|
+
/** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
|
|
4400
|
+
list(request?: {
|
|
4401
|
+
/** V1 error format. */
|
|
4402
|
+
'$.xgafv'?: string;
|
|
4403
|
+
/** OAuth access token. */
|
|
4404
|
+
access_token?: string;
|
|
4405
|
+
/** Data format for response. */
|
|
4406
|
+
alt?: string;
|
|
4407
|
+
/** JSONP */
|
|
4408
|
+
callback?: string;
|
|
4409
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4410
|
+
fields?: string;
|
|
4411
|
+
/** The standard list filter. */
|
|
4412
|
+
filter?: string;
|
|
4413
|
+
/** 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. */
|
|
4414
|
+
key?: string;
|
|
4415
|
+
/** The name of the operation's parent resource. */
|
|
4416
|
+
name: string;
|
|
4417
|
+
/** OAuth 2.0 token for the current user. */
|
|
4418
|
+
oauth_token?: string;
|
|
4419
|
+
/** The standard list page size. */
|
|
4420
|
+
pageSize?: number;
|
|
4421
|
+
/** The standard list page token. */
|
|
4422
|
+
pageToken?: string;
|
|
4423
|
+
/** Returns response with indentations and line breaks. */
|
|
4424
|
+
prettyPrint?: boolean;
|
|
4425
|
+
/** 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. */
|
|
4426
|
+
quotaUser?: string;
|
|
4427
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4428
|
+
upload_protocol?: string;
|
|
4429
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4430
|
+
uploadType?: string;
|
|
4431
|
+
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
4432
|
+
}
|
|
4433
|
+
interface OperationsResource {
|
|
4434
|
+
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
4435
|
+
get(request?: {
|
|
4436
|
+
/** V1 error format. */
|
|
4437
|
+
'$.xgafv'?: string;
|
|
4438
|
+
/** OAuth access token. */
|
|
4439
|
+
access_token?: string;
|
|
4440
|
+
/** Data format for response. */
|
|
4441
|
+
alt?: string;
|
|
4442
|
+
/** JSONP */
|
|
4443
|
+
callback?: string;
|
|
4444
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4445
|
+
fields?: string;
|
|
4446
|
+
/** 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. */
|
|
4447
|
+
key?: string;
|
|
4448
|
+
/** The name of the operation resource. */
|
|
4449
|
+
name: string;
|
|
4450
|
+
/** OAuth 2.0 token for the current user. */
|
|
4451
|
+
oauth_token?: string;
|
|
4452
|
+
/** Returns response with indentations and line breaks. */
|
|
4453
|
+
prettyPrint?: boolean;
|
|
4454
|
+
/** 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. */
|
|
4455
|
+
quotaUser?: string;
|
|
4456
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4457
|
+
upload_protocol?: string;
|
|
4458
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4459
|
+
uploadType?: string;
|
|
4460
|
+
}): Request<GoogleLongrunningOperation>;
|
|
4461
|
+
/** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
|
|
4462
|
+
list(request?: {
|
|
4463
|
+
/** V1 error format. */
|
|
4464
|
+
'$.xgafv'?: string;
|
|
4465
|
+
/** OAuth access token. */
|
|
3635
4466
|
access_token?: string;
|
|
3636
4467
|
/** Data format for response. */
|
|
3637
4468
|
alt?: string;
|
|
@@ -4801,6 +5632,7 @@ declare namespace gapi.client {
|
|
|
4801
5632
|
operations: OperationsResource;
|
|
4802
5633
|
schemas: SchemasResource;
|
|
4803
5634
|
servingConfigs: ServingConfigsResource;
|
|
5635
|
+
sessions: SessionsResource;
|
|
4804
5636
|
siteSearchEngine: SiteSearchEngineResource;
|
|
4805
5637
|
suggestionDenyListEntries: SuggestionDenyListEntriesResource;
|
|
4806
5638
|
userEvents: UserEventsResource;
|
|
@@ -5137,6 +5969,64 @@ declare namespace gapi.client {
|
|
|
5137
5969
|
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
5138
5970
|
}
|
|
5139
5971
|
interface ServingConfigsResource {
|
|
5972
|
+
/** Answer query method. */
|
|
5973
|
+
answer(request: {
|
|
5974
|
+
/** V1 error format. */
|
|
5975
|
+
'$.xgafv'?: string;
|
|
5976
|
+
/** OAuth access token. */
|
|
5977
|
+
access_token?: string;
|
|
5978
|
+
/** Data format for response. */
|
|
5979
|
+
alt?: string;
|
|
5980
|
+
/** JSONP */
|
|
5981
|
+
callback?: string;
|
|
5982
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
5983
|
+
fields?: string;
|
|
5984
|
+
/** 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. */
|
|
5985
|
+
key?: string;
|
|
5986
|
+
/** OAuth 2.0 token for the current user. */
|
|
5987
|
+
oauth_token?: string;
|
|
5988
|
+
/** Returns response with indentations and line breaks. */
|
|
5989
|
+
prettyPrint?: boolean;
|
|
5990
|
+
/** 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. */
|
|
5991
|
+
quotaUser?: string;
|
|
5992
|
+
/** 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. */
|
|
5993
|
+
servingConfig: string;
|
|
5994
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5995
|
+
upload_protocol?: string;
|
|
5996
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5997
|
+
uploadType?: string;
|
|
5998
|
+
/** Request body */
|
|
5999
|
+
resource: GoogleCloudDiscoveryengineV1betaAnswerQueryRequest;
|
|
6000
|
+
}): Request<GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>;
|
|
6001
|
+
answer(
|
|
6002
|
+
request: {
|
|
6003
|
+
/** V1 error format. */
|
|
6004
|
+
'$.xgafv'?: string;
|
|
6005
|
+
/** OAuth access token. */
|
|
6006
|
+
access_token?: string;
|
|
6007
|
+
/** Data format for response. */
|
|
6008
|
+
alt?: string;
|
|
6009
|
+
/** JSONP */
|
|
6010
|
+
callback?: string;
|
|
6011
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6012
|
+
fields?: string;
|
|
6013
|
+
/** 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. */
|
|
6014
|
+
key?: string;
|
|
6015
|
+
/** OAuth 2.0 token for the current user. */
|
|
6016
|
+
oauth_token?: string;
|
|
6017
|
+
/** Returns response with indentations and line breaks. */
|
|
6018
|
+
prettyPrint?: boolean;
|
|
6019
|
+
/** 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. */
|
|
6020
|
+
quotaUser?: string;
|
|
6021
|
+
/** 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. */
|
|
6022
|
+
servingConfig: string;
|
|
6023
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6024
|
+
upload_protocol?: string;
|
|
6025
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6026
|
+
uploadType?: string;
|
|
6027
|
+
},
|
|
6028
|
+
body: GoogleCloudDiscoveryengineV1betaAnswerQueryRequest
|
|
6029
|
+
): Request<GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>;
|
|
5140
6030
|
/** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
|
|
5141
6031
|
get(request?: {
|
|
5142
6032
|
/** V1 error format. */
|
|
@@ -5335,16 +6225,254 @@ declare namespace gapi.client {
|
|
|
5335
6225
|
prettyPrint?: boolean;
|
|
5336
6226
|
/** 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. */
|
|
5337
6227
|
quotaUser?: string;
|
|
5338
|
-
/** 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/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
5339
|
-
servingConfig: string;
|
|
6228
|
+
/** 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/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
6229
|
+
servingConfig: string;
|
|
6230
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6231
|
+
upload_protocol?: string;
|
|
6232
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6233
|
+
uploadType?: string;
|
|
6234
|
+
/** Request body */
|
|
6235
|
+
resource: GoogleCloudDiscoveryengineV1betaSearchRequest;
|
|
6236
|
+
}): Request<GoogleCloudDiscoveryengineV1betaSearchResponse>;
|
|
6237
|
+
search(
|
|
6238
|
+
request: {
|
|
6239
|
+
/** V1 error format. */
|
|
6240
|
+
'$.xgafv'?: string;
|
|
6241
|
+
/** OAuth access token. */
|
|
6242
|
+
access_token?: string;
|
|
6243
|
+
/** Data format for response. */
|
|
6244
|
+
alt?: string;
|
|
6245
|
+
/** JSONP */
|
|
6246
|
+
callback?: string;
|
|
6247
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6248
|
+
fields?: string;
|
|
6249
|
+
/** 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. */
|
|
6250
|
+
key?: string;
|
|
6251
|
+
/** OAuth 2.0 token for the current user. */
|
|
6252
|
+
oauth_token?: string;
|
|
6253
|
+
/** Returns response with indentations and line breaks. */
|
|
6254
|
+
prettyPrint?: boolean;
|
|
6255
|
+
/** 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. */
|
|
6256
|
+
quotaUser?: string;
|
|
6257
|
+
/** 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/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
6258
|
+
servingConfig: string;
|
|
6259
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6260
|
+
upload_protocol?: string;
|
|
6261
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6262
|
+
uploadType?: string;
|
|
6263
|
+
},
|
|
6264
|
+
body: GoogleCloudDiscoveryengineV1betaSearchRequest
|
|
6265
|
+
): Request<GoogleCloudDiscoveryengineV1betaSearchResponse>;
|
|
6266
|
+
}
|
|
6267
|
+
interface AnswersResource {
|
|
6268
|
+
/** Gets a Answer. */
|
|
6269
|
+
get(request?: {
|
|
6270
|
+
/** V1 error format. */
|
|
6271
|
+
'$.xgafv'?: string;
|
|
6272
|
+
/** OAuth access token. */
|
|
6273
|
+
access_token?: string;
|
|
6274
|
+
/** Data format for response. */
|
|
6275
|
+
alt?: string;
|
|
6276
|
+
/** JSONP */
|
|
6277
|
+
callback?: string;
|
|
6278
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6279
|
+
fields?: string;
|
|
6280
|
+
/** 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. */
|
|
6281
|
+
key?: string;
|
|
6282
|
+
/** Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` */
|
|
6283
|
+
name: string;
|
|
6284
|
+
/** OAuth 2.0 token for the current user. */
|
|
6285
|
+
oauth_token?: string;
|
|
6286
|
+
/** Returns response with indentations and line breaks. */
|
|
6287
|
+
prettyPrint?: boolean;
|
|
6288
|
+
/** 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. */
|
|
6289
|
+
quotaUser?: string;
|
|
6290
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6291
|
+
upload_protocol?: string;
|
|
6292
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6293
|
+
uploadType?: string;
|
|
6294
|
+
}): Request<GoogleCloudDiscoveryengineV1betaAnswer>;
|
|
6295
|
+
}
|
|
6296
|
+
interface SessionsResource {
|
|
6297
|
+
/** Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. */
|
|
6298
|
+
create(request: {
|
|
6299
|
+
/** V1 error format. */
|
|
6300
|
+
'$.xgafv'?: string;
|
|
6301
|
+
/** OAuth access token. */
|
|
6302
|
+
access_token?: string;
|
|
6303
|
+
/** Data format for response. */
|
|
6304
|
+
alt?: string;
|
|
6305
|
+
/** JSONP */
|
|
6306
|
+
callback?: string;
|
|
6307
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6308
|
+
fields?: string;
|
|
6309
|
+
/** 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. */
|
|
6310
|
+
key?: string;
|
|
6311
|
+
/** OAuth 2.0 token for the current user. */
|
|
6312
|
+
oauth_token?: string;
|
|
6313
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
6314
|
+
parent: string;
|
|
6315
|
+
/** Returns response with indentations and line breaks. */
|
|
6316
|
+
prettyPrint?: boolean;
|
|
6317
|
+
/** 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. */
|
|
6318
|
+
quotaUser?: string;
|
|
6319
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6320
|
+
upload_protocol?: string;
|
|
6321
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6322
|
+
uploadType?: string;
|
|
6323
|
+
/** Request body */
|
|
6324
|
+
resource: GoogleCloudDiscoveryengineV1betaSession;
|
|
6325
|
+
}): Request<GoogleCloudDiscoveryengineV1betaSession>;
|
|
6326
|
+
create(
|
|
6327
|
+
request: {
|
|
6328
|
+
/** V1 error format. */
|
|
6329
|
+
'$.xgafv'?: string;
|
|
6330
|
+
/** OAuth access token. */
|
|
6331
|
+
access_token?: string;
|
|
6332
|
+
/** Data format for response. */
|
|
6333
|
+
alt?: string;
|
|
6334
|
+
/** JSONP */
|
|
6335
|
+
callback?: string;
|
|
6336
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6337
|
+
fields?: string;
|
|
6338
|
+
/** 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. */
|
|
6339
|
+
key?: string;
|
|
6340
|
+
/** OAuth 2.0 token for the current user. */
|
|
6341
|
+
oauth_token?: string;
|
|
6342
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
6343
|
+
parent: string;
|
|
6344
|
+
/** Returns response with indentations and line breaks. */
|
|
6345
|
+
prettyPrint?: boolean;
|
|
6346
|
+
/** 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. */
|
|
6347
|
+
quotaUser?: string;
|
|
6348
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6349
|
+
upload_protocol?: string;
|
|
6350
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6351
|
+
uploadType?: string;
|
|
6352
|
+
},
|
|
6353
|
+
body: GoogleCloudDiscoveryengineV1betaSession
|
|
6354
|
+
): Request<GoogleCloudDiscoveryengineV1betaSession>;
|
|
6355
|
+
/** Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. */
|
|
6356
|
+
delete(request?: {
|
|
6357
|
+
/** V1 error format. */
|
|
6358
|
+
'$.xgafv'?: string;
|
|
6359
|
+
/** OAuth access token. */
|
|
6360
|
+
access_token?: string;
|
|
6361
|
+
/** Data format for response. */
|
|
6362
|
+
alt?: string;
|
|
6363
|
+
/** JSONP */
|
|
6364
|
+
callback?: string;
|
|
6365
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6366
|
+
fields?: string;
|
|
6367
|
+
/** 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. */
|
|
6368
|
+
key?: string;
|
|
6369
|
+
/** Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
6370
|
+
name: string;
|
|
6371
|
+
/** OAuth 2.0 token for the current user. */
|
|
6372
|
+
oauth_token?: string;
|
|
6373
|
+
/** Returns response with indentations and line breaks. */
|
|
6374
|
+
prettyPrint?: boolean;
|
|
6375
|
+
/** 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. */
|
|
6376
|
+
quotaUser?: string;
|
|
6377
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6378
|
+
upload_protocol?: string;
|
|
6379
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6380
|
+
uploadType?: string;
|
|
6381
|
+
}): Request<{}>;
|
|
6382
|
+
/** Gets a Session. */
|
|
6383
|
+
get(request?: {
|
|
6384
|
+
/** V1 error format. */
|
|
6385
|
+
'$.xgafv'?: string;
|
|
6386
|
+
/** OAuth access token. */
|
|
6387
|
+
access_token?: string;
|
|
6388
|
+
/** Data format for response. */
|
|
6389
|
+
alt?: string;
|
|
6390
|
+
/** JSONP */
|
|
6391
|
+
callback?: string;
|
|
6392
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6393
|
+
fields?: string;
|
|
6394
|
+
/** 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. */
|
|
6395
|
+
key?: string;
|
|
6396
|
+
/** Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
6397
|
+
name: string;
|
|
6398
|
+
/** OAuth 2.0 token for the current user. */
|
|
6399
|
+
oauth_token?: string;
|
|
6400
|
+
/** Returns response with indentations and line breaks. */
|
|
6401
|
+
prettyPrint?: boolean;
|
|
6402
|
+
/** 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. */
|
|
6403
|
+
quotaUser?: string;
|
|
6404
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6405
|
+
upload_protocol?: string;
|
|
6406
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6407
|
+
uploadType?: string;
|
|
6408
|
+
}): Request<GoogleCloudDiscoveryengineV1betaSession>;
|
|
6409
|
+
/** Lists all Sessions by their parent DataStore. */
|
|
6410
|
+
list(request?: {
|
|
6411
|
+
/** V1 error format. */
|
|
6412
|
+
'$.xgafv'?: string;
|
|
6413
|
+
/** OAuth access token. */
|
|
6414
|
+
access_token?: string;
|
|
6415
|
+
/** Data format for response. */
|
|
6416
|
+
alt?: string;
|
|
6417
|
+
/** JSONP */
|
|
6418
|
+
callback?: string;
|
|
6419
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6420
|
+
fields?: string;
|
|
6421
|
+
/** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
|
|
6422
|
+
filter?: string;
|
|
6423
|
+
/** 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. */
|
|
6424
|
+
key?: string;
|
|
6425
|
+
/** OAuth 2.0 token for the current user. */
|
|
6426
|
+
oauth_token?: string;
|
|
6427
|
+
/** 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" */
|
|
6428
|
+
orderBy?: string;
|
|
6429
|
+
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
6430
|
+
pageSize?: number;
|
|
6431
|
+
/** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
|
|
6432
|
+
pageToken?: string;
|
|
6433
|
+
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
6434
|
+
parent: string;
|
|
6435
|
+
/** Returns response with indentations and line breaks. */
|
|
6436
|
+
prettyPrint?: boolean;
|
|
6437
|
+
/** 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. */
|
|
6438
|
+
quotaUser?: string;
|
|
6439
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6440
|
+
upload_protocol?: string;
|
|
6441
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6442
|
+
uploadType?: string;
|
|
6443
|
+
}): Request<GoogleCloudDiscoveryengineV1betaListSessionsResponse>;
|
|
6444
|
+
/** Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. */
|
|
6445
|
+
patch(request: {
|
|
6446
|
+
/** V1 error format. */
|
|
6447
|
+
'$.xgafv'?: string;
|
|
6448
|
+
/** OAuth access token. */
|
|
6449
|
+
access_token?: string;
|
|
6450
|
+
/** Data format for response. */
|
|
6451
|
+
alt?: string;
|
|
6452
|
+
/** JSONP */
|
|
6453
|
+
callback?: string;
|
|
6454
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6455
|
+
fields?: string;
|
|
6456
|
+
/** 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. */
|
|
6457
|
+
key?: string;
|
|
6458
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
6459
|
+
name: string;
|
|
6460
|
+
/** OAuth 2.0 token for the current user. */
|
|
6461
|
+
oauth_token?: string;
|
|
6462
|
+
/** Returns response with indentations and line breaks. */
|
|
6463
|
+
prettyPrint?: boolean;
|
|
6464
|
+
/** 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. */
|
|
6465
|
+
quotaUser?: string;
|
|
6466
|
+
/** 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. */
|
|
6467
|
+
updateMask?: string;
|
|
5340
6468
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5341
6469
|
upload_protocol?: string;
|
|
5342
6470
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5343
6471
|
uploadType?: string;
|
|
5344
6472
|
/** Request body */
|
|
5345
|
-
resource:
|
|
5346
|
-
}): Request<
|
|
5347
|
-
|
|
6473
|
+
resource: GoogleCloudDiscoveryengineV1betaSession;
|
|
6474
|
+
}): Request<GoogleCloudDiscoveryengineV1betaSession>;
|
|
6475
|
+
patch(
|
|
5348
6476
|
request: {
|
|
5349
6477
|
/** V1 error format. */
|
|
5350
6478
|
'$.xgafv'?: string;
|
|
@@ -5358,21 +6486,24 @@ declare namespace gapi.client {
|
|
|
5358
6486
|
fields?: string;
|
|
5359
6487
|
/** 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. */
|
|
5360
6488
|
key?: string;
|
|
6489
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
6490
|
+
name: string;
|
|
5361
6491
|
/** OAuth 2.0 token for the current user. */
|
|
5362
6492
|
oauth_token?: string;
|
|
5363
6493
|
/** Returns response with indentations and line breaks. */
|
|
5364
6494
|
prettyPrint?: boolean;
|
|
5365
6495
|
/** 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. */
|
|
5366
6496
|
quotaUser?: string;
|
|
5367
|
-
/**
|
|
5368
|
-
|
|
6497
|
+
/** 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. */
|
|
6498
|
+
updateMask?: string;
|
|
5369
6499
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5370
6500
|
upload_protocol?: string;
|
|
5371
6501
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5372
6502
|
uploadType?: string;
|
|
5373
6503
|
},
|
|
5374
|
-
body:
|
|
5375
|
-
): Request<
|
|
6504
|
+
body: GoogleCloudDiscoveryengineV1betaSession
|
|
6505
|
+
): Request<GoogleCloudDiscoveryengineV1betaSession>;
|
|
6506
|
+
answers: AnswersResource;
|
|
5376
6507
|
}
|
|
5377
6508
|
interface EnginesResource {
|
|
5378
6509
|
/** Creates a Engine. */
|
|
@@ -5763,6 +6894,7 @@ declare namespace gapi.client {
|
|
|
5763
6894
|
conversations: ConversationsResource;
|
|
5764
6895
|
operations: OperationsResource;
|
|
5765
6896
|
servingConfigs: ServingConfigsResource;
|
|
6897
|
+
sessions: SessionsResource;
|
|
5766
6898
|
}
|
|
5767
6899
|
interface OperationsResource {
|
|
5768
6900
|
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
@@ -6785,29 +7917,267 @@ declare namespace gapi.client {
|
|
|
6785
7917
|
fields?: string;
|
|
6786
7918
|
/** 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. */
|
|
6787
7919
|
key?: string;
|
|
6788
|
-
/** Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
6789
|
-
name: string;
|
|
7920
|
+
/** Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
7921
|
+
name: string;
|
|
7922
|
+
/** OAuth 2.0 token for the current user. */
|
|
7923
|
+
oauth_token?: string;
|
|
7924
|
+
/** Returns response with indentations and line breaks. */
|
|
7925
|
+
prettyPrint?: boolean;
|
|
7926
|
+
/** 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. */
|
|
7927
|
+
quotaUser?: string;
|
|
7928
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7929
|
+
upload_protocol?: string;
|
|
7930
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7931
|
+
uploadType?: string;
|
|
7932
|
+
/** Request body */
|
|
7933
|
+
resource: GoogleCloudDiscoveryengineV1betaSchema;
|
|
7934
|
+
}): Request<GoogleLongrunningOperation>;
|
|
7935
|
+
patch(
|
|
7936
|
+
request: {
|
|
7937
|
+
/** V1 error format. */
|
|
7938
|
+
'$.xgafv'?: string;
|
|
7939
|
+
/** OAuth access token. */
|
|
7940
|
+
access_token?: string;
|
|
7941
|
+
/** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
|
|
7942
|
+
allowMissing?: boolean;
|
|
7943
|
+
/** Data format for response. */
|
|
7944
|
+
alt?: string;
|
|
7945
|
+
/** JSONP */
|
|
7946
|
+
callback?: string;
|
|
7947
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
7948
|
+
fields?: string;
|
|
7949
|
+
/** 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. */
|
|
7950
|
+
key?: string;
|
|
7951
|
+
/** Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
7952
|
+
name: string;
|
|
7953
|
+
/** OAuth 2.0 token for the current user. */
|
|
7954
|
+
oauth_token?: string;
|
|
7955
|
+
/** Returns response with indentations and line breaks. */
|
|
7956
|
+
prettyPrint?: boolean;
|
|
7957
|
+
/** 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. */
|
|
7958
|
+
quotaUser?: string;
|
|
7959
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7960
|
+
upload_protocol?: string;
|
|
7961
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7962
|
+
uploadType?: string;
|
|
7963
|
+
},
|
|
7964
|
+
body: GoogleCloudDiscoveryengineV1betaSchema
|
|
7965
|
+
): Request<GoogleLongrunningOperation>;
|
|
7966
|
+
}
|
|
7967
|
+
interface ServingConfigsResource {
|
|
7968
|
+
/** Answer query method. */
|
|
7969
|
+
answer(request: {
|
|
7970
|
+
/** V1 error format. */
|
|
7971
|
+
'$.xgafv'?: string;
|
|
7972
|
+
/** OAuth access token. */
|
|
7973
|
+
access_token?: string;
|
|
7974
|
+
/** Data format for response. */
|
|
7975
|
+
alt?: string;
|
|
7976
|
+
/** JSONP */
|
|
7977
|
+
callback?: string;
|
|
7978
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
7979
|
+
fields?: string;
|
|
7980
|
+
/** 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. */
|
|
7981
|
+
key?: string;
|
|
7982
|
+
/** OAuth 2.0 token for the current user. */
|
|
7983
|
+
oauth_token?: string;
|
|
7984
|
+
/** Returns response with indentations and line breaks. */
|
|
7985
|
+
prettyPrint?: boolean;
|
|
7986
|
+
/** 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. */
|
|
7987
|
+
quotaUser?: string;
|
|
7988
|
+
/** 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. */
|
|
7989
|
+
servingConfig: string;
|
|
7990
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7991
|
+
upload_protocol?: string;
|
|
7992
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7993
|
+
uploadType?: string;
|
|
7994
|
+
/** Request body */
|
|
7995
|
+
resource: GoogleCloudDiscoveryengineV1betaAnswerQueryRequest;
|
|
7996
|
+
}): Request<GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>;
|
|
7997
|
+
answer(
|
|
7998
|
+
request: {
|
|
7999
|
+
/** V1 error format. */
|
|
8000
|
+
'$.xgafv'?: string;
|
|
8001
|
+
/** OAuth access token. */
|
|
8002
|
+
access_token?: string;
|
|
8003
|
+
/** Data format for response. */
|
|
8004
|
+
alt?: string;
|
|
8005
|
+
/** JSONP */
|
|
8006
|
+
callback?: string;
|
|
8007
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8008
|
+
fields?: string;
|
|
8009
|
+
/** 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. */
|
|
8010
|
+
key?: string;
|
|
8011
|
+
/** OAuth 2.0 token for the current user. */
|
|
8012
|
+
oauth_token?: string;
|
|
8013
|
+
/** Returns response with indentations and line breaks. */
|
|
8014
|
+
prettyPrint?: boolean;
|
|
8015
|
+
/** 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. */
|
|
8016
|
+
quotaUser?: string;
|
|
8017
|
+
/** 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. */
|
|
8018
|
+
servingConfig: string;
|
|
8019
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8020
|
+
upload_protocol?: string;
|
|
8021
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8022
|
+
uploadType?: string;
|
|
8023
|
+
},
|
|
8024
|
+
body: GoogleCloudDiscoveryengineV1betaAnswerQueryRequest
|
|
8025
|
+
): Request<GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>;
|
|
8026
|
+
/** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
|
|
8027
|
+
get(request?: {
|
|
8028
|
+
/** V1 error format. */
|
|
8029
|
+
'$.xgafv'?: string;
|
|
8030
|
+
/** OAuth access token. */
|
|
8031
|
+
access_token?: string;
|
|
8032
|
+
/** Data format for response. */
|
|
8033
|
+
alt?: string;
|
|
8034
|
+
/** JSONP */
|
|
8035
|
+
callback?: string;
|
|
8036
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8037
|
+
fields?: string;
|
|
8038
|
+
/** 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. */
|
|
8039
|
+
key?: string;
|
|
8040
|
+
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
8041
|
+
name: string;
|
|
8042
|
+
/** OAuth 2.0 token for the current user. */
|
|
8043
|
+
oauth_token?: string;
|
|
8044
|
+
/** Returns response with indentations and line breaks. */
|
|
8045
|
+
prettyPrint?: boolean;
|
|
8046
|
+
/** 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. */
|
|
8047
|
+
quotaUser?: string;
|
|
8048
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8049
|
+
upload_protocol?: string;
|
|
8050
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8051
|
+
uploadType?: string;
|
|
8052
|
+
}): Request<GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
8053
|
+
/** Lists all ServingConfigs linked to this dataStore. */
|
|
8054
|
+
list(request?: {
|
|
8055
|
+
/** V1 error format. */
|
|
8056
|
+
'$.xgafv'?: string;
|
|
8057
|
+
/** OAuth access token. */
|
|
8058
|
+
access_token?: string;
|
|
8059
|
+
/** Data format for response. */
|
|
8060
|
+
alt?: string;
|
|
8061
|
+
/** JSONP */
|
|
8062
|
+
callback?: string;
|
|
8063
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8064
|
+
fields?: string;
|
|
8065
|
+
/** 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. */
|
|
8066
|
+
key?: string;
|
|
8067
|
+
/** OAuth 2.0 token for the current user. */
|
|
8068
|
+
oauth_token?: string;
|
|
8069
|
+
/** Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. */
|
|
8070
|
+
pageSize?: number;
|
|
8071
|
+
/** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
|
|
8072
|
+
pageToken?: string;
|
|
8073
|
+
/** Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
8074
|
+
parent: string;
|
|
8075
|
+
/** Returns response with indentations and line breaks. */
|
|
8076
|
+
prettyPrint?: boolean;
|
|
8077
|
+
/** 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. */
|
|
8078
|
+
quotaUser?: string;
|
|
8079
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8080
|
+
upload_protocol?: string;
|
|
8081
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8082
|
+
uploadType?: string;
|
|
8083
|
+
}): Request<GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>;
|
|
8084
|
+
/** Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. */
|
|
8085
|
+
patch(request: {
|
|
8086
|
+
/** V1 error format. */
|
|
8087
|
+
'$.xgafv'?: string;
|
|
8088
|
+
/** OAuth access token. */
|
|
8089
|
+
access_token?: string;
|
|
8090
|
+
/** Data format for response. */
|
|
8091
|
+
alt?: string;
|
|
8092
|
+
/** JSONP */
|
|
8093
|
+
callback?: string;
|
|
8094
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8095
|
+
fields?: string;
|
|
8096
|
+
/** 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. */
|
|
8097
|
+
key?: string;
|
|
8098
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
8099
|
+
name: string;
|
|
8100
|
+
/** OAuth 2.0 token for the current user. */
|
|
8101
|
+
oauth_token?: string;
|
|
8102
|
+
/** Returns response with indentations and line breaks. */
|
|
8103
|
+
prettyPrint?: boolean;
|
|
8104
|
+
/** 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. */
|
|
8105
|
+
quotaUser?: string;
|
|
8106
|
+
/** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
|
|
8107
|
+
updateMask?: string;
|
|
8108
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8109
|
+
upload_protocol?: string;
|
|
8110
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8111
|
+
uploadType?: string;
|
|
8112
|
+
/** Request body */
|
|
8113
|
+
resource: GoogleCloudDiscoveryengineV1betaServingConfig;
|
|
8114
|
+
}): Request<GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
8115
|
+
patch(
|
|
8116
|
+
request: {
|
|
8117
|
+
/** V1 error format. */
|
|
8118
|
+
'$.xgafv'?: string;
|
|
8119
|
+
/** OAuth access token. */
|
|
8120
|
+
access_token?: string;
|
|
8121
|
+
/** Data format for response. */
|
|
8122
|
+
alt?: string;
|
|
8123
|
+
/** JSONP */
|
|
8124
|
+
callback?: string;
|
|
8125
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8126
|
+
fields?: string;
|
|
8127
|
+
/** 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. */
|
|
8128
|
+
key?: string;
|
|
8129
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
8130
|
+
name: string;
|
|
8131
|
+
/** OAuth 2.0 token for the current user. */
|
|
8132
|
+
oauth_token?: string;
|
|
8133
|
+
/** Returns response with indentations and line breaks. */
|
|
8134
|
+
prettyPrint?: boolean;
|
|
8135
|
+
/** 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. */
|
|
8136
|
+
quotaUser?: string;
|
|
8137
|
+
/** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
|
|
8138
|
+
updateMask?: string;
|
|
8139
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8140
|
+
upload_protocol?: string;
|
|
8141
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8142
|
+
uploadType?: string;
|
|
8143
|
+
},
|
|
8144
|
+
body: GoogleCloudDiscoveryengineV1betaServingConfig
|
|
8145
|
+
): Request<GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
8146
|
+
/** Makes a recommendation, which requires a contextual user event. */
|
|
8147
|
+
recommend(request: {
|
|
8148
|
+
/** V1 error format. */
|
|
8149
|
+
'$.xgafv'?: string;
|
|
8150
|
+
/** OAuth access token. */
|
|
8151
|
+
access_token?: string;
|
|
8152
|
+
/** Data format for response. */
|
|
8153
|
+
alt?: string;
|
|
8154
|
+
/** JSONP */
|
|
8155
|
+
callback?: string;
|
|
8156
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8157
|
+
fields?: string;
|
|
8158
|
+
/** 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. */
|
|
8159
|
+
key?: string;
|
|
6790
8160
|
/** OAuth 2.0 token for the current user. */
|
|
6791
8161
|
oauth_token?: string;
|
|
6792
8162
|
/** Returns response with indentations and line breaks. */
|
|
6793
8163
|
prettyPrint?: boolean;
|
|
6794
8164
|
/** 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. */
|
|
6795
8165
|
quotaUser?: string;
|
|
8166
|
+
/** Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
|
|
8167
|
+
servingConfig: string;
|
|
6796
8168
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6797
8169
|
upload_protocol?: string;
|
|
6798
8170
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6799
8171
|
uploadType?: string;
|
|
6800
8172
|
/** Request body */
|
|
6801
|
-
resource:
|
|
6802
|
-
}): Request<
|
|
6803
|
-
|
|
8173
|
+
resource: GoogleCloudDiscoveryengineV1betaRecommendRequest;
|
|
8174
|
+
}): Request<GoogleCloudDiscoveryengineV1betaRecommendResponse>;
|
|
8175
|
+
recommend(
|
|
6804
8176
|
request: {
|
|
6805
8177
|
/** V1 error format. */
|
|
6806
8178
|
'$.xgafv'?: string;
|
|
6807
8179
|
/** OAuth access token. */
|
|
6808
8180
|
access_token?: string;
|
|
6809
|
-
/** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
|
|
6810
|
-
allowMissing?: boolean;
|
|
6811
8181
|
/** Data format for response. */
|
|
6812
8182
|
alt?: string;
|
|
6813
8183
|
/** JSONP */
|
|
@@ -6816,25 +8186,23 @@ declare namespace gapi.client {
|
|
|
6816
8186
|
fields?: string;
|
|
6817
8187
|
/** 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. */
|
|
6818
8188
|
key?: string;
|
|
6819
|
-
/** Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
6820
|
-
name: string;
|
|
6821
8189
|
/** OAuth 2.0 token for the current user. */
|
|
6822
8190
|
oauth_token?: string;
|
|
6823
8191
|
/** Returns response with indentations and line breaks. */
|
|
6824
8192
|
prettyPrint?: boolean;
|
|
6825
8193
|
/** 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. */
|
|
6826
8194
|
quotaUser?: string;
|
|
8195
|
+
/** Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
|
|
8196
|
+
servingConfig: string;
|
|
6827
8197
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6828
8198
|
upload_protocol?: string;
|
|
6829
8199
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6830
8200
|
uploadType?: string;
|
|
6831
8201
|
},
|
|
6832
|
-
body:
|
|
6833
|
-
): Request<
|
|
6834
|
-
|
|
6835
|
-
|
|
6836
|
-
/** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
|
|
6837
|
-
get(request?: {
|
|
8202
|
+
body: GoogleCloudDiscoveryengineV1betaRecommendRequest
|
|
8203
|
+
): Request<GoogleCloudDiscoveryengineV1betaRecommendResponse>;
|
|
8204
|
+
/** Performs a search. */
|
|
8205
|
+
search(request: {
|
|
6838
8206
|
/** V1 error format. */
|
|
6839
8207
|
'$.xgafv'?: string;
|
|
6840
8208
|
/** OAuth access token. */
|
|
@@ -6847,21 +8215,54 @@ declare namespace gapi.client {
|
|
|
6847
8215
|
fields?: string;
|
|
6848
8216
|
/** 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. */
|
|
6849
8217
|
key?: string;
|
|
6850
|
-
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
6851
|
-
name: string;
|
|
6852
8218
|
/** OAuth 2.0 token for the current user. */
|
|
6853
8219
|
oauth_token?: string;
|
|
6854
8220
|
/** Returns response with indentations and line breaks. */
|
|
6855
8221
|
prettyPrint?: boolean;
|
|
6856
8222
|
/** 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. */
|
|
6857
8223
|
quotaUser?: string;
|
|
8224
|
+
/** 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/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
8225
|
+
servingConfig: string;
|
|
6858
8226
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6859
8227
|
upload_protocol?: string;
|
|
6860
8228
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6861
8229
|
uploadType?: string;
|
|
6862
|
-
|
|
6863
|
-
|
|
6864
|
-
|
|
8230
|
+
/** Request body */
|
|
8231
|
+
resource: GoogleCloudDiscoveryengineV1betaSearchRequest;
|
|
8232
|
+
}): Request<GoogleCloudDiscoveryengineV1betaSearchResponse>;
|
|
8233
|
+
search(
|
|
8234
|
+
request: {
|
|
8235
|
+
/** V1 error format. */
|
|
8236
|
+
'$.xgafv'?: string;
|
|
8237
|
+
/** OAuth access token. */
|
|
8238
|
+
access_token?: string;
|
|
8239
|
+
/** Data format for response. */
|
|
8240
|
+
alt?: string;
|
|
8241
|
+
/** JSONP */
|
|
8242
|
+
callback?: string;
|
|
8243
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8244
|
+
fields?: string;
|
|
8245
|
+
/** 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. */
|
|
8246
|
+
key?: string;
|
|
8247
|
+
/** OAuth 2.0 token for the current user. */
|
|
8248
|
+
oauth_token?: string;
|
|
8249
|
+
/** Returns response with indentations and line breaks. */
|
|
8250
|
+
prettyPrint?: boolean;
|
|
8251
|
+
/** 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. */
|
|
8252
|
+
quotaUser?: string;
|
|
8253
|
+
/** 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/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
8254
|
+
servingConfig: string;
|
|
8255
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8256
|
+
upload_protocol?: string;
|
|
8257
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8258
|
+
uploadType?: string;
|
|
8259
|
+
},
|
|
8260
|
+
body: GoogleCloudDiscoveryengineV1betaSearchRequest
|
|
8261
|
+
): Request<GoogleCloudDiscoveryengineV1betaSearchResponse>;
|
|
8262
|
+
}
|
|
8263
|
+
interface AnswersResource {
|
|
8264
|
+
/** Gets a Answer. */
|
|
8265
|
+
get(request?: {
|
|
6865
8266
|
/** V1 error format. */
|
|
6866
8267
|
'$.xgafv'?: string;
|
|
6867
8268
|
/** OAuth access token. */
|
|
@@ -6874,14 +8275,10 @@ declare namespace gapi.client {
|
|
|
6874
8275
|
fields?: string;
|
|
6875
8276
|
/** 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. */
|
|
6876
8277
|
key?: string;
|
|
8278
|
+
/** Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` */
|
|
8279
|
+
name: string;
|
|
6877
8280
|
/** OAuth 2.0 token for the current user. */
|
|
6878
8281
|
oauth_token?: string;
|
|
6879
|
-
/** Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. */
|
|
6880
|
-
pageSize?: number;
|
|
6881
|
-
/** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
|
|
6882
|
-
pageToken?: string;
|
|
6883
|
-
/** Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
6884
|
-
parent: string;
|
|
6885
8282
|
/** Returns response with indentations and line breaks. */
|
|
6886
8283
|
prettyPrint?: boolean;
|
|
6887
8284
|
/** 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. */
|
|
@@ -6890,9 +8287,11 @@ declare namespace gapi.client {
|
|
|
6890
8287
|
upload_protocol?: string;
|
|
6891
8288
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6892
8289
|
uploadType?: string;
|
|
6893
|
-
}): Request<
|
|
6894
|
-
|
|
6895
|
-
|
|
8290
|
+
}): Request<GoogleCloudDiscoveryengineV1betaAnswer>;
|
|
8291
|
+
}
|
|
8292
|
+
interface SessionsResource {
|
|
8293
|
+
/** Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. */
|
|
8294
|
+
create(request: {
|
|
6896
8295
|
/** V1 error format. */
|
|
6897
8296
|
'$.xgafv'?: string;
|
|
6898
8297
|
/** OAuth access token. */
|
|
@@ -6905,24 +8304,22 @@ declare namespace gapi.client {
|
|
|
6905
8304
|
fields?: string;
|
|
6906
8305
|
/** 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. */
|
|
6907
8306
|
key?: string;
|
|
6908
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
6909
|
-
name: string;
|
|
6910
8307
|
/** OAuth 2.0 token for the current user. */
|
|
6911
8308
|
oauth_token?: string;
|
|
8309
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
8310
|
+
parent: string;
|
|
6912
8311
|
/** Returns response with indentations and line breaks. */
|
|
6913
8312
|
prettyPrint?: boolean;
|
|
6914
8313
|
/** 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. */
|
|
6915
8314
|
quotaUser?: string;
|
|
6916
|
-
/** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
|
|
6917
|
-
updateMask?: string;
|
|
6918
8315
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6919
8316
|
upload_protocol?: string;
|
|
6920
8317
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6921
8318
|
uploadType?: string;
|
|
6922
8319
|
/** Request body */
|
|
6923
|
-
resource:
|
|
6924
|
-
}): Request<
|
|
6925
|
-
|
|
8320
|
+
resource: GoogleCloudDiscoveryengineV1betaSession;
|
|
8321
|
+
}): Request<GoogleCloudDiscoveryengineV1betaSession>;
|
|
8322
|
+
create(
|
|
6926
8323
|
request: {
|
|
6927
8324
|
/** V1 error format. */
|
|
6928
8325
|
'$.xgafv'?: string;
|
|
@@ -6936,25 +8333,23 @@ declare namespace gapi.client {
|
|
|
6936
8333
|
fields?: string;
|
|
6937
8334
|
/** 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. */
|
|
6938
8335
|
key?: string;
|
|
6939
|
-
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
6940
|
-
name: string;
|
|
6941
8336
|
/** OAuth 2.0 token for the current user. */
|
|
6942
8337
|
oauth_token?: string;
|
|
8338
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
8339
|
+
parent: string;
|
|
6943
8340
|
/** Returns response with indentations and line breaks. */
|
|
6944
8341
|
prettyPrint?: boolean;
|
|
6945
8342
|
/** 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. */
|
|
6946
8343
|
quotaUser?: string;
|
|
6947
|
-
/** Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */
|
|
6948
|
-
updateMask?: string;
|
|
6949
8344
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6950
8345
|
upload_protocol?: string;
|
|
6951
8346
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6952
8347
|
uploadType?: string;
|
|
6953
8348
|
},
|
|
6954
|
-
body:
|
|
6955
|
-
): Request<
|
|
6956
|
-
/**
|
|
6957
|
-
|
|
8349
|
+
body: GoogleCloudDiscoveryengineV1betaSession
|
|
8350
|
+
): Request<GoogleCloudDiscoveryengineV1betaSession>;
|
|
8351
|
+
/** Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. */
|
|
8352
|
+
delete(request?: {
|
|
6958
8353
|
/** V1 error format. */
|
|
6959
8354
|
'$.xgafv'?: string;
|
|
6960
8355
|
/** OAuth access token. */
|
|
@@ -6967,52 +8362,21 @@ declare namespace gapi.client {
|
|
|
6967
8362
|
fields?: string;
|
|
6968
8363
|
/** 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. */
|
|
6969
8364
|
key?: string;
|
|
8365
|
+
/** Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
8366
|
+
name: string;
|
|
6970
8367
|
/** OAuth 2.0 token for the current user. */
|
|
6971
8368
|
oauth_token?: string;
|
|
6972
8369
|
/** Returns response with indentations and line breaks. */
|
|
6973
8370
|
prettyPrint?: boolean;
|
|
6974
8371
|
/** 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. */
|
|
6975
8372
|
quotaUser?: string;
|
|
6976
|
-
/** Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
|
|
6977
|
-
servingConfig: string;
|
|
6978
8373
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6979
8374
|
upload_protocol?: string;
|
|
6980
8375
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6981
8376
|
uploadType?: string;
|
|
6982
|
-
|
|
6983
|
-
|
|
6984
|
-
|
|
6985
|
-
recommend(
|
|
6986
|
-
request: {
|
|
6987
|
-
/** V1 error format. */
|
|
6988
|
-
'$.xgafv'?: string;
|
|
6989
|
-
/** OAuth access token. */
|
|
6990
|
-
access_token?: string;
|
|
6991
|
-
/** Data format for response. */
|
|
6992
|
-
alt?: string;
|
|
6993
|
-
/** JSONP */
|
|
6994
|
-
callback?: string;
|
|
6995
|
-
/** Selector specifying which fields to include in a partial response. */
|
|
6996
|
-
fields?: string;
|
|
6997
|
-
/** 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. */
|
|
6998
|
-
key?: string;
|
|
6999
|
-
/** OAuth 2.0 token for the current user. */
|
|
7000
|
-
oauth_token?: string;
|
|
7001
|
-
/** Returns response with indentations and line breaks. */
|
|
7002
|
-
prettyPrint?: boolean;
|
|
7003
|
-
/** 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. */
|
|
7004
|
-
quotaUser?: string;
|
|
7005
|
-
/** Required. Full resource name of a ServingConfig: `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*/locations/global/collections/*/engines/my-engine`, you can use `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
|
|
7006
|
-
servingConfig: string;
|
|
7007
|
-
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7008
|
-
upload_protocol?: string;
|
|
7009
|
-
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7010
|
-
uploadType?: string;
|
|
7011
|
-
},
|
|
7012
|
-
body: GoogleCloudDiscoveryengineV1betaRecommendRequest
|
|
7013
|
-
): Request<GoogleCloudDiscoveryengineV1betaRecommendResponse>;
|
|
7014
|
-
/** Performs a search. */
|
|
7015
|
-
search(request: {
|
|
8377
|
+
}): Request<{}>;
|
|
8378
|
+
/** Gets a Session. */
|
|
8379
|
+
get(request?: {
|
|
7016
8380
|
/** V1 error format. */
|
|
7017
8381
|
'$.xgafv'?: string;
|
|
7018
8382
|
/** OAuth access token. */
|
|
@@ -7025,22 +8389,86 @@ declare namespace gapi.client {
|
|
|
7025
8389
|
fields?: string;
|
|
7026
8390
|
/** 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. */
|
|
7027
8391
|
key?: string;
|
|
8392
|
+
/** Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
8393
|
+
name: string;
|
|
7028
8394
|
/** OAuth 2.0 token for the current user. */
|
|
7029
8395
|
oauth_token?: string;
|
|
7030
8396
|
/** Returns response with indentations and line breaks. */
|
|
7031
8397
|
prettyPrint?: boolean;
|
|
7032
8398
|
/** 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. */
|
|
7033
8399
|
quotaUser?: string;
|
|
7034
|
-
/**
|
|
7035
|
-
|
|
8400
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8401
|
+
upload_protocol?: string;
|
|
8402
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8403
|
+
uploadType?: string;
|
|
8404
|
+
}): Request<GoogleCloudDiscoveryengineV1betaSession>;
|
|
8405
|
+
/** Lists all Sessions by their parent DataStore. */
|
|
8406
|
+
list(request?: {
|
|
8407
|
+
/** V1 error format. */
|
|
8408
|
+
'$.xgafv'?: string;
|
|
8409
|
+
/** OAuth access token. */
|
|
8410
|
+
access_token?: string;
|
|
8411
|
+
/** Data format for response. */
|
|
8412
|
+
alt?: string;
|
|
8413
|
+
/** JSONP */
|
|
8414
|
+
callback?: string;
|
|
8415
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8416
|
+
fields?: string;
|
|
8417
|
+
/** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
|
|
8418
|
+
filter?: string;
|
|
8419
|
+
/** 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. */
|
|
8420
|
+
key?: string;
|
|
8421
|
+
/** OAuth 2.0 token for the current user. */
|
|
8422
|
+
oauth_token?: string;
|
|
8423
|
+
/** 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" */
|
|
8424
|
+
orderBy?: string;
|
|
8425
|
+
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
8426
|
+
pageSize?: number;
|
|
8427
|
+
/** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
|
|
8428
|
+
pageToken?: string;
|
|
8429
|
+
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
8430
|
+
parent: string;
|
|
8431
|
+
/** Returns response with indentations and line breaks. */
|
|
8432
|
+
prettyPrint?: boolean;
|
|
8433
|
+
/** 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. */
|
|
8434
|
+
quotaUser?: string;
|
|
8435
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8436
|
+
upload_protocol?: string;
|
|
8437
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8438
|
+
uploadType?: string;
|
|
8439
|
+
}): Request<GoogleCloudDiscoveryengineV1betaListSessionsResponse>;
|
|
8440
|
+
/** Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. */
|
|
8441
|
+
patch(request: {
|
|
8442
|
+
/** V1 error format. */
|
|
8443
|
+
'$.xgafv'?: string;
|
|
8444
|
+
/** OAuth access token. */
|
|
8445
|
+
access_token?: string;
|
|
8446
|
+
/** Data format for response. */
|
|
8447
|
+
alt?: string;
|
|
8448
|
+
/** JSONP */
|
|
8449
|
+
callback?: string;
|
|
8450
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8451
|
+
fields?: string;
|
|
8452
|
+
/** 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. */
|
|
8453
|
+
key?: string;
|
|
8454
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
8455
|
+
name: string;
|
|
8456
|
+
/** OAuth 2.0 token for the current user. */
|
|
8457
|
+
oauth_token?: string;
|
|
8458
|
+
/** Returns response with indentations and line breaks. */
|
|
8459
|
+
prettyPrint?: boolean;
|
|
8460
|
+
/** 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. */
|
|
8461
|
+
quotaUser?: string;
|
|
8462
|
+
/** 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. */
|
|
8463
|
+
updateMask?: string;
|
|
7036
8464
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7037
8465
|
upload_protocol?: string;
|
|
7038
8466
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7039
8467
|
uploadType?: string;
|
|
7040
8468
|
/** Request body */
|
|
7041
|
-
resource:
|
|
7042
|
-
}): Request<
|
|
7043
|
-
|
|
8469
|
+
resource: GoogleCloudDiscoveryengineV1betaSession;
|
|
8470
|
+
}): Request<GoogleCloudDiscoveryengineV1betaSession>;
|
|
8471
|
+
patch(
|
|
7044
8472
|
request: {
|
|
7045
8473
|
/** V1 error format. */
|
|
7046
8474
|
'$.xgafv'?: string;
|
|
@@ -7054,21 +8482,24 @@ declare namespace gapi.client {
|
|
|
7054
8482
|
fields?: string;
|
|
7055
8483
|
/** 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. */
|
|
7056
8484
|
key?: string;
|
|
8485
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
8486
|
+
name: string;
|
|
7057
8487
|
/** OAuth 2.0 token for the current user. */
|
|
7058
8488
|
oauth_token?: string;
|
|
7059
8489
|
/** Returns response with indentations and line breaks. */
|
|
7060
8490
|
prettyPrint?: boolean;
|
|
7061
8491
|
/** 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. */
|
|
7062
8492
|
quotaUser?: string;
|
|
7063
|
-
/**
|
|
7064
|
-
|
|
8493
|
+
/** 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. */
|
|
8494
|
+
updateMask?: string;
|
|
7065
8495
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7066
8496
|
upload_protocol?: string;
|
|
7067
8497
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7068
8498
|
uploadType?: string;
|
|
7069
8499
|
},
|
|
7070
|
-
body:
|
|
7071
|
-
): Request<
|
|
8500
|
+
body: GoogleCloudDiscoveryengineV1betaSession
|
|
8501
|
+
): Request<GoogleCloudDiscoveryengineV1betaSession>;
|
|
8502
|
+
answers: AnswersResource;
|
|
7072
8503
|
}
|
|
7073
8504
|
interface TargetSitesResource {
|
|
7074
8505
|
/** Creates TargetSite in a batch. */
|
|
@@ -8061,10 +9492,71 @@ declare namespace gapi.client {
|
|
|
8061
9492
|
operations: OperationsResource;
|
|
8062
9493
|
schemas: SchemasResource;
|
|
8063
9494
|
servingConfigs: ServingConfigsResource;
|
|
9495
|
+
sessions: SessionsResource;
|
|
8064
9496
|
siteSearchEngine: SiteSearchEngineResource;
|
|
8065
9497
|
suggestionDenyListEntries: SuggestionDenyListEntriesResource;
|
|
8066
9498
|
userEvents: UserEventsResource;
|
|
8067
9499
|
}
|
|
9500
|
+
interface GroundingConfigsResource {
|
|
9501
|
+
/** Performs a grounding check. */
|
|
9502
|
+
check(request: {
|
|
9503
|
+
/** V1 error format. */
|
|
9504
|
+
'$.xgafv'?: string;
|
|
9505
|
+
/** OAuth access token. */
|
|
9506
|
+
access_token?: string;
|
|
9507
|
+
/** Data format for response. */
|
|
9508
|
+
alt?: string;
|
|
9509
|
+
/** JSONP */
|
|
9510
|
+
callback?: string;
|
|
9511
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9512
|
+
fields?: string;
|
|
9513
|
+
/** Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`. */
|
|
9514
|
+
groundingConfig: string;
|
|
9515
|
+
/** 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. */
|
|
9516
|
+
key?: string;
|
|
9517
|
+
/** OAuth 2.0 token for the current user. */
|
|
9518
|
+
oauth_token?: string;
|
|
9519
|
+
/** Returns response with indentations and line breaks. */
|
|
9520
|
+
prettyPrint?: boolean;
|
|
9521
|
+
/** 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. */
|
|
9522
|
+
quotaUser?: string;
|
|
9523
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9524
|
+
upload_protocol?: string;
|
|
9525
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9526
|
+
uploadType?: string;
|
|
9527
|
+
/** Request body */
|
|
9528
|
+
resource: GoogleCloudDiscoveryengineV1betaCheckGroundingRequest;
|
|
9529
|
+
}): Request<GoogleCloudDiscoveryengineV1betaCheckGroundingResponse>;
|
|
9530
|
+
check(
|
|
9531
|
+
request: {
|
|
9532
|
+
/** V1 error format. */
|
|
9533
|
+
'$.xgafv'?: string;
|
|
9534
|
+
/** OAuth access token. */
|
|
9535
|
+
access_token?: string;
|
|
9536
|
+
/** Data format for response. */
|
|
9537
|
+
alt?: string;
|
|
9538
|
+
/** JSONP */
|
|
9539
|
+
callback?: string;
|
|
9540
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9541
|
+
fields?: string;
|
|
9542
|
+
/** Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`. */
|
|
9543
|
+
groundingConfig: string;
|
|
9544
|
+
/** 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. */
|
|
9545
|
+
key?: string;
|
|
9546
|
+
/** OAuth 2.0 token for the current user. */
|
|
9547
|
+
oauth_token?: string;
|
|
9548
|
+
/** Returns response with indentations and line breaks. */
|
|
9549
|
+
prettyPrint?: boolean;
|
|
9550
|
+
/** 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. */
|
|
9551
|
+
quotaUser?: string;
|
|
9552
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9553
|
+
upload_protocol?: string;
|
|
9554
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9555
|
+
uploadType?: string;
|
|
9556
|
+
},
|
|
9557
|
+
body: GoogleCloudDiscoveryengineV1betaCheckGroundingRequest
|
|
9558
|
+
): Request<GoogleCloudDiscoveryengineV1betaCheckGroundingResponse>;
|
|
9559
|
+
}
|
|
8068
9560
|
interface OperationsResource {
|
|
8069
9561
|
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
8070
9562
|
get(request?: {
|
|
@@ -8190,6 +9682,7 @@ declare namespace gapi.client {
|
|
|
8190
9682
|
interface LocationsResource {
|
|
8191
9683
|
collections: CollectionsResource;
|
|
8192
9684
|
dataStores: DataStoresResource;
|
|
9685
|
+
groundingConfigs: GroundingConfigsResource;
|
|
8193
9686
|
operations: OperationsResource;
|
|
8194
9687
|
rankingConfigs: RankingConfigsResource;
|
|
8195
9688
|
}
|