@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240329 → 0.0.20240409

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +1482 -118
  2. 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: 20240329
12
+ // Revision: 20240409
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 Gen App Builder. */
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;
@@ -126,39 +402,69 @@ declare namespace gapi.client {
126
402
  families?: {
127
403
  [P in string]: GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily;
128
404
  };
129
- /** The field name used for saving row key value in the UCS document. The name has to match a-zA-Z0-9* */
405
+ /** The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`. */
130
406
  keyFieldName?: string;
131
407
  }
132
408
  interface GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn {
133
- /** Optional. 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. */
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. */
134
410
  encoding?: string;
135
- /** The field name to use for this column in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the qualifier bytes with best effort. However, field name collisions could happen, where parsing behavior is undefined. */
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. */
136
412
  fieldName?: string;
137
- /** Required. Qualifier of the column. If cannot decode with utf-8, store a base-64 encoded string. */
413
+ /** Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead. */
138
414
  qualifier?: string;
139
- /** Optional. 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. */
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`. */
140
416
  type?: string;
141
417
  }
142
418
  interface GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily {
143
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. */
144
420
  columns?: GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn[];
145
- /** Optional. 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. */
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. */
146
422
  encoding?: string;
147
- /** The field name to use for this column family in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the family name with best effort. However, due to difference naming pattern, there could be field name collisions, where parsing behavior is undefined. */
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. */
148
424
  fieldName?: string;
149
- /** Optional. 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. */
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`. */
150
426
  type?: string;
151
427
  }
152
428
  interface GoogleCloudDiscoveryengineV1alphaBigtableSource {
153
429
  /** Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations. */
154
430
  bigtableOptions?: GoogleCloudDiscoveryengineV1alphaBigtableOptions;
155
- /** Required. The instance ID of the Cloud Bigtable that needs to be exported. */
431
+ /** Required. The instance ID of the Cloud Bigtable that needs to be imported. */
156
432
  instanceId?: string;
157
- /** The project ID (can be project # or 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. */
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. */
158
434
  projectId?: string;
159
- /** Required. The table ID of the Cloud Bigtable that needs to be exported. */
435
+ /** Required. The table ID of the Cloud Bigtable that needs to be imported. */
160
436
  tableId?: string;
161
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
+ }
162
468
  interface GoogleCloudDiscoveryengineV1alphaChunk {
163
469
  /** Output only. Metadata of the current chunk. */
164
470
  chunkMetadata?: GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata;
@@ -168,7 +474,7 @@ declare namespace gapi.client {
168
474
  derivedStructData?: {[P in string]: any};
169
475
  /** Metadata of the document from the current chunk. */
170
476
  documentMetadata?: GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata;
171
- /** Unique chunk id of the current chunk. */
477
+ /** Unique chunk ID of the current chunk. */
172
478
  id?: string;
173
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. */
174
480
  name?: string;
@@ -196,13 +502,13 @@ declare namespace gapi.client {
196
502
  interface GoogleCloudDiscoveryengineV1alphaCloudSqlSource {
197
503
  /** Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. */
198
504
  databaseId?: string;
199
- /** Optional. 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 GCS Storage Admin permissions to access the specified GCS directory. */
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. */
200
506
  gcsStagingDir?: string;
201
507
  /** Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. */
202
508
  instanceId?: string;
203
- /** Optional. Option for serverless export. Enabling this option will incur additional cost. More info: https://cloud.google.com/sql/pricing#serverless */
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). */
204
510
  offload?: boolean;
205
- /** Optional. The project ID (can be project # or 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. */
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. */
206
512
  projectId?: string;
207
513
  /** Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. */
208
514
  tableId?: string;
@@ -616,6 +922,14 @@ declare namespace gapi.client {
616
922
  /** Total number of documents. */
617
923
  documentCount?: string;
618
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
+ }
619
933
  interface GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse {
620
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. */
621
935
  nextPageToken?: string;
@@ -651,24 +965,26 @@ declare namespace gapi.client {
651
965
  searchableOption?: string;
652
966
  }
653
967
  interface GoogleCloudDiscoveryengineV1alphaFirestoreSource {
654
- /** Required. The Firestore collection to copy the data from with a length limit of 1500 characters. */
968
+ /** Required. The Firestore collection to copy the data from with a length limit of 1,500 characters. */
655
969
  collectionId?: string;
656
970
  /** Required. The Firestore database to copy the data from with a length limit of 256 characters. */
657
971
  databaseId?: string;
658
- /** Optional. 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 GCS Storage Admin permissions to access the specified GCS directory. */
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. */
659
973
  gcsStagingDir?: string;
660
- /** Optional. The project ID (can be project # or 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. */
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. */
661
975
  projectId?: string;
662
976
  }
663
977
  interface GoogleCloudDiscoveryengineV1alphaGcsSource {
664
- /** 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 Gen App Builder. * `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 Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. */
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. */
665
979
  dataSchema?: string;
666
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`). */
667
981
  inputUris?: string[];
668
982
  }
669
- interface GoogleCloudDiscoveryengineV1alphaGroundingConfig {
670
- /** Required. Name of the GroundingConfig, of the form `projects/{project}/locations/{location}/groundingConfig`. */
671
- name?: string;
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;
672
988
  }
673
989
  interface GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec {
674
990
  /** Whether or not to enable and include refinement attributes in gudied search result. */
@@ -709,11 +1025,13 @@ declare namespace gapi.client {
709
1025
  failureCount?: string;
710
1026
  /** Count of entries that were processed successfully. */
711
1027
  successCount?: string;
1028
+ /** Total count of entries that were processed. */
1029
+ totalCount?: string;
712
1030
  /** Operation last update time. If the operation is done, this is also the finish time. */
713
1031
  updateTime?: string;
714
1032
  }
715
1033
  interface GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest {
716
- /** 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. */
717
1035
  autoGenerateIds?: boolean;
718
1036
  /** BigQuery input source. */
719
1037
  bigquerySource?: GoogleCloudDiscoveryengineV1alphaBigQuerySource;
@@ -729,7 +1047,7 @@ declare namespace gapi.client {
729
1047
  firestoreSource?: GoogleCloudDiscoveryengineV1alphaFirestoreSource;
730
1048
  /** Cloud Storage location for the input content. */
731
1049
  gcsSource?: GoogleCloudDiscoveryengineV1alphaGcsSource;
732
- /** 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. */
733
1051
  idField?: string;
734
1052
  /** The Inline source for the input content for documents. */
735
1053
  inlineSource?: GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource;
@@ -737,6 +1055,8 @@ declare namespace gapi.client {
737
1055
  reconciliationMode?: string;
738
1056
  /** Spanner input source. */
739
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;
740
1060
  }
741
1061
  interface GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource {
742
1062
  /** Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. */
@@ -862,6 +1182,12 @@ declare namespace gapi.client {
862
1182
  /** All the ServingConfigs for a given dataStore. */
863
1183
  servingConfigs?: GoogleCloudDiscoveryengineV1alphaServingConfig[];
864
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
+ }
865
1191
  interface GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse {
866
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. */
867
1193
  nextPageToken?: string;
@@ -982,6 +1308,12 @@ declare namespace gapi.client {
982
1308
  /** The total count of events purged as a result of the operation. */
983
1309
  purgeCount?: string;
984
1310
  }
1311
+ interface GoogleCloudDiscoveryengineV1alphaQuery {
1312
+ /** Unique Id for the query. */
1313
+ queryId?: string;
1314
+ /** Plain text. */
1315
+ text?: string;
1316
+ }
985
1317
  interface GoogleCloudDiscoveryengineV1alphaRankingRecord {
986
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. */
987
1319
  content?: string;
@@ -999,7 +1331,7 @@ declare namespace gapi.client {
999
1331
  model?: string;
1000
1332
  /** The query to use. */
1001
1333
  query?: string;
1002
- /** Required. A list of records to rank. */
1334
+ /** Required. A list of records to rank. At most 100 records to rank. */
1003
1335
  records?: GoogleCloudDiscoveryengineV1alphaRankingRecord[];
1004
1336
  /** The number of results to return. If this is unset or no bigger than zero, returns all results. */
1005
1337
  topN?: number;
@@ -1140,7 +1472,7 @@ declare namespace gapi.client {
1140
1472
  offset?: number;
1141
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. */
1142
1474
  orderBy?: string;
1143
- /** Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 are coerced to 100. If this field is negative, an `INVALID_ARGUMENT` is returned. */
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. */
1144
1476
  pageSize?: number;
1145
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. */
1146
1478
  pageToken?: string;
@@ -1172,9 +1504,27 @@ declare namespace gapi.client {
1172
1504
  interface GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec {
1173
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. */
1174
1506
  boost?: number;
1507
+ /** Complex specification for custom ranking based on customer defined attribute value. */
1508
+ boostControlSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec;
1175
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"))` */
1176
1510
  condition?: string;
1177
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
+ }
1178
1528
  interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec {
1179
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 */
1180
1530
  chunkSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec;
@@ -1484,6 +1834,26 @@ declare namespace gapi.client {
1484
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. */
1485
1835
  demotionEventType?: string;
1486
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
+ }
1487
1857
  interface GoogleCloudDiscoveryengineV1alphaSiteSearchEngine {
1488
1858
  /** The fully qualified resource name of the site search engine. Format: `projects/*‍/locations/*‍/dataStores/*‍/siteSearchEngine` */
1489
1859
  name?: string;
@@ -1497,7 +1867,7 @@ declare namespace gapi.client {
1497
1867
  interface GoogleCloudDiscoveryengineV1alphaSpannerSource {
1498
1868
  /** Required. The database ID of the source Spanner table. */
1499
1869
  databaseId?: string;
1500
- /** Optional. Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info: https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas */
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). */
1501
1871
  enableDataBoost?: boolean;
1502
1872
  /** Required. The instance ID of the source Spanner table. */
1503
1873
  instanceId?: string;
@@ -1577,7 +1947,7 @@ declare namespace gapi.client {
1577
1947
  errorSamples?: GoogleRpcStatus[];
1578
1948
  /** The metrics of the trained model. */
1579
1949
  metrics?: {[P in string]: number};
1580
- /** 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. */
1581
1951
  modelStatus?: string;
1582
1952
  }
1583
1953
  interface GoogleCloudDiscoveryengineV1alphaTransactionInfo {
@@ -1989,10 +2359,6 @@ declare namespace gapi.client {
1989
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. */
1990
2360
  searchTier?: string;
1991
2361
  }
1992
- interface GoogleCloudDiscoveryengineV1betaGroundingConfig {
1993
- /** Required. Name of the GroundingConfig, of the form `projects/{project}/locations/{location}/groundingConfig`. */
1994
- name?: string;
1995
- }
1996
2362
  interface GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata {
1997
2363
  /** Operation create time. */
1998
2364
  createTime?: string;
@@ -2000,6 +2366,8 @@ declare namespace gapi.client {
2000
2366
  failureCount?: string;
2001
2367
  /** Count of entries that were processed successfully. */
2002
2368
  successCount?: string;
2369
+ /** Total count of entries that were processed. */
2370
+ totalCount?: string;
2003
2371
  /** Operation last update time. If the operation is done, this is also the finish time. */
2004
2372
  updateTime?: string;
2005
2373
  }
@@ -2132,7 +2500,7 @@ declare namespace gapi.client {
2132
2500
  errorSamples?: GoogleRpcStatus[];
2133
2501
  /** The metrics of the trained model. */
2134
2502
  metrics?: {[P in string]: number};
2135
- /** 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. */
2136
2504
  modelStatus?: string;
2137
2505
  }
2138
2506
  interface GoogleCloudDiscoveryengineV1betaTuneEngineMetadata {
@@ -2317,6 +2685,8 @@ declare namespace gapi.client {
2317
2685
  failureCount?: string;
2318
2686
  /** Count of entries that were processed successfully. */
2319
2687
  successCount?: string;
2688
+ /** Total count of entries that were processed. */
2689
+ totalCount?: string;
2320
2690
  /** Operation last update time. If the operation is done, this is also the finish time. */
2321
2691
  updateTime?: string;
2322
2692
  }
@@ -3942,6 +4312,64 @@ declare namespace gapi.client {
3942
4312
  operations: OperationsResource;
3943
4313
  }
3944
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>;
3945
4373
  /** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
3946
4374
  get(request?: {
3947
4375
  /** V1 error format. */
@@ -4179,8 +4607,8 @@ declare namespace gapi.client {
4179
4607
  body: GoogleCloudDiscoveryengineV1alphaSearchRequest
4180
4608
  ): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
4181
4609
  }
4182
- interface OperationsResource {
4183
- /** 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. */
4610
+ interface AnswersResource {
4611
+ /** Gets a Answer. */
4184
4612
  get(request?: {
4185
4613
  /** V1 error format. */
4186
4614
  '$.xgafv'?: string;
@@ -4194,7 +4622,7 @@ declare namespace gapi.client {
4194
4622
  fields?: string;
4195
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. */
4196
4624
  key?: string;
4197
- /** The name of the operation resource. */
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}` */
4198
4626
  name: string;
4199
4627
  /** OAuth 2.0 token for the current user. */
4200
4628
  oauth_token?: string;
@@ -4206,9 +4634,11 @@ declare namespace gapi.client {
4206
4634
  upload_protocol?: string;
4207
4635
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4208
4636
  uploadType?: string;
4209
- }): Request<GoogleLongrunningOperation>;
4210
- /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
4211
- list(request?: {
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: {
4212
4642
  /** V1 error format. */
4213
4643
  '$.xgafv'?: string;
4214
4644
  /** OAuth access token. */
@@ -4219,18 +4649,70 @@ declare namespace gapi.client {
4219
4649
  callback?: string;
4220
4650
  /** Selector specifying which fields to include in a partial response. */
4221
4651
  fields?: string;
4222
- /** The standard list filter. */
4223
- filter?: string;
4224
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. */
4225
4653
  key?: string;
4226
- /** The name of the operation's parent resource. */
4654
+ /** OAuth 2.0 token for the current user. */
4655
+ oauth_token?: 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;
4658
+ /** Returns response with indentations and line breaks. */
4659
+ prettyPrint?: boolean;
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. */
4661
+ quotaUser?: string;
4662
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4663
+ upload_protocol?: string;
4664
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4665
+ uploadType?: string;
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?: {
4700
+ /** V1 error format. */
4701
+ '$.xgafv'?: string;
4702
+ /** OAuth access token. */
4703
+ access_token?: string;
4704
+ /** Data format for response. */
4705
+ alt?: string;
4706
+ /** JSONP */
4707
+ callback?: string;
4708
+ /** Selector specifying which fields to include in a partial response. */
4709
+ fields?: string;
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. */
4711
+ key?: string;
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}` */
4227
4713
  name: string;
4228
4714
  /** OAuth 2.0 token for the current user. */
4229
4715
  oauth_token?: string;
4230
- /** The standard list page size. */
4231
- pageSize?: number;
4232
- /** The standard list page token. */
4233
- pageToken?: string;
4234
4716
  /** Returns response with indentations and line breaks. */
4235
4717
  prettyPrint?: boolean;
4236
4718
  /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
@@ -4239,10 +4721,8 @@ declare namespace gapi.client {
4239
4721
  upload_protocol?: string;
4240
4722
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4241
4723
  uploadType?: string;
4242
- }): Request<GoogleLongrunningListOperationsResponse>;
4243
- }
4244
- interface OperationsResource {
4245
- /** 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. */
4724
+ }): Request<{}>;
4725
+ /** Gets a Session. */
4246
4726
  get(request?: {
4247
4727
  /** V1 error format. */
4248
4728
  '$.xgafv'?: string;
@@ -4256,7 +4736,7 @@ declare namespace gapi.client {
4256
4736
  fields?: string;
4257
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. */
4258
4738
  key?: string;
4259
- /** The name of the operation resource. */
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}` */
4260
4740
  name: string;
4261
4741
  /** OAuth 2.0 token for the current user. */
4262
4742
  oauth_token?: string;
@@ -4268,8 +4748,8 @@ declare namespace gapi.client {
4268
4748
  upload_protocol?: string;
4269
4749
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4270
4750
  uploadType?: string;
4271
- }): Request<GoogleLongrunningOperation>;
4272
- /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
4751
+ }): Request<GoogleCloudDiscoveryengineV1alphaSession>;
4752
+ /** Lists all Sessions by their parent DataStore. */
4273
4753
  list(request?: {
4274
4754
  /** V1 error format. */
4275
4755
  '$.xgafv'?: string;
@@ -4281,18 +4761,20 @@ declare namespace gapi.client {
4281
4761
  callback?: string;
4282
4762
  /** Selector specifying which fields to include in a partial response. */
4283
4763
  fields?: string;
4284
- /** The standard list filter. */
4764
+ /** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
4285
4765
  filter?: string;
4286
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. */
4287
4767
  key?: string;
4288
- /** The name of the operation's parent resource. */
4289
- name: string;
4290
4768
  /** OAuth 2.0 token for the current user. */
4291
4769
  oauth_token?: string;
4292
- /** The standard list page size. */
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. */
4293
4773
  pageSize?: number;
4294
- /** The standard list page token. */
4774
+ /** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
4295
4775
  pageToken?: string;
4776
+ /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
4777
+ parent: string;
4296
4778
  /** Returns response with indentations and line breaks. */
4297
4779
  prettyPrint?: boolean;
4298
4780
  /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
@@ -4301,11 +4783,9 @@ declare namespace gapi.client {
4301
4783
  upload_protocol?: string;
4302
4784
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4303
4785
  uploadType?: string;
4304
- }): Request<GoogleLongrunningListOperationsResponse>;
4305
- }
4306
- interface TargetSitesResource {
4307
- /** Creates TargetSite in a batch. */
4308
- batchCreate(request: {
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: {
4309
4789
  /** V1 error format. */
4310
4790
  '$.xgafv'?: string;
4311
4791
  /** OAuth access token. */
@@ -4318,22 +4798,24 @@ declare namespace gapi.client {
4318
4798
  fields?: string;
4319
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. */
4320
4800
  key?: string;
4801
+ /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
4802
+ name: string;
4321
4803
  /** OAuth 2.0 token for the current user. */
4322
4804
  oauth_token?: string;
4323
- /** 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. */
4324
- parent: string;
4325
4805
  /** Returns response with indentations and line breaks. */
4326
4806
  prettyPrint?: boolean;
4327
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. */
4328
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;
4329
4811
  /** Upload protocol for media (e.g. "raw", "multipart"). */
4330
4812
  upload_protocol?: string;
4331
4813
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4332
4814
  uploadType?: string;
4333
4815
  /** Request body */
4334
- resource: GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest;
4335
- }): Request<GoogleLongrunningOperation>;
4336
- batchCreate(
4816
+ resource: GoogleCloudDiscoveryengineV1alphaSession;
4817
+ }): Request<GoogleCloudDiscoveryengineV1alphaSession>;
4818
+ patch(
4337
4819
  request: {
4338
4820
  /** V1 error format. */
4339
4821
  '$.xgafv'?: string;
@@ -4347,20 +4829,207 @@ declare namespace gapi.client {
4347
4829
  fields?: string;
4348
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. */
4349
4831
  key?: string;
4832
+ /** Immutable. Fully qualified name `project/*‍/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
4833
+ name: string;
4350
4834
  /** OAuth 2.0 token for the current user. */
4351
4835
  oauth_token?: string;
4352
- /** 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. */
4353
- parent: string;
4354
4836
  /** Returns response with indentations and line breaks. */
4355
4837
  prettyPrint?: boolean;
4356
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. */
4357
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;
4358
4842
  /** Upload protocol for media (e.g. "raw", "multipart"). */
4359
4843
  upload_protocol?: string;
4360
4844
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4361
4845
  uploadType?: string;
4362
4846
  },
4363
- body: GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest
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. */
5012
+ alt?: string;
5013
+ /** JSONP */
5014
+ callback?: string;
5015
+ /** Selector specifying which fields to include in a partial response. */
5016
+ fields?: string;
5017
+ /** 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. */
5018
+ key?: string;
5019
+ /** OAuth 2.0 token for the current user. */
5020
+ oauth_token?: string;
5021
+ /** 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. */
5022
+ parent: string;
5023
+ /** Returns response with indentations and line breaks. */
5024
+ prettyPrint?: boolean;
5025
+ /** 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. */
5026
+ quotaUser?: string;
5027
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
5028
+ upload_protocol?: string;
5029
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5030
+ uploadType?: string;
5031
+ },
5032
+ body: GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest
4364
5033
  ): Request<GoogleLongrunningOperation>;
4365
5034
  /** Creates a TargetSite. */
4366
5035
  create(request: {
@@ -5590,6 +6259,7 @@ declare namespace gapi.client {
5590
6259
  operations: OperationsResource;
5591
6260
  schemas: SchemasResource;
5592
6261
  servingConfigs: ServingConfigsResource;
6262
+ sessions: SessionsResource;
5593
6263
  siteSearchEngine: SiteSearchEngineResource;
5594
6264
  suggestionDenyListEntries: SuggestionDenyListEntriesResource;
5595
6265
  userEvents: UserEventsResource;
@@ -5926,6 +6596,64 @@ declare namespace gapi.client {
5926
6596
  }): Request<GoogleLongrunningListOperationsResponse>;
5927
6597
  }
5928
6598
  interface ServingConfigsResource {
6599
+ /** Answer query method. */
6600
+ answer(request: {
6601
+ /** V1 error format. */
6602
+ '$.xgafv'?: string;
6603
+ /** OAuth access token. */
6604
+ access_token?: string;
6605
+ /** Data format for response. */
6606
+ alt?: string;
6607
+ /** JSONP */
6608
+ callback?: string;
6609
+ /** Selector specifying which fields to include in a partial response. */
6610
+ fields?: string;
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. */
6612
+ key?: string;
6613
+ /** OAuth 2.0 token for the current user. */
6614
+ oauth_token?: string;
6615
+ /** Returns response with indentations and line breaks. */
6616
+ prettyPrint?: boolean;
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. */
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;
6621
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6622
+ upload_protocol?: string;
6623
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6624
+ uploadType?: string;
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>;
5929
6657
  /** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
5930
6658
  get(request?: {
5931
6659
  /** V1 error format. */
@@ -6163,9 +6891,9 @@ declare namespace gapi.client {
6163
6891
  body: GoogleCloudDiscoveryengineV1alphaSearchRequest
6164
6892
  ): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
6165
6893
  }
6166
- interface EnginesResource {
6167
- /** Creates a Engine. */
6168
- create(request: {
6894
+ interface AnswersResource {
6895
+ /** Gets a Answer. */
6896
+ get(request?: {
6169
6897
  /** V1 error format. */
6170
6898
  '$.xgafv'?: string;
6171
6899
  /** OAuth access token. */
@@ -6174,16 +6902,14 @@ declare namespace gapi.client {
6174
6902
  alt?: string;
6175
6903
  /** JSONP */
6176
6904
  callback?: string;
6177
- /** Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
6178
- engineId?: string;
6179
6905
  /** Selector specifying which fields to include in a partial response. */
6180
6906
  fields?: string;
6181
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. */
6182
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;
6183
6911
  /** OAuth 2.0 token for the current user. */
6184
6912
  oauth_token?: string;
6185
- /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. */
6186
- parent: string;
6187
6913
  /** Returns response with indentations and line breaks. */
6188
6914
  prettyPrint?: boolean;
6189
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. */
@@ -6192,21 +6918,264 @@ declare namespace gapi.client {
6192
6918
  upload_protocol?: string;
6193
6919
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6194
6920
  uploadType?: string;
6195
- /** Request body */
6196
- resource: GoogleCloudDiscoveryengineV1alphaEngine;
6197
- }): Request<GoogleLongrunningOperation>;
6198
- create(
6199
- request: {
6200
- /** V1 error format. */
6201
- '$.xgafv'?: string;
6202
- /** OAuth access token. */
6203
- access_token?: string;
6204
- /** Data format for response. */
6205
- alt?: string;
6206
- /** JSONP */
6207
- callback?: string;
6208
- /** Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
6209
- engineId?: 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
+ }
7135
+ interface EnginesResource {
7136
+ /** Creates a Engine. */
7137
+ create(request: {
7138
+ /** V1 error format. */
7139
+ '$.xgafv'?: string;
7140
+ /** OAuth access token. */
7141
+ access_token?: string;
7142
+ /** Data format for response. */
7143
+ alt?: string;
7144
+ /** JSONP */
7145
+ callback?: string;
7146
+ /** Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
7147
+ engineId?: string;
7148
+ /** Selector specifying which fields to include in a partial response. */
7149
+ fields?: string;
7150
+ /** 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. */
7151
+ key?: string;
7152
+ /** OAuth 2.0 token for the current user. */
7153
+ oauth_token?: string;
7154
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. */
7155
+ parent: string;
7156
+ /** Returns response with indentations and line breaks. */
7157
+ prettyPrint?: boolean;
7158
+ /** 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. */
7159
+ quotaUser?: string;
7160
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7161
+ upload_protocol?: string;
7162
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7163
+ uploadType?: string;
7164
+ /** Request body */
7165
+ resource: GoogleCloudDiscoveryengineV1alphaEngine;
7166
+ }): Request<GoogleLongrunningOperation>;
7167
+ create(
7168
+ request: {
7169
+ /** V1 error format. */
7170
+ '$.xgafv'?: string;
7171
+ /** OAuth access token. */
7172
+ access_token?: string;
7173
+ /** Data format for response. */
7174
+ alt?: string;
7175
+ /** JSONP */
7176
+ callback?: string;
7177
+ /** Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
7178
+ engineId?: string;
6210
7179
  /** Selector specifying which fields to include in a partial response. */
6211
7180
  fields?: string;
6212
7181
  /** 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. */
@@ -6552,6 +7521,7 @@ declare namespace gapi.client {
6552
7521
  conversations: ConversationsResource;
6553
7522
  operations: OperationsResource;
6554
7523
  servingConfigs: ServingConfigsResource;
7524
+ sessions: SessionsResource;
6555
7525
  }
6556
7526
  interface OperationsResource {
6557
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. */
@@ -7718,8 +8688,8 @@ declare namespace gapi.client {
7718
8688
  ): Request<GoogleLongrunningOperation>;
7719
8689
  }
7720
8690
  interface ServingConfigsResource {
7721
- /** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
7722
- get(request?: {
8691
+ /** Answer query method. */
8692
+ answer(request: {
7723
8693
  /** V1 error format. */
7724
8694
  '$.xgafv'?: string;
7725
8695
  /** OAuth access token. */
@@ -7732,37 +8702,95 @@ declare namespace gapi.client {
7732
8702
  fields?: string;
7733
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. */
7734
8704
  key?: string;
7735
- /** Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
7736
- name: string;
7737
8705
  /** OAuth 2.0 token for the current user. */
7738
8706
  oauth_token?: string;
7739
8707
  /** Returns response with indentations and line breaks. */
7740
8708
  prettyPrint?: boolean;
7741
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. */
7742
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;
7743
8713
  /** Upload protocol for media (e.g. "raw", "multipart"). */
7744
8714
  upload_protocol?: string;
7745
8715
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7746
8716
  uploadType?: string;
7747
- }): Request<GoogleCloudDiscoveryengineV1alphaServingConfig>;
7748
- /** Lists all ServingConfigs linked to this dataStore. */
7749
- list(request?: {
7750
- /** V1 error format. */
7751
- '$.xgafv'?: string;
7752
- /** OAuth access token. */
7753
- access_token?: string;
7754
- /** Data format for response. */
7755
- alt?: string;
7756
- /** JSONP */
7757
- callback?: string;
7758
- /** Selector specifying which fields to include in a partial response. */
7759
- fields?: string;
7760
- /** 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. */
7761
- key?: string;
7762
- /** OAuth 2.0 token for the current user. */
7763
- oauth_token?: string;
7764
- /** 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. */
7765
- pageSize?: number;
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;
8786
+ /** Selector specifying which fields to include in a partial response. */
8787
+ fields?: string;
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. */
8789
+ key?: string;
8790
+ /** OAuth 2.0 token for the current user. */
8791
+ oauth_token?: string;
8792
+ /** 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. */
8793
+ pageSize?: number;
7766
8794
  /** Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */
7767
8795
  pageToken?: string;
7768
8796
  /** Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` */
@@ -7955,6 +8983,247 @@ declare namespace gapi.client {
7955
8983
  body: GoogleCloudDiscoveryengineV1alphaSearchRequest
7956
8984
  ): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
7957
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
+ }
7958
9227
  interface TargetSitesResource {
7959
9228
  /** Creates TargetSite in a batch. */
7960
9229
  batchCreate(request: {
@@ -9093,10 +10362,103 @@ declare namespace gapi.client {
9093
10362
  operations: OperationsResource;
9094
10363
  schemas: SchemasResource;
9095
10364
  servingConfigs: ServingConfigsResource;
10365
+ sessions: SessionsResource;
9096
10366
  siteSearchEngine: SiteSearchEngineResource;
9097
10367
  suggestionDenyListEntries: SuggestionDenyListEntriesResource;
9098
10368
  userEvents: UserEventsResource;
9099
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
+ }
9100
10462
  interface OperationsResource {
9101
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. */
9102
10464
  get(request?: {
@@ -9365,6 +10727,8 @@ declare namespace gapi.client {
9365
10727
  ): Request<GoogleCloudDiscoveryengineV1alphaAclConfig>;
9366
10728
  collections: CollectionsResource;
9367
10729
  dataStores: DataStoresResource;
10730
+ evaluations: EvaluationsResource;
10731
+ groundingConfigs: GroundingConfigsResource;
9368
10732
  operations: OperationsResource;
9369
10733
  rankingConfigs: RankingConfigsResource;
9370
10734
  }