Skip to content

Commit 092bfce

Browse files
feat(discoveryengine): update the api
#### discoveryengine:v1 The following keys were added: - resources.projects.resources.locations.resources.userEvents.methods.collect (Total Keys: 18) - schemas.GoogleCloudDiscoveryengineV1AlloyDbSource (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1AnswerQueryRequest.properties.userLabels (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams.properties.searchResultMode.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1Chunk (Total Keys: 32) - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfig.properties.chunkingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig.properties.layoutParsingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1ImportDocumentsRequest.properties.alloyDbSource.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec.properties.chunkSpec.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec.properties.searchResultMode.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1SearchResponseSearchResult.properties.chunk.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig.properties.chunkingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig.properties.layoutParsingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig (Total Keys: 2) #### discoveryengine:v1alpha The following keys were added: - resources.projects.resources.locations.resources.requirements.methods.checkRequirement (Total Keys: 12) - resources.projects.resources.locations.resources.userEvents.methods.collect (Total Keys: 18) - schemas.GoogleApiDistribution (Total Keys: 56) - schemas.GoogleApiMonitoredResource (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfig.properties.chunkingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig.properties.layoutParsingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaAlloyDbSource (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest.properties.userLabels (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse (Total Keys: 17) - schemas.GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest.properties.alloyDbSource.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaRequirement (Total Keys: 28) - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig.properties.chunkingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig.properties.layoutParsingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig (Total Keys: 2) - schemas.GoogleMonitoringV3TypedValue (Total Keys: 9) - schemas.GoogleTypeExpr (Total Keys: 4) #### discoveryengine:v1beta The following keys were added: - resources.projects.resources.locations.resources.userEvents.methods.collect (Total Keys: 18) - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfig.properties.chunkingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig.properties.layoutParsingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1betaAlloyDbSource (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1betaAnswerQueryRequest.properties.userLabels (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams.properties.searchResultMode.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaChunk (Total Keys: 32) - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig.properties.chunkingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig.properties.layoutParsingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1betaImportDocumentsRequest.properties.alloyDbSource.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec.properties.chunkSpec.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec.properties.searchResultMode.type (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec (Total Keys: 6) - schemas.GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult.properties.chunk.$ref (Total Keys: 1)
1 parent da84cc4 commit 092bfce

File tree

42 files changed

+2370
-55
lines changed

Some content is hidden

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

42 files changed

+2370
-55
lines changed

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,14 @@ <h3>Method Details</h3>
229229
The object takes the form of:
230230

231231
{ # Request message for Import methods.
232+
&quot;alloyDbSource&quot;: { # AlloyDB source import data from. # AlloyDB input source.
233+
&quot;clusterId&quot;: &quot;A String&quot;, # Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.
234+
&quot;databaseId&quot;: &quot;A String&quot;, # Required. The AlloyDB database to copy the data from with a length limit of 256 characters.
235+
&quot;gcsStagingDir&quot;: &quot;A String&quot;, # 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 AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.
236+
&quot;locationId&quot;: &quot;A String&quot;, # Required. The AlloyDB location to copy the data from with a length limit of 256 characters.
237+
&quot;projectId&quot;: &quot;A String&quot;, # The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
238+
&quot;tableId&quot;: &quot;A String&quot;, # Required. The AlloyDB table to copy the data from with a length limit of 256 characters.
239+
},
232240
&quot;autoGenerateIds&quot;: True or False, # 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.
233241
&quot;bigquerySource&quot;: { # BigQuery source import data from. # BigQuery input source.
234242
&quot;dataSchema&quot;: &quot;A String&quot;, # 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.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ <h3>Method Details</h3>
106106
<pre>Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.
107107

108108
Args:
109-
parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` (required)
109+
parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. (required)
110110
body: object, The request body.
111111
The object takes the form of:
112112

@@ -293,7 +293,7 @@ <h3>Method Details</h3>
293293
<pre>Lists all Controls by their parent DataStore.
294294

295295
Args:
296-
parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` (required)
296+
parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. (required)
297297
filter: string, Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.
298298
pageSize: integer, Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
299299
pageToken: string, Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -341,6 +341,34 @@ <h3>Method Details</h3>
341341
},
342342
&quot;searchResults&quot;: [ # Search Results.
343343
{ # Represents the search results.
344+
&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.
345+
&quot;chunkMetadata&quot;: { # Metadata of the current chunk. This field is only populated on SearchService.Search API. # Output only. Metadata of the current chunk.
346+
&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.
347+
# Object with schema name: GoogleCloudDiscoveryengineV1Chunk
348+
],
349+
&quot;previousChunks&quot;: [ # The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API.
350+
# Object with schema name: GoogleCloudDiscoveryengineV1Chunk
351+
],
352+
},
353+
&quot;content&quot;: &quot;A String&quot;, # Content is a string from a document (parsed content).
354+
&quot;derivedStructData&quot;: { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
355+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
356+
},
357+
&quot;documentMetadata&quot;: { # Document metadata contains the information of the document of the current chunk. # Metadata of the document from the current chunk.
358+
&quot;structData&quot;: { # Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
359+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
360+
},
361+
&quot;title&quot;: &quot;A String&quot;, # Title of the document.
362+
&quot;uri&quot;: &quot;A String&quot;, # Uri of the document.
363+
},
364+
&quot;id&quot;: &quot;A String&quot;, # Unique chunk ID of the current chunk.
365+
&quot;name&quot;: &quot;A String&quot;, # 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.
366+
&quot;pageSpan&quot;: { # Page span of the chunk. # Page span of the chunk.
367+
&quot;pageEnd&quot;: 42, # The end page of the chunk.
368+
&quot;pageStart&quot;: 42, # The start page of the chunk.
369+
},
370+
&quot;relevanceScore&quot;: 3.14, # Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse.
371+
},
344372
&quot;document&quot;: { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as `retrievable` are populated.
345373
&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.
346374
&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.

0 commit comments

Comments
 (0)