Skip to content

Commit ef9affe

Browse files
feat(discoveryengine): update the api
#### discoveryengine:v1 The following keys were added: - schemas.GoogleCloudDiscoveryengineV1Chunk.properties.annotationContents (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1SearchLinkPromotion.properties.document.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion.properties.document.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaSearchLinkPromotion.properties.document.type (Total Keys: 1) #### discoveryengine:v1alpha The following keys were added: - resources.projects.resources.locations.resources.collections.resources.dataConnector.methods.getConnectorSecret (Total Keys: 11) - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.branches.resources.documents.methods.getProcessedDocument.parameters.imageId (Total Keys: 2) - resources.projects.resources.locations.resources.dataStores.resources.branches.resources.documents.methods.getProcessedDocument.parameters.imageId (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1SearchLinkPromotion.properties.document.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaChunk.properties.annotationContents (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1alphaGetConnectorSecretResponse (Total Keys: 7) - schemas.GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion.properties.document.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaSearchLinkPromotion.properties.document.type (Total Keys: 1) #### discoveryengine:v1beta The following keys were added: - schemas.GoogleCloudDiscoveryengineV1SearchLinkPromotion.properties.document.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion.properties.document.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaChunk.properties.annotationContents (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1betaSearchLinkPromotion.properties.document.type (Total Keys: 1)
1 parent d8d04b1 commit ef9affe

File tree

46 files changed

+840
-300
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+840
-300
lines changed

docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html

Lines changed: 14 additions & 14 deletions
Large diffs are not rendered by default.

docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.controls.html

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ <h3>Method Details</h3>
139139
&quot;startTime&quot;: &quot;A String&quot;, # Start of time range. Range is inclusive.
140140
},
141141
],
142-
&quot;queryRegex&quot;: &quot;A String&quot;, # 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+
&quot;queryRegex&quot;: &quot;A String&quot;, # 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.
143143
&quot;queryTerms&quot;: [ # 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.
144144
{ # Matcher for search request query
145145
&quot;fullMatch&quot;: True or False, # Whether the search query needs to exactly match the query term.
@@ -158,6 +158,7 @@ <h3>Method Details</h3>
158158
&quot;dataStore&quot;: &quot;A String&quot;, # Required. Data store with which this promotion is attached to.
159159
&quot;searchLinkPromotion&quot;: { # Promotion proto includes uri and other helping information to display the promotion. # Required. Promotion attached to this action.
160160
&quot;description&quot;: &quot;A String&quot;, # Optional. The Promotion description. Maximum length: 200 characters.
161+
&quot;document&quot;: &quot;A String&quot;, # Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.
161162
&quot;enabled&quot;: 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.
162163
&quot;imageUri&quot;: &quot;A String&quot;, # Optional. The promotion thumbnail image url.
163164
&quot;title&quot;: &quot;A String&quot;, # Required. The title of the promotion. Maximum length: 160 characters.
@@ -216,7 +217,7 @@ <h3>Method Details</h3>
216217
&quot;startTime&quot;: &quot;A String&quot;, # Start of time range. Range is inclusive.
217218
},
218219
],
219-
&quot;queryRegex&quot;: &quot;A String&quot;, # 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+
&quot;queryRegex&quot;: &quot;A String&quot;, # 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.
220221
&quot;queryTerms&quot;: [ # 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.
221222
{ # Matcher for search request query
222223
&quot;fullMatch&quot;: True or False, # Whether the search query needs to exactly match the query term.
@@ -235,6 +236,7 @@ <h3>Method Details</h3>
235236
&quot;dataStore&quot;: &quot;A String&quot;, # Required. Data store with which this promotion is attached to.
236237
&quot;searchLinkPromotion&quot;: { # Promotion proto includes uri and other helping information to display the promotion. # Required. Promotion attached to this action.
237238
&quot;description&quot;: &quot;A String&quot;, # Optional. The Promotion description. Maximum length: 200 characters.
239+
&quot;document&quot;: &quot;A String&quot;, # Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.
238240
&quot;enabled&quot;: 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.
239241
&quot;imageUri&quot;: &quot;A String&quot;, # Optional. The promotion thumbnail image url.
240242
&quot;title&quot;: &quot;A String&quot;, # Required. The title of the promotion. Maximum length: 160 characters.
@@ -317,7 +319,7 @@ <h3>Method Details</h3>
317319
&quot;startTime&quot;: &quot;A String&quot;, # Start of time range. Range is inclusive.
318320
},
319321
],
320-
&quot;queryRegex&quot;: &quot;A String&quot;, # 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+
&quot;queryRegex&quot;: &quot;A String&quot;, # 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.
321323
&quot;queryTerms&quot;: [ # 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.
322324
{ # Matcher for search request query
323325
&quot;fullMatch&quot;: True or False, # Whether the search query needs to exactly match the query term.
@@ -336,6 +338,7 @@ <h3>Method Details</h3>
336338
&quot;dataStore&quot;: &quot;A String&quot;, # Required. Data store with which this promotion is attached to.
337339
&quot;searchLinkPromotion&quot;: { # Promotion proto includes uri and other helping information to display the promotion. # Required. Promotion attached to this action.
338340
&quot;description&quot;: &quot;A String&quot;, # Optional. The Promotion description. Maximum length: 200 characters.
341+
&quot;document&quot;: &quot;A String&quot;, # Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.
339342
&quot;enabled&quot;: 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.
340343
&quot;imageUri&quot;: &quot;A String&quot;, # Optional. The promotion thumbnail image url.
341344
&quot;title&quot;: &quot;A String&quot;, # Required. The title of the promotion. Maximum length: 160 characters.
@@ -405,7 +408,7 @@ <h3>Method Details</h3>
405408
&quot;startTime&quot;: &quot;A String&quot;, # Start of time range. Range is inclusive.
406409
},
407410
],
408-
&quot;queryRegex&quot;: &quot;A String&quot;, # 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+
&quot;queryRegex&quot;: &quot;A String&quot;, # 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.
409412
&quot;queryTerms&quot;: [ # 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.
410413
{ # Matcher for search request query
411414
&quot;fullMatch&quot;: True or False, # Whether the search query needs to exactly match the query term.
@@ -424,6 +427,7 @@ <h3>Method Details</h3>
424427
&quot;dataStore&quot;: &quot;A String&quot;, # Required. Data store with which this promotion is attached to.
425428
&quot;searchLinkPromotion&quot;: { # Promotion proto includes uri and other helping information to display the promotion. # Required. Promotion attached to this action.
426429
&quot;description&quot;: &quot;A String&quot;, # Optional. The Promotion description. Maximum length: 200 characters.
430+
&quot;document&quot;: &quot;A String&quot;, # Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.
427431
&quot;enabled&quot;: 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.
428432
&quot;imageUri&quot;: &quot;A String&quot;, # Optional. The promotion thumbnail image url.
429433
&quot;title&quot;: &quot;A String&quot;, # Required. The title of the promotion. Maximum length: 160 characters.
@@ -500,7 +504,7 @@ <h3>Method Details</h3>
500504
&quot;startTime&quot;: &quot;A String&quot;, # Start of time range. Range is inclusive.
501505
},
502506
],
503-
&quot;queryRegex&quot;: &quot;A String&quot;, # 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+
&quot;queryRegex&quot;: &quot;A String&quot;, # 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.
504508
&quot;queryTerms&quot;: [ # 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.
505509
{ # Matcher for search request query
506510
&quot;fullMatch&quot;: True or False, # Whether the search query needs to exactly match the query term.
@@ -519,6 +523,7 @@ <h3>Method Details</h3>
519523
&quot;dataStore&quot;: &quot;A String&quot;, # Required. Data store with which this promotion is attached to.
520524
&quot;searchLinkPromotion&quot;: { # Promotion proto includes uri and other helping information to display the promotion. # Required. Promotion attached to this action.
521525
&quot;description&quot;: &quot;A String&quot;, # Optional. The Promotion description. Maximum length: 200 characters.
526+
&quot;document&quot;: &quot;A String&quot;, # Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.
522527
&quot;enabled&quot;: 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.
523528
&quot;imageUri&quot;: &quot;A String&quot;, # Optional. The promotion thumbnail image url.
524529
&quot;title&quot;: &quot;A String&quot;, # Required. The title of the promotion. Maximum length: 160 characters.
@@ -577,7 +582,7 @@ <h3>Method Details</h3>
577582
&quot;startTime&quot;: &quot;A String&quot;, # Start of time range. Range is inclusive.
578583
},
579584
],
580-
&quot;queryRegex&quot;: &quot;A String&quot;, # 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+
&quot;queryRegex&quot;: &quot;A String&quot;, # 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.
581586
&quot;queryTerms&quot;: [ # 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.
582587
{ # Matcher for search request query
583588
&quot;fullMatch&quot;: True or False, # Whether the search query needs to exactly match the query term.
@@ -596,6 +601,7 @@ <h3>Method Details</h3>
596601
&quot;dataStore&quot;: &quot;A String&quot;, # Required. Data store with which this promotion is attached to.
597602
&quot;searchLinkPromotion&quot;: { # Promotion proto includes uri and other helping information to display the promotion. # Required. Promotion attached to this action.
598603
&quot;description&quot;: &quot;A String&quot;, # Optional. The Promotion description. Maximum length: 200 characters.
604+
&quot;document&quot;: &quot;A String&quot;, # Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.
599605
&quot;enabled&quot;: 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.
600606
&quot;imageUri&quot;: &quot;A String&quot;, # Optional. The promotion thumbnail image url.
601607
&quot;title&quot;: &quot;A String&quot;, # Required. The title of the promotion. Maximum length: 160 characters.

docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.conversations.html

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -355,6 +355,9 @@ <h3>Method Details</h3>
355355
&quot;searchResults&quot;: [ # Search Results.
356356
{ # Represents the search results.
357357
&quot;chunk&quot;: { # 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+
&quot;annotationContents&quot;: [ # Output only. Annotation contents if the current chunk contains annotations.
359+
&quot;A String&quot;,
360+
],
358361
&quot;chunkMetadata&quot;: { # Metadata of the current chunk. This field is only populated on SearchService.Search API. # Output only. Metadata of the current chunk.
359362
&quot;nextChunks&quot;: [ # 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.
360363
# Object with schema name: GoogleCloudDiscoveryengineV1Chunk
@@ -364,6 +367,9 @@ <h3>Method Details</h3>
364367
],
365368
},
366369
&quot;content&quot;: &quot;A String&quot;, # Content is a string from a document (parsed content).
370+
&quot;dataUrls&quot;: [ # 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+
&quot;A String&quot;,
372+
],
367373
&quot;derivedStructData&quot;: { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
368374
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
369375
},
@@ -396,8 +402,8 @@ <h3>Method Details</h3>
396402
},
397403
],
398404
},
399-
&quot;content&quot;: { # 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-
&quot;mimeType&quot;: &quot;A String&quot;, # 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+
&quot;content&quot;: { # 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+
&quot;mimeType&quot;: &quot;A String&quot;, # 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.
401407
&quot;rawBytes&quot;: &quot;A String&quot;, # 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!?$*&amp;()&#x27;-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
402408
&quot;uri&quot;: &quot;A String&quot;, # 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.
403409
},

0 commit comments

Comments
 (0)