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.html
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -232,7 +232,7 @@ <h3>Method Details</h3>
232
232
},
233
233
},
234
234
"name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
235
-
"parsingConfigOverrides": { # 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
+
"parsingConfigOverrides": { # 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.
236
236
"a_key": { # Related configurations applied to a specific type of document parser.
237
237
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
238
238
},
@@ -366,7 +366,7 @@ <h3>Method Details</h3>
366
366
},
367
367
},
368
368
"name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
369
-
"parsingConfigOverrides": { # 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
+
"parsingConfigOverrides": { # 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.
370
370
"a_key": { # Related configurations applied to a specific type of document parser.
371
371
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
372
372
},
@@ -459,7 +459,7 @@ <h3>Method Details</h3>
459
459
},
460
460
},
461
461
"name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
462
-
"parsingConfigOverrides": { # 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
+
"parsingConfigOverrides": { # 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.
463
463
"a_key": { # Related configurations applied to a specific type of document parser.
464
464
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
465
465
},
@@ -540,7 +540,7 @@ <h3>Method Details</h3>
540
540
},
541
541
},
542
542
"name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
543
-
"parsingConfigOverrides": { # 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
+
"parsingConfigOverrides": { # 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.
544
544
"a_key": { # Related configurations applied to a specific type of document parser.
545
545
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
546
546
},
@@ -603,7 +603,7 @@ <h3>Method Details</h3>
603
603
},
604
604
},
605
605
"name": "A String", # The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
606
-
"parsingConfigOverrides": { # 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
+
"parsingConfigOverrides": { # 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.
607
607
"a_key": { # Related configurations applied to a specific type of document parser.
608
608
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser.
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html
+17-2Lines changed: 17 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -145,7 +145,7 @@ <h3>Method Details</h3>
145
145
],
146
146
},
147
147
"dataStoreSpecs": [ # 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.
149
149
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
150
150
},
151
151
],
@@ -288,6 +288,9 @@ <h3>Method Details</h3>
288
288
"snippetStatus": "A String", # Status of the snippet defined by the search team.
289
289
},
290
290
],
291
+
"structData": { # Data representation. The structured JSON data for the document. It'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
+
"a_key": "", # Properties of the object.
293
+
},
291
294
"title": "A String", # Title.
292
295
"uri": "A String", # URI for the document.
293
296
},
@@ -523,7 +526,7 @@ <h3>Method Details</h3>
523
526
},
524
527
},
525
528
"dataStoreSpecs": [ # 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.
527
530
"dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
528
531
},
529
532
],
@@ -576,6 +579,14 @@ <h3>Method Details</h3>
576
579
"pinUnexpandedResults": 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.
577
580
},
578
581
"safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
582
+
"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
583
+
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
584
+
},
585
+
"session": "A String", # 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 "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". 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
+
"sessionSpec": { # 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
+
"queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } 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 & query ID.
588
+
"searchResultPersistenceCount": 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
+
},
579
590
"spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
580
591
"mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
581
592
},
@@ -676,6 +687,10 @@ <h3>Method Details</h3>
676
687
"id": "A String", # Document.id of the searched Document.
677
688
},
678
689
],
690
+
"sessionInfo": { # Information about the session. # Session information. Only set if SearchRequest.session is provided. See its description for more details.
691
+
"name": "A String", # Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name.
692
+
"queryId": "A String", # 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
+
},
679
694
"summary": { # 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.
680
695
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
681
696
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html
+3Lines changed: 3 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -184,6 +184,9 @@ <h3>Method Details</h3>
184
184
"snippetStatus": "A String", # Status of the snippet defined by the search team.
185
185
},
186
186
],
187
+
"structData": { # Data representation. The structured JSON data for the document. It'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
+
"a_key": "", # Properties of the object.
189
+
},
187
190
"title": "A String", # Title.
188
191
"uri": "A String", # URI for the document.
0 commit comments