Skip to content

Commit 0c7f11b

Browse files
feat(discoveryengine): update the api
#### discoveryengine:v1 The following keys were added: - schemas.GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult.properties.structData (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1SearchRequest.properties.searchAsYouTypeSpec.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1SearchRequest.properties.session (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1SearchRequestSessionSpec (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1SearchResponse.properties.sessionInfo.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1SearchResponseSessionInfo (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult.properties.structData (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaCustomTuningModel.properties.createTime.deprecated (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaCustomTuningModel.properties.metrics (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1betaCustomTuningModel.properties.createTime.deprecated (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaCustomTuningModel.properties.metrics (Total Keys: 3) #### discoveryengine:v1alpha The following keys were added: - schemas.GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult.properties.structData (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaCustomTuningModel.properties.createTime.deprecated (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaCustomTuningModel.properties.metrics (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.naturalLanguageQueryUnderstandingSpec.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.session (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponse.properties.naturalLanguageQueryUnderstandingInfo.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponse.properties.sessionInfo.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo (Total Keys: 40) - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1betaCustomTuningModel.properties.createTime.deprecated (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaCustomTuningModel.properties.metrics (Total Keys: 3) #### discoveryengine:v1beta The following keys were added: - resources.projects.resources.locations.resources.evaluations.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.sampleQuerySets.resources.operations.methods.get (Total Keys: 11) - schemas.GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult.properties.structData (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaCustomTuningModel.properties.createTime.deprecated (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaCustomTuningModel.properties.metrics (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResult.properties.structData (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1betaCustomTuningModel.properties.createTime.deprecated (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaCustomTuningModel.properties.metrics (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.naturalLanguageQueryUnderstandingSpec.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.searchAsYouTypeSpec.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.session (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1betaSearchResponse.properties.naturalLanguageQueryUnderstandingInfo.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaSearchResponse.properties.sessionInfo.$ref (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo (Total Keys: 40) - schemas.GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo (Total Keys: 4)
1 parent a9c4b03 commit 0c7f11b

File tree

35 files changed

+1714
-134
lines changed

35 files changed

+1714
-134
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ <h3>Method Details</h3>
232232
},
233233
},
234234
&quot;name&quot;: &quot;A String&quot;, # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
235-
&quot;parsingConfigOverrides&quot;: { # Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.
235+
&quot;parsingConfigOverrides&quot;: { # Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.
236236
&quot;a_key&quot;: { # Related configurations applied to a specific type of document parser.
237237
&quot;digitalParsingConfig&quot;: { # The digital parsing configurations for documents. # Configurations applied to digital parser.
238238
},
@@ -366,7 +366,7 @@ <h3>Method Details</h3>
366366
},
367367
},
368368
&quot;name&quot;: &quot;A String&quot;, # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
369-
&quot;parsingConfigOverrides&quot;: { # Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.
369+
&quot;parsingConfigOverrides&quot;: { # Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.
370370
&quot;a_key&quot;: { # Related configurations applied to a specific type of document parser.
371371
&quot;digitalParsingConfig&quot;: { # The digital parsing configurations for documents. # Configurations applied to digital parser.
372372
},
@@ -459,7 +459,7 @@ <h3>Method Details</h3>
459459
},
460460
},
461461
&quot;name&quot;: &quot;A String&quot;, # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
462-
&quot;parsingConfigOverrides&quot;: { # Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.
462+
&quot;parsingConfigOverrides&quot;: { # Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.
463463
&quot;a_key&quot;: { # Related configurations applied to a specific type of document parser.
464464
&quot;digitalParsingConfig&quot;: { # The digital parsing configurations for documents. # Configurations applied to digital parser.
465465
},
@@ -540,7 +540,7 @@ <h3>Method Details</h3>
540540
},
541541
},
542542
&quot;name&quot;: &quot;A String&quot;, # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
543-
&quot;parsingConfigOverrides&quot;: { # Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.
543+
&quot;parsingConfigOverrides&quot;: { # Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.
544544
&quot;a_key&quot;: { # Related configurations applied to a specific type of document parser.
545545
&quot;digitalParsingConfig&quot;: { # The digital parsing configurations for documents. # Configurations applied to digital parser.
546546
},
@@ -603,7 +603,7 @@ <h3>Method Details</h3>
603603
},
604604
},
605605
&quot;name&quot;: &quot;A String&quot;, # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
606-
&quot;parsingConfigOverrides&quot;: { # Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.
606+
&quot;parsingConfigOverrides&quot;: { # Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.
607607
&quot;a_key&quot;: { # Related configurations applied to a specific type of document parser.
608608
&quot;digitalParsingConfig&quot;: { # The digital parsing configurations for documents. # Configurations applied to digital parser.
609609
},

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

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ <h3>Method Details</h3>
145145
],
146146
},
147147
&quot;dataStoreSpecs&quot;: [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
148-
{ # A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
148+
{ # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
149149
&quot;dataStore&quot;: &quot;A String&quot;, # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
150150
},
151151
],
@@ -288,6 +288,9 @@ <h3>Method Details</h3>
288288
&quot;snippetStatus&quot;: &quot;A String&quot;, # Status of the snippet defined by the search team.
289289
},
290290
],
291+
&quot;structData&quot;: { # Data representation. The structured JSON data for the document. It&#x27;s populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL).
292+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
293+
},
291294
&quot;title&quot;: &quot;A String&quot;, # Title.
292295
&quot;uri&quot;: &quot;A String&quot;, # URI for the document.
293296
},
@@ -523,7 +526,7 @@ <h3>Method Details</h3>
523526
},
524527
},
525528
&quot;dataStoreSpecs&quot;: [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
526-
{ # A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
529+
{ # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
527530
&quot;dataStore&quot;: &quot;A String&quot;, # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
528531
},
529532
],
@@ -576,6 +579,14 @@ <h3>Method Details</h3>
576579
&quot;pinUnexpandedResults&quot;: True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
577580
},
578581
&quot;safeSearch&quot;: True or False, # Whether to turn on safe search. This is only supported for website search.
582+
&quot;searchAsYouTypeSpec&quot;: { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
583+
&quot;condition&quot;: &quot;A String&quot;, # The condition under which search as you type should occur. Default to Condition.DISABLED.
584+
},
585+
&quot;session&quot;: &quot;A String&quot;, # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is &quot;How did Alphabet do in 2022?&quot; and the current query is &quot;How about 2023?&quot;, the current query will be interpreted as &quot;How did Alphabet do in 2023?&quot;. Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
586+
&quot;sessionSpec&quot;: { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set.
587+
&quot;queryId&quot;: &quot;A String&quot;, # If set, the search result gets stored to the &quot;turn&quot; specified by this query ID. Example: Let&#x27;s say the session looks like this: session { name: &quot;.../sessions/xxx&quot; turns { query { text: &quot;What is foo?&quot; query_id: &quot;.../questions/yyy&quot; } answer: &quot;Foo is ...&quot; } turns { query { text: &quot;How about bar then?&quot; query_id: &quot;.../questions/zzz&quot; } } } The user can call /search API with a request like this: session: &quot;.../sessions/xxx&quot; session_spec { query_id: &quot;.../questions/zzz&quot; } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID &amp; query ID.
588+
&quot;searchResultPersistenceCount&quot;: 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.
589+
},
579590
&quot;spellCorrectionSpec&quot;: { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
580591
&quot;mode&quot;: &quot;A String&quot;, # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
581592
},
@@ -676,6 +687,10 @@ <h3>Method Details</h3>
676687
&quot;id&quot;: &quot;A String&quot;, # Document.id of the searched Document.
677688
},
678689
],
690+
&quot;sessionInfo&quot;: { # Information about the session. # Session information. Only set if SearchRequest.session is provided. See its description for more details.
691+
&quot;name&quot;: &quot;A String&quot;, # Name of the session. If the auto-session mode is used (when SearchRequest.session ends with &quot;-&quot;), this field holds the newly generated session name.
692+
&quot;queryId&quot;: &quot;A String&quot;, # Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call.
693+
},
679694
&quot;summary&quot;: { # Summary of the top N search results specified by the summary spec. # A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.
680695
&quot;safetyAttributes&quot;: { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
681696
&quot;categories&quot;: [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.

docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,9 @@ <h3>Method Details</h3>
184184
&quot;snippetStatus&quot;: &quot;A String&quot;, # Status of the snippet defined by the search team.
185185
},
186186
],
187+
&quot;structData&quot;: { # Data representation. The structured JSON data for the document. It&#x27;s populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL).
188+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
189+
},
187190
&quot;title&quot;: &quot;A String&quot;, # Title.
188191
&quot;uri&quot;: &quot;A String&quot;, # URI for the document.
189192
},

0 commit comments

Comments
 (0)