Skip to content

Commit

Permalink
feat(discoveryengine): update the api
Browse files Browse the repository at this point in the history
#### discoveryengine:v1

The following keys were added:
- resources.projects.resources.locations.resources.identity_mapping_stores.resources.operations.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.identity_mapping_stores.resources.operations.methods.list (Total Keys: 18)
- schemas.GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec (Total Keys: 3)
- schemas.GoogleCloudDiscoveryengineV1alphaEvaluation (Total Keys: 26)
- schemas.GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata (Total Keys: 12)
- schemas.GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1alphaInterval (Total Keys: 10)
- schemas.GoogleCloudDiscoveryengineV1alphaQualityMetrics (Total Keys: 17)
- schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest (Total Keys: 167)
- schemas.GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata (Total Keys: 6)
- schemas.GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1alphaUserInfo (Total Keys: 4)
- schemas.GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1betaEvaluation (Total Keys: 26)
- schemas.GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata (Total Keys: 12)
- schemas.GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1betaInterval (Total Keys: 10)
- schemas.GoogleCloudDiscoveryengineV1betaQualityMetrics (Total Keys: 17)
- schemas.GoogleCloudDiscoveryengineV1betaSearchRequest (Total Keys: 165)
- schemas.GoogleCloudDiscoveryengineV1betaUserInfo (Total Keys: 4)

#### discoveryengine:v1alpha

The following keys were added:
- resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.getUriPatternDocumentData (Total Keys: 11)
- resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.setUriPatternDocumentData (Total Keys: 12)
- resources.projects.resources.locations.resources.evaluations.methods.create (Total Keys: 12)
- resources.projects.resources.locations.resources.evaluations.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.evaluations.methods.list (Total Keys: 32)
- resources.projects.resources.locations.resources.identity_mapping_stores.resources.operations.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.identity_mapping_stores.resources.operations.methods.list (Total Keys: 18)
- resources.projects.resources.locations.resources.sampleQuerySets.methods.create (Total Keys: 14)
- resources.projects.resources.locations.resources.sampleQuerySets.methods.delete (Total Keys: 11)
- resources.projects.resources.locations.resources.sampleQuerySets.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.sampleQuerySets.methods.list (Total Keys: 16)
- resources.projects.resources.locations.resources.sampleQuerySets.methods.patch (Total Keys: 15)
- resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.create (Total Keys: 14)
- resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.delete (Total Keys: 11)
- resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.import (Total Keys: 12)
- resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.list (Total Keys: 16)
- resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.patch (Total Keys: 15)
- schemas.GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1alphaEvaluation (Total Keys: 26)
- schemas.GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata (Total Keys: 12)
- schemas.GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest (Total Keys: 10)
- schemas.GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse (Total Keys: 11)
- schemas.GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1alphaQualityMetrics (Total Keys: 17)
- schemas.GoogleCloudDiscoveryengineV1alphaSampleQuery (Total Keys: 24)
- schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.servingConfig.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata (Total Keys: 6)
- schemas.GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest (Total Keys: 8)
- schemas.GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1betaEvaluation (Total Keys: 26)
- schemas.GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata (Total Keys: 12)
- schemas.GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1betaInterval (Total Keys: 10)
- schemas.GoogleCloudDiscoveryengineV1betaQualityMetrics (Total Keys: 17)
- schemas.GoogleCloudDiscoveryengineV1betaSearchRequest (Total Keys: 165)
- schemas.GoogleCloudDiscoveryengineV1betaUserInfo (Total Keys: 4)

#### discoveryengine:v1beta

The following keys were added:
- resources.projects.resources.locations.resources.evaluations.methods.create (Total Keys: 12)
- resources.projects.resources.locations.resources.evaluations.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.evaluations.methods.list (Total Keys: 32)
- resources.projects.resources.locations.resources.sampleQuerySets.methods.create (Total Keys: 14)
- resources.projects.resources.locations.resources.sampleQuerySets.methods.delete (Total Keys: 11)
- resources.projects.resources.locations.resources.sampleQuerySets.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.sampleQuerySets.methods.list (Total Keys: 16)
- resources.projects.resources.locations.resources.sampleQuerySets.methods.patch (Total Keys: 15)
- resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.create (Total Keys: 14)
- resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.delete (Total Keys: 11)
- resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.import (Total Keys: 12)
- resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.list (Total Keys: 16)
- resources.projects.resources.locations.resources.sampleQuerySets.resources.sampleQueries.methods.patch (Total Keys: 15)
- schemas.GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec (Total Keys: 3)
- schemas.GoogleCloudDiscoveryengineV1alphaEvaluation (Total Keys: 26)
- schemas.GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata (Total Keys: 12)
- schemas.GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1alphaInterval (Total Keys: 10)
- schemas.GoogleCloudDiscoveryengineV1alphaQualityMetrics (Total Keys: 17)
- schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest (Total Keys: 167)
- schemas.GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata (Total Keys: 6)
- schemas.GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1alphaUserInfo (Total Keys: 4)
- schemas.GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1betaEvaluation (Total Keys: 26)
- schemas.GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata (Total Keys: 12)
- schemas.GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest (Total Keys: 10)
- schemas.GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse (Total Keys: 11)
- schemas.GoogleCloudDiscoveryengineV1betaListEvaluationsResponse (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1betaQualityMetrics (Total Keys: 17)
- schemas.GoogleCloudDiscoveryengineV1betaSampleQuery (Total Keys: 24)
- schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.servingConfig.type (Total Keys: 1)
  • Loading branch information
yoshi-automation committed Jul 25, 2024
1 parent 187dccd commit ba150f2
Show file tree
Hide file tree
Showing 32 changed files with 12,664 additions and 3,857 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ <h3>Method Details</h3>
&quot;filter&quot;: &quot;A String&quot;, # 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 &#x27;name&#x27; in their schema. In this case the filter would look like this: filter --&gt; name:&#x27;ANY(&quot;king kong&quot;)&#x27; For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
&quot;maxReturnResults&quot;: 42, # Number of search results to return. The default value is 10.
&quot;orderBy&quot;: &quot;A String&quot;, # 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.
&quot;searchResultMode&quot;: &quot;A String&quot;, # 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)
&quot;searchResultMode&quot;: &quot;A String&quot;, # 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)
},
&quot;searchResultList&quot;: { # Search result list. # Search result list.
&quot;searchResults&quot;: [ # Search results.
Expand Down Expand Up @@ -205,7 +205,7 @@ <h3>Method Details</h3>
An object of the form:

{ # Response message for ConversationalSearchService.AnswerQuery method.
&quot;answer&quot;: { # 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.
&quot;answer&quot;: { # 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.
&quot;answerSkippedReasons&quot;: [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
&quot;A String&quot;,
],
Expand Down Expand Up @@ -289,7 +289,7 @@ <h3>Method Details</h3>
&quot;snippetStatus&quot;: &quot;A String&quot;, # Status of the snippet defined by the search team.
},
],
&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).
&quot;structData&quot;: { # Data representation. The structured JSON data for the document. It&#x27;s populated from the struct data from the Document , or the Chunk in search result .
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;title&quot;: &quot;A String&quot;, # Title.
Expand Down Expand Up @@ -505,7 +505,7 @@ <h3>Method Details</h3>
&quot;numPreviousSegments&quot;: 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
&quot;returnExtractiveSegmentScore&quot;: 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`.
},
&quot;searchResultMode&quot;: &quot;A String&quot;, # 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`.
&quot;searchResultMode&quot;: &quot;A String&quot;, # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
&quot;snippetSpec&quot;: { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
&quot;maxSnippetCount&quot;: 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 &gt; 0.
&quot;referenceOnly&quot;: True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ <h3>Method Details</h3>
&quot;snippetStatus&quot;: &quot;A String&quot;, # Status of the snippet defined by the search team.
},
],
&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).
&quot;structData&quot;: { # Data representation. The structured JSON data for the document. It&#x27;s populated from the struct data from the Document , or the Chunk in search result .
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;title&quot;: &quot;A String&quot;, # Title.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ <h3>Method Details</h3>
&quot;filter&quot;: &quot;A String&quot;, # 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 &#x27;name&#x27; in their schema. In this case the filter would look like this: filter --&gt; name:&#x27;ANY(&quot;king kong&quot;)&#x27; For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
&quot;maxReturnResults&quot;: 42, # Number of search results to return. The default value is 10.
&quot;orderBy&quot;: &quot;A String&quot;, # 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.
&quot;searchResultMode&quot;: &quot;A String&quot;, # 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)
&quot;searchResultMode&quot;: &quot;A String&quot;, # 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)
},
&quot;searchResultList&quot;: { # Search result list. # Search result list.
&quot;searchResults&quot;: [ # Search results.
Expand Down Expand Up @@ -205,7 +205,7 @@ <h3>Method Details</h3>
An object of the form:

{ # Response message for ConversationalSearchService.AnswerQuery method.
&quot;answer&quot;: { # 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.
&quot;answer&quot;: { # 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.
&quot;answerSkippedReasons&quot;: [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
&quot;A String&quot;,
],
Expand Down Expand Up @@ -289,7 +289,7 @@ <h3>Method Details</h3>
&quot;snippetStatus&quot;: &quot;A String&quot;, # Status of the snippet defined by the search team.
},
],
&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).
&quot;structData&quot;: { # Data representation. The structured JSON data for the document. It&#x27;s populated from the struct data from the Document , or the Chunk in search result .
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;title&quot;: &quot;A String&quot;, # Title.
Expand Down Expand Up @@ -505,7 +505,7 @@ <h3>Method Details</h3>
&quot;numPreviousSegments&quot;: 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
&quot;returnExtractiveSegmentScore&quot;: 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`.
},
&quot;searchResultMode&quot;: &quot;A String&quot;, # 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`.
&quot;searchResultMode&quot;: &quot;A String&quot;, # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
&quot;snippetSpec&quot;: { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
&quot;maxSnippetCount&quot;: 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 &gt; 0.
&quot;referenceOnly&quot;: True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ <h3>Method Details</h3>
&quot;snippetStatus&quot;: &quot;A String&quot;, # Status of the snippet defined by the search team.
},
],
&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).
&quot;structData&quot;: { # Data representation. The structured JSON data for the document. It&#x27;s populated from the struct data from the Document , or the Chunk in search result .
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;title&quot;: &quot;A String&quot;, # Title.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ <h3>Method Details</h3>
&quot;filter&quot;: &quot;A String&quot;, # 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 &#x27;name&#x27; in their schema. In this case the filter would look like this: filter --&gt; name:&#x27;ANY(&quot;king kong&quot;)&#x27; For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
&quot;maxReturnResults&quot;: 42, # Number of search results to return. The default value is 10.
&quot;orderBy&quot;: &quot;A String&quot;, # 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.
&quot;searchResultMode&quot;: &quot;A String&quot;, # 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)
&quot;searchResultMode&quot;: &quot;A String&quot;, # 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)
},
&quot;searchResultList&quot;: { # Search result list. # Search result list.
&quot;searchResults&quot;: [ # Search results.
Expand Down Expand Up @@ -205,7 +205,7 @@ <h3>Method Details</h3>
An object of the form:

{ # Response message for ConversationalSearchService.AnswerQuery method.
&quot;answer&quot;: { # 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.
&quot;answer&quot;: { # 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.
&quot;answerSkippedReasons&quot;: [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
&quot;A String&quot;,
],
Expand Down Expand Up @@ -289,7 +289,7 @@ <h3>Method Details</h3>
&quot;snippetStatus&quot;: &quot;A String&quot;, # Status of the snippet defined by the search team.
},
],
&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).
&quot;structData&quot;: { # Data representation. The structured JSON data for the document. It&#x27;s populated from the struct data from the Document , or the Chunk in search result .
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;title&quot;: &quot;A String&quot;, # Title.
Expand Down Expand Up @@ -505,7 +505,7 @@ <h3>Method Details</h3>
&quot;numPreviousSegments&quot;: 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
&quot;returnExtractiveSegmentScore&quot;: 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`.
},
&quot;searchResultMode&quot;: &quot;A String&quot;, # 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`.
&quot;searchResultMode&quot;: &quot;A String&quot;, # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
&quot;snippetSpec&quot;: { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
&quot;maxSnippetCount&quot;: 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 &gt; 0.
&quot;referenceOnly&quot;: True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ <h3>Method Details</h3>
&quot;snippetStatus&quot;: &quot;A String&quot;, # Status of the snippet defined by the search team.
},
],
&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).
&quot;structData&quot;: { # Data representation. The structured JSON data for the document. It&#x27;s populated from the struct data from the Document , or the Chunk in search result .
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;title&quot;: &quot;A String&quot;, # Title.
Expand Down
5 changes: 5 additions & 0 deletions docs/dyn/discoveryengine_v1.projects.locations.html
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,11 @@ <h2>Instance Methods</h2>
</p>
<p class="firstline">Returns the groundingConfigs Resource.</p>

<p class="toc_element">
<code><a href="discoveryengine_v1.projects.locations.identity_mapping_stores.html">identity_mapping_stores()</a></code>
</p>
<p class="firstline">Returns the identity_mapping_stores Resource.</p>

<p class="toc_element">
<code><a href="discoveryengine_v1.projects.locations.operations.html">operations()</a></code>
</p>
Expand Down
Loading

0 comments on commit ba150f2

Please sign in to comment.