@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240323 → 0.0.20240401
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 +1534 -88
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240401
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -92,6 +92,282 @@ declare namespace gapi.client {
|
|
|
92
92
|
/** Token that used for non-human user check. */
|
|
93
93
|
token?: string;
|
|
94
94
|
}
|
|
95
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswer {
|
|
96
|
+
/** Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. */
|
|
97
|
+
answerSkippedReasons?: string[];
|
|
98
|
+
/** The textual answer. */
|
|
99
|
+
answerText?: string;
|
|
100
|
+
/** Citations. */
|
|
101
|
+
citations?: GoogleCloudDiscoveryengineV1alphaAnswerCitation[];
|
|
102
|
+
/** Output only. Answer completed timestamp. */
|
|
103
|
+
completeTime?: string;
|
|
104
|
+
/** Output only. Answer creation timestamp. */
|
|
105
|
+
createTime?: string;
|
|
106
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*` */
|
|
107
|
+
name?: string;
|
|
108
|
+
/** Query understanding information. */
|
|
109
|
+
queryUnderstandingInfo?: GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo;
|
|
110
|
+
/** References. */
|
|
111
|
+
references?: GoogleCloudDiscoveryengineV1alphaAnswerReference[];
|
|
112
|
+
/** Suggested related questions. */
|
|
113
|
+
relatedQuestions?: string[];
|
|
114
|
+
/** The state of the answer generation. */
|
|
115
|
+
state?: string;
|
|
116
|
+
/** Answer generation steps. */
|
|
117
|
+
steps?: GoogleCloudDiscoveryengineV1alphaAnswerStep[];
|
|
118
|
+
}
|
|
119
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerCitation {
|
|
120
|
+
/** End of the attributed segment, exclusive. */
|
|
121
|
+
endIndex?: string;
|
|
122
|
+
/** Citation sources for the attributed segment. */
|
|
123
|
+
sources?: GoogleCloudDiscoveryengineV1alphaAnswerCitationSource[];
|
|
124
|
+
/** Index indicates the start of the segment, measured in bytes (UTF-8 unicode). */
|
|
125
|
+
startIndex?: string;
|
|
126
|
+
}
|
|
127
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerCitationSource {
|
|
128
|
+
/** ID of the citation source. */
|
|
129
|
+
referenceId?: string;
|
|
130
|
+
}
|
|
131
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest {
|
|
132
|
+
/** Answer generation specification. */
|
|
133
|
+
answerGenerationSpec?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec;
|
|
134
|
+
/** 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. */
|
|
135
|
+
asynchronousMode?: boolean;
|
|
136
|
+
/** Required. Current user query. */
|
|
137
|
+
query?: GoogleCloudDiscoveryengineV1alphaQuery;
|
|
138
|
+
/** Query understanding specification. */
|
|
139
|
+
queryUnderstandingSpec?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec;
|
|
140
|
+
/** Related questions specification. */
|
|
141
|
+
relatedQuestionsSpec?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec;
|
|
142
|
+
/** Model specification. */
|
|
143
|
+
safetySpec?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec;
|
|
144
|
+
/** Search specification. */
|
|
145
|
+
searchSpec?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec;
|
|
146
|
+
/** 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. */
|
|
147
|
+
session?: string;
|
|
148
|
+
/** 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. */
|
|
149
|
+
userPseudoId?: string;
|
|
150
|
+
}
|
|
151
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec {
|
|
152
|
+
/** 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. */
|
|
153
|
+
answerLanguageCode?: string;
|
|
154
|
+
/** 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. */
|
|
155
|
+
ignoreAdversarialQuery?: boolean;
|
|
156
|
+
/** 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. */
|
|
157
|
+
ignoreNonAnswerSeekingQuery?: boolean;
|
|
158
|
+
/** Specifies whether to include citation metadata in the answer. The default value is `false`. */
|
|
159
|
+
includeCitations?: boolean;
|
|
160
|
+
/** Answer generation model specification. */
|
|
161
|
+
modelSpec?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec;
|
|
162
|
+
/** Answer generation prompt specification. */
|
|
163
|
+
promptSpec?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec;
|
|
164
|
+
}
|
|
165
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec {
|
|
166
|
+
/** Model version. If not set, it will use the default stable model. Allowed values are: stable, preview. */
|
|
167
|
+
modelVersion?: string;
|
|
168
|
+
}
|
|
169
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec {
|
|
170
|
+
/** Customized preamble. */
|
|
171
|
+
preamble?: string;
|
|
172
|
+
}
|
|
173
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec {
|
|
174
|
+
/** Query classification specification. */
|
|
175
|
+
queryClassificationSpec?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec;
|
|
176
|
+
/** Query rephraser specification. */
|
|
177
|
+
queryRephraserSpec?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec;
|
|
178
|
+
}
|
|
179
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec {
|
|
180
|
+
/** Enabled query classification types. */
|
|
181
|
+
types?: string[];
|
|
182
|
+
}
|
|
183
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec {
|
|
184
|
+
/** Disable query rephraser. */
|
|
185
|
+
disable?: boolean;
|
|
186
|
+
/** Max rephrase steps. The max number is 10 steps. If not set or set to < 1, it will be set to 1 by default. */
|
|
187
|
+
maxRephraseSteps?: number;
|
|
188
|
+
}
|
|
189
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec {
|
|
190
|
+
/** Enable related questions feature if true. */
|
|
191
|
+
enable?: boolean;
|
|
192
|
+
}
|
|
193
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec {
|
|
194
|
+
/** Enable the safety filtering on the answer response. It is false by default. */
|
|
195
|
+
enable?: boolean;
|
|
196
|
+
}
|
|
197
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec {
|
|
198
|
+
/** Search parameters. */
|
|
199
|
+
searchParams?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams;
|
|
200
|
+
/** Search result list. */
|
|
201
|
+
searchResultList?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList;
|
|
202
|
+
}
|
|
203
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams {
|
|
204
|
+
/** 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) */
|
|
205
|
+
boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
206
|
+
/** 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) */
|
|
207
|
+
filter?: string;
|
|
208
|
+
/** Number of search results to return. The default value is 10. */
|
|
209
|
+
maxReturnResults?: number;
|
|
210
|
+
/** 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. */
|
|
211
|
+
orderBy?: string;
|
|
212
|
+
/** Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) */
|
|
213
|
+
searchResultMode?: string;
|
|
214
|
+
}
|
|
215
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList {
|
|
216
|
+
/** Search results. */
|
|
217
|
+
searchResults?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult[];
|
|
218
|
+
}
|
|
219
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult {
|
|
220
|
+
/** Chunk information. */
|
|
221
|
+
chunkInfo?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo;
|
|
222
|
+
/** Unstructured document information. */
|
|
223
|
+
unstructuredDocumentInfo?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo;
|
|
224
|
+
}
|
|
225
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo {
|
|
226
|
+
/** Chunk resource name. */
|
|
227
|
+
chunk?: string;
|
|
228
|
+
/** Chunk textual content. */
|
|
229
|
+
content?: string;
|
|
230
|
+
}
|
|
231
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo {
|
|
232
|
+
/** Document resource name. */
|
|
233
|
+
document?: string;
|
|
234
|
+
/** List of document contexts. */
|
|
235
|
+
documentContexts?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext[];
|
|
236
|
+
/** List of extractive answers. */
|
|
237
|
+
extractiveAnswers?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer[];
|
|
238
|
+
/** List of extractive segments. */
|
|
239
|
+
extractiveSegments?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment[];
|
|
240
|
+
/** Title. */
|
|
241
|
+
title?: string;
|
|
242
|
+
/** URI for the document. */
|
|
243
|
+
uri?: string;
|
|
244
|
+
}
|
|
245
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext {
|
|
246
|
+
/** Document content. */
|
|
247
|
+
content?: string;
|
|
248
|
+
/** Page identifier. */
|
|
249
|
+
pageIdentifier?: string;
|
|
250
|
+
}
|
|
251
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer {
|
|
252
|
+
/** Extractive answer content. */
|
|
253
|
+
content?: string;
|
|
254
|
+
/** Page identifier. */
|
|
255
|
+
pageIdentifier?: string;
|
|
256
|
+
}
|
|
257
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment {
|
|
258
|
+
/** Extractive segment content. */
|
|
259
|
+
content?: string;
|
|
260
|
+
/** Page identifier. */
|
|
261
|
+
pageIdentifier?: string;
|
|
262
|
+
}
|
|
263
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse {
|
|
264
|
+
/** Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. */
|
|
265
|
+
answer?: GoogleCloudDiscoveryengineV1alphaAnswer;
|
|
266
|
+
/** Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request. */
|
|
267
|
+
session?: GoogleCloudDiscoveryengineV1alphaSession;
|
|
268
|
+
}
|
|
269
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo {
|
|
270
|
+
/** Query classification information. */
|
|
271
|
+
queryClassificationInfo?: GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo[];
|
|
272
|
+
}
|
|
273
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo {
|
|
274
|
+
/** Classification output. */
|
|
275
|
+
positive?: boolean;
|
|
276
|
+
/** Query classification type. */
|
|
277
|
+
type?: string;
|
|
278
|
+
}
|
|
279
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerReference {
|
|
280
|
+
/** Chunk information. */
|
|
281
|
+
chunkInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo;
|
|
282
|
+
/** Unstructured document information. */
|
|
283
|
+
unstructuredDocumentInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo;
|
|
284
|
+
}
|
|
285
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo {
|
|
286
|
+
/** Chunk resource name. */
|
|
287
|
+
chunk?: string;
|
|
288
|
+
/** Chunk textual content. */
|
|
289
|
+
content?: string;
|
|
290
|
+
/** Document metadata. */
|
|
291
|
+
documentMetadata?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata;
|
|
292
|
+
/** Relevance score. */
|
|
293
|
+
relevanceScore?: number;
|
|
294
|
+
}
|
|
295
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata {
|
|
296
|
+
/** Document resource name. */
|
|
297
|
+
document?: string;
|
|
298
|
+
/** Page identifier. */
|
|
299
|
+
pageIdentifier?: string;
|
|
300
|
+
/** Title. */
|
|
301
|
+
title?: string;
|
|
302
|
+
/** URI for the document. */
|
|
303
|
+
uri?: string;
|
|
304
|
+
}
|
|
305
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo {
|
|
306
|
+
/** List of cited chunk contents derived from document content. */
|
|
307
|
+
chunkContents?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
|
|
308
|
+
/** Document resource name. */
|
|
309
|
+
document?: string;
|
|
310
|
+
/** Title. */
|
|
311
|
+
title?: string;
|
|
312
|
+
/** URI for the document. */
|
|
313
|
+
uri?: string;
|
|
314
|
+
}
|
|
315
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent {
|
|
316
|
+
/** Chunk textual content. */
|
|
317
|
+
content?: string;
|
|
318
|
+
/** Page identifier. */
|
|
319
|
+
pageIdentifier?: string;
|
|
320
|
+
}
|
|
321
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerStep {
|
|
322
|
+
/** Actions. */
|
|
323
|
+
actions?: GoogleCloudDiscoveryengineV1alphaAnswerStepAction[];
|
|
324
|
+
/** The description of the step. */
|
|
325
|
+
description?: string;
|
|
326
|
+
/** The state of the step. */
|
|
327
|
+
state?: string;
|
|
328
|
+
/** The thought of the step. */
|
|
329
|
+
thought?: string;
|
|
330
|
+
}
|
|
331
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerStepAction {
|
|
332
|
+
/** Observation. */
|
|
333
|
+
observation?: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation;
|
|
334
|
+
/** Search action. */
|
|
335
|
+
searchAction?: GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction;
|
|
336
|
+
}
|
|
337
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation {
|
|
338
|
+
/** Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user. */
|
|
339
|
+
searchResults?: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult[];
|
|
340
|
+
}
|
|
341
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult {
|
|
342
|
+
/** If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info. */
|
|
343
|
+
chunkInfo?: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo[];
|
|
344
|
+
/** Document resource name. */
|
|
345
|
+
document?: string;
|
|
346
|
+
/** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
|
|
347
|
+
snippetInfo?: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[];
|
|
348
|
+
/** Title. */
|
|
349
|
+
title?: string;
|
|
350
|
+
/** URI for the document. */
|
|
351
|
+
uri?: string;
|
|
352
|
+
}
|
|
353
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo {
|
|
354
|
+
/** Chunk resource name. */
|
|
355
|
+
chunk?: string;
|
|
356
|
+
/** Chunk textual content. */
|
|
357
|
+
content?: string;
|
|
358
|
+
/** Relevance score. */
|
|
359
|
+
relevanceScore?: number;
|
|
360
|
+
}
|
|
361
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo {
|
|
362
|
+
/** Snippet content. */
|
|
363
|
+
snippet?: string;
|
|
364
|
+
/** Status of the snippet defined by the search team. */
|
|
365
|
+
snippetStatus?: string;
|
|
366
|
+
}
|
|
367
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction {
|
|
368
|
+
/** The query to search. */
|
|
369
|
+
query?: string;
|
|
370
|
+
}
|
|
95
371
|
interface GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata {
|
|
96
372
|
/** Operation create time. */
|
|
97
373
|
createTime?: string;
|
|
@@ -108,7 +384,7 @@ declare namespace gapi.client {
|
|
|
108
384
|
}
|
|
109
385
|
interface GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest {}
|
|
110
386
|
interface GoogleCloudDiscoveryengineV1alphaBigQuerySource {
|
|
111
|
-
/** 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
|
|
387
|
+
/** 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. */
|
|
112
388
|
dataSchema?: string;
|
|
113
389
|
/** Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. */
|
|
114
390
|
datasetId?: string;
|
|
@@ -121,6 +397,74 @@ declare namespace gapi.client {
|
|
|
121
397
|
/** Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. */
|
|
122
398
|
tableId?: string;
|
|
123
399
|
}
|
|
400
|
+
interface GoogleCloudDiscoveryengineV1alphaBigtableOptions {
|
|
401
|
+
/** The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored. */
|
|
402
|
+
families?: {
|
|
403
|
+
[P in string]: GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily;
|
|
404
|
+
};
|
|
405
|
+
/** The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`. */
|
|
406
|
+
keyFieldName?: string;
|
|
407
|
+
}
|
|
408
|
+
interface GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn {
|
|
409
|
+
/** 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. */
|
|
410
|
+
encoding?: string;
|
|
411
|
+
/** 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. */
|
|
412
|
+
fieldName?: string;
|
|
413
|
+
/** Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead. */
|
|
414
|
+
qualifier?: string;
|
|
415
|
+
/** 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`. */
|
|
416
|
+
type?: string;
|
|
417
|
+
}
|
|
418
|
+
interface GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily {
|
|
419
|
+
/** 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. */
|
|
420
|
+
columns?: GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn[];
|
|
421
|
+
/** 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. */
|
|
422
|
+
encoding?: string;
|
|
423
|
+
/** 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. */
|
|
424
|
+
fieldName?: string;
|
|
425
|
+
/** 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`. */
|
|
426
|
+
type?: string;
|
|
427
|
+
}
|
|
428
|
+
interface GoogleCloudDiscoveryengineV1alphaBigtableSource {
|
|
429
|
+
/** Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations. */
|
|
430
|
+
bigtableOptions?: GoogleCloudDiscoveryengineV1alphaBigtableOptions;
|
|
431
|
+
/** Required. The instance ID of the Cloud Bigtable that needs to be imported. */
|
|
432
|
+
instanceId?: string;
|
|
433
|
+
/** 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. */
|
|
434
|
+
projectId?: string;
|
|
435
|
+
/** Required. The table ID of the Cloud Bigtable that needs to be imported. */
|
|
436
|
+
tableId?: string;
|
|
437
|
+
}
|
|
438
|
+
interface GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest {
|
|
439
|
+
/** Answer candidate to check. */
|
|
440
|
+
answerCandidate?: string;
|
|
441
|
+
/** List of facts for the grounding check. We support up to 200 facts. */
|
|
442
|
+
facts?: GoogleCloudDiscoveryengineV1alphaGroundingFact[];
|
|
443
|
+
/** Configuration of the grounding check. */
|
|
444
|
+
groundingSpec?: GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec;
|
|
445
|
+
}
|
|
446
|
+
interface GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse {
|
|
447
|
+
/** List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. */
|
|
448
|
+
citedChunks?: GoogleCloudDiscoveryengineV1alphaFactChunk[];
|
|
449
|
+
/** Claim texts and citation info across all claims in the answer candidate. */
|
|
450
|
+
claims?: GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim[];
|
|
451
|
+
/** 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. */
|
|
452
|
+
supportScore?: number;
|
|
453
|
+
}
|
|
454
|
+
interface GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim {
|
|
455
|
+
/** 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. */
|
|
456
|
+
citationIndices?: number[];
|
|
457
|
+
/** Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found. */
|
|
458
|
+
claimText?: string;
|
|
459
|
+
/** Position indicating the end of the claim in the answer candidate, exclusive. */
|
|
460
|
+
endPos?: number;
|
|
461
|
+
/** Position indicating the start of the claim in the answer candidate, measured in bytes/unicode. */
|
|
462
|
+
startPos?: number;
|
|
463
|
+
}
|
|
464
|
+
interface GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec {
|
|
465
|
+
/** 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. */
|
|
466
|
+
citationThreshold?: number;
|
|
467
|
+
}
|
|
124
468
|
interface GoogleCloudDiscoveryengineV1alphaChunk {
|
|
125
469
|
/** Output only. Metadata of the current chunk. */
|
|
126
470
|
chunkMetadata?: GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata;
|
|
@@ -130,7 +474,7 @@ declare namespace gapi.client {
|
|
|
130
474
|
derivedStructData?: {[P in string]: any};
|
|
131
475
|
/** Metadata of the document from the current chunk. */
|
|
132
476
|
documentMetadata?: GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata;
|
|
133
|
-
/** Unique chunk
|
|
477
|
+
/** Unique chunk ID of the current chunk. */
|
|
134
478
|
id?: string;
|
|
135
479
|
/** The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
136
480
|
name?: string;
|
|
@@ -155,6 +499,20 @@ declare namespace gapi.client {
|
|
|
155
499
|
/** The start page of the chunk. */
|
|
156
500
|
pageStart?: number;
|
|
157
501
|
}
|
|
502
|
+
interface GoogleCloudDiscoveryengineV1alphaCloudSqlSource {
|
|
503
|
+
/** Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. */
|
|
504
|
+
databaseId?: string;
|
|
505
|
+
/** 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. */
|
|
506
|
+
gcsStagingDir?: string;
|
|
507
|
+
/** Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. */
|
|
508
|
+
instanceId?: string;
|
|
509
|
+
/** Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless). */
|
|
510
|
+
offload?: boolean;
|
|
511
|
+
/** 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. */
|
|
512
|
+
projectId?: string;
|
|
513
|
+
/** Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. */
|
|
514
|
+
tableId?: string;
|
|
515
|
+
}
|
|
158
516
|
interface GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest {
|
|
159
517
|
/** Required. The parent data store resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. */
|
|
160
518
|
dataStore?: string;
|
|
@@ -564,6 +922,14 @@ declare namespace gapi.client {
|
|
|
564
922
|
/** Total number of documents. */
|
|
565
923
|
documentCount?: string;
|
|
566
924
|
}
|
|
925
|
+
interface GoogleCloudDiscoveryengineV1alphaFactChunk {
|
|
926
|
+
/** Text content of the fact chunk. Can be at most 10K characters long. */
|
|
927
|
+
chunkText?: string;
|
|
928
|
+
/** 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. */
|
|
929
|
+
source?: string;
|
|
930
|
+
/** More fine-grained information for the source reference. */
|
|
931
|
+
sourceMetadata?: {[P in string]: string};
|
|
932
|
+
}
|
|
567
933
|
interface GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse {
|
|
568
934
|
/** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
569
935
|
nextPageToken?: string;
|
|
@@ -598,15 +964,27 @@ declare namespace gapi.client {
|
|
|
598
964
|
/** 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. */
|
|
599
965
|
searchableOption?: string;
|
|
600
966
|
}
|
|
967
|
+
interface GoogleCloudDiscoveryengineV1alphaFirestoreSource {
|
|
968
|
+
/** Required. The Firestore collection to copy the data from with a length limit of 1,500 characters. */
|
|
969
|
+
collectionId?: string;
|
|
970
|
+
/** Required. The Firestore database to copy the data from with a length limit of 256 characters. */
|
|
971
|
+
databaseId?: string;
|
|
972
|
+
/** 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. */
|
|
973
|
+
gcsStagingDir?: string;
|
|
974
|
+
/** 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. */
|
|
975
|
+
projectId?: string;
|
|
976
|
+
}
|
|
601
977
|
interface GoogleCloudDiscoveryengineV1alphaGcsSource {
|
|
602
|
-
/** 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
|
|
978
|
+
/** 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. */
|
|
603
979
|
dataSchema?: string;
|
|
604
980
|
/** 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`). */
|
|
605
981
|
inputUris?: string[];
|
|
606
982
|
}
|
|
607
|
-
interface
|
|
608
|
-
/**
|
|
609
|
-
|
|
983
|
+
interface GoogleCloudDiscoveryengineV1alphaGroundingFact {
|
|
984
|
+
/** 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. */
|
|
985
|
+
attributes?: {[P in string]: string};
|
|
986
|
+
/** Text content of the fact. Can be at most 10K characters long. */
|
|
987
|
+
factText?: string;
|
|
610
988
|
}
|
|
611
989
|
interface GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec {
|
|
612
990
|
/** Whether or not to enable and include refinement attributes in gudied search result. */
|
|
@@ -647,26 +1025,38 @@ declare namespace gapi.client {
|
|
|
647
1025
|
failureCount?: string;
|
|
648
1026
|
/** Count of entries that were processed successfully. */
|
|
649
1027
|
successCount?: string;
|
|
1028
|
+
/** Total count of entries that were processed. */
|
|
1029
|
+
totalCount?: string;
|
|
650
1030
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
651
1031
|
updateTime?: string;
|
|
652
1032
|
}
|
|
653
1033
|
interface GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest {
|
|
654
|
-
/** 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 */
|
|
1034
|
+
/** 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. */
|
|
655
1035
|
autoGenerateIds?: boolean;
|
|
656
1036
|
/** BigQuery input source. */
|
|
657
1037
|
bigquerySource?: GoogleCloudDiscoveryengineV1alphaBigQuerySource;
|
|
1038
|
+
/** Cloud Bigtable input source. */
|
|
1039
|
+
bigtableSource?: GoogleCloudDiscoveryengineV1alphaBigtableSource;
|
|
1040
|
+
/** Cloud SQL input source. */
|
|
1041
|
+
cloudSqlSource?: GoogleCloudDiscoveryengineV1alphaCloudSqlSource;
|
|
658
1042
|
/** The desired location of errors incurred during the Import. */
|
|
659
1043
|
errorConfig?: GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
|
|
660
1044
|
/** FhirStore input source. */
|
|
661
1045
|
fhirStoreSource?: GoogleCloudDiscoveryengineV1alphaFhirStoreSource;
|
|
1046
|
+
/** Firestore input source. */
|
|
1047
|
+
firestoreSource?: GoogleCloudDiscoveryengineV1alphaFirestoreSource;
|
|
662
1048
|
/** Cloud Storage location for the input content. */
|
|
663
1049
|
gcsSource?: GoogleCloudDiscoveryengineV1alphaGcsSource;
|
|
664
|
-
/** 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 */
|
|
1050
|
+
/** 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. */
|
|
665
1051
|
idField?: string;
|
|
666
1052
|
/** The Inline source for the input content for documents. */
|
|
667
1053
|
inlineSource?: GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource;
|
|
668
1054
|
/** The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL. */
|
|
669
1055
|
reconciliationMode?: string;
|
|
1056
|
+
/** Spanner input source. */
|
|
1057
|
+
spannerSource?: GoogleCloudDiscoveryengineV1alphaSpannerSource;
|
|
1058
|
+
/** Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. */
|
|
1059
|
+
updateMask?: string;
|
|
670
1060
|
}
|
|
671
1061
|
interface GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource {
|
|
672
1062
|
/** Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. */
|
|
@@ -792,6 +1182,12 @@ declare namespace gapi.client {
|
|
|
792
1182
|
/** All the ServingConfigs for a given dataStore. */
|
|
793
1183
|
servingConfigs?: GoogleCloudDiscoveryengineV1alphaServingConfig[];
|
|
794
1184
|
}
|
|
1185
|
+
interface GoogleCloudDiscoveryengineV1alphaListSessionsResponse {
|
|
1186
|
+
/** Pagination token, if not returned indicates the last page. */
|
|
1187
|
+
nextPageToken?: string;
|
|
1188
|
+
/** All the Sessions for a given data store. */
|
|
1189
|
+
sessions?: GoogleCloudDiscoveryengineV1alphaSession[];
|
|
1190
|
+
}
|
|
795
1191
|
interface GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse {
|
|
796
1192
|
/** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
797
1193
|
nextPageToken?: string;
|
|
@@ -912,6 +1308,12 @@ declare namespace gapi.client {
|
|
|
912
1308
|
/** The total count of events purged as a result of the operation. */
|
|
913
1309
|
purgeCount?: string;
|
|
914
1310
|
}
|
|
1311
|
+
interface GoogleCloudDiscoveryengineV1alphaQuery {
|
|
1312
|
+
/** Unique Id for the query. */
|
|
1313
|
+
queryId?: string;
|
|
1314
|
+
/** Plain text. */
|
|
1315
|
+
text?: string;
|
|
1316
|
+
}
|
|
915
1317
|
interface GoogleCloudDiscoveryengineV1alphaRankingRecord {
|
|
916
1318
|
/** 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. */
|
|
917
1319
|
content?: string;
|
|
@@ -929,7 +1331,7 @@ declare namespace gapi.client {
|
|
|
929
1331
|
model?: string;
|
|
930
1332
|
/** The query to use. */
|
|
931
1333
|
query?: string;
|
|
932
|
-
/** Required. A list of records to rank. */
|
|
1334
|
+
/** Required. A list of records to rank. At most 100 records to rank. */
|
|
933
1335
|
records?: GoogleCloudDiscoveryengineV1alphaRankingRecord[];
|
|
934
1336
|
/** The number of results to return. If this is unset or no bigger than zero, returns all results. */
|
|
935
1337
|
topN?: number;
|
|
@@ -1070,7 +1472,7 @@ declare namespace gapi.client {
|
|
|
1070
1472
|
offset?: number;
|
|
1071
1473
|
/** 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. */
|
|
1072
1474
|
orderBy?: string;
|
|
1073
|
-
/** Maximum number of Documents to return.
|
|
1475
|
+
/** 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. */
|
|
1074
1476
|
pageSize?: number;
|
|
1075
1477
|
/** 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. */
|
|
1076
1478
|
pageToken?: string;
|
|
@@ -1102,9 +1504,27 @@ declare namespace gapi.client {
|
|
|
1102
1504
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec {
|
|
1103
1505
|
/** 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. */
|
|
1104
1506
|
boost?: number;
|
|
1507
|
+
/** Complex specification for custom ranking based on customer defined attribute value. */
|
|
1508
|
+
boostControlSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec;
|
|
1105
1509
|
/** 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"))` */
|
|
1106
1510
|
condition?: string;
|
|
1107
1511
|
}
|
|
1512
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec {
|
|
1513
|
+
/** 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). */
|
|
1514
|
+
attributeType?: string;
|
|
1515
|
+
/** The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. */
|
|
1516
|
+
controlPoints?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint[];
|
|
1517
|
+
/** The name of the field whose value will be used to determine the boost amount. */
|
|
1518
|
+
fieldName?: string;
|
|
1519
|
+
/** The interpolation type to be applied to connect the control points listed below. */
|
|
1520
|
+
interpolationType?: string;
|
|
1521
|
+
}
|
|
1522
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint {
|
|
1523
|
+
/** 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]`. */
|
|
1524
|
+
attributeValue?: string;
|
|
1525
|
+
/** The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. */
|
|
1526
|
+
boostAmount?: number;
|
|
1527
|
+
}
|
|
1108
1528
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec {
|
|
1109
1529
|
/** Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */
|
|
1110
1530
|
chunkSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec;
|
|
@@ -1414,6 +1834,26 @@ declare namespace gapi.client {
|
|
|
1414
1834
|
/** 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. */
|
|
1415
1835
|
demotionEventType?: string;
|
|
1416
1836
|
}
|
|
1837
|
+
interface GoogleCloudDiscoveryengineV1alphaSession {
|
|
1838
|
+
/** Output only. The time the session finished. */
|
|
1839
|
+
endTime?: string;
|
|
1840
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
1841
|
+
name?: string;
|
|
1842
|
+
/** Output only. The time the session started. */
|
|
1843
|
+
startTime?: string;
|
|
1844
|
+
/** The state of the session. */
|
|
1845
|
+
state?: string;
|
|
1846
|
+
/** Turns. */
|
|
1847
|
+
turns?: GoogleCloudDiscoveryengineV1alphaSessionTurn[];
|
|
1848
|
+
/** A unique identifier for tracking users. */
|
|
1849
|
+
userPseudoId?: string;
|
|
1850
|
+
}
|
|
1851
|
+
interface GoogleCloudDiscoveryengineV1alphaSessionTurn {
|
|
1852
|
+
/** The resource name of the answer to the user query. */
|
|
1853
|
+
answer?: string;
|
|
1854
|
+
/** The user query. */
|
|
1855
|
+
query?: GoogleCloudDiscoveryengineV1alphaQuery;
|
|
1856
|
+
}
|
|
1417
1857
|
interface GoogleCloudDiscoveryengineV1alphaSiteSearchEngine {
|
|
1418
1858
|
/** The fully qualified resource name of the site search engine. Format: `projects/*/locations/*/dataStores/*/siteSearchEngine` */
|
|
1419
1859
|
name?: string;
|
|
@@ -1424,6 +1864,18 @@ declare namespace gapi.client {
|
|
|
1424
1864
|
/** Latest site verification time. */
|
|
1425
1865
|
verifyTime?: string;
|
|
1426
1866
|
}
|
|
1867
|
+
interface GoogleCloudDiscoveryengineV1alphaSpannerSource {
|
|
1868
|
+
/** Required. The database ID of the source Spanner table. */
|
|
1869
|
+
databaseId?: string;
|
|
1870
|
+
/** 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). */
|
|
1871
|
+
enableDataBoost?: boolean;
|
|
1872
|
+
/** Required. The instance ID of the source Spanner table. */
|
|
1873
|
+
instanceId?: string;
|
|
1874
|
+
/** The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
|
|
1875
|
+
projectId?: string;
|
|
1876
|
+
/** Required. The table name of the Spanner database that needs to be imported. */
|
|
1877
|
+
tableId?: string;
|
|
1878
|
+
}
|
|
1427
1879
|
interface GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry {
|
|
1428
1880
|
/** Required. Phrase to block from suggestions served. Can be maximum 125 characters. */
|
|
1429
1881
|
blockPhrase?: string;
|
|
@@ -1495,7 +1947,7 @@ declare namespace gapi.client {
|
|
|
1495
1947
|
errorSamples?: GoogleRpcStatus[];
|
|
1496
1948
|
/** The metrics of the trained model. */
|
|
1497
1949
|
metrics?: {[P in string]: number};
|
|
1498
|
-
/** 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. */
|
|
1950
|
+
/** 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. */
|
|
1499
1951
|
modelStatus?: string;
|
|
1500
1952
|
}
|
|
1501
1953
|
interface GoogleCloudDiscoveryengineV1alphaTransactionInfo {
|
|
@@ -1907,10 +2359,6 @@ declare namespace gapi.client {
|
|
|
1907
2359
|
/** 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. */
|
|
1908
2360
|
searchTier?: string;
|
|
1909
2361
|
}
|
|
1910
|
-
interface GoogleCloudDiscoveryengineV1betaGroundingConfig {
|
|
1911
|
-
/** Required. Name of the GroundingConfig, of the form `projects/{project}/locations/{location}/groundingConfig`. */
|
|
1912
|
-
name?: string;
|
|
1913
|
-
}
|
|
1914
2362
|
interface GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata {
|
|
1915
2363
|
/** Operation create time. */
|
|
1916
2364
|
createTime?: string;
|
|
@@ -1918,6 +2366,8 @@ declare namespace gapi.client {
|
|
|
1918
2366
|
failureCount?: string;
|
|
1919
2367
|
/** Count of entries that were processed successfully. */
|
|
1920
2368
|
successCount?: string;
|
|
2369
|
+
/** Total count of entries that were processed. */
|
|
2370
|
+
totalCount?: string;
|
|
1921
2371
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1922
2372
|
updateTime?: string;
|
|
1923
2373
|
}
|
|
@@ -2050,7 +2500,7 @@ declare namespace gapi.client {
|
|
|
2050
2500
|
errorSamples?: GoogleRpcStatus[];
|
|
2051
2501
|
/** The metrics of the trained model. */
|
|
2052
2502
|
metrics?: {[P in string]: number};
|
|
2053
|
-
/** 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. */
|
|
2503
|
+
/** 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. */
|
|
2054
2504
|
modelStatus?: string;
|
|
2055
2505
|
}
|
|
2056
2506
|
interface GoogleCloudDiscoveryengineV1betaTuneEngineMetadata {
|
|
@@ -2235,6 +2685,8 @@ declare namespace gapi.client {
|
|
|
2235
2685
|
failureCount?: string;
|
|
2236
2686
|
/** Count of entries that were processed successfully. */
|
|
2237
2687
|
successCount?: string;
|
|
2688
|
+
/** Total count of entries that were processed. */
|
|
2689
|
+
totalCount?: string;
|
|
2238
2690
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
2239
2691
|
updateTime?: string;
|
|
2240
2692
|
}
|
|
@@ -3860,6 +4312,64 @@ declare namespace gapi.client {
|
|
|
3860
4312
|
operations: OperationsResource;
|
|
3861
4313
|
}
|
|
3862
4314
|
interface ServingConfigsResource {
|
|
4315
|
+
/** Answer query method. */
|
|
4316
|
+
answer(request: {
|
|
4317
|
+
/** V1 error format. */
|
|
4318
|
+
'$.xgafv'?: string;
|
|
4319
|
+
/** OAuth access token. */
|
|
4320
|
+
access_token?: string;
|
|
4321
|
+
/** Data format for response. */
|
|
4322
|
+
alt?: string;
|
|
4323
|
+
/** JSONP */
|
|
4324
|
+
callback?: string;
|
|
4325
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4326
|
+
fields?: string;
|
|
4327
|
+
/** 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. */
|
|
4328
|
+
key?: string;
|
|
4329
|
+
/** OAuth 2.0 token for the current user. */
|
|
4330
|
+
oauth_token?: string;
|
|
4331
|
+
/** Returns response with indentations and line breaks. */
|
|
4332
|
+
prettyPrint?: boolean;
|
|
4333
|
+
/** 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. */
|
|
4334
|
+
quotaUser?: string;
|
|
4335
|
+
/** 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. */
|
|
4336
|
+
servingConfig: string;
|
|
4337
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4338
|
+
upload_protocol?: string;
|
|
4339
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4340
|
+
uploadType?: string;
|
|
4341
|
+
/** Request body */
|
|
4342
|
+
resource: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
|
|
4343
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>;
|
|
4344
|
+
answer(
|
|
4345
|
+
request: {
|
|
4346
|
+
/** V1 error format. */
|
|
4347
|
+
'$.xgafv'?: string;
|
|
4348
|
+
/** OAuth access token. */
|
|
4349
|
+
access_token?: string;
|
|
4350
|
+
/** Data format for response. */
|
|
4351
|
+
alt?: string;
|
|
4352
|
+
/** JSONP */
|
|
4353
|
+
callback?: string;
|
|
4354
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4355
|
+
fields?: string;
|
|
4356
|
+
/** 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. */
|
|
4357
|
+
key?: string;
|
|
4358
|
+
/** OAuth 2.0 token for the current user. */
|
|
4359
|
+
oauth_token?: string;
|
|
4360
|
+
/** Returns response with indentations and line breaks. */
|
|
4361
|
+
prettyPrint?: boolean;
|
|
4362
|
+
/** 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. */
|
|
4363
|
+
quotaUser?: string;
|
|
4364
|
+
/** 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. */
|
|
4365
|
+
servingConfig: string;
|
|
4366
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4367
|
+
upload_protocol?: string;
|
|
4368
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4369
|
+
uploadType?: string;
|
|
4370
|
+
},
|
|
4371
|
+
body: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest
|
|
4372
|
+
): Request<GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>;
|
|
3863
4373
|
/** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
|
|
3864
4374
|
get(request?: {
|
|
3865
4375
|
/** V1 error format. */
|
|
@@ -4097,8 +4607,8 @@ declare namespace gapi.client {
|
|
|
4097
4607
|
body: GoogleCloudDiscoveryengineV1alphaSearchRequest
|
|
4098
4608
|
): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
|
|
4099
4609
|
}
|
|
4100
|
-
interface
|
|
4101
|
-
/** Gets
|
|
4610
|
+
interface AnswersResource {
|
|
4611
|
+
/** Gets a Answer. */
|
|
4102
4612
|
get(request?: {
|
|
4103
4613
|
/** V1 error format. */
|
|
4104
4614
|
'$.xgafv'?: string;
|
|
@@ -4112,7 +4622,7 @@ declare namespace gapi.client {
|
|
|
4112
4622
|
fields?: string;
|
|
4113
4623
|
/** 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. */
|
|
4114
4624
|
key?: string;
|
|
4115
|
-
/** The name of the
|
|
4625
|
+
/** 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}` */
|
|
4116
4626
|
name: string;
|
|
4117
4627
|
/** OAuth 2.0 token for the current user. */
|
|
4118
4628
|
oauth_token?: string;
|
|
@@ -4124,9 +4634,11 @@ declare namespace gapi.client {
|
|
|
4124
4634
|
upload_protocol?: string;
|
|
4125
4635
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4126
4636
|
uploadType?: string;
|
|
4127
|
-
}): Request<
|
|
4128
|
-
|
|
4129
|
-
|
|
4637
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaAnswer>;
|
|
4638
|
+
}
|
|
4639
|
+
interface SessionsResource {
|
|
4640
|
+
/** Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. */
|
|
4641
|
+
create(request: {
|
|
4130
4642
|
/** V1 error format. */
|
|
4131
4643
|
'$.xgafv'?: string;
|
|
4132
4644
|
/** OAuth access token. */
|
|
@@ -4137,18 +4649,12 @@ declare namespace gapi.client {
|
|
|
4137
4649
|
callback?: string;
|
|
4138
4650
|
/** Selector specifying which fields to include in a partial response. */
|
|
4139
4651
|
fields?: string;
|
|
4140
|
-
/** The standard list filter. */
|
|
4141
|
-
filter?: string;
|
|
4142
4652
|
/** 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. */
|
|
4143
4653
|
key?: string;
|
|
4144
|
-
/** The name of the operation's parent resource. */
|
|
4145
|
-
name: string;
|
|
4146
4654
|
/** OAuth 2.0 token for the current user. */
|
|
4147
4655
|
oauth_token?: string;
|
|
4148
|
-
/**
|
|
4149
|
-
|
|
4150
|
-
/** The standard list page token. */
|
|
4151
|
-
pageToken?: string;
|
|
4656
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
4657
|
+
parent: string;
|
|
4152
4658
|
/** Returns response with indentations and line breaks. */
|
|
4153
4659
|
prettyPrint?: boolean;
|
|
4154
4660
|
/** 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. */
|
|
@@ -4157,11 +4663,40 @@ declare namespace gapi.client {
|
|
|
4157
4663
|
upload_protocol?: string;
|
|
4158
4664
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4159
4665
|
uploadType?: string;
|
|
4160
|
-
|
|
4161
|
-
|
|
4162
|
-
|
|
4163
|
-
|
|
4164
|
-
|
|
4666
|
+
/** Request body */
|
|
4667
|
+
resource: GoogleCloudDiscoveryengineV1alphaSession;
|
|
4668
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaSession>;
|
|
4669
|
+
create(
|
|
4670
|
+
request: {
|
|
4671
|
+
/** V1 error format. */
|
|
4672
|
+
'$.xgafv'?: string;
|
|
4673
|
+
/** OAuth access token. */
|
|
4674
|
+
access_token?: string;
|
|
4675
|
+
/** Data format for response. */
|
|
4676
|
+
alt?: string;
|
|
4677
|
+
/** JSONP */
|
|
4678
|
+
callback?: string;
|
|
4679
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4680
|
+
fields?: string;
|
|
4681
|
+
/** 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. */
|
|
4682
|
+
key?: string;
|
|
4683
|
+
/** OAuth 2.0 token for the current user. */
|
|
4684
|
+
oauth_token?: string;
|
|
4685
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
4686
|
+
parent: string;
|
|
4687
|
+
/** Returns response with indentations and line breaks. */
|
|
4688
|
+
prettyPrint?: boolean;
|
|
4689
|
+
/** 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. */
|
|
4690
|
+
quotaUser?: string;
|
|
4691
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4692
|
+
upload_protocol?: string;
|
|
4693
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4694
|
+
uploadType?: string;
|
|
4695
|
+
},
|
|
4696
|
+
body: GoogleCloudDiscoveryengineV1alphaSession
|
|
4697
|
+
): Request<GoogleCloudDiscoveryengineV1alphaSession>;
|
|
4698
|
+
/** Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. */
|
|
4699
|
+
delete(request?: {
|
|
4165
4700
|
/** V1 error format. */
|
|
4166
4701
|
'$.xgafv'?: string;
|
|
4167
4702
|
/** OAuth access token. */
|
|
@@ -4174,7 +4709,7 @@ declare namespace gapi.client {
|
|
|
4174
4709
|
fields?: string;
|
|
4175
4710
|
/** 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. */
|
|
4176
4711
|
key?: string;
|
|
4177
|
-
/** The name of the
|
|
4712
|
+
/** 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}` */
|
|
4178
4713
|
name: string;
|
|
4179
4714
|
/** OAuth 2.0 token for the current user. */
|
|
4180
4715
|
oauth_token?: string;
|
|
@@ -4186,9 +4721,9 @@ declare namespace gapi.client {
|
|
|
4186
4721
|
upload_protocol?: string;
|
|
4187
4722
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4188
4723
|
uploadType?: string;
|
|
4189
|
-
}): Request<
|
|
4190
|
-
/**
|
|
4191
|
-
|
|
4724
|
+
}): Request<{}>;
|
|
4725
|
+
/** Gets a Session. */
|
|
4726
|
+
get(request?: {
|
|
4192
4727
|
/** V1 error format. */
|
|
4193
4728
|
'$.xgafv'?: string;
|
|
4194
4729
|
/** OAuth access token. */
|
|
@@ -4199,18 +4734,12 @@ declare namespace gapi.client {
|
|
|
4199
4734
|
callback?: string;
|
|
4200
4735
|
/** Selector specifying which fields to include in a partial response. */
|
|
4201
4736
|
fields?: string;
|
|
4202
|
-
/** The standard list filter. */
|
|
4203
|
-
filter?: string;
|
|
4204
4737
|
/** 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. */
|
|
4205
4738
|
key?: string;
|
|
4206
|
-
/** The name of the
|
|
4739
|
+
/** 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}` */
|
|
4207
4740
|
name: string;
|
|
4208
4741
|
/** OAuth 2.0 token for the current user. */
|
|
4209
4742
|
oauth_token?: string;
|
|
4210
|
-
/** The standard list page size. */
|
|
4211
|
-
pageSize?: number;
|
|
4212
|
-
/** The standard list page token. */
|
|
4213
|
-
pageToken?: string;
|
|
4214
4743
|
/** Returns response with indentations and line breaks. */
|
|
4215
4744
|
prettyPrint?: boolean;
|
|
4216
4745
|
/** 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. */
|
|
@@ -4219,11 +4748,9 @@ declare namespace gapi.client {
|
|
|
4219
4748
|
upload_protocol?: string;
|
|
4220
4749
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4221
4750
|
uploadType?: string;
|
|
4222
|
-
}): Request<
|
|
4223
|
-
|
|
4224
|
-
|
|
4225
|
-
/** Creates TargetSite in a batch. */
|
|
4226
|
-
batchCreate(request: {
|
|
4751
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaSession>;
|
|
4752
|
+
/** Lists all Sessions by their parent DataStore. */
|
|
4753
|
+
list(request?: {
|
|
4227
4754
|
/** V1 error format. */
|
|
4228
4755
|
'$.xgafv'?: string;
|
|
4229
4756
|
/** OAuth access token. */
|
|
@@ -4234,11 +4761,19 @@ declare namespace gapi.client {
|
|
|
4234
4761
|
callback?: string;
|
|
4235
4762
|
/** Selector specifying which fields to include in a partial response. */
|
|
4236
4763
|
fields?: string;
|
|
4764
|
+
/** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
|
|
4765
|
+
filter?: string;
|
|
4237
4766
|
/** 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. */
|
|
4238
4767
|
key?: string;
|
|
4239
4768
|
/** OAuth 2.0 token for the current user. */
|
|
4240
4769
|
oauth_token?: string;
|
|
4241
|
-
/**
|
|
4770
|
+
/** 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" */
|
|
4771
|
+
orderBy?: string;
|
|
4772
|
+
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
4773
|
+
pageSize?: number;
|
|
4774
|
+
/** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
|
|
4775
|
+
pageToken?: string;
|
|
4776
|
+
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
4242
4777
|
parent: string;
|
|
4243
4778
|
/** Returns response with indentations and line breaks. */
|
|
4244
4779
|
prettyPrint?: boolean;
|
|
@@ -4248,16 +4783,232 @@ declare namespace gapi.client {
|
|
|
4248
4783
|
upload_protocol?: string;
|
|
4249
4784
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4250
4785
|
uploadType?: string;
|
|
4251
|
-
|
|
4252
|
-
|
|
4253
|
-
|
|
4254
|
-
|
|
4255
|
-
|
|
4256
|
-
|
|
4257
|
-
|
|
4258
|
-
|
|
4259
|
-
|
|
4260
|
-
|
|
4786
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaListSessionsResponse>;
|
|
4787
|
+
/** Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. */
|
|
4788
|
+
patch(request: {
|
|
4789
|
+
/** V1 error format. */
|
|
4790
|
+
'$.xgafv'?: string;
|
|
4791
|
+
/** OAuth access token. */
|
|
4792
|
+
access_token?: string;
|
|
4793
|
+
/** Data format for response. */
|
|
4794
|
+
alt?: string;
|
|
4795
|
+
/** JSONP */
|
|
4796
|
+
callback?: string;
|
|
4797
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4798
|
+
fields?: string;
|
|
4799
|
+
/** 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. */
|
|
4800
|
+
key?: string;
|
|
4801
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
4802
|
+
name: string;
|
|
4803
|
+
/** OAuth 2.0 token for the current user. */
|
|
4804
|
+
oauth_token?: string;
|
|
4805
|
+
/** Returns response with indentations and line breaks. */
|
|
4806
|
+
prettyPrint?: boolean;
|
|
4807
|
+
/** 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. */
|
|
4808
|
+
quotaUser?: string;
|
|
4809
|
+
/** 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. */
|
|
4810
|
+
updateMask?: string;
|
|
4811
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4812
|
+
upload_protocol?: string;
|
|
4813
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4814
|
+
uploadType?: string;
|
|
4815
|
+
/** Request body */
|
|
4816
|
+
resource: GoogleCloudDiscoveryengineV1alphaSession;
|
|
4817
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaSession>;
|
|
4818
|
+
patch(
|
|
4819
|
+
request: {
|
|
4820
|
+
/** V1 error format. */
|
|
4821
|
+
'$.xgafv'?: string;
|
|
4822
|
+
/** OAuth access token. */
|
|
4823
|
+
access_token?: string;
|
|
4824
|
+
/** Data format for response. */
|
|
4825
|
+
alt?: string;
|
|
4826
|
+
/** JSONP */
|
|
4827
|
+
callback?: string;
|
|
4828
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4829
|
+
fields?: string;
|
|
4830
|
+
/** 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. */
|
|
4831
|
+
key?: string;
|
|
4832
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
4833
|
+
name: string;
|
|
4834
|
+
/** OAuth 2.0 token for the current user. */
|
|
4835
|
+
oauth_token?: string;
|
|
4836
|
+
/** Returns response with indentations and line breaks. */
|
|
4837
|
+
prettyPrint?: boolean;
|
|
4838
|
+
/** 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. */
|
|
4839
|
+
quotaUser?: string;
|
|
4840
|
+
/** 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. */
|
|
4841
|
+
updateMask?: string;
|
|
4842
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4843
|
+
upload_protocol?: string;
|
|
4844
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4845
|
+
uploadType?: string;
|
|
4846
|
+
},
|
|
4847
|
+
body: GoogleCloudDiscoveryengineV1alphaSession
|
|
4848
|
+
): Request<GoogleCloudDiscoveryengineV1alphaSession>;
|
|
4849
|
+
answers: AnswersResource;
|
|
4850
|
+
}
|
|
4851
|
+
interface OperationsResource {
|
|
4852
|
+
/** 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. */
|
|
4853
|
+
get(request?: {
|
|
4854
|
+
/** V1 error format. */
|
|
4855
|
+
'$.xgafv'?: string;
|
|
4856
|
+
/** OAuth access token. */
|
|
4857
|
+
access_token?: string;
|
|
4858
|
+
/** Data format for response. */
|
|
4859
|
+
alt?: string;
|
|
4860
|
+
/** JSONP */
|
|
4861
|
+
callback?: string;
|
|
4862
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4863
|
+
fields?: string;
|
|
4864
|
+
/** 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. */
|
|
4865
|
+
key?: string;
|
|
4866
|
+
/** The name of the operation resource. */
|
|
4867
|
+
name: string;
|
|
4868
|
+
/** OAuth 2.0 token for the current user. */
|
|
4869
|
+
oauth_token?: string;
|
|
4870
|
+
/** Returns response with indentations and line breaks. */
|
|
4871
|
+
prettyPrint?: boolean;
|
|
4872
|
+
/** 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. */
|
|
4873
|
+
quotaUser?: string;
|
|
4874
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4875
|
+
upload_protocol?: string;
|
|
4876
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4877
|
+
uploadType?: string;
|
|
4878
|
+
}): Request<GoogleLongrunningOperation>;
|
|
4879
|
+
/** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
|
|
4880
|
+
list(request?: {
|
|
4881
|
+
/** V1 error format. */
|
|
4882
|
+
'$.xgafv'?: string;
|
|
4883
|
+
/** OAuth access token. */
|
|
4884
|
+
access_token?: string;
|
|
4885
|
+
/** Data format for response. */
|
|
4886
|
+
alt?: string;
|
|
4887
|
+
/** JSONP */
|
|
4888
|
+
callback?: string;
|
|
4889
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4890
|
+
fields?: string;
|
|
4891
|
+
/** The standard list filter. */
|
|
4892
|
+
filter?: string;
|
|
4893
|
+
/** 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. */
|
|
4894
|
+
key?: string;
|
|
4895
|
+
/** The name of the operation's parent resource. */
|
|
4896
|
+
name: string;
|
|
4897
|
+
/** OAuth 2.0 token for the current user. */
|
|
4898
|
+
oauth_token?: string;
|
|
4899
|
+
/** The standard list page size. */
|
|
4900
|
+
pageSize?: number;
|
|
4901
|
+
/** The standard list page token. */
|
|
4902
|
+
pageToken?: string;
|
|
4903
|
+
/** Returns response with indentations and line breaks. */
|
|
4904
|
+
prettyPrint?: boolean;
|
|
4905
|
+
/** 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. */
|
|
4906
|
+
quotaUser?: string;
|
|
4907
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4908
|
+
upload_protocol?: string;
|
|
4909
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4910
|
+
uploadType?: string;
|
|
4911
|
+
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
4912
|
+
}
|
|
4913
|
+
interface OperationsResource {
|
|
4914
|
+
/** 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. */
|
|
4915
|
+
get(request?: {
|
|
4916
|
+
/** V1 error format. */
|
|
4917
|
+
'$.xgafv'?: string;
|
|
4918
|
+
/** OAuth access token. */
|
|
4919
|
+
access_token?: string;
|
|
4920
|
+
/** Data format for response. */
|
|
4921
|
+
alt?: string;
|
|
4922
|
+
/** JSONP */
|
|
4923
|
+
callback?: string;
|
|
4924
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4925
|
+
fields?: string;
|
|
4926
|
+
/** 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. */
|
|
4927
|
+
key?: string;
|
|
4928
|
+
/** The name of the operation resource. */
|
|
4929
|
+
name: string;
|
|
4930
|
+
/** OAuth 2.0 token for the current user. */
|
|
4931
|
+
oauth_token?: string;
|
|
4932
|
+
/** Returns response with indentations and line breaks. */
|
|
4933
|
+
prettyPrint?: boolean;
|
|
4934
|
+
/** 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. */
|
|
4935
|
+
quotaUser?: string;
|
|
4936
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4937
|
+
upload_protocol?: string;
|
|
4938
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4939
|
+
uploadType?: string;
|
|
4940
|
+
}): Request<GoogleLongrunningOperation>;
|
|
4941
|
+
/** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
|
|
4942
|
+
list(request?: {
|
|
4943
|
+
/** V1 error format. */
|
|
4944
|
+
'$.xgafv'?: string;
|
|
4945
|
+
/** OAuth access token. */
|
|
4946
|
+
access_token?: string;
|
|
4947
|
+
/** Data format for response. */
|
|
4948
|
+
alt?: string;
|
|
4949
|
+
/** JSONP */
|
|
4950
|
+
callback?: string;
|
|
4951
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4952
|
+
fields?: string;
|
|
4953
|
+
/** The standard list filter. */
|
|
4954
|
+
filter?: string;
|
|
4955
|
+
/** 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. */
|
|
4956
|
+
key?: string;
|
|
4957
|
+
/** The name of the operation's parent resource. */
|
|
4958
|
+
name: string;
|
|
4959
|
+
/** OAuth 2.0 token for the current user. */
|
|
4960
|
+
oauth_token?: string;
|
|
4961
|
+
/** The standard list page size. */
|
|
4962
|
+
pageSize?: number;
|
|
4963
|
+
/** The standard list page token. */
|
|
4964
|
+
pageToken?: string;
|
|
4965
|
+
/** Returns response with indentations and line breaks. */
|
|
4966
|
+
prettyPrint?: boolean;
|
|
4967
|
+
/** 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. */
|
|
4968
|
+
quotaUser?: string;
|
|
4969
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4970
|
+
upload_protocol?: string;
|
|
4971
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4972
|
+
uploadType?: string;
|
|
4973
|
+
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
4974
|
+
}
|
|
4975
|
+
interface TargetSitesResource {
|
|
4976
|
+
/** Creates TargetSite in a batch. */
|
|
4977
|
+
batchCreate(request: {
|
|
4978
|
+
/** V1 error format. */
|
|
4979
|
+
'$.xgafv'?: string;
|
|
4980
|
+
/** OAuth access token. */
|
|
4981
|
+
access_token?: string;
|
|
4982
|
+
/** Data format for response. */
|
|
4983
|
+
alt?: string;
|
|
4984
|
+
/** JSONP */
|
|
4985
|
+
callback?: string;
|
|
4986
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4987
|
+
fields?: string;
|
|
4988
|
+
/** 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. */
|
|
4989
|
+
key?: string;
|
|
4990
|
+
/** OAuth 2.0 token for the current user. */
|
|
4991
|
+
oauth_token?: string;
|
|
4992
|
+
/** Required. The parent resource shared by all TargetSites being created. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. */
|
|
4993
|
+
parent: string;
|
|
4994
|
+
/** Returns response with indentations and line breaks. */
|
|
4995
|
+
prettyPrint?: boolean;
|
|
4996
|
+
/** 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. */
|
|
4997
|
+
quotaUser?: string;
|
|
4998
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4999
|
+
upload_protocol?: string;
|
|
5000
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5001
|
+
uploadType?: string;
|
|
5002
|
+
/** Request body */
|
|
5003
|
+
resource: GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest;
|
|
5004
|
+
}): Request<GoogleLongrunningOperation>;
|
|
5005
|
+
batchCreate(
|
|
5006
|
+
request: {
|
|
5007
|
+
/** V1 error format. */
|
|
5008
|
+
'$.xgafv'?: string;
|
|
5009
|
+
/** OAuth access token. */
|
|
5010
|
+
access_token?: string;
|
|
5011
|
+
/** Data format for response. */
|
|
4261
5012
|
alt?: string;
|
|
4262
5013
|
/** JSONP */
|
|
4263
5014
|
callback?: string;
|
|
@@ -5508,6 +6259,7 @@ declare namespace gapi.client {
|
|
|
5508
6259
|
operations: OperationsResource;
|
|
5509
6260
|
schemas: SchemasResource;
|
|
5510
6261
|
servingConfigs: ServingConfigsResource;
|
|
6262
|
+
sessions: SessionsResource;
|
|
5511
6263
|
siteSearchEngine: SiteSearchEngineResource;
|
|
5512
6264
|
suggestionDenyListEntries: SuggestionDenyListEntriesResource;
|
|
5513
6265
|
userEvents: UserEventsResource;
|
|
@@ -5844,8 +6596,8 @@ declare namespace gapi.client {
|
|
|
5844
6596
|
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
5845
6597
|
}
|
|
5846
6598
|
interface ServingConfigsResource {
|
|
5847
|
-
/**
|
|
5848
|
-
|
|
6599
|
+
/** Answer query method. */
|
|
6600
|
+
answer(request: {
|
|
5849
6601
|
/** V1 error format. */
|
|
5850
6602
|
'$.xgafv'?: string;
|
|
5851
6603
|
/** OAuth access token. */
|
|
@@ -5858,21 +6610,52 @@ declare namespace gapi.client {
|
|
|
5858
6610
|
fields?: string;
|
|
5859
6611
|
/** 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. */
|
|
5860
6612
|
key?: string;
|
|
5861
|
-
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
5862
|
-
name: string;
|
|
5863
6613
|
/** OAuth 2.0 token for the current user. */
|
|
5864
6614
|
oauth_token?: string;
|
|
5865
6615
|
/** Returns response with indentations and line breaks. */
|
|
5866
6616
|
prettyPrint?: boolean;
|
|
5867
6617
|
/** 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. */
|
|
5868
6618
|
quotaUser?: string;
|
|
6619
|
+
/** 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. */
|
|
6620
|
+
servingConfig: string;
|
|
5869
6621
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5870
6622
|
upload_protocol?: string;
|
|
5871
6623
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5872
6624
|
uploadType?: string;
|
|
5873
|
-
|
|
5874
|
-
|
|
5875
|
-
|
|
6625
|
+
/** Request body */
|
|
6626
|
+
resource: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
|
|
6627
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>;
|
|
6628
|
+
answer(
|
|
6629
|
+
request: {
|
|
6630
|
+
/** V1 error format. */
|
|
6631
|
+
'$.xgafv'?: string;
|
|
6632
|
+
/** OAuth access token. */
|
|
6633
|
+
access_token?: string;
|
|
6634
|
+
/** Data format for response. */
|
|
6635
|
+
alt?: string;
|
|
6636
|
+
/** JSONP */
|
|
6637
|
+
callback?: string;
|
|
6638
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6639
|
+
fields?: string;
|
|
6640
|
+
/** 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. */
|
|
6641
|
+
key?: string;
|
|
6642
|
+
/** OAuth 2.0 token for the current user. */
|
|
6643
|
+
oauth_token?: string;
|
|
6644
|
+
/** Returns response with indentations and line breaks. */
|
|
6645
|
+
prettyPrint?: boolean;
|
|
6646
|
+
/** 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. */
|
|
6647
|
+
quotaUser?: string;
|
|
6648
|
+
/** 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. */
|
|
6649
|
+
servingConfig: string;
|
|
6650
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6651
|
+
upload_protocol?: string;
|
|
6652
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6653
|
+
uploadType?: string;
|
|
6654
|
+
},
|
|
6655
|
+
body: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest
|
|
6656
|
+
): Request<GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>;
|
|
6657
|
+
/** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
|
|
6658
|
+
get(request?: {
|
|
5876
6659
|
/** V1 error format. */
|
|
5877
6660
|
'$.xgafv'?: string;
|
|
5878
6661
|
/** OAuth access token. */
|
|
@@ -5885,11 +6668,38 @@ declare namespace gapi.client {
|
|
|
5885
6668
|
fields?: string;
|
|
5886
6669
|
/** 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. */
|
|
5887
6670
|
key?: string;
|
|
6671
|
+
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
6672
|
+
name: string;
|
|
5888
6673
|
/** OAuth 2.0 token for the current user. */
|
|
5889
6674
|
oauth_token?: string;
|
|
5890
|
-
/**
|
|
5891
|
-
|
|
5892
|
-
/**
|
|
6675
|
+
/** Returns response with indentations and line breaks. */
|
|
6676
|
+
prettyPrint?: boolean;
|
|
6677
|
+
/** 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. */
|
|
6678
|
+
quotaUser?: string;
|
|
6679
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6680
|
+
upload_protocol?: string;
|
|
6681
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6682
|
+
uploadType?: string;
|
|
6683
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaServingConfig>;
|
|
6684
|
+
/** Lists all ServingConfigs linked to this dataStore. */
|
|
6685
|
+
list(request?: {
|
|
6686
|
+
/** V1 error format. */
|
|
6687
|
+
'$.xgafv'?: string;
|
|
6688
|
+
/** OAuth access token. */
|
|
6689
|
+
access_token?: string;
|
|
6690
|
+
/** Data format for response. */
|
|
6691
|
+
alt?: string;
|
|
6692
|
+
/** JSONP */
|
|
6693
|
+
callback?: string;
|
|
6694
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6695
|
+
fields?: string;
|
|
6696
|
+
/** 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. */
|
|
6697
|
+
key?: string;
|
|
6698
|
+
/** OAuth 2.0 token for the current user. */
|
|
6699
|
+
oauth_token?: string;
|
|
6700
|
+
/** 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. */
|
|
6701
|
+
pageSize?: number;
|
|
6702
|
+
/** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
|
|
5893
6703
|
pageToken?: string;
|
|
5894
6704
|
/** Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
5895
6705
|
parent: string;
|
|
@@ -6081,6 +6891,247 @@ declare namespace gapi.client {
|
|
|
6081
6891
|
body: GoogleCloudDiscoveryengineV1alphaSearchRequest
|
|
6082
6892
|
): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
|
|
6083
6893
|
}
|
|
6894
|
+
interface AnswersResource {
|
|
6895
|
+
/** Gets a Answer. */
|
|
6896
|
+
get(request?: {
|
|
6897
|
+
/** V1 error format. */
|
|
6898
|
+
'$.xgafv'?: string;
|
|
6899
|
+
/** OAuth access token. */
|
|
6900
|
+
access_token?: string;
|
|
6901
|
+
/** Data format for response. */
|
|
6902
|
+
alt?: string;
|
|
6903
|
+
/** JSONP */
|
|
6904
|
+
callback?: string;
|
|
6905
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6906
|
+
fields?: string;
|
|
6907
|
+
/** 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. */
|
|
6908
|
+
key?: string;
|
|
6909
|
+
/** 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}` */
|
|
6910
|
+
name: string;
|
|
6911
|
+
/** OAuth 2.0 token for the current user. */
|
|
6912
|
+
oauth_token?: string;
|
|
6913
|
+
/** Returns response with indentations and line breaks. */
|
|
6914
|
+
prettyPrint?: boolean;
|
|
6915
|
+
/** 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. */
|
|
6916
|
+
quotaUser?: string;
|
|
6917
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6918
|
+
upload_protocol?: string;
|
|
6919
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6920
|
+
uploadType?: string;
|
|
6921
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaAnswer>;
|
|
6922
|
+
}
|
|
6923
|
+
interface SessionsResource {
|
|
6924
|
+
/** Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. */
|
|
6925
|
+
create(request: {
|
|
6926
|
+
/** V1 error format. */
|
|
6927
|
+
'$.xgafv'?: string;
|
|
6928
|
+
/** OAuth access token. */
|
|
6929
|
+
access_token?: string;
|
|
6930
|
+
/** Data format for response. */
|
|
6931
|
+
alt?: string;
|
|
6932
|
+
/** JSONP */
|
|
6933
|
+
callback?: string;
|
|
6934
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6935
|
+
fields?: string;
|
|
6936
|
+
/** 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. */
|
|
6937
|
+
key?: string;
|
|
6938
|
+
/** OAuth 2.0 token for the current user. */
|
|
6939
|
+
oauth_token?: string;
|
|
6940
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
6941
|
+
parent: string;
|
|
6942
|
+
/** Returns response with indentations and line breaks. */
|
|
6943
|
+
prettyPrint?: boolean;
|
|
6944
|
+
/** 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. */
|
|
6945
|
+
quotaUser?: string;
|
|
6946
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6947
|
+
upload_protocol?: string;
|
|
6948
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6949
|
+
uploadType?: string;
|
|
6950
|
+
/** Request body */
|
|
6951
|
+
resource: GoogleCloudDiscoveryengineV1alphaSession;
|
|
6952
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaSession>;
|
|
6953
|
+
create(
|
|
6954
|
+
request: {
|
|
6955
|
+
/** V1 error format. */
|
|
6956
|
+
'$.xgafv'?: string;
|
|
6957
|
+
/** OAuth access token. */
|
|
6958
|
+
access_token?: string;
|
|
6959
|
+
/** Data format for response. */
|
|
6960
|
+
alt?: string;
|
|
6961
|
+
/** JSONP */
|
|
6962
|
+
callback?: string;
|
|
6963
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6964
|
+
fields?: string;
|
|
6965
|
+
/** 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. */
|
|
6966
|
+
key?: string;
|
|
6967
|
+
/** OAuth 2.0 token for the current user. */
|
|
6968
|
+
oauth_token?: string;
|
|
6969
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
6970
|
+
parent: string;
|
|
6971
|
+
/** Returns response with indentations and line breaks. */
|
|
6972
|
+
prettyPrint?: boolean;
|
|
6973
|
+
/** 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. */
|
|
6974
|
+
quotaUser?: string;
|
|
6975
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6976
|
+
upload_protocol?: string;
|
|
6977
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6978
|
+
uploadType?: string;
|
|
6979
|
+
},
|
|
6980
|
+
body: GoogleCloudDiscoveryengineV1alphaSession
|
|
6981
|
+
): Request<GoogleCloudDiscoveryengineV1alphaSession>;
|
|
6982
|
+
/** Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. */
|
|
6983
|
+
delete(request?: {
|
|
6984
|
+
/** V1 error format. */
|
|
6985
|
+
'$.xgafv'?: string;
|
|
6986
|
+
/** OAuth access token. */
|
|
6987
|
+
access_token?: string;
|
|
6988
|
+
/** Data format for response. */
|
|
6989
|
+
alt?: string;
|
|
6990
|
+
/** JSONP */
|
|
6991
|
+
callback?: string;
|
|
6992
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6993
|
+
fields?: string;
|
|
6994
|
+
/** 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. */
|
|
6995
|
+
key?: string;
|
|
6996
|
+
/** 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}` */
|
|
6997
|
+
name: string;
|
|
6998
|
+
/** OAuth 2.0 token for the current user. */
|
|
6999
|
+
oauth_token?: string;
|
|
7000
|
+
/** Returns response with indentations and line breaks. */
|
|
7001
|
+
prettyPrint?: boolean;
|
|
7002
|
+
/** 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. */
|
|
7003
|
+
quotaUser?: string;
|
|
7004
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7005
|
+
upload_protocol?: string;
|
|
7006
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7007
|
+
uploadType?: string;
|
|
7008
|
+
}): Request<{}>;
|
|
7009
|
+
/** Gets a Session. */
|
|
7010
|
+
get(request?: {
|
|
7011
|
+
/** V1 error format. */
|
|
7012
|
+
'$.xgafv'?: string;
|
|
7013
|
+
/** OAuth access token. */
|
|
7014
|
+
access_token?: string;
|
|
7015
|
+
/** Data format for response. */
|
|
7016
|
+
alt?: string;
|
|
7017
|
+
/** JSONP */
|
|
7018
|
+
callback?: string;
|
|
7019
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
7020
|
+
fields?: string;
|
|
7021
|
+
/** 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. */
|
|
7022
|
+
key?: string;
|
|
7023
|
+
/** 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}` */
|
|
7024
|
+
name: string;
|
|
7025
|
+
/** OAuth 2.0 token for the current user. */
|
|
7026
|
+
oauth_token?: string;
|
|
7027
|
+
/** Returns response with indentations and line breaks. */
|
|
7028
|
+
prettyPrint?: boolean;
|
|
7029
|
+
/** 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. */
|
|
7030
|
+
quotaUser?: string;
|
|
7031
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7032
|
+
upload_protocol?: string;
|
|
7033
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7034
|
+
uploadType?: string;
|
|
7035
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaSession>;
|
|
7036
|
+
/** Lists all Sessions by their parent DataStore. */
|
|
7037
|
+
list(request?: {
|
|
7038
|
+
/** V1 error format. */
|
|
7039
|
+
'$.xgafv'?: string;
|
|
7040
|
+
/** OAuth access token. */
|
|
7041
|
+
access_token?: string;
|
|
7042
|
+
/** Data format for response. */
|
|
7043
|
+
alt?: string;
|
|
7044
|
+
/** JSONP */
|
|
7045
|
+
callback?: string;
|
|
7046
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
7047
|
+
fields?: string;
|
|
7048
|
+
/** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
|
|
7049
|
+
filter?: string;
|
|
7050
|
+
/** 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. */
|
|
7051
|
+
key?: string;
|
|
7052
|
+
/** OAuth 2.0 token for the current user. */
|
|
7053
|
+
oauth_token?: string;
|
|
7054
|
+
/** 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" */
|
|
7055
|
+
orderBy?: string;
|
|
7056
|
+
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
7057
|
+
pageSize?: number;
|
|
7058
|
+
/** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
|
|
7059
|
+
pageToken?: string;
|
|
7060
|
+
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
7061
|
+
parent: string;
|
|
7062
|
+
/** Returns response with indentations and line breaks. */
|
|
7063
|
+
prettyPrint?: boolean;
|
|
7064
|
+
/** 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. */
|
|
7065
|
+
quotaUser?: string;
|
|
7066
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7067
|
+
upload_protocol?: string;
|
|
7068
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7069
|
+
uploadType?: string;
|
|
7070
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaListSessionsResponse>;
|
|
7071
|
+
/** Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. */
|
|
7072
|
+
patch(request: {
|
|
7073
|
+
/** V1 error format. */
|
|
7074
|
+
'$.xgafv'?: string;
|
|
7075
|
+
/** OAuth access token. */
|
|
7076
|
+
access_token?: string;
|
|
7077
|
+
/** Data format for response. */
|
|
7078
|
+
alt?: string;
|
|
7079
|
+
/** JSONP */
|
|
7080
|
+
callback?: string;
|
|
7081
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
7082
|
+
fields?: string;
|
|
7083
|
+
/** 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. */
|
|
7084
|
+
key?: string;
|
|
7085
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
7086
|
+
name: string;
|
|
7087
|
+
/** OAuth 2.0 token for the current user. */
|
|
7088
|
+
oauth_token?: string;
|
|
7089
|
+
/** Returns response with indentations and line breaks. */
|
|
7090
|
+
prettyPrint?: boolean;
|
|
7091
|
+
/** 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. */
|
|
7092
|
+
quotaUser?: string;
|
|
7093
|
+
/** 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. */
|
|
7094
|
+
updateMask?: string;
|
|
7095
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7096
|
+
upload_protocol?: string;
|
|
7097
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7098
|
+
uploadType?: string;
|
|
7099
|
+
/** Request body */
|
|
7100
|
+
resource: GoogleCloudDiscoveryengineV1alphaSession;
|
|
7101
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaSession>;
|
|
7102
|
+
patch(
|
|
7103
|
+
request: {
|
|
7104
|
+
/** V1 error format. */
|
|
7105
|
+
'$.xgafv'?: string;
|
|
7106
|
+
/** OAuth access token. */
|
|
7107
|
+
access_token?: string;
|
|
7108
|
+
/** Data format for response. */
|
|
7109
|
+
alt?: string;
|
|
7110
|
+
/** JSONP */
|
|
7111
|
+
callback?: string;
|
|
7112
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
7113
|
+
fields?: string;
|
|
7114
|
+
/** 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. */
|
|
7115
|
+
key?: string;
|
|
7116
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
7117
|
+
name: string;
|
|
7118
|
+
/** OAuth 2.0 token for the current user. */
|
|
7119
|
+
oauth_token?: string;
|
|
7120
|
+
/** Returns response with indentations and line breaks. */
|
|
7121
|
+
prettyPrint?: boolean;
|
|
7122
|
+
/** 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. */
|
|
7123
|
+
quotaUser?: string;
|
|
7124
|
+
/** 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. */
|
|
7125
|
+
updateMask?: string;
|
|
7126
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7127
|
+
upload_protocol?: string;
|
|
7128
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7129
|
+
uploadType?: string;
|
|
7130
|
+
},
|
|
7131
|
+
body: GoogleCloudDiscoveryengineV1alphaSession
|
|
7132
|
+
): Request<GoogleCloudDiscoveryengineV1alphaSession>;
|
|
7133
|
+
answers: AnswersResource;
|
|
7134
|
+
}
|
|
6084
7135
|
interface EnginesResource {
|
|
6085
7136
|
/** Creates a Engine. */
|
|
6086
7137
|
create(request: {
|
|
@@ -6470,6 +7521,7 @@ declare namespace gapi.client {
|
|
|
6470
7521
|
conversations: ConversationsResource;
|
|
6471
7522
|
operations: OperationsResource;
|
|
6472
7523
|
servingConfigs: ServingConfigsResource;
|
|
7524
|
+
sessions: SessionsResource;
|
|
6473
7525
|
}
|
|
6474
7526
|
interface OperationsResource {
|
|
6475
7527
|
/** 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. */
|
|
@@ -7636,8 +8688,8 @@ declare namespace gapi.client {
|
|
|
7636
8688
|
): Request<GoogleLongrunningOperation>;
|
|
7637
8689
|
}
|
|
7638
8690
|
interface ServingConfigsResource {
|
|
7639
|
-
/**
|
|
7640
|
-
|
|
8691
|
+
/** Answer query method. */
|
|
8692
|
+
answer(request: {
|
|
7641
8693
|
/** V1 error format. */
|
|
7642
8694
|
'$.xgafv'?: string;
|
|
7643
8695
|
/** OAuth access token. */
|
|
@@ -7650,29 +8702,87 @@ declare namespace gapi.client {
|
|
|
7650
8702
|
fields?: string;
|
|
7651
8703
|
/** 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. */
|
|
7652
8704
|
key?: string;
|
|
7653
|
-
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
7654
|
-
name: string;
|
|
7655
8705
|
/** OAuth 2.0 token for the current user. */
|
|
7656
8706
|
oauth_token?: string;
|
|
7657
8707
|
/** Returns response with indentations and line breaks. */
|
|
7658
8708
|
prettyPrint?: boolean;
|
|
7659
8709
|
/** 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. */
|
|
7660
8710
|
quotaUser?: string;
|
|
8711
|
+
/** 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. */
|
|
8712
|
+
servingConfig: string;
|
|
7661
8713
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7662
8714
|
upload_protocol?: string;
|
|
7663
8715
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7664
8716
|
uploadType?: string;
|
|
7665
|
-
|
|
7666
|
-
|
|
7667
|
-
|
|
7668
|
-
|
|
7669
|
-
|
|
7670
|
-
|
|
7671
|
-
|
|
7672
|
-
|
|
7673
|
-
|
|
7674
|
-
|
|
7675
|
-
|
|
8717
|
+
/** Request body */
|
|
8718
|
+
resource: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
|
|
8719
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>;
|
|
8720
|
+
answer(
|
|
8721
|
+
request: {
|
|
8722
|
+
/** V1 error format. */
|
|
8723
|
+
'$.xgafv'?: string;
|
|
8724
|
+
/** OAuth access token. */
|
|
8725
|
+
access_token?: string;
|
|
8726
|
+
/** Data format for response. */
|
|
8727
|
+
alt?: string;
|
|
8728
|
+
/** JSONP */
|
|
8729
|
+
callback?: string;
|
|
8730
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8731
|
+
fields?: string;
|
|
8732
|
+
/** 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. */
|
|
8733
|
+
key?: string;
|
|
8734
|
+
/** OAuth 2.0 token for the current user. */
|
|
8735
|
+
oauth_token?: string;
|
|
8736
|
+
/** Returns response with indentations and line breaks. */
|
|
8737
|
+
prettyPrint?: boolean;
|
|
8738
|
+
/** 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. */
|
|
8739
|
+
quotaUser?: string;
|
|
8740
|
+
/** 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. */
|
|
8741
|
+
servingConfig: string;
|
|
8742
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8743
|
+
upload_protocol?: string;
|
|
8744
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8745
|
+
uploadType?: string;
|
|
8746
|
+
},
|
|
8747
|
+
body: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest
|
|
8748
|
+
): Request<GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>;
|
|
8749
|
+
/** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
|
|
8750
|
+
get(request?: {
|
|
8751
|
+
/** V1 error format. */
|
|
8752
|
+
'$.xgafv'?: string;
|
|
8753
|
+
/** OAuth access token. */
|
|
8754
|
+
access_token?: string;
|
|
8755
|
+
/** Data format for response. */
|
|
8756
|
+
alt?: string;
|
|
8757
|
+
/** JSONP */
|
|
8758
|
+
callback?: string;
|
|
8759
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8760
|
+
fields?: string;
|
|
8761
|
+
/** 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. */
|
|
8762
|
+
key?: string;
|
|
8763
|
+
/** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
|
|
8764
|
+
name: string;
|
|
8765
|
+
/** OAuth 2.0 token for the current user. */
|
|
8766
|
+
oauth_token?: string;
|
|
8767
|
+
/** Returns response with indentations and line breaks. */
|
|
8768
|
+
prettyPrint?: boolean;
|
|
8769
|
+
/** 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. */
|
|
8770
|
+
quotaUser?: string;
|
|
8771
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8772
|
+
upload_protocol?: string;
|
|
8773
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8774
|
+
uploadType?: string;
|
|
8775
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaServingConfig>;
|
|
8776
|
+
/** Lists all ServingConfigs linked to this dataStore. */
|
|
8777
|
+
list(request?: {
|
|
8778
|
+
/** V1 error format. */
|
|
8779
|
+
'$.xgafv'?: string;
|
|
8780
|
+
/** OAuth access token. */
|
|
8781
|
+
access_token?: string;
|
|
8782
|
+
/** Data format for response. */
|
|
8783
|
+
alt?: string;
|
|
8784
|
+
/** JSONP */
|
|
8785
|
+
callback?: string;
|
|
7676
8786
|
/** Selector specifying which fields to include in a partial response. */
|
|
7677
8787
|
fields?: string;
|
|
7678
8788
|
/** 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. */
|
|
@@ -7873,6 +8983,247 @@ declare namespace gapi.client {
|
|
|
7873
8983
|
body: GoogleCloudDiscoveryengineV1alphaSearchRequest
|
|
7874
8984
|
): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
|
|
7875
8985
|
}
|
|
8986
|
+
interface AnswersResource {
|
|
8987
|
+
/** Gets a Answer. */
|
|
8988
|
+
get(request?: {
|
|
8989
|
+
/** V1 error format. */
|
|
8990
|
+
'$.xgafv'?: string;
|
|
8991
|
+
/** OAuth access token. */
|
|
8992
|
+
access_token?: string;
|
|
8993
|
+
/** Data format for response. */
|
|
8994
|
+
alt?: string;
|
|
8995
|
+
/** JSONP */
|
|
8996
|
+
callback?: string;
|
|
8997
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8998
|
+
fields?: string;
|
|
8999
|
+
/** 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. */
|
|
9000
|
+
key?: string;
|
|
9001
|
+
/** 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}` */
|
|
9002
|
+
name: string;
|
|
9003
|
+
/** OAuth 2.0 token for the current user. */
|
|
9004
|
+
oauth_token?: string;
|
|
9005
|
+
/** Returns response with indentations and line breaks. */
|
|
9006
|
+
prettyPrint?: boolean;
|
|
9007
|
+
/** 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. */
|
|
9008
|
+
quotaUser?: string;
|
|
9009
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9010
|
+
upload_protocol?: string;
|
|
9011
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9012
|
+
uploadType?: string;
|
|
9013
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaAnswer>;
|
|
9014
|
+
}
|
|
9015
|
+
interface SessionsResource {
|
|
9016
|
+
/** Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. */
|
|
9017
|
+
create(request: {
|
|
9018
|
+
/** V1 error format. */
|
|
9019
|
+
'$.xgafv'?: string;
|
|
9020
|
+
/** OAuth access token. */
|
|
9021
|
+
access_token?: string;
|
|
9022
|
+
/** Data format for response. */
|
|
9023
|
+
alt?: string;
|
|
9024
|
+
/** JSONP */
|
|
9025
|
+
callback?: string;
|
|
9026
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9027
|
+
fields?: string;
|
|
9028
|
+
/** 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. */
|
|
9029
|
+
key?: string;
|
|
9030
|
+
/** OAuth 2.0 token for the current user. */
|
|
9031
|
+
oauth_token?: string;
|
|
9032
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
9033
|
+
parent: string;
|
|
9034
|
+
/** Returns response with indentations and line breaks. */
|
|
9035
|
+
prettyPrint?: boolean;
|
|
9036
|
+
/** 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. */
|
|
9037
|
+
quotaUser?: string;
|
|
9038
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9039
|
+
upload_protocol?: string;
|
|
9040
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9041
|
+
uploadType?: string;
|
|
9042
|
+
/** Request body */
|
|
9043
|
+
resource: GoogleCloudDiscoveryengineV1alphaSession;
|
|
9044
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaSession>;
|
|
9045
|
+
create(
|
|
9046
|
+
request: {
|
|
9047
|
+
/** V1 error format. */
|
|
9048
|
+
'$.xgafv'?: string;
|
|
9049
|
+
/** OAuth access token. */
|
|
9050
|
+
access_token?: string;
|
|
9051
|
+
/** Data format for response. */
|
|
9052
|
+
alt?: string;
|
|
9053
|
+
/** JSONP */
|
|
9054
|
+
callback?: string;
|
|
9055
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9056
|
+
fields?: string;
|
|
9057
|
+
/** 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. */
|
|
9058
|
+
key?: string;
|
|
9059
|
+
/** OAuth 2.0 token for the current user. */
|
|
9060
|
+
oauth_token?: string;
|
|
9061
|
+
/** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
9062
|
+
parent: string;
|
|
9063
|
+
/** Returns response with indentations and line breaks. */
|
|
9064
|
+
prettyPrint?: boolean;
|
|
9065
|
+
/** 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. */
|
|
9066
|
+
quotaUser?: string;
|
|
9067
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9068
|
+
upload_protocol?: string;
|
|
9069
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9070
|
+
uploadType?: string;
|
|
9071
|
+
},
|
|
9072
|
+
body: GoogleCloudDiscoveryengineV1alphaSession
|
|
9073
|
+
): Request<GoogleCloudDiscoveryengineV1alphaSession>;
|
|
9074
|
+
/** Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. */
|
|
9075
|
+
delete(request?: {
|
|
9076
|
+
/** V1 error format. */
|
|
9077
|
+
'$.xgafv'?: string;
|
|
9078
|
+
/** OAuth access token. */
|
|
9079
|
+
access_token?: string;
|
|
9080
|
+
/** Data format for response. */
|
|
9081
|
+
alt?: string;
|
|
9082
|
+
/** JSONP */
|
|
9083
|
+
callback?: string;
|
|
9084
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9085
|
+
fields?: string;
|
|
9086
|
+
/** 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. */
|
|
9087
|
+
key?: string;
|
|
9088
|
+
/** 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}` */
|
|
9089
|
+
name: string;
|
|
9090
|
+
/** OAuth 2.0 token for the current user. */
|
|
9091
|
+
oauth_token?: string;
|
|
9092
|
+
/** Returns response with indentations and line breaks. */
|
|
9093
|
+
prettyPrint?: boolean;
|
|
9094
|
+
/** 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. */
|
|
9095
|
+
quotaUser?: string;
|
|
9096
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9097
|
+
upload_protocol?: string;
|
|
9098
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9099
|
+
uploadType?: string;
|
|
9100
|
+
}): Request<{}>;
|
|
9101
|
+
/** Gets a Session. */
|
|
9102
|
+
get(request?: {
|
|
9103
|
+
/** V1 error format. */
|
|
9104
|
+
'$.xgafv'?: string;
|
|
9105
|
+
/** OAuth access token. */
|
|
9106
|
+
access_token?: string;
|
|
9107
|
+
/** Data format for response. */
|
|
9108
|
+
alt?: string;
|
|
9109
|
+
/** JSONP */
|
|
9110
|
+
callback?: string;
|
|
9111
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9112
|
+
fields?: string;
|
|
9113
|
+
/** 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. */
|
|
9114
|
+
key?: string;
|
|
9115
|
+
/** 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}` */
|
|
9116
|
+
name: string;
|
|
9117
|
+
/** OAuth 2.0 token for the current user. */
|
|
9118
|
+
oauth_token?: string;
|
|
9119
|
+
/** Returns response with indentations and line breaks. */
|
|
9120
|
+
prettyPrint?: boolean;
|
|
9121
|
+
/** 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. */
|
|
9122
|
+
quotaUser?: string;
|
|
9123
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9124
|
+
upload_protocol?: string;
|
|
9125
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9126
|
+
uploadType?: string;
|
|
9127
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaSession>;
|
|
9128
|
+
/** Lists all Sessions by their parent DataStore. */
|
|
9129
|
+
list(request?: {
|
|
9130
|
+
/** V1 error format. */
|
|
9131
|
+
'$.xgafv'?: string;
|
|
9132
|
+
/** OAuth access token. */
|
|
9133
|
+
access_token?: string;
|
|
9134
|
+
/** Data format for response. */
|
|
9135
|
+
alt?: string;
|
|
9136
|
+
/** JSONP */
|
|
9137
|
+
callback?: string;
|
|
9138
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9139
|
+
fields?: string;
|
|
9140
|
+
/** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
|
|
9141
|
+
filter?: string;
|
|
9142
|
+
/** 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. */
|
|
9143
|
+
key?: string;
|
|
9144
|
+
/** OAuth 2.0 token for the current user. */
|
|
9145
|
+
oauth_token?: string;
|
|
9146
|
+
/** 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" */
|
|
9147
|
+
orderBy?: string;
|
|
9148
|
+
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
9149
|
+
pageSize?: number;
|
|
9150
|
+
/** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
|
|
9151
|
+
pageToken?: string;
|
|
9152
|
+
/** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
|
|
9153
|
+
parent: string;
|
|
9154
|
+
/** Returns response with indentations and line breaks. */
|
|
9155
|
+
prettyPrint?: boolean;
|
|
9156
|
+
/** 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. */
|
|
9157
|
+
quotaUser?: string;
|
|
9158
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9159
|
+
upload_protocol?: string;
|
|
9160
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9161
|
+
uploadType?: string;
|
|
9162
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaListSessionsResponse>;
|
|
9163
|
+
/** Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. */
|
|
9164
|
+
patch(request: {
|
|
9165
|
+
/** V1 error format. */
|
|
9166
|
+
'$.xgafv'?: string;
|
|
9167
|
+
/** OAuth access token. */
|
|
9168
|
+
access_token?: string;
|
|
9169
|
+
/** Data format for response. */
|
|
9170
|
+
alt?: string;
|
|
9171
|
+
/** JSONP */
|
|
9172
|
+
callback?: string;
|
|
9173
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9174
|
+
fields?: string;
|
|
9175
|
+
/** 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. */
|
|
9176
|
+
key?: string;
|
|
9177
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
9178
|
+
name: string;
|
|
9179
|
+
/** OAuth 2.0 token for the current user. */
|
|
9180
|
+
oauth_token?: string;
|
|
9181
|
+
/** Returns response with indentations and line breaks. */
|
|
9182
|
+
prettyPrint?: boolean;
|
|
9183
|
+
/** 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. */
|
|
9184
|
+
quotaUser?: string;
|
|
9185
|
+
/** 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. */
|
|
9186
|
+
updateMask?: string;
|
|
9187
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9188
|
+
upload_protocol?: string;
|
|
9189
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9190
|
+
uploadType?: string;
|
|
9191
|
+
/** Request body */
|
|
9192
|
+
resource: GoogleCloudDiscoveryengineV1alphaSession;
|
|
9193
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaSession>;
|
|
9194
|
+
patch(
|
|
9195
|
+
request: {
|
|
9196
|
+
/** V1 error format. */
|
|
9197
|
+
'$.xgafv'?: string;
|
|
9198
|
+
/** OAuth access token. */
|
|
9199
|
+
access_token?: string;
|
|
9200
|
+
/** Data format for response. */
|
|
9201
|
+
alt?: string;
|
|
9202
|
+
/** JSONP */
|
|
9203
|
+
callback?: string;
|
|
9204
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9205
|
+
fields?: string;
|
|
9206
|
+
/** 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. */
|
|
9207
|
+
key?: string;
|
|
9208
|
+
/** Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
|
|
9209
|
+
name: string;
|
|
9210
|
+
/** OAuth 2.0 token for the current user. */
|
|
9211
|
+
oauth_token?: string;
|
|
9212
|
+
/** Returns response with indentations and line breaks. */
|
|
9213
|
+
prettyPrint?: boolean;
|
|
9214
|
+
/** 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. */
|
|
9215
|
+
quotaUser?: string;
|
|
9216
|
+
/** 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. */
|
|
9217
|
+
updateMask?: string;
|
|
9218
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9219
|
+
upload_protocol?: string;
|
|
9220
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9221
|
+
uploadType?: string;
|
|
9222
|
+
},
|
|
9223
|
+
body: GoogleCloudDiscoveryengineV1alphaSession
|
|
9224
|
+
): Request<GoogleCloudDiscoveryengineV1alphaSession>;
|
|
9225
|
+
answers: AnswersResource;
|
|
9226
|
+
}
|
|
7876
9227
|
interface TargetSitesResource {
|
|
7877
9228
|
/** Creates TargetSite in a batch. */
|
|
7878
9229
|
batchCreate(request: {
|
|
@@ -9011,10 +10362,103 @@ declare namespace gapi.client {
|
|
|
9011
10362
|
operations: OperationsResource;
|
|
9012
10363
|
schemas: SchemasResource;
|
|
9013
10364
|
servingConfigs: ServingConfigsResource;
|
|
10365
|
+
sessions: SessionsResource;
|
|
9014
10366
|
siteSearchEngine: SiteSearchEngineResource;
|
|
9015
10367
|
suggestionDenyListEntries: SuggestionDenyListEntriesResource;
|
|
9016
10368
|
userEvents: UserEventsResource;
|
|
9017
10369
|
}
|
|
10370
|
+
interface OperationsResource {
|
|
10371
|
+
/** 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. */
|
|
10372
|
+
get(request?: {
|
|
10373
|
+
/** V1 error format. */
|
|
10374
|
+
'$.xgafv'?: string;
|
|
10375
|
+
/** OAuth access token. */
|
|
10376
|
+
access_token?: string;
|
|
10377
|
+
/** Data format for response. */
|
|
10378
|
+
alt?: string;
|
|
10379
|
+
/** JSONP */
|
|
10380
|
+
callback?: string;
|
|
10381
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10382
|
+
fields?: string;
|
|
10383
|
+
/** 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. */
|
|
10384
|
+
key?: string;
|
|
10385
|
+
/** The name of the operation resource. */
|
|
10386
|
+
name: string;
|
|
10387
|
+
/** OAuth 2.0 token for the current user. */
|
|
10388
|
+
oauth_token?: string;
|
|
10389
|
+
/** Returns response with indentations and line breaks. */
|
|
10390
|
+
prettyPrint?: boolean;
|
|
10391
|
+
/** 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. */
|
|
10392
|
+
quotaUser?: string;
|
|
10393
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10394
|
+
upload_protocol?: string;
|
|
10395
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10396
|
+
uploadType?: string;
|
|
10397
|
+
}): Request<GoogleLongrunningOperation>;
|
|
10398
|
+
}
|
|
10399
|
+
interface EvaluationsResource {
|
|
10400
|
+
operations: OperationsResource;
|
|
10401
|
+
}
|
|
10402
|
+
interface GroundingConfigsResource {
|
|
10403
|
+
/** Performs a grounding check. */
|
|
10404
|
+
check(request: {
|
|
10405
|
+
/** V1 error format. */
|
|
10406
|
+
'$.xgafv'?: string;
|
|
10407
|
+
/** OAuth access token. */
|
|
10408
|
+
access_token?: string;
|
|
10409
|
+
/** Data format for response. */
|
|
10410
|
+
alt?: string;
|
|
10411
|
+
/** JSONP */
|
|
10412
|
+
callback?: string;
|
|
10413
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10414
|
+
fields?: string;
|
|
10415
|
+
/** Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`. */
|
|
10416
|
+
groundingConfig: string;
|
|
10417
|
+
/** 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. */
|
|
10418
|
+
key?: string;
|
|
10419
|
+
/** OAuth 2.0 token for the current user. */
|
|
10420
|
+
oauth_token?: string;
|
|
10421
|
+
/** Returns response with indentations and line breaks. */
|
|
10422
|
+
prettyPrint?: boolean;
|
|
10423
|
+
/** 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. */
|
|
10424
|
+
quotaUser?: string;
|
|
10425
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10426
|
+
upload_protocol?: string;
|
|
10427
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10428
|
+
uploadType?: string;
|
|
10429
|
+
/** Request body */
|
|
10430
|
+
resource: GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest;
|
|
10431
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse>;
|
|
10432
|
+
check(
|
|
10433
|
+
request: {
|
|
10434
|
+
/** V1 error format. */
|
|
10435
|
+
'$.xgafv'?: string;
|
|
10436
|
+
/** OAuth access token. */
|
|
10437
|
+
access_token?: string;
|
|
10438
|
+
/** Data format for response. */
|
|
10439
|
+
alt?: string;
|
|
10440
|
+
/** JSONP */
|
|
10441
|
+
callback?: string;
|
|
10442
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10443
|
+
fields?: string;
|
|
10444
|
+
/** Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`. */
|
|
10445
|
+
groundingConfig: string;
|
|
10446
|
+
/** 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. */
|
|
10447
|
+
key?: string;
|
|
10448
|
+
/** OAuth 2.0 token for the current user. */
|
|
10449
|
+
oauth_token?: string;
|
|
10450
|
+
/** Returns response with indentations and line breaks. */
|
|
10451
|
+
prettyPrint?: boolean;
|
|
10452
|
+
/** 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. */
|
|
10453
|
+
quotaUser?: string;
|
|
10454
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10455
|
+
upload_protocol?: string;
|
|
10456
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10457
|
+
uploadType?: string;
|
|
10458
|
+
},
|
|
10459
|
+
body: GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest
|
|
10460
|
+
): Request<GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse>;
|
|
10461
|
+
}
|
|
9018
10462
|
interface OperationsResource {
|
|
9019
10463
|
/** 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. */
|
|
9020
10464
|
get(request?: {
|
|
@@ -9283,6 +10727,8 @@ declare namespace gapi.client {
|
|
|
9283
10727
|
): Request<GoogleCloudDiscoveryengineV1alphaAclConfig>;
|
|
9284
10728
|
collections: CollectionsResource;
|
|
9285
10729
|
dataStores: DataStoresResource;
|
|
10730
|
+
evaluations: EvaluationsResource;
|
|
10731
|
+
groundingConfigs: GroundingConfigsResource;
|
|
9286
10732
|
operations: OperationsResource;
|
|
9287
10733
|
rankingConfigs: RankingConfigsResource;
|
|
9288
10734
|
}
|