You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.controls.html
+12-6Lines changed: 12 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -139,7 +139,7 @@ <h3>Method Details</h3>
139
139
"startTime": "A String", # Start of time range. Range is inclusive.
140
140
},
141
141
],
142
-
"queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.
142
+
"queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.
143
143
"queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.
144
144
{ # Matcher for search request query
145
145
"fullMatch": True or False, # Whether the search query needs to exactly match the query term.
@@ -158,6 +158,7 @@ <h3>Method Details</h3>
158
158
"dataStore": "A String", # Required. Data store with which this promotion is attached to.
159
159
"searchLinkPromotion": { # Promotion proto includes uri and other helping information to display the promotion. # Required. Promotion attached to this action.
160
160
"description": "A String", # Optional. The Promotion description. Maximum length: 200 characters.
161
+
"document": "A String", # Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.
161
162
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
162
163
"imageUri": "A String", # Optional. The promotion thumbnail image url.
163
164
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
@@ -216,7 +217,7 @@ <h3>Method Details</h3>
216
217
"startTime": "A String", # Start of time range. Range is inclusive.
217
218
},
218
219
],
219
-
"queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.
220
+
"queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.
220
221
"queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.
221
222
{ # Matcher for search request query
222
223
"fullMatch": True or False, # Whether the search query needs to exactly match the query term.
@@ -235,6 +236,7 @@ <h3>Method Details</h3>
235
236
"dataStore": "A String", # Required. Data store with which this promotion is attached to.
236
237
"searchLinkPromotion": { # Promotion proto includes uri and other helping information to display the promotion. # Required. Promotion attached to this action.
237
238
"description": "A String", # Optional. The Promotion description. Maximum length: 200 characters.
239
+
"document": "A String", # Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.
238
240
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
239
241
"imageUri": "A String", # Optional. The promotion thumbnail image url.
240
242
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
@@ -317,7 +319,7 @@ <h3>Method Details</h3>
317
319
"startTime": "A String", # Start of time range. Range is inclusive.
318
320
},
319
321
],
320
-
"queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.
322
+
"queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.
321
323
"queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.
322
324
{ # Matcher for search request query
323
325
"fullMatch": True or False, # Whether the search query needs to exactly match the query term.
@@ -336,6 +338,7 @@ <h3>Method Details</h3>
336
338
"dataStore": "A String", # Required. Data store with which this promotion is attached to.
337
339
"searchLinkPromotion": { # Promotion proto includes uri and other helping information to display the promotion. # Required. Promotion attached to this action.
338
340
"description": "A String", # Optional. The Promotion description. Maximum length: 200 characters.
341
+
"document": "A String", # Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.
339
342
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
340
343
"imageUri": "A String", # Optional. The promotion thumbnail image url.
341
344
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
@@ -405,7 +408,7 @@ <h3>Method Details</h3>
405
408
"startTime": "A String", # Start of time range. Range is inclusive.
406
409
},
407
410
],
408
-
"queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.
411
+
"queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.
409
412
"queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.
410
413
{ # Matcher for search request query
411
414
"fullMatch": True or False, # Whether the search query needs to exactly match the query term.
@@ -424,6 +427,7 @@ <h3>Method Details</h3>
424
427
"dataStore": "A String", # Required. Data store with which this promotion is attached to.
425
428
"searchLinkPromotion": { # Promotion proto includes uri and other helping information to display the promotion. # Required. Promotion attached to this action.
426
429
"description": "A String", # Optional. The Promotion description. Maximum length: 200 characters.
430
+
"document": "A String", # Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.
427
431
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
428
432
"imageUri": "A String", # Optional. The promotion thumbnail image url.
429
433
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
@@ -500,7 +504,7 @@ <h3>Method Details</h3>
500
504
"startTime": "A String", # Start of time range. Range is inclusive.
501
505
},
502
506
],
503
-
"queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.
507
+
"queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.
504
508
"queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.
505
509
{ # Matcher for search request query
506
510
"fullMatch": True or False, # Whether the search query needs to exactly match the query term.
@@ -519,6 +523,7 @@ <h3>Method Details</h3>
519
523
"dataStore": "A String", # Required. Data store with which this promotion is attached to.
520
524
"searchLinkPromotion": { # Promotion proto includes uri and other helping information to display the promotion. # Required. Promotion attached to this action.
521
525
"description": "A String", # Optional. The Promotion description. Maximum length: 200 characters.
526
+
"document": "A String", # Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.
522
527
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
523
528
"imageUri": "A String", # Optional. The promotion thumbnail image url.
524
529
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
@@ -577,7 +582,7 @@ <h3>Method Details</h3>
577
582
"startTime": "A String", # Start of time range. Range is inclusive.
578
583
},
579
584
],
580
-
"queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.
585
+
"queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.
581
586
"queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.
582
587
{ # Matcher for search request query
583
588
"fullMatch": True or False, # Whether the search query needs to exactly match the query term.
@@ -596,6 +601,7 @@ <h3>Method Details</h3>
596
601
"dataStore": "A String", # Required. Data store with which this promotion is attached to.
597
602
"searchLinkPromotion": { # Promotion proto includes uri and other helping information to display the promotion. # Required. Promotion attached to this action.
598
603
"description": "A String", # Optional. The Promotion description. Maximum length: 200 characters.
604
+
"document": "A String", # Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.
599
605
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
600
606
"imageUri": "A String", # Optional. The promotion thumbnail image url.
601
607
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html
+8-2Lines changed: 8 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -355,6 +355,9 @@ <h3>Method Details</h3>
355
355
"searchResults": [ # Search Results.
356
356
{ # Represents the search results.
357
357
"chunk": { # Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. # The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
358
+
"annotationContents": [ # Output only. Annotation contents if the current chunk contains annotations.
359
+
"A String",
360
+
],
358
361
"chunkMetadata": { # Metadata of the current chunk. This field is only populated on SearchService.Search API. # Output only. Metadata of the current chunk.
359
362
"nextChunks": [ # The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API.
360
363
# Object with schema name: GoogleCloudDiscoveryengineV1Chunk
@@ -364,6 +367,9 @@ <h3>Method Details</h3>
364
367
],
365
368
},
366
369
"content": "A String", # Content is a string from a document (parsed content).
370
+
"dataUrls": [ # Output only. Image Data URLs if the current chunk contains images. Data URLs are composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,
371
+
"A String",
372
+
],
367
373
"derivedStructData": { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
368
374
"a_key": "", # Properties of the object.
369
375
},
@@ -396,8 +402,8 @@ <h3>Method Details</h3>
396
402
},
397
403
],
398
404
},
399
-
"content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store.
400
-
"mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
405
+
"content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content can only be set and must be set if this document is under a `CONTENT_REQUIRED` data store.
406
+
"mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) * `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml.
401
407
"rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
402
408
"uri": "A String", # The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 2.5 MB for text-based formats, 200 MB for other formats.
0 commit comments