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.servingConfigs.html
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -153,7 +153,7 @@ <h3>Method Details</h3>
153
153
"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
154
154
"maxReturnResults": 42, # Number of search results to return. The default value is 10.
155
155
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
156
-
"searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)
156
+
"searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)
157
157
},
158
158
"searchResultList": { # Search result list. # Search result list.
159
159
"searchResults": [ # Search results.
@@ -205,7 +205,7 @@ <h3>Method Details</h3>
205
205
An object of the form:
206
206
207
207
{ # Response message for ConversationalSearchService.AnswerQuery method.
208
-
"answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API.
208
+
"answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API.
209
209
"answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
210
210
"A String",
211
211
],
@@ -289,7 +289,7 @@ <h3>Method Details</h3>
289
289
"snippetStatus": "A String", # Status of the snippet defined by the search team.
290
290
},
291
291
],
292
-
"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
+
"structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .
293
293
"a_key": "", # Properties of the object.
294
294
},
295
295
"title": "A String", # Title.
@@ -505,7 +505,7 @@ <h3>Method Details</h3>
505
505
"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
506
506
"returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
507
507
},
508
-
"searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.
508
+
"searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
509
509
"snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
510
510
"maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
511
511
"referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -184,7 +184,7 @@ <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).
187
+
"structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .
188
188
"a_key": "", # Properties of the object.
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -153,7 +153,7 @@ <h3>Method Details</h3>
153
153
"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
154
154
"maxReturnResults": 42, # Number of search results to return. The default value is 10.
155
155
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
156
-
"searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)
156
+
"searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)
157
157
},
158
158
"searchResultList": { # Search result list. # Search result list.
159
159
"searchResults": [ # Search results.
@@ -205,7 +205,7 @@ <h3>Method Details</h3>
205
205
An object of the form:
206
206
207
207
{ # Response message for ConversationalSearchService.AnswerQuery method.
208
-
"answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API.
208
+
"answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API.
209
209
"answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
210
210
"A String",
211
211
],
@@ -289,7 +289,7 @@ <h3>Method Details</h3>
289
289
"snippetStatus": "A String", # Status of the snippet defined by the search team.
290
290
},
291
291
],
292
-
"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
+
"structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .
293
293
"a_key": "", # Properties of the object.
294
294
},
295
295
"title": "A String", # Title.
@@ -505,7 +505,7 @@ <h3>Method Details</h3>
505
505
"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
506
506
"returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
507
507
},
508
-
"searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.
508
+
"searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
509
509
"snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
510
510
"maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
511
511
"referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -184,7 +184,7 @@ <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).
187
+
"structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .
188
188
"a_key": "", # Properties of the object.
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -153,7 +153,7 @@ <h3>Method Details</h3>
153
153
"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
154
154
"maxReturnResults": 42, # Number of search results to return. The default value is 10.
155
155
"orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
156
-
"searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)
156
+
"searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)
157
157
},
158
158
"searchResultList": { # Search result list. # Search result list.
159
159
"searchResults": [ # Search results.
@@ -205,7 +205,7 @@ <h3>Method Details</h3>
205
205
An object of the form:
206
206
207
207
{ # Response message for ConversationalSearchService.AnswerQuery method.
208
-
"answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API.
208
+
"answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API.
209
209
"answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
210
210
"A String",
211
211
],
@@ -289,7 +289,7 @@ <h3>Method Details</h3>
289
289
"snippetStatus": "A String", # Status of the snippet defined by the search team.
290
290
},
291
291
],
292
-
"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
+
"structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .
293
293
"a_key": "", # Properties of the object.
294
294
},
295
295
"title": "A String", # Title.
@@ -505,7 +505,7 @@ <h3>Method Details</h3>
505
505
"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
506
506
"returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
507
507
},
508
-
"searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.
508
+
"searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
509
509
"snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
510
510
"maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
511
511
"referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -184,7 +184,7 @@ <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).
187
+
"structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .
188
188
"a_key": "", # Properties of the object.
0 commit comments