From ba150f23302f316a1a711970129288c71846aaa5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Thu, 25 Jul 2024 14:10:26 +0000 Subject: [PATCH] feat(discoveryengine): update the api #### 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) --- ...collections.dataStores.servingConfigs.html | 8 +- ...llections.dataStores.sessions.answers.html | 2 +- ...ns.collections.engines.servingConfigs.html | 8 +- ....collections.engines.sessions.answers.html | 2 +- ...s.locations.dataStores.servingConfigs.html | 8 +- ...locations.dataStores.sessions.answers.html | 2 +- ...discoveryengine_v1.projects.locations.html | 5 + ...cts.locations.identity_mapping_stores.html | 91 + ...collections.dataStores.servingConfigs.html | 19 +- ...llections.dataStores.sessions.answers.html | 2 +- ...llections.dataStores.siteSearchEngine.html | 79 + ...ns.collections.engines.servingConfigs.html | 19 +- ....collections.engines.sessions.answers.html | 2 +- ...s.locations.dataStores.servingConfigs.html | 19 +- ...locations.dataStores.sessions.answers.html | 2 +- ...1alpha.projects.locations.evaluations.html | 842 ++ ...veryengine_v1alpha.projects.locations.html | 5 + ...cts.locations.identity_mapping_stores.html | 91 + ...ha.projects.locations.sampleQuerySets.html | 172 + ...cations.sampleQuerySets.sampleQueries.html | 398 + ...collections.dataStores.servingConfigs.html | 19 +- ...llections.dataStores.sessions.answers.html | 2 +- ...ns.collections.engines.servingConfigs.html | 19 +- ....collections.engines.sessions.answers.html | 2 +- ...s.locations.dataStores.servingConfigs.html | 19 +- ...locations.dataStores.sessions.answers.html | 2 +- ...v1beta.projects.locations.evaluations.html | 830 ++ ...ta.projects.locations.sampleQuerySets.html | 172 + ...cations.sampleQuerySets.sampleQueries.html | 398 + .../documents/discoveryengine.v1.json | 3858 ++++++--- .../documents/discoveryengine.v1alpha.json | 2483 +++++- .../documents/discoveryengine.v1beta.json | 6941 +++++++++++------ 32 files changed, 12664 insertions(+), 3857 deletions(-) create mode 100644 docs/dyn/discoveryengine_v1.projects.locations.identity_mapping_stores.html create mode 100644 docs/dyn/discoveryengine_v1alpha.projects.locations.identity_mapping_stores.html create mode 100644 docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.sampleQueries.html create mode 100644 docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.sampleQueries.html diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html index 1902cb81a80..c6a82e54163 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html @@ -153,7 +153,7 @@

Method Details

"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) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "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. - "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) + "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) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -205,7 +205,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "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. + "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. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -289,7 +289,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "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). + "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 . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -505,7 +505,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html index dee378f44c7..a89732a9410 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "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). + "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 . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html index c1e3772091c..dc6f44acd26 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html @@ -153,7 +153,7 @@

Method Details

"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) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "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. - "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) + "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) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -205,7 +205,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "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. + "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. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -289,7 +289,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "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). + "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 . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -505,7 +505,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html index ed3327f930e..3759f97e32e 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "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). + "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 . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html index 26cdb02fa76..170838df867 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html @@ -153,7 +153,7 @@

Method Details

"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) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "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. - "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) + "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) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -205,7 +205,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "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. + "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. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -289,7 +289,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "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). + "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 . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -505,7 +505,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html index 1a446a88b92..0e4661a208d 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "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). + "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 . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.html b/docs/dyn/discoveryengine_v1.projects.locations.html index 8396d5bdb2a..4631def3024 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.html @@ -89,6 +89,11 @@

Instance Methods

Returns the groundingConfigs Resource.

+

+ identity_mapping_stores() +

+

Returns the identity_mapping_stores Resource.

+

operations()

diff --git a/docs/dyn/discoveryengine_v1.projects.locations.identity_mapping_stores.html b/docs/dyn/discoveryengine_v1.projects.locations.identity_mapping_stores.html new file mode 100644 index 00000000000..2aebaab5a22 --- /dev/null +++ b/docs/dyn/discoveryengine_v1.projects.locations.identity_mapping_stores.html @@ -0,0 +1,91 @@ + + + +

Discovery Engine API . projects . locations . identity_mapping_stores

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html index cf6235dad8b..07787261a60 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html @@ -179,7 +179,7 @@

Method Details

"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) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "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. - "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) + "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) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -231,7 +231,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "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. + "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. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -315,7 +315,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "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). + "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 . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -405,7 +405,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -512,7 +512,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -625,7 +625,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -721,7 +721,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -972,7 +972,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -1049,7 +1049,7 @@

Method Details

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. "A String", ], }, @@ -1072,6 +1072,7 @@

Method Details

"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, + "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. "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. "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. "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. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html index 9c715ecdad6..cb0e428c6c8 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "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). + "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 . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.html index 92717248ea3..e19dee476ac 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.html @@ -102,9 +102,15 @@

Instance Methods

fetchDomainVerificationStatus_next()

Retrieves the next page of results.

+

+ getUriPatternDocumentData(siteSearchEngine, x__xgafv=None)

+

Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.

recrawlUris(siteSearchEngine, body=None, x__xgafv=None)

Request on-demand recrawl for a list of URIs.

+

+ setUriPatternDocumentData(siteSearchEngine, body=None, x__xgafv=None)

+

Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.

Method Details

batchVerifyTargetSites(parent, body=None, x__xgafv=None) @@ -291,6 +297,29 @@

Method Details

+
+ getUriPatternDocumentData(siteSearchEngine, x__xgafv=None) + 
Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.
+
+Args:
+  siteSearchEngine: string, Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for SiteSearchEngineService.GetUriPatternDocumentData method.
+  "documentDataMap": { # Document data keyed by URI pattern. For example: document_data_map = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } }
+    "a_key": {
+      "a_key": "", # Properties of the object.
+    },
+  },
+}
+
+
recrawlUris(siteSearchEngine, body=None, x__xgafv=None) 
Request on-demand recrawl for a list of URIs.
@@ -335,4 +364,54 @@ 
Method Details

 }
+
+ setUriPatternDocumentData(siteSearchEngine, body=None, x__xgafv=None) + 
Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.
+
+Args:
+  siteSearchEngine: string, Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SiteSearchEngineService.SetUriPatternDocumentData method.
+  "documentDataMap": { # Document data keyed by URI pattern. Each entry must be consistent with the Schema. For example: Schema = { "type": "object", "properties": { "Categories": { "type": "array", "items": { "retrievable": true, "type": "string" } } } document_data_map = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } }
+    "a_key": {
+      "a_key": "", # Properties of the object.
+    },
+  },
+  "emptyDocumentDataMap": True or False, # If true, clears the document data map. If true, SetUriPatternDocumentDataRequest.document_data_map must be empty.
+  "schema": { # Optional. If not provided, the current Schema is used. If provided, validates and updates the Schema. If validation fails, an error is returned.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html index fca18948394..3106e8aca61 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html @@ -179,7 +179,7 @@

Method Details

"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) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "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. - "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) + "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) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -231,7 +231,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "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. + "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. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -315,7 +315,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "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). + "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 . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -405,7 +405,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -512,7 +512,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -625,7 +625,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -721,7 +721,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -972,7 +972,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -1049,7 +1049,7 @@

Method Details

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. "A String", ], }, @@ -1072,6 +1072,7 @@

Method Details

"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, + "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. "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. "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. "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. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html index 19d73e2fc45..7a4c93028cd 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "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). + "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 . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html index c321c594903..b71e82b412e 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html @@ -179,7 +179,7 @@

Method Details

"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) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "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. - "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) + "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) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -231,7 +231,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "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. + "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. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -315,7 +315,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "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). + "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 . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -405,7 +405,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -512,7 +512,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -625,7 +625,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -721,7 +721,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -972,7 +972,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -1049,7 +1049,7 @@

Method Details

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. "A String", ], }, @@ -1072,6 +1072,7 @@

Method Details

"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, + "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. "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. "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. "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. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html index 8e9fe4835bc..5bdbc0a1587 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "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). + "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 . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html index 4fd237b35d4..d3f9e0c86f9 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html @@ -82,10 +82,852 @@

Instance Methods

close()

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.

+

+ get(name, x__xgafv=None)

+

Gets a Evaluation.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Gets a list of Evaluations.

+

+ listResults(evaluation, pageSize=None, pageToken=None, x__xgafv=None)

+

Gets a list of results for a given a Evaluation.

+

+ listResults_next()

+

Retrieves the next page of results.

+

+ list_next()

+

Retrieves the next page of results.

Method Details

close() 
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None) + 
Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.
+
+Args:
+  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.
+  "createTime": "A String", # Output only. Timestamp the Evaluation was created at.
+  "endTime": "A String", # Output only. Timestamp the Evaluation was completed at.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "errorSamples": [ # Output only. A sample of errors encountered while processing the request.
+    { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+      ],
+      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+    },
+  ],
+  "evaluationSpec": { # Describes the specification of the evaluation. # Required. The specification of the evaluation.
+    "querySetSpec": { # Describes the specification of the query set. # Required. The specification of the query set.
+      "sampleQuerySet": "A String", # Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+    },
+    "searchRequest": { # Request message for SearchService.Search method. # Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id
+      "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
+        "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+          { # Boost applies to documents which match a condition.
+            "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+            "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+              "attributeType": "A String", # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+              "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+                  "attributeValue": "A String", # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+                  "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                },
+              ],
+              "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+              "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+            },
+            "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
+          },
+        ],
+      },
+      "branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
+      "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
+      "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search.
+        "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+          "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+          "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+        },
+        "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+          "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+          "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+          "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+          "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+          "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`.
+        },
+        "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+        "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+          "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.
+          "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+          "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+        },
+        "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+          "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+          "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+          "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+          "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+          "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+            "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+          },
+          "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+            "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+          },
+          "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+          "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+        },
+      },
+      "customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec.
+        "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model.
+      },
+      "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.
+        { # 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.
+          "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+        },
+      ],
+      "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
+        "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1.
+          { # Embedding vector.
+            "fieldPath": "A String", # Embedding field path in schema.
+            "vector": [ # Query embedding vector.
+              3.14,
+            ],
+          },
+        ],
+      },
+      "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+        { # A facet specification to perform faceted search.
+          "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.
+          "excludedFilterKeys": [ # List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+            "A String",
+          ],
+          "facetKey": { # Specifies how a facet is computed. # Required. The facet key specification.
+            "caseInsensitive": True or False, # True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
+            "contains": [ # Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "intervals": [ # Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
+              { # A floating point interval.
+                "exclusiveMaximum": 3.14, # Exclusive upper bound.
+                "exclusiveMinimum": 3.14, # Exclusive lower bound.
+                "maximum": 3.14, # Inclusive upper bound.
+                "minimum": 3.14, # Inclusive lower bound.
+              },
+            ],
+            "key": "A String", # Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
+            "orderBy": "A String", # The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
+            "prefixes": [ # Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "restrictedValues": [ # Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+          },
+          "limit": 42, # Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.
+        },
+      ],
+      "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. 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 customer 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)
+      "imageQuery": { # Specifies the image query input. # Raw image query.
+        "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
+      },
+      "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
+      "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+        "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED.
+        "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
+          "A String",
+        ],
+      },
+      "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+      "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`
+        "a_key": "",
+      },
+      "query": "A String", # Raw search query.
+      "queryExpansionSpec": { # Specification to determine under which conditions query expansion should occur. # The query expansion specification that specifies the conditions under which query expansion occurs.
+        "condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
+        "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.
+      },
+      "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+      "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
+      "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.
+      "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+      "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
+        "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
+      },
+      "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
+      "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.
+      "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.
+        "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.
+        "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.
+      },
+      "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
+        "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
+      },
+      "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
+        "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
+        "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      },
+      "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+        "a_key": "A String",
+      },
+      "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+    },
+  },
+  "name": "A String", # Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.
+    "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+  },
+  "state": "A String", # Output only. The state of the evaluation.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) + 
Gets a Evaluation.
+
+Args:
+  name: string, Required. Full resource name of Evaluation, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.
+  "createTime": "A String", # Output only. Timestamp the Evaluation was created at.
+  "endTime": "A String", # Output only. Timestamp the Evaluation was completed at.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "errorSamples": [ # Output only. A sample of errors encountered while processing the request.
+    { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+      ],
+      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+    },
+  ],
+  "evaluationSpec": { # Describes the specification of the evaluation. # Required. The specification of the evaluation.
+    "querySetSpec": { # Describes the specification of the query set. # Required. The specification of the query set.
+      "sampleQuerySet": "A String", # Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+    },
+    "searchRequest": { # Request message for SearchService.Search method. # Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id
+      "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
+        "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+          { # Boost applies to documents which match a condition.
+            "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+            "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+              "attributeType": "A String", # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+              "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+                  "attributeValue": "A String", # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+                  "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                },
+              ],
+              "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+              "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+            },
+            "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
+          },
+        ],
+      },
+      "branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
+      "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
+      "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search.
+        "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+          "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+          "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+        },
+        "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+          "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+          "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+          "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+          "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+          "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`.
+        },
+        "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+        "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+          "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.
+          "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+          "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+        },
+        "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+          "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+          "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+          "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+          "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+          "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+            "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+          },
+          "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+            "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+          },
+          "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+          "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+        },
+      },
+      "customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec.
+        "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model.
+      },
+      "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.
+        { # 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.
+          "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+        },
+      ],
+      "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
+        "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1.
+          { # Embedding vector.
+            "fieldPath": "A String", # Embedding field path in schema.
+            "vector": [ # Query embedding vector.
+              3.14,
+            ],
+          },
+        ],
+      },
+      "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+        { # A facet specification to perform faceted search.
+          "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.
+          "excludedFilterKeys": [ # List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+            "A String",
+          ],
+          "facetKey": { # Specifies how a facet is computed. # Required. The facet key specification.
+            "caseInsensitive": True or False, # True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
+            "contains": [ # Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "intervals": [ # Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
+              { # A floating point interval.
+                "exclusiveMaximum": 3.14, # Exclusive upper bound.
+                "exclusiveMinimum": 3.14, # Exclusive lower bound.
+                "maximum": 3.14, # Inclusive upper bound.
+                "minimum": 3.14, # Inclusive lower bound.
+              },
+            ],
+            "key": "A String", # Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
+            "orderBy": "A String", # The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
+            "prefixes": [ # Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "restrictedValues": [ # Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+          },
+          "limit": 42, # Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.
+        },
+      ],
+      "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. 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 customer 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)
+      "imageQuery": { # Specifies the image query input. # Raw image query.
+        "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
+      },
+      "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
+      "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+        "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED.
+        "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
+          "A String",
+        ],
+      },
+      "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+      "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`
+        "a_key": "",
+      },
+      "query": "A String", # Raw search query.
+      "queryExpansionSpec": { # Specification to determine under which conditions query expansion should occur. # The query expansion specification that specifies the conditions under which query expansion occurs.
+        "condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
+        "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.
+      },
+      "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+      "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
+      "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.
+      "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+      "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
+        "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
+      },
+      "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
+      "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.
+      "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.
+        "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.
+        "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.
+      },
+      "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
+        "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
+      },
+      "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
+        "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
+        "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      },
+      "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+        "a_key": "A String",
+      },
+      "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+    },
+  },
+  "name": "A String", # Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.
+    "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+  },
+  "state": "A String", # Output only. The state of the evaluation.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Gets a list of Evaluations.
+
+Args:
+  parent: string, Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for EvaluationService.ListEvaluations method.
+  "evaluations": [ # The Evaluations.
+    { # An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.
+      "createTime": "A String", # Output only. Timestamp the Evaluation was created at.
+      "endTime": "A String", # Output only. Timestamp the Evaluation was completed at.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "errorSamples": [ # Output only. A sample of errors encountered while processing the request.
+        { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+        },
+      ],
+      "evaluationSpec": { # Describes the specification of the evaluation. # Required. The specification of the evaluation.
+        "querySetSpec": { # Describes the specification of the query set. # Required. The specification of the query set.
+          "sampleQuerySet": "A String", # Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+        },
+        "searchRequest": { # Request message for SearchService.Search method. # Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id
+          "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
+            "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+              { # Boost applies to documents which match a condition.
+                "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+                "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+                  "attributeType": "A String", # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+                  "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                    { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+                      "attributeValue": "A String", # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+                      "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                    },
+                  ],
+                  "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+                  "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+                },
+                "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
+              },
+            ],
+          },
+          "branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
+          "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
+          "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search.
+            "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+              "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+              "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+            },
+            "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+              "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+              "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+              "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+              "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+              "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`.
+            },
+            "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+            "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+              "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.
+              "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+              "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+            },
+            "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+              "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+              "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+              "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+              "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+              "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+                "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+              },
+              "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+                "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+              },
+              "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+              "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+            },
+          },
+          "customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec.
+            "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model.
+          },
+          "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.
+            { # 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.
+              "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+            },
+          ],
+          "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
+            "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1.
+              { # Embedding vector.
+                "fieldPath": "A String", # Embedding field path in schema.
+                "vector": [ # Query embedding vector.
+                  3.14,
+                ],
+              },
+            ],
+          },
+          "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+            { # A facet specification to perform faceted search.
+              "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.
+              "excludedFilterKeys": [ # List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+                "A String",
+              ],
+              "facetKey": { # Specifies how a facet is computed. # Required. The facet key specification.
+                "caseInsensitive": True or False, # True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
+                "contains": [ # Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
+                  "A String",
+                ],
+                "intervals": [ # Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
+                  { # A floating point interval.
+                    "exclusiveMaximum": 3.14, # Exclusive upper bound.
+                    "exclusiveMinimum": 3.14, # Exclusive lower bound.
+                    "maximum": 3.14, # Inclusive upper bound.
+                    "minimum": 3.14, # Inclusive lower bound.
+                  },
+                ],
+                "key": "A String", # Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
+                "orderBy": "A String", # The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
+                "prefixes": [ # Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
+                  "A String",
+                ],
+                "restrictedValues": [ # Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
+                  "A String",
+                ],
+              },
+              "limit": 42, # Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.
+            },
+          ],
+          "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. 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 customer 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)
+          "imageQuery": { # Specifies the image query input. # Raw image query.
+            "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
+          },
+          "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
+          "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+            "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED.
+            "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
+              "A String",
+            ],
+          },
+          "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+          "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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+          "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
+          "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`
+            "a_key": "",
+          },
+          "query": "A String", # Raw search query.
+          "queryExpansionSpec": { # Specification to determine under which conditions query expansion should occur. # The query expansion specification that specifies the conditions under which query expansion occurs.
+            "condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
+            "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.
+          },
+          "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+          "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
+          "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.
+          "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+          "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
+            "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
+          },
+          "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
+          "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.
+          "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.
+            "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.
+            "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.
+          },
+          "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
+            "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
+          },
+          "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
+            "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
+            "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          },
+          "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+            "a_key": "A String",
+          },
+          "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+        },
+      },
+      "name": "A String", # Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+      "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.
+        "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+      },
+      "state": "A String", # Output only. The state of the evaluation.
+    },
+  ],
+  "nextPageToken": "A String", # A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ listResults(evaluation, pageSize=None, pageToken=None, x__xgafv=None) + 
Gets a list of results for a given a Evaluation.
+
+Args:
+  evaluation: string, Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for EvaluationService.ListEvaluationResults method.
+  "evaluationResults": [ # The EvaluationResults.
+    { # Represents the results of an evaluation for a single SampleQuery.
+      "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, for a given SampleQuery.
+        "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+      },
+      "sampleQuery": { # Sample Query captures metadata to be used for evaluation. # Output only. The SampleQuery that was evaluated.
+        "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+        "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+        "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+          "query": "A String", # Required. The query.
+          "targets": [ # List of targets for the query.
+            { # Defines the parameters of the query's expected outcome.
+              "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+                42,
+              ],
+              "score": 3.14, # Relevance score of the target.
+              "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+            },
+          ],
+        },
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ listResults_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html index 7631051a91a..c07864082b1 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html @@ -94,6 +94,11 @@

Instance Methods

Returns the groundingConfigs Resource.

+

+ identity_mapping_stores() +

+

Returns the identity_mapping_stores Resource.

+

operations()

diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.identity_mapping_stores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.identity_mapping_stores.html new file mode 100644 index 00000000000..ed188bb7977 --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.identity_mapping_stores.html @@ -0,0 +1,91 @@ + + + +

Discovery Engine API . projects . locations . identity_mapping_stores

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.html index b7f1eb3e676..18abd8ea1bb 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.html @@ -79,13 +79,185 @@

Instance Methods

Returns the operations Resource.

+

+ sampleQueries() +

+

Returns the sampleQueries Resource.

+

close()

Close httplib2 connections.

+

+ create(parent, body=None, sampleQuerySetId=None, x__xgafv=None)

+

Creates a SampleQuerySet

+

+ delete(name, x__xgafv=None)

+

Deletes a SampleQuerySet.

+

+ get(name, x__xgafv=None)

+

Gets a SampleQuerySet.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Gets a list of SampleQuerySets.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a SampleQuerySet.

Method Details

close() 
Close httplib2 connections.
+
+ create(parent, body=None, sampleQuerySetId=None, x__xgafv=None) + 
Creates a SampleQuerySet
+
+Args:
+  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+  sampleQuerySetId: string, Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ +
+ delete(name, x__xgafv=None) + 
Deletes a SampleQuerySet.
+
+Args:
+  name: string, Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
Gets a SampleQuerySet.
+
+Args:
+  name: string, Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Gets a list of SampleQuerySets.
+
+Args:
+  parent: string, Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for SampleQuerySetService.ListSampleQuerySets method.
+  "nextPageToken": "A String", # A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "sampleQuerySets": [ # The SampleQuerySets.
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+      "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+      "description": "A String", # The description of the SampleQuerySet.
+      "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+      "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+    },
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates a SampleQuerySet.
+
+Args:
+  name: string, Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+  updateMask: string, Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.sampleQueries.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.sampleQueries.html new file mode 100644 index 00000000000..3dfea63cd8c --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.sampleQueries.html @@ -0,0 +1,398 @@ + + + +

Discovery Engine API . projects . locations . sampleQuerySets . sampleQueries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, sampleQueryId=None, x__xgafv=None)

+

Creates a SampleQuery

+

+ delete(name, x__xgafv=None)

+

Deletes a SampleQuery.

+

+ get(name, x__xgafv=None)

+

Gets a SampleQuery.

+

+ import_(parent, body=None, x__xgafv=None)

+

Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Gets a list of SampleQuerys.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a SampleQuery.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, sampleQueryId=None, x__xgafv=None) + 
Creates a SampleQuery
+
+Args:
+  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+  sampleQueryId: string, Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) + 
Deletes a SampleQuery.
+
+Args:
+  name: string, Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
Gets a SampleQuery.
+
+Args:
+  name: string, Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+ +
+ import_(parent, body=None, x__xgafv=None) + 
Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.
+
+Args:
+  parent: string, Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SampleQueryService.ImportSampleQueries method.
+  "bigquerySource": { # BigQuery source import data from. # BigQuery input source.
+    "dataSchema": "A String", # 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.
+    "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
+    "gcsStagingDir": "A String", # 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 BigQuery export to a specific Cloud Storage directory.
+    "partitionDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "projectId": "A String", # The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
+    "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
+  },
+  "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import.
+    "gcsPrefix": "A String", # Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
+  },
+  "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content.
+    "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON 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. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.
+    "inputUris": [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
+      "A String",
+    ],
+  },
+  "inlineSource": { # The inline source for SampleQuerys. # The Inline source for sample query entries.
+    "sampleQueries": [ # Required. A list of SampleQuerys to import. Max of 1000 items.
+      { # Sample Query captures metadata to be used for evaluation.
+        "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+        "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+        "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+          "query": "A String", # Required. The query.
+          "targets": [ # List of targets for the query.
+            { # Defines the parameters of the query's expected outcome.
+              "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+                42,
+              ],
+              "score": 3.14, # Relevance score of the target.
+              "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+            },
+          ],
+        },
+      },
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Gets a list of SampleQuerys.
+
+Args:
+  parent: string, Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for SampleQueryService.ListSampleQueries method.
+  "nextPageToken": "A String", # A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "sampleQueries": [ # The SampleQuerys.
+    { # Sample Query captures metadata to be used for evaluation.
+      "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+      "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+      "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+        "query": "A String", # Required. The query.
+        "targets": [ # List of targets for the query.
+          { # Defines the parameters of the query's expected outcome.
+            "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+              42,
+            ],
+            "score": 3.14, # Relevance score of the target.
+            "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+          },
+        ],
+      },
+    },
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates a SampleQuery.
+
+Args:
+  name: string, Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+  updateMask: string, Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html index f97b75bd12f..1dbddaff8f0 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -176,7 +176,7 @@

Method Details

"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) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "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. - "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) + "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) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -228,7 +228,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "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. + "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. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -312,7 +312,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "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). + "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 . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -399,7 +399,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -498,7 +498,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -603,7 +603,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -691,7 +691,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -925,7 +925,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -999,7 +999,7 @@

Method Details

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. "A String", ], }, @@ -1021,6 +1021,7 @@

Method Details

"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, + "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. "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. "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. "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. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html index 6512be89516..b9de6a69fc2 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "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). + "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 . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html index 4853e21a08e..2918dad648b 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -176,7 +176,7 @@

Method Details

"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) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "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. - "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) + "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) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -228,7 +228,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "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. + "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. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -312,7 +312,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "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). + "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 . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -399,7 +399,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -498,7 +498,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -603,7 +603,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -691,7 +691,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -925,7 +925,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -999,7 +999,7 @@

Method Details

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. "A String", ], }, @@ -1021,6 +1021,7 @@

Method Details

"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, + "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. "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. "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. "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. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html index 82932881d2b..50026fc8d25 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "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). + "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 . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index fab6652d4c3..5cba7a9d3a0 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -176,7 +176,7 @@

Method Details

"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) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "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. - "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) + "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) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -228,7 +228,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "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. + "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. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -312,7 +312,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "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). + "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 . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -399,7 +399,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -498,7 +498,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -603,7 +603,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -691,7 +691,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -925,7 +925,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "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`. }, - "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`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "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. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -999,7 +999,7 @@

Method Details

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. "A String", ], }, @@ -1021,6 +1021,7 @@

Method Details

"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, + "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. "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. "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. "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. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html index 443ff931a9b..240338cfb05 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "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). + "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 . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html index 7df82cad4d0..a538e2d2304 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html @@ -82,10 +82,840 @@

Instance Methods

close()

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.

+

+ get(name, x__xgafv=None)

+

Gets a Evaluation.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Gets a list of Evaluations.

+

+ listResults(evaluation, pageSize=None, pageToken=None, x__xgafv=None)

+

Gets a list of results for a given a Evaluation.

+

+ listResults_next()

+

Retrieves the next page of results.

+

+ list_next()

+

Retrieves the next page of results.

Method Details

close() 
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None) + 
Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.
+
+Args:
+  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.
+  "createTime": "A String", # Output only. Timestamp the Evaluation was created at.
+  "endTime": "A String", # Output only. Timestamp the Evaluation was completed at.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "errorSamples": [ # Output only. A sample of errors encountered while processing the request.
+    { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+      ],
+      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+    },
+  ],
+  "evaluationSpec": { # Describes the specification of the evaluation. # Required. The specification of the evaluation.
+    "querySetSpec": { # Describes the specification of the query set. # Required. The specification of the query set.
+      "sampleQuerySet": "A String", # Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+    },
+    "searchRequest": { # Request message for SearchService.Search method. # Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id
+      "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
+        "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+          { # Boost applies to documents which match a condition.
+            "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+            "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+              "attributeType": "A String", # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+              "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+                  "attributeValue": "A String", # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+                  "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                },
+              ],
+              "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+              "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+            },
+            "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
+          },
+        ],
+      },
+      "branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
+      "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
+      "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search.
+        "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+          "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+          "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+        },
+        "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+          "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+          "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+          "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+          "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+          "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`.
+        },
+        "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+        "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+          "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.
+          "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+          "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+        },
+        "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+          "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+          "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+          "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+          "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+          "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+            "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+          },
+          "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+            "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+          },
+          "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+          "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+        },
+      },
+      "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.
+        { # 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.
+          "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+        },
+      ],
+      "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
+        "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1.
+          { # Embedding vector.
+            "fieldPath": "A String", # Embedding field path in schema.
+            "vector": [ # Query embedding vector.
+              3.14,
+            ],
+          },
+        ],
+      },
+      "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+        { # A facet specification to perform faceted search.
+          "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.
+          "excludedFilterKeys": [ # List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+            "A String",
+          ],
+          "facetKey": { # Specifies how a facet is computed. # Required. The facet key specification.
+            "caseInsensitive": True or False, # True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
+            "contains": [ # Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "intervals": [ # Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
+              { # A floating point interval.
+                "exclusiveMaximum": 3.14, # Exclusive upper bound.
+                "exclusiveMinimum": 3.14, # Exclusive lower bound.
+                "maximum": 3.14, # Inclusive upper bound.
+                "minimum": 3.14, # Inclusive lower bound.
+              },
+            ],
+            "key": "A String", # Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
+            "orderBy": "A String", # The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
+            "prefixes": [ # Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "restrictedValues": [ # Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+          },
+          "limit": 42, # Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.
+        },
+      ],
+      "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. 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 customer 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)
+      "imageQuery": { # Specifies the image query input. # Raw image query.
+        "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
+      },
+      "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
+      "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+        "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED.
+        "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
+          "A String",
+        ],
+      },
+      "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+      "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`
+        "a_key": "",
+      },
+      "query": "A String", # Raw search query.
+      "queryExpansionSpec": { # Specification to determine under which conditions query expansion should occur. # The query expansion specification that specifies the conditions under which query expansion occurs.
+        "condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
+        "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.
+      },
+      "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+      "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
+      "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+      "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
+        "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
+      },
+      "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
+      "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.
+      "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.
+        "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.
+        "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.
+      },
+      "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
+        "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
+      },
+      "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
+        "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
+        "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      },
+      "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+        "a_key": "A String",
+      },
+      "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+    },
+  },
+  "name": "A String", # Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.
+    "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+  },
+  "state": "A String", # Output only. The state of the evaluation.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) + 
Gets a Evaluation.
+
+Args:
+  name: string, Required. Full resource name of Evaluation, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.
+  "createTime": "A String", # Output only. Timestamp the Evaluation was created at.
+  "endTime": "A String", # Output only. Timestamp the Evaluation was completed at.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "errorSamples": [ # Output only. A sample of errors encountered while processing the request.
+    { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+      ],
+      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+    },
+  ],
+  "evaluationSpec": { # Describes the specification of the evaluation. # Required. The specification of the evaluation.
+    "querySetSpec": { # Describes the specification of the query set. # Required. The specification of the query set.
+      "sampleQuerySet": "A String", # Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+    },
+    "searchRequest": { # Request message for SearchService.Search method. # Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id
+      "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
+        "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+          { # Boost applies to documents which match a condition.
+            "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+            "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+              "attributeType": "A String", # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+              "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+                  "attributeValue": "A String", # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+                  "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                },
+              ],
+              "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+              "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+            },
+            "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
+          },
+        ],
+      },
+      "branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
+      "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
+      "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search.
+        "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+          "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+          "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+        },
+        "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+          "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+          "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+          "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+          "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+          "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`.
+        },
+        "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+        "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+          "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.
+          "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+          "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+        },
+        "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+          "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+          "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+          "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+          "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+          "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+            "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+          },
+          "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+            "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+          },
+          "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+          "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+        },
+      },
+      "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.
+        { # 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.
+          "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+        },
+      ],
+      "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
+        "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1.
+          { # Embedding vector.
+            "fieldPath": "A String", # Embedding field path in schema.
+            "vector": [ # Query embedding vector.
+              3.14,
+            ],
+          },
+        ],
+      },
+      "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+        { # A facet specification to perform faceted search.
+          "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.
+          "excludedFilterKeys": [ # List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+            "A String",
+          ],
+          "facetKey": { # Specifies how a facet is computed. # Required. The facet key specification.
+            "caseInsensitive": True or False, # True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
+            "contains": [ # Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "intervals": [ # Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
+              { # A floating point interval.
+                "exclusiveMaximum": 3.14, # Exclusive upper bound.
+                "exclusiveMinimum": 3.14, # Exclusive lower bound.
+                "maximum": 3.14, # Inclusive upper bound.
+                "minimum": 3.14, # Inclusive lower bound.
+              },
+            ],
+            "key": "A String", # Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
+            "orderBy": "A String", # The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
+            "prefixes": [ # Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "restrictedValues": [ # Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+          },
+          "limit": 42, # Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.
+        },
+      ],
+      "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. 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 customer 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)
+      "imageQuery": { # Specifies the image query input. # Raw image query.
+        "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
+      },
+      "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
+      "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+        "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED.
+        "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
+          "A String",
+        ],
+      },
+      "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+      "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`
+        "a_key": "",
+      },
+      "query": "A String", # Raw search query.
+      "queryExpansionSpec": { # Specification to determine under which conditions query expansion should occur. # The query expansion specification that specifies the conditions under which query expansion occurs.
+        "condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
+        "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.
+      },
+      "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+      "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
+      "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+      "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
+        "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
+      },
+      "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
+      "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.
+      "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.
+        "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.
+        "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.
+      },
+      "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
+        "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
+      },
+      "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
+        "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
+        "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      },
+      "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+        "a_key": "A String",
+      },
+      "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+    },
+  },
+  "name": "A String", # Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.
+    "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+  },
+  "state": "A String", # Output only. The state of the evaluation.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Gets a list of Evaluations.
+
+Args:
+  parent: string, Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for EvaluationService.ListEvaluations method.
+  "evaluations": [ # The Evaluations.
+    { # An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.
+      "createTime": "A String", # Output only. Timestamp the Evaluation was created at.
+      "endTime": "A String", # Output only. Timestamp the Evaluation was completed at.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "errorSamples": [ # Output only. A sample of errors encountered while processing the request.
+        { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+        },
+      ],
+      "evaluationSpec": { # Describes the specification of the evaluation. # Required. The specification of the evaluation.
+        "querySetSpec": { # Describes the specification of the query set. # Required. The specification of the query set.
+          "sampleQuerySet": "A String", # Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+        },
+        "searchRequest": { # Request message for SearchService.Search method. # Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id
+          "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
+            "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+              { # Boost applies to documents which match a condition.
+                "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+                "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+                  "attributeType": "A String", # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+                  "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                    { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+                      "attributeValue": "A String", # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+                      "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                    },
+                  ],
+                  "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+                  "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+                },
+                "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
+              },
+            ],
+          },
+          "branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
+          "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
+          "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search.
+            "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+              "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+              "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+            },
+            "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+              "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+              "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+              "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+              "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+              "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`.
+            },
+            "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+            "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+              "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.
+              "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+              "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+            },
+            "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+              "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+              "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+              "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+              "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+              "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+                "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+              },
+              "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+                "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+              },
+              "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+              "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+            },
+          },
+          "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.
+            { # 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.
+              "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+            },
+          ],
+          "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
+            "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1.
+              { # Embedding vector.
+                "fieldPath": "A String", # Embedding field path in schema.
+                "vector": [ # Query embedding vector.
+                  3.14,
+                ],
+              },
+            ],
+          },
+          "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+            { # A facet specification to perform faceted search.
+              "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.
+              "excludedFilterKeys": [ # List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+                "A String",
+              ],
+              "facetKey": { # Specifies how a facet is computed. # Required. The facet key specification.
+                "caseInsensitive": True or False, # True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
+                "contains": [ # Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
+                  "A String",
+                ],
+                "intervals": [ # Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
+                  { # A floating point interval.
+                    "exclusiveMaximum": 3.14, # Exclusive upper bound.
+                    "exclusiveMinimum": 3.14, # Exclusive lower bound.
+                    "maximum": 3.14, # Inclusive upper bound.
+                    "minimum": 3.14, # Inclusive lower bound.
+                  },
+                ],
+                "key": "A String", # Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
+                "orderBy": "A String", # The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
+                "prefixes": [ # Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
+                  "A String",
+                ],
+                "restrictedValues": [ # Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
+                  "A String",
+                ],
+              },
+              "limit": 42, # Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.
+            },
+          ],
+          "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. 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 customer 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)
+          "imageQuery": { # Specifies the image query input. # Raw image query.
+            "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
+          },
+          "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
+          "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+            "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED.
+            "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
+              "A String",
+            ],
+          },
+          "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+          "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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+          "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
+          "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`
+            "a_key": "",
+          },
+          "query": "A String", # Raw search query.
+          "queryExpansionSpec": { # Specification to determine under which conditions query expansion should occur. # The query expansion specification that specifies the conditions under which query expansion occurs.
+            "condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
+            "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.
+          },
+          "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+          "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
+          "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+          "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
+            "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
+          },
+          "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
+          "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.
+          "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.
+            "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.
+            "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.
+          },
+          "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
+            "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
+          },
+          "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
+            "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
+            "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          },
+          "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+            "a_key": "A String",
+          },
+          "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+        },
+      },
+      "name": "A String", # Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+      "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.
+        "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+      },
+      "state": "A String", # Output only. The state of the evaluation.
+    },
+  ],
+  "nextPageToken": "A String", # A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ listResults(evaluation, pageSize=None, pageToken=None, x__xgafv=None) + 
Gets a list of results for a given a Evaluation.
+
+Args:
+  evaluation: string, Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for EvaluationService.ListEvaluationResults method.
+  "evaluationResults": [ # The EvaluationResults.
+    { # Represents the results of an evaluation for a single SampleQuery.
+      "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, for a given SampleQuery.
+        "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+      },
+      "sampleQuery": { # Sample Query captures metadata to be used for evaluation. # Output only. The SampleQuery that was evaluated.
+        "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+        "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+        "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+          "query": "A String", # Required. The query.
+          "targets": [ # List of targets for the query.
+            { # Defines the parameters of the query's expected outcome.
+              "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+                42,
+              ],
+              "score": 3.14, # Relevance score of the target.
+              "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+            },
+          ],
+        },
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ listResults_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.html b/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.html index f9afeb97172..5500436b5b9 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.html @@ -79,13 +79,185 @@

Instance Methods

Returns the operations Resource.

+

+ sampleQueries() +

+

Returns the sampleQueries Resource.

+

close()

Close httplib2 connections.

+

+ create(parent, body=None, sampleQuerySetId=None, x__xgafv=None)

+

Creates a SampleQuerySet

+

+ delete(name, x__xgafv=None)

+

Deletes a SampleQuerySet.

+

+ get(name, x__xgafv=None)

+

Gets a SampleQuerySet.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Gets a list of SampleQuerySets.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a SampleQuerySet.

Method Details

close() 
Close httplib2 connections.
+
+ create(parent, body=None, sampleQuerySetId=None, x__xgafv=None) + 
Creates a SampleQuerySet
+
+Args:
+  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+  sampleQuerySetId: string, Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ +
+ delete(name, x__xgafv=None) + 
Deletes a SampleQuerySet.
+
+Args:
+  name: string, Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
Gets a SampleQuerySet.
+
+Args:
+  name: string, Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Gets a list of SampleQuerySets.
+
+Args:
+  parent: string, Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for SampleQuerySetService.ListSampleQuerySets method.
+  "nextPageToken": "A String", # A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "sampleQuerySets": [ # The SampleQuerySets.
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+      "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+      "description": "A String", # The description of the SampleQuerySet.
+      "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+      "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+    },
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates a SampleQuerySet.
+
+Args:
+  name: string, Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+  updateMask: string, Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.sampleQueries.html b/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.sampleQueries.html new file mode 100644 index 00000000000..70a61c930b0 --- /dev/null +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.sampleQueries.html @@ -0,0 +1,398 @@ + + + +

Discovery Engine API . projects . locations . sampleQuerySets . sampleQueries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, sampleQueryId=None, x__xgafv=None)

+

Creates a SampleQuery

+

+ delete(name, x__xgafv=None)

+

Deletes a SampleQuery.

+

+ get(name, x__xgafv=None)

+

Gets a SampleQuery.

+

+ import_(parent, body=None, x__xgafv=None)

+

Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Gets a list of SampleQuerys.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a SampleQuery.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, sampleQueryId=None, x__xgafv=None) + 
Creates a SampleQuery
+
+Args:
+  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+  sampleQueryId: string, Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) + 
Deletes a SampleQuery.
+
+Args:
+  name: string, Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
Gets a SampleQuery.
+
+Args:
+  name: string, Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+ +
+ import_(parent, body=None, x__xgafv=None) + 
Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.
+
+Args:
+  parent: string, Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SampleQueryService.ImportSampleQueries method.
+  "bigquerySource": { # BigQuery source import data from. # BigQuery input source.
+    "dataSchema": "A String", # 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.
+    "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
+    "gcsStagingDir": "A String", # 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 BigQuery export to a specific Cloud Storage directory.
+    "partitionDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "projectId": "A String", # The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
+    "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
+  },
+  "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import.
+    "gcsPrefix": "A String", # Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
+  },
+  "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content.
+    "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON 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. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.
+    "inputUris": [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
+      "A String",
+    ],
+  },
+  "inlineSource": { # The inline source for SampleQuerys. # The Inline source for sample query entries.
+    "sampleQueries": [ # Required. A list of SampleQuerys to import. Max of 1000 items.
+      { # Sample Query captures metadata to be used for evaluation.
+        "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+        "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+        "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+          "query": "A String", # Required. The query.
+          "targets": [ # List of targets for the query.
+            { # Defines the parameters of the query's expected outcome.
+              "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+                42,
+              ],
+              "score": 3.14, # Relevance score of the target.
+              "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+            },
+          ],
+        },
+      },
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Gets a list of SampleQuerys.
+
+Args:
+  parent: string, Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for SampleQueryService.ListSampleQueries method.
+  "nextPageToken": "A String", # A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "sampleQueries": [ # The SampleQuerys.
+    { # Sample Query captures metadata to be used for evaluation.
+      "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+      "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+      "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+        "query": "A String", # Required. The query.
+        "targets": [ # List of targets for the query.
+          { # Defines the parameters of the query's expected outcome.
+            "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+              42,
+            ],
+            "score": 3.14, # Relevance score of the target.
+            "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+          },
+        ],
+      },
+    },
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates a SampleQuery.
+
+Args:
+  name: string, Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+  updateMask: string, Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index 333411ed03b..a8cc9cb0323 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -5428,6 +5428,80 @@ } } }, +"identity_mapping_stores": { +"resources": { +"operations": { +"methods": { +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.identity_mapping_stores.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.identity_mapping_stores.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, "operations": { "methods": { "get": { @@ -5711,7 +5785,7 @@ } } }, -"revision": "20240704", +"revision": "20240715", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -6252,7 +6326,7 @@ "type": "string" }, "searchResultMode": { -"description": "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)", +"description": "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)", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -6403,7 +6477,7 @@ "properties": { "answer": { "$ref": "GoogleCloudDiscoveryengineV1Answer", -"description": "Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." +"description": "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." }, "answerQueryToken": { "description": "A global unique ID used for logging.", @@ -6667,7 +6741,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "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).", +"description": "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 .", "type": "object" }, "title": { @@ -9753,7 +9827,7 @@ "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, "searchResultMode": { -"description": "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`.", +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -11263,7 +11337,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "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).", +"description": "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 .", "type": "object" }, "title": { @@ -11582,6 +11656,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata": { +"description": "Metadata for EvaluationService.CreateEvaluation method.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { "description": "Metadata for Create Schema LRO.", "id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", @@ -11616,6 +11696,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec": { +"description": "Defines custom fine tuning spec.", +"id": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", +"properties": { +"enableSearchAdaptor": { +"description": "Whether or not to enable and include custom fine tuned search adaptor model.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaCustomTuningModel": { "description": "Metadata that describes a custom tuned model.", "id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel", @@ -12322,6 +12413,96 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaEvaluation": { +"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluation", +"properties": { +"createTime": { +"description": "Output only. Timestamp the Evaluation was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. Timestamp the Evaluation was completed at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", +"readOnly": true +}, +"errorSamples": { +"description": "Output only. A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"readOnly": true, +"type": "array" +}, +"evaluationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", +"description": "Required. The specification of the evaluation." +}, +"name": { +"description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", +"readOnly": true +}, +"state": { +"description": "Output only. The state of the evaluation.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The evaluation is unspecified.", +"The service is preparing to run the evaluation.", +"The evaluation is in progress.", +"The evaluation completed successfully.", +"The evaluation failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec": { +"description": "Describes the specification of the evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", +"properties": { +"querySetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", +"description": "Required. The specification of the query set." +}, +"searchRequest": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest", +"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec": { +"description": "Describes the specification of the query set.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", +"properties": { +"sampleQuerySet": { +"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": { "description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata", @@ -12505,6 +12686,24 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": { +"description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.", +"id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse", +"properties": { +"documentDataMap": { +"additionalProperties": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"description": "Document data keyed by URI pattern. For example: document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaIdpConfig": { "description": "Identity Provider Config.", "id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", @@ -12647,6 +12846,56 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": { +"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata", +"properties": { +"createTime": { +"description": "ImportSampleQueries operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of SampleQuerys that failed to be imported.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of SampleQuerys successfully imported.", +"format": "int64", +"type": "string" +}, +"totalCount": { +"description": "Total count of SampleQuerys that were processed.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse": { +"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", @@ -12743,6 +12992,33 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaInterval": { +"description": "A floating point interval.", +"id": "GoogleCloudDiscoveryengineV1alphaInterval", +"properties": { +"exclusiveMaximum": { +"description": "Exclusive upper bound.", +"format": "double", +"type": "number" +}, +"exclusiveMinimum": { +"description": "Exclusive lower bound.", +"format": "double", +"type": "number" +}, +"maximum": { +"description": "Inclusive upper bound.", +"format": "double", +"type": "number" +}, +"minimum": { +"description": "Inclusive lower bound.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaLanguageInfo": { "description": "Language info for DataStore.", "id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", @@ -13049,6 +13325,60 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaQualityMetrics": { +"description": "Describes the metrics produced by the evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", +"properties": { +"docNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"docPrecision": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" +}, +"docRecall": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" +}, +"pageNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"pageRecall": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics": { +"description": "Stores the metric values at specific top-k levels.", +"id": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"properties": { +"top1": { +"description": "The top-1 value.", +"format": "double", +"type": "number" +}, +"top10": { +"description": "The top-10 value.", +"format": "double", +"type": "number" +}, +"top3": { +"description": "The top-3 value.", +"format": "double", +"type": "number" +}, +"top5": { +"description": "The top-5 value.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaQuery": { "description": "Defines a user inputed query.", "id": "GoogleCloudDiscoveryengineV1alphaQuery", @@ -13203,561 +13533,732 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaSession": { -"description": "External session proto definition.", -"id": "GoogleCloudDiscoveryengineV1alphaSession", +"GoogleCloudDiscoveryengineV1alphaSearchRequest": { +"description": "Request message for SearchService.Search method.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequest", "properties": { -"endTime": { -"description": "Output only. The time the session finished.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"boostSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", +"description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" }, -"name": { -"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", +"branch": { +"description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", "type": "string" }, -"startTime": { -"description": "Output only. The time the session started.", -"format": "google-datetime", -"readOnly": true, +"canonicalFilter": { +"description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", "type": "string" }, -"state": { -"description": "The state of the session.", -"enum": [ -"STATE_UNSPECIFIED", -"IN_PROGRESS" -], -"enumDescriptions": [ -"State is unspecified.", -"The session is currently open." -], -"type": "string" +"contentSearchSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", +"description": "A specification for configuring the behavior of content search." }, -"turns": { -"description": "Turns.", +"customFineTuningSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", +"description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec." +}, +"dataStoreSpecs": { +"description": "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.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaSessionTurn" +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" }, "type": "array" }, -"userPseudoId": { -"description": "A unique identifier for tracking users.", +"embeddingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", +"description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." +}, +"facetSpecs": { +"description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec" +}, +"type": "array" +}, +"filter": { +"description": "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. 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 customer 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)", "type": "string" -} }, -"type": "object" +"imageQuery": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", +"description": "Raw image query." }, -"GoogleCloudDiscoveryengineV1alphaSessionTurn": { -"description": "Represents a turn, including a query from the user and a answer from service.", -"id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", -"properties": { -"answer": { -"description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", +"languageCode": { +"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", "type": "string" }, -"query": { -"$ref": "GoogleCloudDiscoveryengineV1alphaQuery", -"description": "The user query." -} +"naturalLanguageQueryUnderstandingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", +"description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." }, -"type": "object" +"offset": { +"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" }, -"GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { -"description": "Verification information for target sites in advanced site search.", -"id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", -"properties": { -"siteVerificationState": { -"description": "Site verification state indicating the ownership and validity.", -"enum": [ -"SITE_VERIFICATION_STATE_UNSPECIFIED", -"VERIFIED", -"UNVERIFIED", -"EXEMPTED" -], -"enumDescriptions": [ -"Defaults to VERIFIED.", -"Site ownership verified.", -"Site ownership pending verification or verification failed.", -"Site exempt from verification, e.g., a public website that opens to all." -], +"orderBy": { +"description": "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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, -"verifyTime": { -"description": "Latest site verification time.", -"format": "google-datetime", +"pageSize": { +"description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" -} }, +"params": { +"additionalProperties": { +"type": "any" +}, +"description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaTargetSite": { -"description": "A target site for the SiteSearchEngine.", -"id": "GoogleCloudDiscoveryengineV1alphaTargetSite", -"properties": { -"exactMatch": { -"description": "Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.", -"type": "boolean" +"query": { +"description": "Raw search query.", +"type": "string" }, -"failureReason": { -"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", -"description": "Output only. Failure reason.", -"readOnly": true +"queryExpansionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", +"description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, -"generatedUriPattern": { -"description": "Output only. This is system-generated based on the provided_uri_pattern.", -"readOnly": true, +"rankingExpression": { +"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", "type": "string" }, -"indexingStatus": { -"description": "Output only. Indexing status.", +"regionCode": { +"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", +"type": "string" +}, +"relevanceThreshold": { +"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.", "enum": [ -"INDEXING_STATUS_UNSPECIFIED", -"PENDING", -"FAILED", -"SUCCEEDED", -"DELETING" +"RELEVANCE_THRESHOLD_UNSPECIFIED", +"LOWEST", +"LOW", +"MEDIUM", +"HIGH" ], "enumDescriptions": [ -"Defaults to SUCCEEDED.", -"The target site is in the update queue and will be picked up by indexing pipeline.", -"The target site fails to be indexed.", -"The target site has been indexed.", -"The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails." +"Default value. In this case, server behavior defaults to Google defined threshold.", +"Lowest relevance threshold.", +"Low relevance threshold.", +"Medium relevance threshold.", +"High relevance threshold." ], -"readOnly": true, "type": "string" }, -"name": { -"description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", -"readOnly": true, -"type": "string" +"safeSearch": { +"description": "Whether to turn on safe search. This is only supported for website search.", +"type": "boolean" }, -"providedUriPattern": { -"description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", +"searchAsYouTypeSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", +"description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." +}, +"servingConfig": { +"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", "type": "string" }, -"rootDomainUri": { -"description": "Output only. Root domain of the provided_uri_pattern.", -"readOnly": true, +"session": { +"description": "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.", "type": "string" }, -"siteVerificationInfo": { -"$ref": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", -"description": "Output only. Site ownership and validity verification status.", -"readOnly": true +"sessionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", +"description": "Session specification. Can be used only when `session` is set." }, -"type": { -"description": "The type of the target site, e.g., whether the site is to be included or excluded.", -"enum": [ -"TYPE_UNSPECIFIED", -"INCLUDE", -"EXCLUDE" -], -"enumDescriptions": [ -"This value is unused. In this case, server behavior defaults to Type.INCLUDE.", -"Include the target site.", -"Exclude the target site." -], -"type": "string" +"spellCorrectionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", +"description": "The spell correction specification that specifies the mode under which spell correction takes effect." }, -"updateTime": { -"description": "Output only. The target site's last updated time.", -"format": "google-datetime", -"readOnly": true, +"userInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", +"description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." +}, +"userLabels": { +"additionalProperties": { "type": "string" -} }, +"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason": { -"description": "Site search indexing failure reasons.", -"id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", -"properties": { -"quotaFailure": { -"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", -"description": "Failed due to insufficient quota." +"userPseudoId": { +"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure": { -"description": "Failed due to insufficient quota.", -"id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec": { +"description": "Boost specification to boost certain documents.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", "properties": { -"totalRequiredQuota": { -"description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", -"format": "int64", -"type": "string" +"conditionBoostSpecs": { +"description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata": { -"description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec": { +"description": "Boost applies to documents which match a condition.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"boost": { +"description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.", +"format": "float", +"type": "number" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"boostControlSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", +"description": "Complex specification for custom ranking based on customer defined attribute value." +}, +"condition": { +"description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": { -"description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { +"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", -"description": "Echoes the destination for the complete errors in the request if set." +"attributeType": { +"description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", +"enum": [ +"ATTRIBUTE_TYPE_UNSPECIFIED", +"NUMERICAL", +"FRESHNESS" +], +"enumDescriptions": [ +"Unspecified AttributeType.", +"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", +"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." +], +"type": "string" }, -"errorSamples": { -"description": "A sample of errors encountered while processing the data.", +"controlPoints": { +"description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" }, "type": "array" }, -"metrics": { -"additionalProperties": { -"format": "double", -"type": "number" -}, -"description": "The metrics of the trained model.", -"type": "object" -}, -"modelName": { -"description": "Fully qualified name of the CustomTuningModel.", +"fieldName": { +"description": "The name of the field whose value will be used to determine the boost amount.", "type": "string" }, -"modelStatus": { -"description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.", +"interpolationType": { +"description": "The interpolation type to be applied to connect the control points listed below.", +"enum": [ +"INTERPOLATION_TYPE_UNSPECIFIED", +"LINEAR" +], +"enumDescriptions": [ +"Interpolation type is unspecified. In this case, it defaults to Linear.", +"Piecewise linear interpolation will be applied." +], "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata": { -"description": "Metadata associated with a tune operation.", -"id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { +"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "properties": { -"engine": { -"description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", +"attributeValue": { +"description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", "type": "string" -} }, -"type": "object" +"boostAmount": { +"description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", +"format": "float", +"type": "number" +} }, -"GoogleCloudDiscoveryengineV1alphaTuneEngineResponse": { -"description": "Response associated with a tune operation.", -"id": "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse", -"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { -"description": "Metadata for UpdateSchema LRO.", -"id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec": { +"description": "A specification for configuring the behavior of content search.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"chunkSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"extractiveContentSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", +"description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." +}, +"searchResultMode": { +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", +"enum": [ +"SEARCH_RESULT_MODE_UNSPECIFIED", +"DOCUMENTS", +"CHUNKS" +], +"enumDescriptions": [ +"Default value.", +"Returns documents in the search result.", +"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." +], "type": "string" +}, +"snippetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", +"description": "If `snippetSpec` is not specified, snippets are not included in the search response." +}, +"summarySpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", +"description": "If `summarySpec` is not specified, summaries are not included in the search response." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec": { +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"numNextChunks": { +"description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.", +"format": "int32", +"type": "integer" +}, +"numPreviousChunks": { +"description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec": { +"description": "A specification for configuring the extractive content in a search response.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", +"properties": { +"maxExtractiveAnswerCount": { +"description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.", +"format": "int32", +"type": "integer" +}, +"maxExtractiveSegmentCount": { +"description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.", +"format": "int32", +"type": "integer" +}, +"numNextSegments": { +"description": "Return at most `num_next_segments` segments after each selected segments.", +"format": "int32", +"type": "integer" +}, +"numPreviousSegments": { +"description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", +"format": "int32", +"type": "integer" +}, +"returnExtractiveSegmentScore": { +"description": "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`.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec": { +"description": "A specification for configuring snippets in a search response.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", +"properties": { +"maxSnippetCount": { +"deprecated": true, +"description": "[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.", +"format": "int32", +"type": "integer" +}, +"referenceOnly": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", +"type": "boolean" +}, +"returnSnippet": { +"description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec": { +"description": "A specification for configuring a summary returned in a search response.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", +"properties": { +"ignoreAdversarialQuery": { +"description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", +"type": "boolean" +}, +"ignoreNonSummarySeekingQuery": { +"description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", +"type": "boolean" +}, +"includeCitations": { +"description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.", +"type": "boolean" +}, +"languageCode": { +"description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"modelPromptSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", +"description": "If specified, the spec will be used to modify the prompt provided to the LLM." +}, +"modelSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", +"description": "If specified, the spec will be used to modify the model specification provided to the LLM." +}, +"summaryResultCount": { +"description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.", +"format": "int32", +"type": "integer" +}, +"useSemanticChunks": { +"description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { +"description": "Specification of the prompt to use with the model.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", +"properties": { +"preamble": { +"description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec": { +"description": "Specification of the model.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"version": { +"description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).", "type": "string" +} }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": { +"description": "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.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse": { -"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", -"id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse", +"GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": { +"description": "The specification that uses customized query embedding vector to do semantic document retrieval.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", "properties": { -"targetSites": { -"description": "TargetSites created.", +"embeddingVectors": { +"description": "The embedding vector used for retrieval. Limit to 1.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1betaTargetSite" +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaCondition": { -"description": "Defines circumstances to be checked before allowing a behavior", -"id": "GoogleCloudDiscoveryengineV1betaCondition", +"GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector": { +"description": "Embedding vector.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector", "properties": { -"activeTimeRange": { -"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1betaConditionTimeRange" -}, -"type": "array" +"fieldPath": { +"description": "Embedding field path in schema.", +"type": "string" }, -"queryTerms": { -"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", +"vector": { +"description": "Query embedding vector.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm" +"format": "float", +"type": "number" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaConditionQueryTerm": { -"description": "Matcher for search request query", -"id": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm", +"GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec": { +"description": "A facet specification to perform faceted search.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec", "properties": { -"fullMatch": { -"description": "Whether the search query needs to exactly match the query term.", +"enableDynamicPosition": { +"description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.", "type": "boolean" }, -"value": { -"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", +"excludedFilterKeys": { +"description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { "type": "string" -} }, -"type": "object" +"type": "array" }, -"GoogleCloudDiscoveryengineV1betaConditionTimeRange": { -"description": "Used for time-dependent conditions.", -"id": "GoogleCloudDiscoveryengineV1betaConditionTimeRange", -"properties": { -"endTime": { -"description": "End of time range. Range is inclusive. Must be in the future.", -"format": "google-datetime", -"type": "string" +"facetKey": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", +"description": "Required. The facet key specification." }, -"startTime": { -"description": "Start of time range. Range is inclusive.", -"format": "google-datetime", -"type": "string" +"limit": { +"description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaControl": { -"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", -"id": "GoogleCloudDiscoveryengineV1betaControl", +"GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey": { +"description": "Specifies how a facet is computed.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", "properties": { -"associatedServingConfigIds": { -"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"caseInsensitive": { +"description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", +"type": "boolean" +}, +"contains": { +"description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", "items": { "type": "string" }, -"readOnly": true, "type": "array" }, -"boostAction": { -"$ref": "GoogleCloudDiscoveryengineV1betaControlBoostAction", -"description": "Defines a boost-type control" -}, -"conditions": { -"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", +"intervals": { +"description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1betaCondition" +"$ref": "GoogleCloudDiscoveryengineV1alphaInterval" }, "type": "array" }, -"displayName": { -"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"key": { +"description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.", "type": "string" }, -"filterAction": { -"$ref": "GoogleCloudDiscoveryengineV1betaControlFilterAction", -"description": "Defines a filter-type control Currently not supported by Recommendation" +"orderBy": { +"description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", +"type": "string" }, -"name": { -"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", +"prefixes": { +"description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.", +"items": { "type": "string" }, -"redirectAction": { -"$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", -"description": "Defines a redirect-type control." +"type": "array" }, -"solutionType": { -"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", -"enum": [ -"SOLUTION_TYPE_UNSPECIFIED", -"SOLUTION_TYPE_RECOMMENDATION", -"SOLUTION_TYPE_SEARCH", -"SOLUTION_TYPE_CHAT", -"SOLUTION_TYPE_GENERATIVE_CHAT" -], -"enumDescriptions": [ -"Default value.", -"Used for Recommendations AI.", -"Used for Discovery Search.", -"Used for use cases related to the Generative AI agent.", -"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." -], +"restrictedValues": { +"description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.", +"items": { "type": "string" }, -"synonymsAction": { -"$ref": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", -"description": "Treats a group of terms as synonyms of one another." +"type": "array" +} }, -"useCases": { -"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", -"items": { +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery": { +"description": "Specifies the image query input.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", +"properties": { +"imageBytes": { +"description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec": { +"description": "Specification to enable natural language understanding capabilities for search requests.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", +"properties": { +"filterExtractionCondition": { +"description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", "enum": [ -"SEARCH_USE_CASE_UNSPECIFIED", -"SEARCH_USE_CASE_SEARCH", -"SEARCH_USE_CASE_BROWSE" +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" ], "enumDescriptions": [ -"Value used when unset. Will not occur in CSS.", -"Search use case. Expects the traffic has a non-empty query.", -"Browse use case. Expects the traffic has an empty query." +"Server behavior defaults to Condition.DISABLED.", +"Disables NL filter extraction.", +"Enables NL filter extraction." ], "type": "string" }, +"geoSearchQueryDetectionFieldNames": { +"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", +"items": { +"type": "string" +}, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaControlBoostAction": { -"description": "Adjusts order of products in returned list.", -"id": "GoogleCloudDiscoveryengineV1betaControlBoostAction", +"GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": { +"description": "Specification to determine under which conditions query expansion should occur.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", "properties": { -"boost": { -"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", -"format": "float", -"type": "number" -}, -"dataStore": { -"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", +"condition": { +"description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"AUTO" +], +"enumDescriptions": [ +"Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.", +"Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.", +"Automatic query expansion built by the Search API." +], "type": "string" }, -"filter": { -"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", -"type": "string" +"pinUnexpandedResults": { +"description": "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.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaControlFilterAction": { -"description": "Specified which products may be included in results. Uses same filter as boost.", -"id": "GoogleCloudDiscoveryengineV1betaControlFilterAction", +"GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { +"description": "Specification for search as you type in search requests.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", "properties": { -"dataStore": { -"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", -"type": "string" -}, -"filter": { -"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"condition": { +"description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Server behavior defaults to Condition.DISABLED.", +"Disables Search As You Type.", +"Enables Search As You Type." +], "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaControlRedirectAction": { -"description": "Redirects a shopper to the provided URI.", -"id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", +"GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec": { +"description": "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.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", "properties": { -"redirectUri": { -"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"queryId": { +"description": "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.", "type": "string" +}, +"searchResultPersistenceCount": { +"description": "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.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaControlSynonymsAction": { -"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", -"id": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", +"GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec": { +"description": "The specification for query spell correction.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", "properties": { -"synonyms": { -"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", -"items": { +"mode": { +"description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", +"enum": [ +"MODE_UNSPECIFIED", +"SUGGESTION_ONLY", +"AUTO" +], +"enumDescriptions": [ +"Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", +"Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", +"Automatic spell correction built by the Search API. Search will be based on the corrected query if found." +], "type": "string" -}, -"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": { -"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata", +"GoogleCloudDiscoveryengineV1alphaSession": { +"description": "External session proto definition.", +"id": "GoogleCloudDiscoveryengineV1alphaSession", "properties": { -"createTime": { -"description": "Operation create time.", +"endTime": { +"description": "Output only. The time the session finished.", "format": "google-datetime", +"readOnly": true, "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", +"name": { +"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", +"type": "string" +}, +"startTime": { +"description": "Output only. The time the session started.", "format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "The state of the session.", +"enum": [ +"STATE_UNSPECIFIED", +"IN_PROGRESS" +], +"enumDescriptions": [ +"State is unspecified.", +"The session is currently open." +], +"type": "string" +}, +"turns": { +"description": "Turns.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSessionTurn" +}, +"type": "array" +}, +"userPseudoId": { +"description": "A unique identifier for tracking users.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaCreateEngineMetadata": { -"description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata", +"GoogleCloudDiscoveryengineV1alphaSessionTurn": { +"description": "Represents a turn, including a query from the user and a answer from service.", +"id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"answer": { +"description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"query": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQuery", +"description": "The user query." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { -"description": "Metadata for Create Schema LRO.", -"id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", +"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -13772,178 +14273,145 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse": { +"description": "Response message for SiteSearchEngineService.SetUriPatternDocumentData method.", +"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { +"description": "Verification information for target sites in advanced site search.", +"id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"siteVerificationState": { +"description": "Site verification state indicating the ownership and validity.", +"enum": [ +"SITE_VERIFICATION_STATE_UNSPECIFIED", +"VERIFIED", +"UNVERIFIED", +"EXEMPTED" +], +"enumDescriptions": [ +"Defaults to VERIFIED.", +"Site ownership verified.", +"Site ownership pending verification or verification failed.", +"Site exempt from verification, e.g., a public website that opens to all." +], "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", +"verifyTime": { +"description": "Latest site verification time.", "format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaCustomTuningModel": { -"description": "Metadata that describes a custom tuned model.", -"id": "GoogleCloudDiscoveryengineV1betaCustomTuningModel", +"GoogleCloudDiscoveryengineV1alphaTargetSite": { +"description": "A target site for the SiteSearchEngine.", +"id": "GoogleCloudDiscoveryengineV1alphaTargetSite", "properties": { -"createTime": { -"deprecated": true, -"description": "Timestamp the Model was created at.", -"format": "google-datetime", -"type": "string" +"exactMatch": { +"description": "Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.", +"type": "boolean" }, -"displayName": { -"description": "The display name of the model.", -"type": "string" +"failureReason": { +"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", +"description": "Output only. Failure reason.", +"readOnly": true }, -"metrics": { -"additionalProperties": { -"format": "double", -"type": "number" -}, -"description": "The metrics of the trained model.", -"type": "object" +"generatedUriPattern": { +"description": "Output only. This is system-generated based on the provided_uri_pattern.", +"readOnly": true, +"type": "string" }, -"modelState": { -"description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", +"indexingStatus": { +"description": "Output only. Indexing status.", "enum": [ -"MODEL_STATE_UNSPECIFIED", -"TRAINING_PAUSED", -"TRAINING", -"TRAINING_COMPLETE", -"READY_FOR_SERVING", -"TRAINING_FAILED", -"NO_IMPROVEMENT" +"INDEXING_STATUS_UNSPECIFIED", +"PENDING", +"FAILED", +"SUCCEEDED", +"DELETING" ], "enumDescriptions": [ -"Default value.", -"The model is in a paused training state.", -"The model is currently training.", -"The model has successfully completed training.", -"The model is ready for serving.", -"The model training failed.", -"The model training finished successfully but metrics did not improve." +"Defaults to SUCCEEDED.", +"The target site is in the update queue and will be picked up by indexing pipeline.", +"The target site fails to be indexed.", +"The target site has been indexed.", +"The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails." ], +"readOnly": true, "type": "string" }, -"modelVersion": { -"description": "The version of the model.", -"format": "int64", +"name": { +"description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", +"readOnly": true, "type": "string" }, -"name": { -"description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", +"providedUriPattern": { +"description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", "type": "string" }, -"trainingStartTime": { -"description": "Timestamp the model training was initiated.", -"format": "google-datetime", +"rootDomainUri": { +"description": "Output only. Root domain of the provided_uri_pattern.", +"readOnly": true, "type": "string" -} }, -"type": "object" +"siteVerificationInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", +"description": "Output only. Site ownership and validity verification status.", +"readOnly": true }, -"GoogleCloudDiscoveryengineV1betaDataStore": { -"description": "DataStore captures global settings and configs at the DataStore level.", -"id": "GoogleCloudDiscoveryengineV1betaDataStore", -"properties": { -"contentConfig": { -"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", +"type": { +"description": "The type of the target site, e.g., whether the site is to be included or excluded.", "enum": [ -"CONTENT_CONFIG_UNSPECIFIED", -"NO_CONTENT", -"CONTENT_REQUIRED", -"PUBLIC_WEBSITE" +"TYPE_UNSPECIFIED", +"INCLUDE", +"EXCLUDE" ], "enumDescriptions": [ -"Default value.", -"Only contains documents without any Document.content.", -"Only contains documents with Document.content.", -"The data store is used for public website search." +"This value is unused. In this case, server behavior defaults to Type.INCLUDE.", +"Include the target site.", +"Exclude the target site." ], "type": "string" }, -"createTime": { -"description": "Output only. Timestamp the DataStore was created at.", +"updateTime": { +"description": "Output only. The target site's last updated time.", "format": "google-datetime", "readOnly": true, "type": "string" +} }, -"defaultSchemaId": { -"description": "Output only. The id of the default Schema asscociated to this data store.", -"readOnly": true, -"type": "string" -}, -"displayName": { -"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", -"type": "string" -}, -"documentProcessingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", -"description": "Configuration for Document understanding and enrichment." -}, -"industryVertical": { -"description": "Immutable. The industry vertical that the data store registers.", -"enum": [ -"INDUSTRY_VERTICAL_UNSPECIFIED", -"GENERIC", -"MEDIA", -"HEALTHCARE_FHIR" -], -"enumDescriptions": [ -"Value used when unset.", -"The generic vertical for documents that are not specific to any industry vertical.", -"The media industry vertical.", -"The healthcare FHIR vertical." -], -"type": "string" +"type": "object" }, -"languageInfo": { -"$ref": "GoogleCloudDiscoveryengineV1betaLanguageInfo", -"description": "Language info for DataStore." +"GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason": { +"description": "Site search indexing failure reasons.", +"id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", +"properties": { +"quotaFailure": { +"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", +"description": "Failed due to insufficient quota." +} }, -"name": { -"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", -"type": "string" +"type": "object" }, -"solutionTypes": { -"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", -"items": { -"enum": [ -"SOLUTION_TYPE_UNSPECIFIED", -"SOLUTION_TYPE_RECOMMENDATION", -"SOLUTION_TYPE_SEARCH", -"SOLUTION_TYPE_CHAT", -"SOLUTION_TYPE_GENERATIVE_CHAT" -], -"enumDescriptions": [ -"Default value.", -"Used for Recommendations AI.", -"Used for Discovery Search.", -"Used for use cases related to the Generative AI agent.", -"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." -], +"GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure": { +"description": "Failed due to insufficient quota.", +"id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", +"properties": { +"totalRequiredQuota": { +"description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", +"format": "int64", "type": "string" -}, -"type": "array" -}, -"startingSchema": { -"$ref": "GoogleCloudDiscoveryengineV1betaSchema", -"description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { -"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", +"GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata": { +"description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -13958,26 +14426,60 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata": { -"description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata", +"GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": { +"description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "Echoes the destination for the complete errors in the request if set." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the data.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"metrics": { +"additionalProperties": { +"format": "double", +"type": "number" +}, +"description": "The metrics of the trained model.", +"type": "object" +}, +"modelName": { +"description": "Fully qualified name of the CustomTuningModel.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"modelStatus": { +"description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata": { -"description": "Metadata for DeleteSchema LRO.", -"id": "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata", +"GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata": { +"description": "Metadata associated with a tune operation.", +"id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", +"properties": { +"engine": { +"description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaTuneEngineResponse": { +"description": "Response associated with a tune operation.", +"id": "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { +"description": "Metadata for UpdateSchema LRO.", +"id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -13992,9 +14494,9 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -14009,9 +14511,24 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata", +"GoogleCloudDiscoveryengineV1alphaUserInfo": { +"description": "Information of an end user.", +"id": "GoogleCloudDiscoveryengineV1alphaUserInfo", +"properties": { +"userAgent": { +"description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.", +"type": "string" +}, +"userId": { +"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -14026,198 +14543,114 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse": { -"description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", -"id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig": { -"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", -"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", +"GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse": { +"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", +"id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse", "properties": { -"chunkingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", -"description": "Whether chunking mode is enabled." -}, -"defaultParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", -"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." -}, -"name": { -"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", -"type": "string" -}, -"parsingConfigOverrides": { -"additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig" +"targetSites": { +"description": "TargetSites created.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaTargetSite" }, -"description": "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.", -"type": "object" +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { -"description": "Configuration for chunking config.", -"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", +"GoogleCloudDiscoveryengineV1betaCondition": { +"description": "Defines circumstances to be checked before allowing a behavior", +"id": "GoogleCloudDiscoveryengineV1betaCondition", "properties": { -"layoutBasedChunkingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", -"description": "Configuration for the layout based chunking." -} +"activeTimeRange": { +"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaConditionTimeRange" }, -"type": "object" +"type": "array" }, -"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { -"description": "Configuration for the layout based chunking.", -"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", -"properties": { -"chunkSize": { -"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", -"format": "int32", -"type": "integer" +"queryTerms": { +"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm" }, -"includeAncestorHeadings": { -"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", -"type": "boolean" +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { -"description": "Related configurations applied to a specific type of document parser.", -"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", +"GoogleCloudDiscoveryengineV1betaConditionQueryTerm": { +"description": "Matcher for search request query", +"id": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm", "properties": { -"digitalParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", -"description": "Configurations applied to digital parser." -}, -"layoutParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", -"description": "Configurations applied to layout parser." -}, -"ocrParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", -"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { -"description": "The digital parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { -"description": "The layout parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", -"properties": {}, -"type": "object" +"fullMatch": { +"description": "Whether the search query needs to exactly match the query term.", +"type": "boolean" }, -"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { -"description": "The OCR parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", -"properties": { -"enhancedDocumentElements": { -"deprecated": true, -"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", -"items": { +"value": { +"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", "type": "string" -}, -"type": "array" -}, -"useNativeText": { -"description": "If true, will use native text instead of OCR text on pages containing native text.", -"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata", +"GoogleCloudDiscoveryengineV1betaConditionTimeRange": { +"description": "Used for time-dependent conditions.", +"id": "GoogleCloudDiscoveryengineV1betaConditionTimeRange", "properties": { -"createTime": { -"description": "Operation create time.", +"endTime": { +"description": "End of time range. Range is inclusive. Must be in the future.", "format": "google-datetime", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", +"startTime": { +"description": "Start of time range. Range is inclusive.", "format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse": { -"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", -"id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1betaEngine": { -"description": "Metadata that describes the training and serving parameters of an Engine.", -"id": "GoogleCloudDiscoveryengineV1betaEngine", +"GoogleCloudDiscoveryengineV1betaControl": { +"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", +"id": "GoogleCloudDiscoveryengineV1betaControl", "properties": { -"chatEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", -"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." -}, -"chatEngineMetadata": { -"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", -"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", -"readOnly": true -}, -"commonConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", -"description": "Common config spec that specifies the metadata of the engine." +"associatedServingConfigIds": { +"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"items": { +"type": "string" }, -"createTime": { -"description": "Output only. Timestamp the Recommendation Engine was created at.", -"format": "google-datetime", "readOnly": true, -"type": "string" +"type": "array" }, -"dataStoreIds": { -"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", +"boostAction": { +"$ref": "GoogleCloudDiscoveryengineV1betaControlBoostAction", +"description": "Defines a boost-type control" +}, +"conditions": { +"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", "items": { -"type": "string" +"$ref": "GoogleCloudDiscoveryengineV1betaCondition" }, "type": "array" }, "displayName": { -"description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", +"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" }, -"industryVertical": { -"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", -"enum": [ -"INDUSTRY_VERTICAL_UNSPECIFIED", -"GENERIC", -"MEDIA", -"HEALTHCARE_FHIR" -], -"enumDescriptions": [ -"Value used when unset.", -"The generic vertical for documents that are not specific to any industry vertical.", -"The media industry vertical.", -"The healthcare FHIR vertical." -], -"type": "string" +"filterAction": { +"$ref": "GoogleCloudDiscoveryengineV1betaControlFilterAction", +"description": "Defines a filter-type control Currently not supported by Recommendation" }, "name": { -"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", +"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "type": "string" }, -"searchEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", -"description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." +"redirectAction": { +"$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", +"description": "Defines a redirect-type control." }, "solutionType": { -"description": "Required. The solutions of the engine.", +"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", @@ -14234,475 +14667,1915 @@ ], "type": "string" }, -"updateTime": { -"description": "Output only. Timestamp the Recommendation Engine was last updated.", -"format": "google-datetime", -"readOnly": true, +"synonymsAction": { +"$ref": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", +"description": "Treats a group of terms as synonyms of one another." +}, +"useCases": { +"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", +"items": { +"enum": [ +"SEARCH_USE_CASE_UNSPECIFIED", +"SEARCH_USE_CASE_SEARCH", +"SEARCH_USE_CASE_BROWSE" +], +"enumDescriptions": [ +"Value used when unset. Will not occur in CSS.", +"Search use case. Expects the traffic has a non-empty query.", +"Browse use case. Expects the traffic has an empty query." +], "type": "string" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig": { -"description": "Configurations for a Chat Engine.", -"id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", +"GoogleCloudDiscoveryengineV1betaControlBoostAction": { +"description": "Adjusts order of products in returned list.", +"id": "GoogleCloudDiscoveryengineV1betaControlBoostAction", "properties": { -"agentCreationConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", -"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." +"boost": { +"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", +"format": "float", +"type": "number" }, -"dialogflowAgentToLink": { -"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", +"dataStore": { +"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", +"type": "string" +}, +"filter": { +"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig": { -"description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", -"id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", +"GoogleCloudDiscoveryengineV1betaControlFilterAction": { +"description": "Specified which products may be included in results. Uses same filter as boost.", +"id": "GoogleCloudDiscoveryengineV1betaControlFilterAction", "properties": { -"business": { -"description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", +"dataStore": { +"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", "type": "string" }, -"defaultLanguageCode": { -"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", +"filter": { +"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" +} }, -"location": { -"description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaControlRedirectAction": { +"description": "Redirects a shopper to the provided URI.", +"id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", +"properties": { +"redirectUri": { +"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" +} }, -"timeZone": { -"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaControlSynonymsAction": { +"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", +"id": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", +"properties": { +"synonyms": { +"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", +"items": { "type": "string" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata": { -"description": "Additional information of a Chat Engine. Fields in this message are output only.", -"id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", +"GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": { +"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata", "properties": { -"dialogflowAgent": { -"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { -"description": "Common configurations for an Engine.", -"id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", +"GoogleCloudDiscoveryengineV1betaCreateEngineMetadata": { +"description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata", "properties": { -"companyName": { -"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { -"description": "Configurations for a Search Engine.", -"id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", +"GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata": { +"description": "Metadata for EvaluationService.CreateEvaluation method.", +"id": "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { +"description": "Metadata for Create Schema LRO.", +"id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", "properties": { -"searchAddOns": { -"description": "The add-on that this search engine enables.", -"items": { -"enum": [ -"SEARCH_ADD_ON_UNSPECIFIED", -"SEARCH_ADD_ON_LLM" -], -"enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Large language model add-on." -], +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"type": "array" +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} }, -"searchTier": { -"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaCustomTuningModel": { +"description": "Metadata that describes a custom tuned model.", +"id": "GoogleCloudDiscoveryengineV1betaCustomTuningModel", +"properties": { +"createTime": { +"deprecated": true, +"description": "Timestamp the Model was created at.", +"format": "google-datetime", +"type": "string" +}, +"displayName": { +"description": "The display name of the model.", +"type": "string" +}, +"metrics": { +"additionalProperties": { +"format": "double", +"type": "number" +}, +"description": "The metrics of the trained model.", +"type": "object" +}, +"modelState": { +"description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", "enum": [ -"SEARCH_TIER_UNSPECIFIED", -"SEARCH_TIER_STANDARD", -"SEARCH_TIER_ENTERPRISE" +"MODEL_STATE_UNSPECIFIED", +"TRAINING_PAUSED", +"TRAINING", +"TRAINING_COMPLETE", +"READY_FOR_SERVING", +"TRAINING_FAILED", +"NO_IMPROVEMENT" ], "enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Standard tier.", -"Enterprise tier." +"Default value.", +"The model is in a paused training state.", +"The model is currently training.", +"The model has successfully completed training.", +"The model is ready for serving.", +"The model training failed.", +"The model training finished successfully but metrics did not improve." ], "type": "string" +}, +"modelVersion": { +"description": "The version of the model.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", +"type": "string" +}, +"trainingStartTime": { +"description": "Timestamp the model training was initiated.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { -"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", +"GoogleCloudDiscoveryengineV1betaDataStore": { +"description": "DataStore captures global settings and configs at the DataStore level.", +"id": "GoogleCloudDiscoveryengineV1betaDataStore", "properties": { +"contentConfig": { +"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", +"enum": [ +"CONTENT_CONFIG_UNSPECIFIED", +"NO_CONTENT", +"CONTENT_REQUIRED", +"PUBLIC_WEBSITE" +], +"enumDescriptions": [ +"Default value.", +"Only contains documents without any Document.content.", +"Only contains documents with Document.content.", +"The data store is used for public website search." +], +"type": "string" +}, "createTime": { -"description": "Operation create time.", +"description": "Output only. Timestamp the DataStore was created at.", "format": "google-datetime", +"readOnly": true, "type": "string" }, -"failureCount": { -"description": "Count of CompletionSuggestions that failed to be imported.", -"format": "int64", +"defaultSchemaId": { +"description": "Output only. The id of the default Schema asscociated to this data store.", +"readOnly": true, "type": "string" }, -"successCount": { -"description": "Count of CompletionSuggestions successfully imported.", -"format": "int64", +"displayName": { +"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"documentProcessingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", +"description": "Configuration for Document understanding and enrichment." +}, +"industryVertical": { +"description": "Immutable. The industry vertical that the data store registers.", +"enum": [ +"INDUSTRY_VERTICAL_UNSPECIFIED", +"GENERIC", +"MEDIA", +"HEALTHCARE_FHIR" +], +"enumDescriptions": [ +"Value used when unset.", +"The generic vertical for documents that are not specific to any industry vertical.", +"The media industry vertical.", +"The healthcare FHIR vertical." +], +"type": "string" +}, +"languageInfo": { +"$ref": "GoogleCloudDiscoveryengineV1betaLanguageInfo", +"description": "Language info for DataStore." +}, +"name": { +"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"solutionTypes": { +"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", +"items": { +"enum": [ +"SOLUTION_TYPE_UNSPECIFIED", +"SOLUTION_TYPE_RECOMMENDATION", +"SOLUTION_TYPE_SEARCH", +"SOLUTION_TYPE_CHAT", +"SOLUTION_TYPE_GENERATIVE_CHAT" +], +"enumDescriptions": [ +"Default value.", +"Used for Recommendations AI.", +"Used for Discovery Search.", +"Used for use cases related to the Generative AI agent.", +"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +], "type": "string" +}, +"type": "array" +}, +"startingSchema": { +"$ref": "GoogleCloudDiscoveryengineV1betaSchema", +"description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse": { +"GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { +"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata": { +"description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata": { +"description": "Metadata for DeleteSchema LRO.", +"id": "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse": { +"description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", +"id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig": { +"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", +"properties": { +"chunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", +"description": "Whether chunking mode is enabled." +}, +"defaultParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", +"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." +}, +"name": { +"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", +"type": "string" +}, +"parsingConfigOverrides": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig" +}, +"description": "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.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { +"description": "Configuration for chunking config.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", +"properties": { +"layoutBasedChunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"description": "Configuration for the layout based chunking." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { +"description": "Configuration for the layout based chunking.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"properties": { +"chunkSize": { +"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", +"format": "int32", +"type": "integer" +}, +"includeAncestorHeadings": { +"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { +"description": "Related configurations applied to a specific type of document parser.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", +"properties": { +"digitalParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", +"description": "Configurations applied to digital parser." +}, +"layoutParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", +"description": "Configurations applied to layout parser." +}, +"ocrParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", +"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { +"description": "The digital parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { +"description": "The layout parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { +"description": "The OCR parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", +"properties": { +"enhancedDocumentElements": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"useNativeText": { +"description": "If true, will use native text instead of OCR text on pages containing native text.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse": { +"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", +"id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngine": { +"description": "Metadata that describes the training and serving parameters of an Engine.", +"id": "GoogleCloudDiscoveryengineV1betaEngine", +"properties": { +"chatEngineConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", +"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." +}, +"chatEngineMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", +"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", +"readOnly": true +}, +"commonConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", +"description": "Common config spec that specifies the metadata of the engine." +}, +"createTime": { +"description": "Output only. Timestamp the Recommendation Engine was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"dataStoreIds": { +"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", +"items": { +"type": "string" +}, +"type": "array" +}, +"displayName": { +"description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", +"type": "string" +}, +"industryVertical": { +"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", +"enum": [ +"INDUSTRY_VERTICAL_UNSPECIFIED", +"GENERIC", +"MEDIA", +"HEALTHCARE_FHIR" +], +"enumDescriptions": [ +"Value used when unset.", +"The generic vertical for documents that are not specific to any industry vertical.", +"The media industry vertical.", +"The healthcare FHIR vertical." +], +"type": "string" +}, +"name": { +"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", +"type": "string" +}, +"searchEngineConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", +"description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." +}, +"solutionType": { +"description": "Required. The solutions of the engine.", +"enum": [ +"SOLUTION_TYPE_UNSPECIFIED", +"SOLUTION_TYPE_RECOMMENDATION", +"SOLUTION_TYPE_SEARCH", +"SOLUTION_TYPE_CHAT", +"SOLUTION_TYPE_GENERATIVE_CHAT" +], +"enumDescriptions": [ +"Default value.", +"Used for Recommendations AI.", +"Used for Discovery Search.", +"Used for use cases related to the Generative AI agent.", +"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +], +"type": "string" +}, +"updateTime": { +"description": "Output only. Timestamp the Recommendation Engine was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig": { +"description": "Configurations for a Chat Engine.", +"id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", +"properties": { +"agentCreationConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", +"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." +}, +"dialogflowAgentToLink": { +"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig": { +"description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", +"id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", +"properties": { +"business": { +"description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", +"type": "string" +}, +"defaultLanguageCode": { +"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", +"type": "string" +}, +"location": { +"description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", +"type": "string" +}, +"timeZone": { +"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata": { +"description": "Additional information of a Chat Engine. Fields in this message are output only.", +"id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", +"properties": { +"dialogflowAgent": { +"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { +"description": "Common configurations for an Engine.", +"id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", +"properties": { +"companyName": { +"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { +"description": "Configurations for a Search Engine.", +"id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", +"properties": { +"searchAddOns": { +"description": "The add-on that this search engine enables.", +"items": { +"enum": [ +"SEARCH_ADD_ON_UNSPECIFIED", +"SEARCH_ADD_ON_LLM" +], +"enumDescriptions": [ +"Default value when the enum is unspecified. This is invalid to use.", +"Large language model add-on." +], +"type": "string" +}, +"type": "array" +}, +"searchTier": { +"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", +"enum": [ +"SEARCH_TIER_UNSPECIFIED", +"SEARCH_TIER_STANDARD", +"SEARCH_TIER_ENTERPRISE" +], +"enumDescriptions": [ +"Default value when the enum is unspecified. This is invalid to use.", +"Standard tier.", +"Enterprise tier." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEvaluation": { +"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluation", +"properties": { +"createTime": { +"description": "Output only. Timestamp the Evaluation was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. Timestamp the Evaluation was completed at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", +"readOnly": true +}, +"errorSamples": { +"description": "Output only. A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"readOnly": true, +"type": "array" +}, +"evaluationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", +"description": "Required. The specification of the evaluation." +}, +"name": { +"description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", +"readOnly": true +}, +"state": { +"description": "Output only. The state of the evaluation.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The evaluation is unspecified.", +"The service is preparing to run the evaluation.", +"The evaluation is in progress.", +"The evaluation completed successfully.", +"The evaluation failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec": { +"description": "Describes the specification of the evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", +"properties": { +"querySetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", +"description": "Required. The specification of the query set." +}, +"searchRequest": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest", +"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec": { +"description": "Describes the specification of the query set.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", +"properties": { +"sampleQuerySet": { +"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { +"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of CompletionSuggestions that failed to be imported.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of CompletionSuggestions successfully imported.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse": { "description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", -"description": "The desired location of errors incurred during the Import." +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata": { +"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of entries that were processed successfully.", +"format": "int64", +"type": "string" +}, +"totalCount": { +"description": "Total count of entries that were processed.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportDocumentsResponse": { +"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", +"id": "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"description": "Echoes the destination for the complete errors in the request if set." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportErrorConfig": { +"description": "Configuration of destination for Import related errors.", +"id": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"properties": { +"gcsPrefix": { +"description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata": { +"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata", +"properties": { +"createTime": { +"description": "ImportSampleQueries operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of SampleQuerys that failed to be imported.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of SampleQuerys successfully imported.", +"format": "int64", +"type": "string" +}, +"totalCount": { +"description": "Total count of SampleQuerys that were processed.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse": { +"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse", +"properties": { +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"failedEntriesCount": { +"description": "Count of deny list entries that failed to be imported.", +"format": "int64", +"type": "string" +}, +"importedEntriesCount": { +"description": "Count of deny list entries successfully imported.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata": { +"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of entries that were processed successfully.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportUserEventsResponse": { +"description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", +"id": "GoogleCloudDiscoveryengineV1betaImportUserEventsResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"description": "Echoes the destination for the complete errors if this field was set in the request." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"joinedEventsCount": { +"description": "Count of user events imported with complete existing Documents.", +"format": "int64", +"type": "string" +}, +"unjoinedEventsCount": { +"description": "Count of user events imported, but with Document information not found in the existing Branch.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaInterval": { +"description": "A floating point interval.", +"id": "GoogleCloudDiscoveryengineV1betaInterval", +"properties": { +"exclusiveMaximum": { +"description": "Exclusive upper bound.", +"format": "double", +"type": "number" +}, +"exclusiveMinimum": { +"description": "Exclusive lower bound.", +"format": "double", +"type": "number" +}, +"maximum": { +"description": "Inclusive upper bound.", +"format": "double", +"type": "number" +}, +"minimum": { +"description": "Inclusive lower bound.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaLanguageInfo": { +"description": "Language info for DataStore.", +"id": "GoogleCloudDiscoveryengineV1betaLanguageInfo", +"properties": { +"language": { +"description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", +"readOnly": true, +"type": "string" +}, +"languageCode": { +"description": "The language code for the DataStore.", +"type": "string" +}, +"normalizedLanguageCode": { +"description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", +"readOnly": true, +"type": "string" +}, +"region": { +"description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaListCustomModelsResponse": { +"description": "Response message for SearchTuningService.ListCustomModels method.", +"id": "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse", +"properties": { +"models": { +"description": "List of custom tuning models.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaProject": { +"description": "Metadata and configurations for a Google Cloud project in the service.", +"id": "GoogleCloudDiscoveryengineV1betaProject", +"properties": { +"createTime": { +"description": "Output only. The timestamp when this project is created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", +"readOnly": true, +"type": "string" +}, +"provisionCompletionTime": { +"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"serviceTermsMap": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" +}, +"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { +"description": "Metadata about the terms of service.", +"id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", +"properties": { +"acceptTime": { +"description": "The last time when the project agreed to the terms of service.", +"format": "google-datetime", +"type": "string" +}, +"declineTime": { +"description": "The last time when the project declined or revoked the agreement to terms of service.", +"format": "google-datetime", +"type": "string" +}, +"id": { +"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", +"type": "string" +}, +"state": { +"description": "Whether the project has accepted/rejected the service terms or it is still pending.", +"enum": [ +"STATE_UNSPECIFIED", +"TERMS_ACCEPTED", +"TERMS_PENDING", +"TERMS_DECLINED" +], +"enumDescriptions": [ +"The default value of the enum. This value is not actually used.", +"The project has given consent to the terms of service.", +"The project is pending to review and accept the terms of service.", +"The project has declined or revoked the agreement to terms of service." +], +"type": "string" +}, +"version": { +"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { +"description": "Metadata associated with a project provision operation.", +"id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { +"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", +"type": "string" +}, +"ignoredCount": { +"description": "Count of entries that were ignored as entries were not found.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of entries that were deleted successfully.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse": { +"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse", +"properties": { +"purgeCount": { +"description": "The total count of documents purged as a result of the operation.", +"format": "int64", +"type": "string" +}, +"purgeSample": { +"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", +"properties": { +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"purgeCount": { +"description": "Number of suggestion deny list entries purged.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaQualityMetrics": { +"description": "Describes the metrics produced by the evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaQualityMetrics", +"properties": { +"docNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"docPrecision": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" +}, +"docRecall": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" +}, +"pageNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"pageRecall": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics": { +"description": "Stores the metric values at specific top-k levels.", +"id": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"properties": { +"top1": { +"description": "The top-1 value.", +"format": "double", +"type": "number" +}, +"top10": { +"description": "The top-10 value.", +"format": "double", +"type": "number" +}, +"top3": { +"description": "The top-3 value.", +"format": "double", +"type": "number" +}, +"top5": { +"description": "The top-5 value.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSchema": { +"description": "Defines the structure and layout of a type of document data.", +"id": "GoogleCloudDiscoveryengineV1betaSchema", +"properties": { +"jsonSchema": { +"description": "The JSON representation of the schema.", +"type": "string" +}, +"name": { +"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"structSchema": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The structured representation of the schema.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequest": { +"description": "Request message for SearchService.Search method.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequest", +"properties": { +"boostSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", +"description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" +}, +"branch": { +"description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", +"type": "string" +}, +"canonicalFilter": { +"description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", +"type": "string" +}, +"contentSearchSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", +"description": "A specification for configuring the behavior of content search." +}, +"dataStoreSpecs": { +"description": "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.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" +}, +"type": "array" +}, +"embeddingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", +"description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." +}, +"facetSpecs": { +"description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec" +}, +"type": "array" +}, +"filter": { +"description": "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. 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 customer 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)", +"type": "string" +}, +"imageQuery": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", +"description": "Raw image query." +}, +"languageCode": { +"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", +"type": "string" +}, +"naturalLanguageQueryUnderstandingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", +"description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." +}, +"offset": { +"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" +}, +"orderBy": { +"description": "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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", +"type": "string" +}, +"pageSize": { +"description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +}, +"params": { +"additionalProperties": { +"type": "any" +}, +"description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", +"type": "object" +}, +"query": { +"description": "Raw search query.", +"type": "string" +}, +"queryExpansionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", +"description": "The query expansion specification that specifies the conditions under which query expansion occurs." +}, +"rankingExpression": { +"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", +"type": "string" +}, +"regionCode": { +"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", +"type": "string" +}, +"safeSearch": { +"description": "Whether to turn on safe search. This is only supported for website search.", +"type": "boolean" +}, +"searchAsYouTypeSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", +"description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." +}, +"servingConfig": { +"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", +"type": "string" +}, +"session": { +"description": "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.", +"type": "string" +}, +"sessionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", +"description": "Session specification. Can be used only when `session` is set." +}, +"spellCorrectionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", +"description": "The spell correction specification that specifies the mode under which spell correction takes effect." +}, +"userInfo": { +"$ref": "GoogleCloudDiscoveryengineV1betaUserInfo", +"description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." +}, +"userLabels": { +"additionalProperties": { +"type": "string" +}, +"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", +"type": "object" +}, +"userPseudoId": { +"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec": { +"description": "Boost specification to boost certain documents.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", +"properties": { +"conditionBoostSpecs": { +"description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec": { +"description": "Boost applies to documents which match a condition.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec", +"properties": { +"boost": { +"description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.", +"format": "float", +"type": "number" }, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"boostControlSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", +"description": "Complex specification for custom ranking based on customer defined attribute value." }, -"type": "array" +"condition": { +"description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata": { -"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata", +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { +"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"attributeType": { +"description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", +"enum": [ +"ATTRIBUTE_TYPE_UNSPECIFIED", +"NUMERICAL", +"FRESHNESS" +], +"enumDescriptions": [ +"Unspecified AttributeType.", +"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", +"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." +], "type": "string" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", -"type": "string" +"controlPoints": { +"description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" }, -"successCount": { -"description": "Count of entries that were processed successfully.", -"format": "int64", -"type": "string" +"type": "array" }, -"totalCount": { -"description": "Total count of entries that were processed.", -"format": "int64", +"fieldName": { +"description": "The name of the field whose value will be used to determine the boost amount.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"interpolationType": { +"description": "The interpolation type to be applied to connect the control points listed below.", +"enum": [ +"INTERPOLATION_TYPE_UNSPECIFIED", +"LINEAR" +], +"enumDescriptions": [ +"Interpolation type is unspecified. In this case, it defaults to Linear.", +"Piecewise linear interpolation will be applied." +], "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportDocumentsResponse": { -"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", -"id": "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { +"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", -"description": "Echoes the destination for the complete errors in the request if set." -}, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"attributeValue": { +"description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", +"type": "string" }, -"type": "array" +"boostAmount": { +"description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", +"format": "float", +"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportErrorConfig": { -"description": "Configuration of destination for Import related errors.", -"id": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec": { +"description": "A specification for configuring the behavior of content search.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", "properties": { -"gcsPrefix": { -"description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", +"chunkSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec", +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" +}, +"extractiveContentSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", +"description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." +}, +"searchResultMode": { +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", +"enum": [ +"SEARCH_RESULT_MODE_UNSPECIFIED", +"DOCUMENTS", +"CHUNKS" +], +"enumDescriptions": [ +"Default value.", +"Returns documents in the search result.", +"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." +], "type": "string" +}, +"snippetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", +"description": "If `snippetSpec` is not specified, snippets are not included in the search response." +}, +"summarySpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", +"description": "If `summarySpec` is not specified, summaries are not included in the search response." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec": { +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"numNextChunks": { +"description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.", +"format": "int32", +"type": "integer" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"numPreviousChunks": { +"description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec": { +"description": "A specification for configuring the extractive content in a search response.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"maxExtractiveAnswerCount": { +"description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.", +"format": "int32", +"type": "integer" }, -"type": "array" +"maxExtractiveSegmentCount": { +"description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.", +"format": "int32", +"type": "integer" }, -"failedEntriesCount": { -"description": "Count of deny list entries that failed to be imported.", -"format": "int64", -"type": "string" +"numNextSegments": { +"description": "Return at most `num_next_segments` segments after each selected segments.", +"format": "int32", +"type": "integer" }, -"importedEntriesCount": { -"description": "Count of deny list entries successfully imported.", -"format": "int64", -"type": "string" +"numPreviousSegments": { +"description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", +"format": "int32", +"type": "integer" +}, +"returnExtractiveSegmentScore": { +"description": "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`.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata": { -"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata", +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec": { +"description": "A specification for configuring snippets in a search response.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" -}, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", -"type": "string" +"maxSnippetCount": { +"deprecated": true, +"description": "[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.", +"format": "int32", +"type": "integer" }, -"successCount": { -"description": "Count of entries that were processed successfully.", -"format": "int64", -"type": "string" +"referenceOnly": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", +"type": "boolean" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"returnSnippet": { +"description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportUserEventsResponse": { -"description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", -"id": "GoogleCloudDiscoveryengineV1betaImportUserEventsResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec": { +"description": "A specification for configuring a summary returned in a search response.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", -"description": "Echoes the destination for the complete errors if this field was set in the request." +"ignoreAdversarialQuery": { +"description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", +"type": "boolean" }, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"ignoreNonSummarySeekingQuery": { +"description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", +"type": "boolean" }, -"type": "array" +"includeCitations": { +"description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.", +"type": "boolean" }, -"joinedEventsCount": { -"description": "Count of user events imported with complete existing Documents.", -"format": "int64", +"languageCode": { +"description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", "type": "string" }, -"unjoinedEventsCount": { -"description": "Count of user events imported, but with Document information not found in the existing Branch.", -"format": "int64", -"type": "string" +"modelPromptSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", +"description": "If specified, the spec will be used to modify the prompt provided to the LLM." +}, +"modelSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", +"description": "If specified, the spec will be used to modify the model specification provided to the LLM." +}, +"summaryResultCount": { +"description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.", +"format": "int32", +"type": "integer" +}, +"useSemanticChunks": { +"description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaLanguageInfo": { -"description": "Language info for DataStore.", -"id": "GoogleCloudDiscoveryengineV1betaLanguageInfo", +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { +"description": "Specification of the prompt to use with the model.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", "properties": { -"language": { -"description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", -"readOnly": true, +"preamble": { +"description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", "type": "string" +} }, -"languageCode": { -"description": "The language code for the DataStore.", -"type": "string" +"type": "object" }, -"normalizedLanguageCode": { -"description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", -"readOnly": true, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec": { +"description": "Specification of the model.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", +"properties": { +"version": { +"description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).", "type": "string" +} }, -"region": { -"description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", -"readOnly": true, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": { +"description": "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.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaListCustomModelsResponse": { -"description": "Response message for SearchTuningService.ListCustomModels method.", -"id": "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": { +"description": "The specification that uses customized query embedding vector to do semantic document retrieval.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", "properties": { -"models": { -"description": "List of custom tuning models.", +"embeddingVectors": { +"description": "The embedding vector used for retrieval. Limit to 1.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel" +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaProject": { -"description": "Metadata and configurations for a Google Cloud project in the service.", -"id": "GoogleCloudDiscoveryengineV1betaProject", +"GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector": { +"description": "Embedding vector.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector", "properties": { -"createTime": { -"description": "Output only. The timestamp when this project is created.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"name": { -"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", -"readOnly": true, -"type": "string" -}, -"provisionCompletionTime": { -"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", -"format": "google-datetime", -"readOnly": true, +"fieldPath": { +"description": "Embedding field path in schema.", "type": "string" }, -"serviceTermsMap": { -"additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" +"vector": { +"description": "Query embedding vector.", +"items": { +"format": "float", +"type": "number" }, -"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", -"readOnly": true, -"type": "object" +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { -"description": "Metadata about the terms of service.", -"id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", +"GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec": { +"description": "A facet specification to perform faceted search.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec", "properties": { -"acceptTime": { -"description": "The last time when the project agreed to the terms of service.", -"format": "google-datetime", -"type": "string" +"enableDynamicPosition": { +"description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.", +"type": "boolean" }, -"declineTime": { -"description": "The last time when the project declined or revoked the agreement to terms of service.", -"format": "google-datetime", +"excludedFilterKeys": { +"description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { "type": "string" }, -"id": { -"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", -"type": "string" +"type": "array" }, -"state": { -"description": "Whether the project has accepted/rejected the service terms or it is still pending.", -"enum": [ -"STATE_UNSPECIFIED", -"TERMS_ACCEPTED", -"TERMS_PENDING", -"TERMS_DECLINED" -], -"enumDescriptions": [ -"The default value of the enum. This value is not actually used.", -"The project has given consent to the terms of service.", -"The project is pending to review and accept the terms of service.", -"The project has declined or revoked the agreement to terms of service." -], -"type": "string" +"facetKey": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", +"description": "Required. The facet key specification." }, -"version": { -"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", -"type": "string" +"limit": { +"description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { -"description": "Metadata associated with a project provision operation.", -"id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { -"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", +"GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey": { +"description": "Specifies how a facet is computed.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"caseInsensitive": { +"description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", +"type": "boolean" +}, +"contains": { +"description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", +"items": { "type": "string" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", +"type": "array" +}, +"intervals": { +"description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaInterval" +}, +"type": "array" +}, +"key": { +"description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.", "type": "string" }, -"ignoredCount": { -"description": "Count of entries that were ignored as entries were not found.", -"format": "int64", +"orderBy": { +"description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", "type": "string" }, -"successCount": { -"description": "Count of entries that were deleted successfully.", -"format": "int64", +"prefixes": { +"description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.", +"items": { "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"type": "array" +}, +"restrictedValues": { +"description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery": { +"description": "Specifies the image query input.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", +"properties": { +"imageBytes": { +"description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse": { -"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec": { +"description": "Specification to enable natural language understanding capabilities for search requests.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { -"purgeCount": { -"description": "The total count of documents purged as a result of the operation.", -"format": "int64", +"filterExtractionCondition": { +"description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Server behavior defaults to Condition.DISABLED.", +"Disables NL filter extraction.", +"Enables NL filter extraction." +], "type": "string" }, -"purgeSample": { -"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", +"geoSearchQueryDetectionFieldNames": { +"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", "items": { "type": "string" }, @@ -14711,61 +16584,85 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", +"GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec": { +"description": "Specification to determine under which conditions query expansion should occur.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"condition": { +"description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"AUTO" +], +"enumDescriptions": [ +"Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.", +"Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.", +"Automatic query expansion built by the Search API." +], "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"pinUnexpandedResults": { +"description": "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.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": { +"description": "Specification for search as you type in search requests.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" -}, -"purgeCount": { -"description": "Number of suggestion deny list entries purged.", -"format": "int64", +"condition": { +"description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Server behavior defaults to Condition.DISABLED.", +"Disables Search As You Type.", +"Enables Search As You Type." +], "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaSchema": { -"description": "Defines the structure and layout of a type of document data.", -"id": "GoogleCloudDiscoveryengineV1betaSchema", +"GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec": { +"description": "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.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", "properties": { -"jsonSchema": { -"description": "The JSON representation of the schema.", -"type": "string" -}, -"name": { -"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"queryId": { +"description": "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.", "type": "string" }, -"structSchema": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"searchResultPersistenceCount": { +"description": "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.", +"format": "int32", +"type": "integer" +} }, -"description": "The structured representation of the schema.", "type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec": { +"description": "The specification for query spell correction.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", +"properties": { +"mode": { +"description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", +"enum": [ +"MODE_UNSPECIFIED", +"SUGGESTION_ONLY", +"AUTO" +], +"enumDescriptions": [ +"Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", +"Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", +"Automatic spell correction built by the Search API. Search will be based on the corrected query if found." +], +"type": "string" } }, "type": "object" @@ -15002,6 +16899,21 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaUserInfo": { +"description": "Information of an end user.", +"id": "GoogleCloudDiscoveryengineV1betaUserInfo", +"properties": { +"userAgent": { +"description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.", +"type": "string" +}, +"userId": { +"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +} +}, +"type": "object" +}, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "GoogleLongrunningCancelOperationRequest", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 3f6b0851113..ac0803f1935 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -2428,6 +2428,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getUriPatternDocumentData": { +"description": "Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:getUriPatternDocumentData", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.getUriPatternDocumentData", +"parameterOrder": [ +"siteSearchEngine" +], +"parameters": { +"siteSearchEngine": { +"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+siteSearchEngine}:getUriPatternDocumentData", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "recrawlUris": { "description": "Request on-demand recrawl for a list of URIs.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris", @@ -2455,6 +2480,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"setUriPatternDocumentData": { +"description": "Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:setUriPatternDocumentData", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.setUriPatternDocumentData", +"parameterOrder": [ +"siteSearchEngine" +], +"parameters": { +"siteSearchEngine": { +"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+siteSearchEngine}:setUriPatternDocumentData", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -6377,6 +6430,133 @@ } }, "evaluations": { +"methods": { +"create": { +"description": "Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.evaluations.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/evaluations", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a Evaluation.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.evaluations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of Evaluation, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Gets a list of Evaluations.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.evaluations.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/evaluations", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"listResults": { +"description": "Gets a list of results for a given a Evaluation.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}:listResults", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.evaluations.listResults", +"parameterOrder": [ +"evaluation" +], +"parameters": { +"evaluation": { +"description": "Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+evaluation}:listResults", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "operations": { "methods": { @@ -6441,6 +6621,80 @@ } } }, +"identity_mapping_stores": { +"resources": { +"operations": { +"methods": { +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.identity_mapping_stores.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.identity_mapping_stores.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, "operations": { "methods": { "get": { @@ -6576,125 +6830,169 @@ } }, "sampleQuerySets": { -"resources": { -"operations": { "methods": { -"get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.sampleQuerySets.operations.get", +"create": { +"description": "Creates a SampleQuerySet", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.sampleQuerySets.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "The name of the operation resource.", +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" +}, +"sampleQuerySetId": { +"description": "Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" } }, -"path": "v1alpha/{+name}", +"path": "v1alpha/{+parent}/sampleQuerySets", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" +}, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} }, -"userEvents": { -"methods": { -"collect": { -"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:collect", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.userEvents.collect", +"delete": { +"description": "Deletes a SampleQuerySet.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.sampleQuerySets.delete", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"ets": { -"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", -"format": "int64", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", +"name": { +"description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "required": true, "type": "string" +} }, -"uri": { -"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", -"location": "query", -"type": "string" +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" }, -"userEvent": { -"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", -"location": "query", +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a SampleQuerySet.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.sampleQuerySets.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", +"required": true, "type": "string" } }, -"path": "v1alpha/{+parent}/userEvents:collect", +"path": "v1alpha/{+name}", "response": { -"$ref": "GoogleApiHttpBody" +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"write": { -"description": "Writes a single user event.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:write", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.userEvents.write", +"list": { +"description": "Gets a list of SampleQuerySets.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.sampleQuerySets.list", "parameterOrder": [ "parent" ], "parameters": { +"pageSize": { +"description": "Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +}, "parent": { -"description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", +"description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" +} }, -"writeAsync": { -"description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", +"path": "v1alpha/{+parent}/sampleQuerySets", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a SampleQuerySet.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.sampleQuerySets.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.", +"format": "google-fieldmask", "location": "query", -"type": "boolean" +"type": "string" } }, -"path": "v1alpha/{+parent}/userEvents:write", +"path": "v1alpha/{+name}", "request": { -"$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } -} -} -} }, +"resources": { "operations": { "methods": { "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1alpha/projects/{projectsId}/operations/{operationsId}", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "discoveryengine.projects.operations.get", +"id": "discoveryengine.projects.locations.sampleQuerySets.operations.get", "parameterOrder": [ "name" ], @@ -6702,7 +7000,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6714,85 +7012,381 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} }, -"list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1alpha/projects/{projectsId}/operations", -"httpMethod": "GET", -"id": "discoveryengine.projects.operations.list", +"sampleQueries": { +"methods": { +"create": { +"description": "Creates a SampleQuery", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"filter": { -"description": "The standard list filter.", +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", +"required": true, +"type": "string" +}, +"sampleQueryId": { +"description": "Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" +} +}, +"path": "v1alpha/{+parent}/sampleQueries", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] }, +"delete": { +"description": "Deletes a SampleQuery.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.delete", +"parameterOrder": [ +"name" +], +"parameters": { "name": { -"description": "The name of the operation's parent resource.", +"description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned.", "location": "path", -"pattern": "^projects/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a SampleQuery.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"import": { +"description": "Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries:import", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.import", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "required": true, "type": "string" +} +}, +"path": "v1alpha/{+parent}/sampleQueries:import", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] }, +"list": { +"description": "Gets a list of SampleQuerys.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.list", +"parameterOrder": [ +"parent" +], +"parameters": { "pageSize": { -"description": "The standard list page size.", +"description": "Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token.", +"description": "A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" +}, +"parent": { +"description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", +"required": true, +"type": "string" } }, -"path": "v1alpha/{+name}/operations", +"path": "v1alpha/{+parent}/sampleQueries", "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"patch": { +"description": "Updates a SampleQuery.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } } } }, -"revision": "20240704", -"rootUrl": "https://discoveryengine.googleapis.com/", -"schemas": { -"GoogleApiDistribution": { -"description": "`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.", -"id": "GoogleApiDistribution", -"properties": { -"bucketCounts": { -"description": "The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).", -"items": { +"userEvents": { +"methods": { +"collect": { +"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:collect", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.userEvents.collect", +"parameterOrder": [ +"parent" +], +"parameters": { +"ets": { +"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", "format": "int64", +"location": "query", "type": "string" }, -"type": "array" -}, -"bucketOptions": { -"$ref": "GoogleApiDistributionBucketOptions", -"description": "Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field." +"parent": { +"description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" }, -"count": { -"description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.", -"format": "int64", +"uri": { +"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", +"location": "query", "type": "string" }, -"exemplars": { -"description": "Must be in increasing order of `value` field.", -"items": { -"$ref": "GoogleApiDistributionExemplar" +"userEvent": { +"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", +"location": "query", +"type": "string" +} }, -"type": "array" +"path": "v1alpha/{+parent}/userEvents:collect", +"response": { +"$ref": "GoogleApiHttpBody" }, -"mean": { +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"write": { +"description": "Writes a single user event.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:write", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.userEvents.write", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"writeAsync": { +"description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1alpha/{+parent}/userEvents:write", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"operations": { +"methods": { +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1alpha/projects/{projectsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1alpha/projects/{projectsId}/operations", +"httpMethod": "GET", +"id": "discoveryengine.projects.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +}, +"revision": "20240715", +"rootUrl": "https://discoveryengine.googleapis.com/", +"schemas": { +"GoogleApiDistribution": { +"description": "`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.", +"id": "GoogleApiDistribution", +"properties": { +"bucketCounts": { +"description": "The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"bucketOptions": { +"$ref": "GoogleApiDistributionBucketOptions", +"description": "Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field." +}, +"count": { +"description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.", +"format": "int64", +"type": "string" +}, +"exemplars": { +"description": "Must be in increasing order of `value` field.", +"items": { +"$ref": "GoogleApiDistributionExemplar" +}, +"type": "array" +}, +"mean": { "description": "The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.", "format": "double", "type": "number" @@ -8875,7 +9469,7 @@ "type": "string" }, "searchResultMode": { -"description": "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)", +"description": "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)", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -9026,7 +9620,7 @@ "properties": { "answer": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer", -"description": "Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." +"description": "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." }, "answerQueryToken": { "description": "A global unique ID used for logging.", @@ -9290,7 +9884,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "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).", +"description": "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 .", "type": "object" }, "title": { @@ -10390,6 +10984,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata": { +"description": "Metadata for EvaluationService.CreateEvaluation method.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { "description": "Metadata for Create Schema LRO.", "id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", @@ -11416,6 +12016,96 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaEvaluation": { +"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluation", +"properties": { +"createTime": { +"description": "Output only. Timestamp the Evaluation was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. Timestamp the Evaluation was completed at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", +"readOnly": true +}, +"errorSamples": { +"description": "Output only. A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"readOnly": true, +"type": "array" +}, +"evaluationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", +"description": "Required. The specification of the evaluation." +}, +"name": { +"description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", +"readOnly": true +}, +"state": { +"description": "Output only. The state of the evaluation.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The evaluation is unspecified.", +"The service is preparing to run the evaluation.", +"The evaluation is in progress.", +"The evaluation completed successfully.", +"The evaluation failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec": { +"description": "Describes the specification of the evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", +"properties": { +"querySetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", +"description": "Required. The specification of the query set." +}, +"searchRequest": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest", +"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec": { +"description": "Describes the specification of the query set.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", +"properties": { +"sampleQuerySet": { +"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": { "description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata", @@ -11705,6 +12395,24 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": { +"description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.", +"id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse", +"properties": { +"documentDataMap": { +"additionalProperties": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"description": "Document data keyed by URI pattern. For example: document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaGroundingFact": { "description": "Grounding Fact.", "id": "GoogleCloudDiscoveryengineV1alphaGroundingFact", @@ -12010,55 +12718,142 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": { +"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata", "properties": { "createTime": { -"description": "Operation create time.", +"description": "ImportSampleQueries operation create time.", "format": "google-datetime", "type": "string" }, +"failureCount": { +"description": "Count of SampleQuerys that failed to be imported.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of SampleQuerys successfully imported.", +"format": "int64", +"type": "string" +}, +"totalCount": { +"description": "Total count of SampleQuerys that were processed.", +"format": "int64", +"type": "string" +}, "updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", +"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest": { -"description": "Request message for CompletionService.ImportSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest", +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest": { +"description": "Request message for SampleQueryService.ImportSampleQueries method.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest", "properties": { +"bigquerySource": { +"$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", +"description": "BigQuery input source." +}, +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, "gcsSource": { "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", -"description": "Cloud Storage location for the input content. Only 1 file can be specified that contains all entries to import. Supported values `gcs_source.schema` for autocomplete suggestion deny list entry imports: * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry] per line." +"description": "Cloud Storage location for the input content." }, "inlineSource": { -"$ref": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", -"description": "The Inline source for the input content for suggestion deny list entries." +"$ref": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource", +"description": "The Inline source for sample query entries." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource": { -"description": "The inline source for SuggestionDenyListEntry.", -"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource": { +"description": "The inline source for SampleQuerys.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource", "properties": { -"entries": { -"description": "Required. A list of all denylist entries to import. Max of 1000 items.", +"sampleQueries": { +"description": "Required. A list of SampleQuerys to import. Max of 1000 items.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry" +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse": { +"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest": { +"description": "Request message for CompletionService.ImportSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest", +"properties": { +"gcsSource": { +"$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", +"description": "Cloud Storage location for the input content. Only 1 file can be specified that contains all entries to import. Supported values `gcs_source.schema` for autocomplete suggestion deny list entry imports: * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry] per line." +}, +"inlineSource": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", +"description": "The Inline source for the input content for suggestion deny list entries." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource": { +"description": "The inline source for SuggestionDenyListEntry.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", +"properties": { +"entries": { +"description": "Required. A list of all denylist entries to import. Max of 1000 items.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the request.", @@ -12347,6 +13142,95 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse": { +"description": "Response message for EvaluationService.ListEvaluationResults method.", +"id": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse", +"properties": { +"evaluationResults": { +"description": "The EvaluationResults.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult": { +"description": "Represents the results of an evaluation for a single SampleQuery.", +"id": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult", +"properties": { +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, for a given SampleQuery.", +"readOnly": true +}, +"sampleQuery": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery", +"description": "Output only. The SampleQuery that was evaluated.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse": { +"description": "Response message for EvaluationService.ListEvaluations method.", +"id": "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse", +"properties": { +"evaluations": { +"description": "The Evaluations.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse": { +"description": "Response message for SampleQueryService.ListSampleQueries method.", +"id": "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse", +"properties": { +"nextPageToken": { +"description": "A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"sampleQueries": { +"description": "The SampleQuerys.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse": { +"description": "Response message for SampleQuerySetService.ListSampleQuerySets method.", +"id": "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse", +"properties": { +"nextPageToken": { +"description": "A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"sampleQuerySets": { +"description": "The SampleQuerySets.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaListSchemasResponse": { "description": "Response message for SchemaService.ListSchemas method.", "id": "GoogleCloudDiscoveryengineV1alphaListSchemasResponse", @@ -12867,6 +13751,60 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaQualityMetrics": { +"description": "Describes the metrics produced by the evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", +"properties": { +"docNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"docPrecision": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" +}, +"docRecall": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" +}, +"pageNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"pageRecall": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics": { +"description": "Stores the metric values at specific top-k levels.", +"id": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"properties": { +"top1": { +"description": "The top-1 value.", +"format": "double", +"type": "number" +}, +"top10": { +"description": "The top-10 value.", +"format": "double", +"type": "number" +}, +"top3": { +"description": "The top-3 value.", +"format": "double", +"type": "number" +}, +"top5": { +"description": "The top-5 value.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaQuery": { "description": "Defines a user inputed query.", "id": "GoogleCloudDiscoveryengineV1alphaQuery", @@ -13367,6 +14305,94 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaSampleQuery": { +"description": "Sample Query captures metadata to be used for evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaSampleQuery", +"properties": { +"createTime": { +"description": "Output only. Timestamp the SampleQuery was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"queryEntry": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry", +"description": "The query entry." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry": { +"description": "Query Entry captures metadata to be used for search evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry", +"properties": { +"query": { +"description": "Required. The query.", +"type": "string" +}, +"targets": { +"description": "List of targets for the query.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget": { +"description": "Defines the parameters of the query's expected outcome.", +"id": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget", +"properties": { +"pageNumbers": { +"description": "Expected page numbers of the target. Each page number must be non negative.", +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, +"score": { +"description": "Relevance score of the target.", +"format": "double", +"type": "number" +}, +"uri": { +"description": "Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSampleQuerySet": { +"description": "A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.", +"id": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet", +"properties": { +"createTime": { +"description": "Output only. Timestamp the SampleQuerySet was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "The description of the SampleQuerySet.", +"type": "string" +}, +"displayName": { +"description": "Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.", +"type": "string" +}, +"name": { +"description": "Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaSchema": { "description": "Defines the structure and layout of a type of document data.", "id": "GoogleCloudDiscoveryengineV1alphaSchema", @@ -13543,6 +14569,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." }, +"servingConfig": { +"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", +"type": "string" +}, "session": { "description": "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.", "type": "string" @@ -13680,7 +14710,7 @@ "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, "searchResultMode": { -"description": "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`.", +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -13984,7 +15014,7 @@ "type": "string" }, "geoSearchQueryDetectionFieldNames": { -"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names.", +"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", "items": { "type": "string" }, @@ -14868,6 +15898,59 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest": { +"description": "Request message for SiteSearchEngineService.SetUriPatternDocumentData method.", +"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest", +"properties": { +"documentDataMap": { +"additionalProperties": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"description": "Document data keyed by URI pattern. Each entry must be consistent with the Schema. For example: Schema = { \"type\": \"object\", \"properties\": { \"Categories\": { \"type\": \"array\", \"items\": { \"retrievable\": true, \"type\": \"string\" } } } document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }", +"type": "object" +}, +"emptyDocumentDataMap": { +"description": "If true, clears the document data map. If true, SetUriPatternDocumentDataRequest.document_data_map must be empty.", +"type": "boolean" +}, +"schema": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. If not provided, the current Schema is used. If provided, validates and updates the Schema. If validation fails, an error is returned.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse": { +"description": "Response message for SiteSearchEngineService.SetUriPatternDocumentData method.", +"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine": { "description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.", "id": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine", @@ -15639,6 +16722,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata": { +"description": "Metadata for EvaluationService.CreateEvaluation method.", +"id": "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { "description": "Metadata for Create Schema LRO.", "id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", @@ -16223,19 +17312,109 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { -"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", +"GoogleCloudDiscoveryengineV1betaEvaluation": { +"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluation", "properties": { "createTime": { -"description": "Operation create time.", +"description": "Output only. Timestamp the Evaluation was created at.", "format": "google-datetime", +"readOnly": true, "type": "string" }, -"failureCount": { -"description": "Count of CompletionSuggestions that failed to be imported.", -"format": "int64", -"type": "string" +"endTime": { +"description": "Output only. Timestamp the Evaluation was completed at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", +"readOnly": true +}, +"errorSamples": { +"description": "Output only. A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"readOnly": true, +"type": "array" +}, +"evaluationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", +"description": "Required. The specification of the evaluation." +}, +"name": { +"description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", +"readOnly": true +}, +"state": { +"description": "Output only. The state of the evaluation.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The evaluation is unspecified.", +"The service is preparing to run the evaluation.", +"The evaluation is in progress.", +"The evaluation completed successfully.", +"The evaluation failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec": { +"description": "Describes the specification of the evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", +"properties": { +"querySetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", +"description": "Required. The specification of the query set." +}, +"searchRequest": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest", +"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec": { +"description": "Describes the specification of the query set.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", +"properties": { +"sampleQuerySet": { +"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { +"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of CompletionSuggestions that failed to be imported.", +"format": "int64", +"type": "string" }, "successCount": { "description": "Count of CompletionSuggestions successfully imported.", @@ -16329,6 +17508,56 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata": { +"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata", +"properties": { +"createTime": { +"description": "ImportSampleQueries operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of SampleQuerys that failed to be imported.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of SampleQuerys successfully imported.", +"format": "int64", +"type": "string" +}, +"totalCount": { +"description": "Total count of SampleQuerys that were processed.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse": { +"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", @@ -16425,6 +17654,33 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaInterval": { +"description": "A floating point interval.", +"id": "GoogleCloudDiscoveryengineV1betaInterval", +"properties": { +"exclusiveMaximum": { +"description": "Exclusive upper bound.", +"format": "double", +"type": "number" +}, +"exclusiveMinimum": { +"description": "Exclusive lower bound.", +"format": "double", +"type": "number" +}, +"maximum": { +"description": "Inclusive upper bound.", +"format": "double", +"type": "number" +}, +"minimum": { +"description": "Inclusive lower bound.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaLanguageInfo": { "description": "Language info for DataStore.", "id": "GoogleCloudDiscoveryengineV1betaLanguageInfo", @@ -16458,135 +17714,805 @@ "models": { "description": "List of custom tuning models.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel" +"$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaProject": { +"description": "Metadata and configurations for a Google Cloud project in the service.", +"id": "GoogleCloudDiscoveryengineV1betaProject", +"properties": { +"createTime": { +"description": "Output only. The timestamp when this project is created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", +"readOnly": true, +"type": "string" +}, +"provisionCompletionTime": { +"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"serviceTermsMap": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" +}, +"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { +"description": "Metadata about the terms of service.", +"id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", +"properties": { +"acceptTime": { +"description": "The last time when the project agreed to the terms of service.", +"format": "google-datetime", +"type": "string" +}, +"declineTime": { +"description": "The last time when the project declined or revoked the agreement to terms of service.", +"format": "google-datetime", +"type": "string" +}, +"id": { +"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", +"type": "string" +}, +"state": { +"description": "Whether the project has accepted/rejected the service terms or it is still pending.", +"enum": [ +"STATE_UNSPECIFIED", +"TERMS_ACCEPTED", +"TERMS_PENDING", +"TERMS_DECLINED" +], +"enumDescriptions": [ +"The default value of the enum. This value is not actually used.", +"The project has given consent to the terms of service.", +"The project is pending to review and accept the terms of service.", +"The project has declined or revoked the agreement to terms of service." +], +"type": "string" +}, +"version": { +"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { +"description": "Metadata associated with a project provision operation.", +"id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { +"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", +"type": "string" +}, +"ignoredCount": { +"description": "Count of entries that were ignored as entries were not found.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of entries that were deleted successfully.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse": { +"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse", +"properties": { +"purgeCount": { +"description": "The total count of documents purged as a result of the operation.", +"format": "int64", +"type": "string" +}, +"purgeSample": { +"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", +"properties": { +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"purgeCount": { +"description": "Number of suggestion deny list entries purged.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaQualityMetrics": { +"description": "Describes the metrics produced by the evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaQualityMetrics", +"properties": { +"docNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"docPrecision": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" +}, +"docRecall": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" +}, +"pageNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"pageRecall": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics": { +"description": "Stores the metric values at specific top-k levels.", +"id": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"properties": { +"top1": { +"description": "The top-1 value.", +"format": "double", +"type": "number" +}, +"top10": { +"description": "The top-10 value.", +"format": "double", +"type": "number" +}, +"top3": { +"description": "The top-3 value.", +"format": "double", +"type": "number" +}, +"top5": { +"description": "The top-5 value.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSchema": { +"description": "Defines the structure and layout of a type of document data.", +"id": "GoogleCloudDiscoveryengineV1betaSchema", +"properties": { +"jsonSchema": { +"description": "The JSON representation of the schema.", +"type": "string" +}, +"name": { +"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"structSchema": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The structured representation of the schema.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequest": { +"description": "Request message for SearchService.Search method.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequest", +"properties": { +"boostSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", +"description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" +}, +"branch": { +"description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", +"type": "string" +}, +"canonicalFilter": { +"description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", +"type": "string" +}, +"contentSearchSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", +"description": "A specification for configuring the behavior of content search." +}, +"dataStoreSpecs": { +"description": "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.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" +}, +"type": "array" +}, +"embeddingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", +"description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." +}, +"facetSpecs": { +"description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec" +}, +"type": "array" +}, +"filter": { +"description": "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. 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 customer 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)", +"type": "string" +}, +"imageQuery": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", +"description": "Raw image query." +}, +"languageCode": { +"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", +"type": "string" +}, +"naturalLanguageQueryUnderstandingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", +"description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." +}, +"offset": { +"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" +}, +"orderBy": { +"description": "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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", +"type": "string" +}, +"pageSize": { +"description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +}, +"params": { +"additionalProperties": { +"type": "any" +}, +"description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", +"type": "object" +}, +"query": { +"description": "Raw search query.", +"type": "string" +}, +"queryExpansionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", +"description": "The query expansion specification that specifies the conditions under which query expansion occurs." +}, +"rankingExpression": { +"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", +"type": "string" +}, +"regionCode": { +"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", +"type": "string" +}, +"safeSearch": { +"description": "Whether to turn on safe search. This is only supported for website search.", +"type": "boolean" +}, +"searchAsYouTypeSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", +"description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." +}, +"servingConfig": { +"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", +"type": "string" +}, +"session": { +"description": "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.", +"type": "string" +}, +"sessionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", +"description": "Session specification. Can be used only when `session` is set." +}, +"spellCorrectionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", +"description": "The spell correction specification that specifies the mode under which spell correction takes effect." +}, +"userInfo": { +"$ref": "GoogleCloudDiscoveryengineV1betaUserInfo", +"description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." +}, +"userLabels": { +"additionalProperties": { +"type": "string" +}, +"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", +"type": "object" +}, +"userPseudoId": { +"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec": { +"description": "Boost specification to boost certain documents.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", +"properties": { +"conditionBoostSpecs": { +"description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec": { +"description": "Boost applies to documents which match a condition.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec", +"properties": { +"boost": { +"description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.", +"format": "float", +"type": "number" +}, +"boostControlSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", +"description": "Complex specification for custom ranking based on customer defined attribute value." +}, +"condition": { +"description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { +"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", +"properties": { +"attributeType": { +"description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", +"enum": [ +"ATTRIBUTE_TYPE_UNSPECIFIED", +"NUMERICAL", +"FRESHNESS" +], +"enumDescriptions": [ +"Unspecified AttributeType.", +"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", +"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." +], +"type": "string" +}, +"controlPoints": { +"description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" +}, +"type": "array" +}, +"fieldName": { +"description": "The name of the field whose value will be used to determine the boost amount.", +"type": "string" +}, +"interpolationType": { +"description": "The interpolation type to be applied to connect the control points listed below.", +"enum": [ +"INTERPOLATION_TYPE_UNSPECIFIED", +"LINEAR" +], +"enumDescriptions": [ +"Interpolation type is unspecified. In this case, it defaults to Linear.", +"Piecewise linear interpolation will be applied." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { +"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", +"properties": { +"attributeValue": { +"description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", +"type": "string" +}, +"boostAmount": { +"description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec": { +"description": "A specification for configuring the behavior of content search.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", +"properties": { +"chunkSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec", +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" +}, +"extractiveContentSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", +"description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." +}, +"searchResultMode": { +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", +"enum": [ +"SEARCH_RESULT_MODE_UNSPECIFIED", +"DOCUMENTS", +"CHUNKS" +], +"enumDescriptions": [ +"Default value.", +"Returns documents in the search result.", +"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." +], +"type": "string" +}, +"snippetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", +"description": "If `snippetSpec` is not specified, snippets are not included in the search response." +}, +"summarySpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", +"description": "If `summarySpec` is not specified, summaries are not included in the search response." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec": { +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec", +"properties": { +"numNextChunks": { +"description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.", +"format": "int32", +"type": "integer" +}, +"numPreviousChunks": { +"description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec": { +"description": "A specification for configuring the extractive content in a search response.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", +"properties": { +"maxExtractiveAnswerCount": { +"description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.", +"format": "int32", +"type": "integer" +}, +"maxExtractiveSegmentCount": { +"description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.", +"format": "int32", +"type": "integer" +}, +"numNextSegments": { +"description": "Return at most `num_next_segments` segments after each selected segments.", +"format": "int32", +"type": "integer" +}, +"numPreviousSegments": { +"description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", +"format": "int32", +"type": "integer" +}, +"returnExtractiveSegmentScore": { +"description": "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`.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec": { +"description": "A specification for configuring snippets in a search response.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", +"properties": { +"maxSnippetCount": { +"deprecated": true, +"description": "[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.", +"format": "int32", +"type": "integer" +}, +"referenceOnly": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", +"type": "boolean" +}, +"returnSnippet": { +"description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec": { +"description": "A specification for configuring a summary returned in a search response.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", +"properties": { +"ignoreAdversarialQuery": { +"description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", +"type": "boolean" +}, +"ignoreNonSummarySeekingQuery": { +"description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", +"type": "boolean" +}, +"includeCitations": { +"description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.", +"type": "boolean" +}, +"languageCode": { +"description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", +"type": "string" +}, +"modelPromptSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", +"description": "If specified, the spec will be used to modify the prompt provided to the LLM." +}, +"modelSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", +"description": "If specified, the spec will be used to modify the model specification provided to the LLM." +}, +"summaryResultCount": { +"description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.", +"format": "int32", +"type": "integer" +}, +"useSemanticChunks": { +"description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { +"description": "Specification of the prompt to use with the model.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", +"properties": { +"preamble": { +"description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec": { +"description": "Specification of the model.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", +"properties": { +"version": { +"description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": { +"description": "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.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": { +"description": "The specification that uses customized query embedding vector to do semantic document retrieval.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", +"properties": { +"embeddingVectors": { +"description": "The embedding vector used for retrieval. Limit to 1.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector": { +"description": "Embedding vector.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector", +"properties": { +"fieldPath": { +"description": "Embedding field path in schema.", +"type": "string" +}, +"vector": { +"description": "Query embedding vector.", +"items": { +"format": "float", +"type": "number" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaProject": { -"description": "Metadata and configurations for a Google Cloud project in the service.", -"id": "GoogleCloudDiscoveryengineV1betaProject", +"GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec": { +"description": "A facet specification to perform faceted search.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec", "properties": { -"createTime": { -"description": "Output only. The timestamp when this project is created.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"enableDynamicPosition": { +"description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.", +"type": "boolean" }, -"name": { -"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", -"readOnly": true, +"excludedFilterKeys": { +"description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { "type": "string" }, -"provisionCompletionTime": { -"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"type": "array" }, -"serviceTermsMap": { -"additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" +"facetKey": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", +"description": "Required. The facet key specification." }, -"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", -"readOnly": true, -"type": "object" +"limit": { +"description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { -"description": "Metadata about the terms of service.", -"id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", +"GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey": { +"description": "Specifies how a facet is computed.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", "properties": { -"acceptTime": { -"description": "The last time when the project agreed to the terms of service.", -"format": "google-datetime", -"type": "string" -}, -"declineTime": { -"description": "The last time when the project declined or revoked the agreement to terms of service.", -"format": "google-datetime", -"type": "string" -}, -"id": { -"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", -"type": "string" +"caseInsensitive": { +"description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", +"type": "boolean" }, -"state": { -"description": "Whether the project has accepted/rejected the service terms or it is still pending.", -"enum": [ -"STATE_UNSPECIFIED", -"TERMS_ACCEPTED", -"TERMS_PENDING", -"TERMS_DECLINED" -], -"enumDescriptions": [ -"The default value of the enum. This value is not actually used.", -"The project has given consent to the terms of service.", -"The project is pending to review and accept the terms of service.", -"The project has declined or revoked the agreement to terms of service." -], +"contains": { +"description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", +"items": { "type": "string" }, -"version": { -"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", -"type": "string" -} +"type": "array" }, -"type": "object" +"intervals": { +"description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaInterval" }, -"GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { -"description": "Metadata associated with a project provision operation.", -"id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata", -"properties": {}, -"type": "object" +"type": "array" }, -"GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { -"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"key": { +"description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.", "type": "string" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", +"orderBy": { +"description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", "type": "string" }, -"ignoredCount": { -"description": "Count of entries that were ignored as entries were not found.", -"format": "int64", +"prefixes": { +"description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.", +"items": { "type": "string" }, -"successCount": { -"description": "Count of entries that were deleted successfully.", -"format": "int64", +"type": "array" +}, +"restrictedValues": { +"description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.", +"items": { "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery": { +"description": "Specifies the image query input.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", +"properties": { +"imageBytes": { +"description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse": { -"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec": { +"description": "Specification to enable natural language understanding capabilities for search requests.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { -"purgeCount": { -"description": "The total count of documents purged as a result of the operation.", -"format": "int64", +"filterExtractionCondition": { +"description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Server behavior defaults to Condition.DISABLED.", +"Disables NL filter extraction.", +"Enables NL filter extraction." +], "type": "string" }, -"purgeSample": { -"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", +"geoSearchQueryDetectionFieldNames": { +"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", "items": { "type": "string" }, @@ -16595,61 +18521,85 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", +"GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec": { +"description": "Specification to determine under which conditions query expansion should occur.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"condition": { +"description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"AUTO" +], +"enumDescriptions": [ +"Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.", +"Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.", +"Automatic query expansion built by the Search API." +], "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"pinUnexpandedResults": { +"description": "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.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": { +"description": "Specification for search as you type in search requests.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" -}, -"purgeCount": { -"description": "Number of suggestion deny list entries purged.", -"format": "int64", +"condition": { +"description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Server behavior defaults to Condition.DISABLED.", +"Disables Search As You Type.", +"Enables Search As You Type." +], "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaSchema": { -"description": "Defines the structure and layout of a type of document data.", -"id": "GoogleCloudDiscoveryengineV1betaSchema", +"GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec": { +"description": "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.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", "properties": { -"jsonSchema": { -"description": "The JSON representation of the schema.", -"type": "string" -}, -"name": { -"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"queryId": { +"description": "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.", "type": "string" }, -"structSchema": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"searchResultPersistenceCount": { +"description": "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.", +"format": "int32", +"type": "integer" +} }, -"description": "The structured representation of the schema.", "type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec": { +"description": "The specification for query spell correction.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", +"properties": { +"mode": { +"description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", +"enum": [ +"MODE_UNSPECIFIED", +"SUGGESTION_ONLY", +"AUTO" +], +"enumDescriptions": [ +"Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", +"Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", +"Automatic spell correction built by the Search API. Search will be based on the corrected query if found." +], +"type": "string" } }, "type": "object" @@ -16886,6 +18836,21 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaUserInfo": { +"description": "Information of an end user.", +"id": "GoogleCloudDiscoveryengineV1betaUserInfo", +"properties": { +"userAgent": { +"description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.", +"type": "string" +}, +"userId": { +"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +} +}, +"type": "object" +}, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "GoogleLongrunningCancelOperationRequest", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index 3a7a3ab31b8..bcf237ddb17 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -5823,6 +5823,133 @@ } }, "evaluations": { +"methods": { +"create": { +"description": "Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.evaluations.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/evaluations", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluation" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a Evaluation.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.evaluations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of Evaluation, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Gets a list of Evaluations.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.evaluations.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/evaluations", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaListEvaluationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"listResults": { +"description": "Gets a list of results for a given a Evaluation.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}:listResults", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.evaluations.listResults", +"parameterOrder": [ +"evaluation" +], +"parameters": { +"evaluation": { +"description": "Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+evaluation}:listResults", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "operations": { "methods": { @@ -5990,125 +6117,169 @@ } }, "sampleQuerySets": { -"resources": { -"operations": { "methods": { +"create": { +"description": "Creates a SampleQuerySet", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.sampleQuerySets.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"sampleQuerySetId": { +"description": "Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+parent}/sampleQuerySets", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a SampleQuerySet.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.sampleQuerySets.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}", +"description": "Gets a SampleQuerySet.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", "httpMethod": "GET", -"id": "discoveryengine.projects.locations.sampleQuerySets.operations.get", +"id": "discoveryengine.projects.locations.sampleQuerySets.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} }, -"userEvents": { -"methods": { -"collect": { -"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", -"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:collect", +"list": { +"description": "Gets a list of SampleQuerySets.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", "httpMethod": "GET", -"id": "discoveryengine.projects.locations.userEvents.collect", +"id": "discoveryengine.projects.locations.sampleQuerySets.list", "parameterOrder": [ "parent" ], "parameters": { -"ets": { -"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", -"format": "int64", +"pageSize": { +"description": "Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", +"description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" -}, -"uri": { -"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", -"location": "query", -"type": "string" -}, -"userEvent": { -"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", -"location": "query", -"type": "string" } }, -"path": "v1beta/{+parent}/userEvents:collect", +"path": "v1beta/{+parent}/sampleQuerySets", "response": { -"$ref": "GoogleApiHttpBody" +"$ref": "GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"write": { -"description": "Writes a single user event.", -"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:write", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.userEvents.write", +"patch": { +"description": "Updates a SampleQuerySet.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.sampleQuerySets.patch", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", +"name": { +"description": "Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "required": true, "type": "string" }, -"writeAsync": { -"description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", +"updateMask": { +"description": "Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.", +"format": "google-fieldmask", "location": "query", -"type": "boolean" +"type": "string" } }, -"path": "v1beta/{+parent}/userEvents:write", +"path": "v1beta/{+name}", "request": { -"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" }, "response": { -"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } -} -} -} }, +"resources": { "operations": { "methods": { "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1beta/projects/{projectsId}/operations/{operationsId}", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "discoveryengine.projects.operations.get", +"id": "discoveryengine.projects.locations.sampleQuerySets.operations.get", "parameterOrder": [ "name" ], @@ -6116,7 +6287,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6128,205 +6299,1075 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} }, -"list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta/projects/{projectsId}/operations", -"httpMethod": "GET", -"id": "discoveryengine.projects.operations.list", +"sampleQueries": { +"methods": { +"create": { +"description": "Creates a SampleQuery", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", -"type": "string" -}, -"name": { -"description": "The name of the operation's parent resource.", +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", "location": "path", -"pattern": "^projects/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "required": true, "type": "string" }, -"pageSize": { -"description": "The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "The standard list page token.", +"sampleQueryId": { +"description": "Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } }, -"path": "v1beta/{+name}/operations", +"path": "v1beta/{+parent}/sampleQueries", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" +}, "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} -} }, -"revision": "20240704", -"rootUrl": "https://discoveryengine.googleapis.com/", -"schemas": { -"GoogleApiHttpBody": { -"description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", -"id": "GoogleApiHttpBody", +"delete": { +"description": "Deletes a SampleQuery.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a SampleQuery.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"import": { +"description": "Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries:import", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.import", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/sampleQueries:import", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Gets a list of SampleQuerys.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/sampleQueries", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a SampleQuery.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"userEvents": { +"methods": { +"collect": { +"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:collect", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.userEvents.collect", +"parameterOrder": [ +"parent" +], +"parameters": { +"ets": { +"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", +"format": "int64", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"uri": { +"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", +"location": "query", +"type": "string" +}, +"userEvent": { +"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+parent}/userEvents:collect", +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"write": { +"description": "Writes a single user event.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:write", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.userEvents.write", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"writeAsync": { +"description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta/{+parent}/userEvents:write", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"operations": { +"methods": { +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1beta/projects/{projectsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta/projects/{projectsId}/operations", +"httpMethod": "GET", +"id": "discoveryengine.projects.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +}, +"revision": "20240715", +"rootUrl": "https://discoveryengine.googleapis.com/", +"schemas": { +"GoogleApiHttpBody": { +"description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", +"id": "GoogleApiHttpBody", +"properties": { +"contentType": { +"description": "The HTTP Content-Type header value specifying the content type of the body.", +"type": "string" +}, +"data": { +"description": "The HTTP request/response body as raw binary.", +"format": "byte", +"type": "string" +}, +"extensions": { +"description": "Application specific response metadata. Must be set in the first response for streaming APIs.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineLoggingErrorContext": { +"description": "A description of the context in which an error occurred.", +"id": "GoogleCloudDiscoveryengineLoggingErrorContext", +"properties": { +"httpRequest": { +"$ref": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", +"description": "The HTTP request which was processed when the error was triggered." +}, +"reportLocation": { +"$ref": "GoogleCloudDiscoveryengineLoggingSourceLocation", +"description": "The location in the source code where the decision was made to report the error, usually the place where it was logged." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineLoggingErrorLog": { +"description": "An error log which is reported to the Error Reporting system.", +"id": "GoogleCloudDiscoveryengineLoggingErrorLog", +"properties": { +"context": { +"$ref": "GoogleCloudDiscoveryengineLoggingErrorContext", +"description": "A description of the context in which the error occurred." +}, +"importPayload": { +"$ref": "GoogleCloudDiscoveryengineLoggingImportErrorContext", +"description": "The error payload that is populated on LRO import APIs." +}, +"message": { +"description": "A message describing the error.", +"type": "string" +}, +"requestPayload": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The API request payload, represented as a protocol buffer. Most API request types are supported\u2014for example: * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest`", +"type": "object" +}, +"responsePayload": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The API response payload, represented as a protocol buffer. This is used to log some \"soft errors\", where the response is valid but we consider there are some quality issues like unjoined events. The following API responses are supported, and no PII is included: * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent`", +"type": "object" +}, +"serviceContext": { +"$ref": "GoogleCloudDiscoveryengineLoggingServiceContext", +"description": "The service context in which this error has occurred." +}, +"status": { +"$ref": "GoogleRpcStatus", +"description": "The RPC status associated with the error log." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineLoggingHttpRequestContext": { +"description": "HTTP request data that is related to a reported error.", +"id": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", +"properties": { +"responseStatusCode": { +"description": "The HTTP response status code for the request.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineLoggingImportErrorContext": { +"description": "The error payload that is populated on LRO import APIs, including the following: * `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents`", +"id": "GoogleCloudDiscoveryengineLoggingImportErrorContext", +"properties": { +"document": { +"description": "The detailed content which caused the error on importing a document.", +"type": "string" +}, +"gcsPath": { +"description": "Google Cloud Storage file path of the import source. Can be set for batch operation error.", +"type": "string" +}, +"lineNumber": { +"description": "Line number of the content in file. Should be empty for permission or batch operation error.", +"type": "string" +}, +"operation": { +"description": "The operation resource name of the LRO.", +"type": "string" +}, +"userEvent": { +"description": "The detailed content which caused the error on importing a user event.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineLoggingServiceContext": { +"description": "Describes a running service that sends errors.", +"id": "GoogleCloudDiscoveryengineLoggingServiceContext", +"properties": { +"service": { +"description": "An identifier of the service\u2014for example, `discoveryengine.googleapis.com`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineLoggingSourceLocation": { +"description": "Indicates a location in the source code of the service for which errors are reported.", +"id": "GoogleCloudDiscoveryengineLoggingSourceLocation", +"properties": { +"functionName": { +"description": "Human-readable name of a function or method\u2014for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse": { +"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", +"id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse", +"properties": { +"targetSites": { +"description": "TargetSites created.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1TargetSite" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1Condition": { +"description": "Defines circumstances to be checked before allowing a behavior", +"id": "GoogleCloudDiscoveryengineV1Condition", +"properties": { +"activeTimeRange": { +"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1ConditionTimeRange" +}, +"type": "array" +}, +"queryTerms": { +"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ConditionQueryTerm": { +"description": "Matcher for search request query", +"id": "GoogleCloudDiscoveryengineV1ConditionQueryTerm", +"properties": { +"fullMatch": { +"description": "Whether the search query needs to exactly match the query term.", +"type": "boolean" +}, +"value": { +"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ConditionTimeRange": { +"description": "Used for time-dependent conditions.", +"id": "GoogleCloudDiscoveryengineV1ConditionTimeRange", +"properties": { +"endTime": { +"description": "End of time range. Range is inclusive. Must be in the future.", +"format": "google-datetime", +"type": "string" +}, +"startTime": { +"description": "Start of time range. Range is inclusive.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1Control": { +"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", +"id": "GoogleCloudDiscoveryengineV1Control", +"properties": { +"associatedServingConfigIds": { +"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"boostAction": { +"$ref": "GoogleCloudDiscoveryengineV1ControlBoostAction", +"description": "Defines a boost-type control" +}, +"conditions": { +"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1Condition" +}, +"type": "array" +}, +"displayName": { +"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"type": "string" +}, +"filterAction": { +"$ref": "GoogleCloudDiscoveryengineV1ControlFilterAction", +"description": "Defines a filter-type control Currently not supported by Recommendation" +}, +"name": { +"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", +"type": "string" +}, +"redirectAction": { +"$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction", +"description": "Defines a redirect-type control." +}, +"solutionType": { +"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", +"enum": [ +"SOLUTION_TYPE_UNSPECIFIED", +"SOLUTION_TYPE_RECOMMENDATION", +"SOLUTION_TYPE_SEARCH", +"SOLUTION_TYPE_CHAT", +"SOLUTION_TYPE_GENERATIVE_CHAT" +], +"enumDescriptions": [ +"Default value.", +"Used for Recommendations AI.", +"Used for Discovery Search.", +"Used for use cases related to the Generative AI agent.", +"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +], +"type": "string" +}, +"synonymsAction": { +"$ref": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", +"description": "Treats a group of terms as synonyms of one another." +}, +"useCases": { +"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", +"items": { +"enum": [ +"SEARCH_USE_CASE_UNSPECIFIED", +"SEARCH_USE_CASE_SEARCH", +"SEARCH_USE_CASE_BROWSE" +], +"enumDescriptions": [ +"Value used when unset. Will not occur in CSS.", +"Search use case. Expects the traffic has a non-empty query.", +"Browse use case. Expects the traffic has an empty query." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ControlBoostAction": { +"description": "Adjusts order of products in returned list.", +"id": "GoogleCloudDiscoveryengineV1ControlBoostAction", "properties": { -"contentType": { -"description": "The HTTP Content-Type header value specifying the content type of the body.", +"boost": { +"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", +"format": "float", +"type": "number" +}, +"dataStore": { +"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", "type": "string" }, -"data": { -"description": "The HTTP request/response body as raw binary.", -"format": "byte", +"filter": { +"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ControlFilterAction": { +"description": "Specified which products may be included in results. Uses same filter as boost.", +"id": "GoogleCloudDiscoveryengineV1ControlFilterAction", +"properties": { +"dataStore": { +"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", +"type": "string" +}, +"filter": { +"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ControlRedirectAction": { +"description": "Redirects a shopper to the provided URI.", +"id": "GoogleCloudDiscoveryengineV1ControlRedirectAction", +"properties": { +"redirectUri": { +"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ControlSynonymsAction": { +"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", +"id": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", +"properties": { +"synonyms": { +"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1CreateDataStoreMetadata": { +"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1CreateEngineMetadata": { +"description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1CreateEngineMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1CreateSchemaMetadata": { +"description": "Metadata for Create Schema LRO.", +"id": "GoogleCloudDiscoveryengineV1CreateSchemaMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DataStore": { +"description": "DataStore captures global settings and configs at the DataStore level.", +"id": "GoogleCloudDiscoveryengineV1DataStore", +"properties": { +"contentConfig": { +"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", +"enum": [ +"CONTENT_CONFIG_UNSPECIFIED", +"NO_CONTENT", +"CONTENT_REQUIRED", +"PUBLIC_WEBSITE" +], +"enumDescriptions": [ +"Default value.", +"Only contains documents without any Document.content.", +"Only contains documents with Document.content.", +"The data store is used for public website search." +], +"type": "string" +}, +"createTime": { +"description": "Output only. Timestamp the DataStore was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"defaultSchemaId": { +"description": "Output only. The id of the default Schema asscociated to this data store.", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", +"type": "string" +}, +"documentProcessingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", +"description": "Configuration for Document understanding and enrichment." +}, +"industryVertical": { +"description": "Immutable. The industry vertical that the data store registers.", +"enum": [ +"INDUSTRY_VERTICAL_UNSPECIFIED", +"GENERIC", +"MEDIA", +"HEALTHCARE_FHIR" +], +"enumDescriptions": [ +"Value used when unset.", +"The generic vertical for documents that are not specific to any industry vertical.", +"The media industry vertical.", +"The healthcare FHIR vertical." +], +"type": "string" +}, +"name": { +"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"solutionTypes": { +"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", +"items": { +"enum": [ +"SOLUTION_TYPE_UNSPECIFIED", +"SOLUTION_TYPE_RECOMMENDATION", +"SOLUTION_TYPE_SEARCH", +"SOLUTION_TYPE_CHAT", +"SOLUTION_TYPE_GENERATIVE_CHAT" +], +"enumDescriptions": [ +"Default value.", +"Used for Recommendations AI.", +"Used for Discovery Search.", +"Used for use cases related to the Generative AI agent.", +"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +], +"type": "string" +}, +"type": "array" +}, +"startingSchema": { +"$ref": "GoogleCloudDiscoveryengineV1Schema", +"description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { +"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DeleteEngineMetadata": { +"description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1DeleteEngineMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DeleteSchemaMetadata": { +"description": "Metadata for DeleteSchema LRO.", +"id": "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"extensions": { -"description": "Application specific response metadata. Must be set in the first response for streaming APIs.", -"items": { -"additionalProperties": { -"description": "Properties of the object. Contains field @type with type URL.", -"type": "any" +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} }, "type": "object" }, -"type": "array" +"GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineLoggingErrorContext": { -"description": "A description of the context in which an error occurred.", -"id": "GoogleCloudDiscoveryengineLoggingErrorContext", +"GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata", "properties": { -"httpRequest": { -"$ref": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", -"description": "The HTTP request which was processed when the error was triggered." +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" }, -"reportLocation": { -"$ref": "GoogleCloudDiscoveryengineLoggingSourceLocation", -"description": "The location in the source code where the decision was made to report the error, usually the place where it was logged." +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineLoggingErrorLog": { -"description": "An error log which is reported to the Error Reporting system.", -"id": "GoogleCloudDiscoveryengineLoggingErrorLog", +"GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse": { +"description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", +"id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DocumentProcessingConfig": { +"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "properties": { -"context": { -"$ref": "GoogleCloudDiscoveryengineLoggingErrorContext", -"description": "A description of the context in which the error occurred." +"chunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", +"description": "Whether chunking mode is enabled." }, -"importPayload": { -"$ref": "GoogleCloudDiscoveryengineLoggingImportErrorContext", -"description": "The error payload that is populated on LRO import APIs." +"defaultParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", +"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." }, -"message": { -"description": "A message describing the error.", +"name": { +"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "type": "string" }, -"requestPayload": { +"parsingConfigOverrides": { "additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" }, -"description": "The API request payload, represented as a protocol buffer. Most API request types are supported\u2014for example: * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest`", +"description": "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.", "type": "object" +} }, -"responsePayload": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "The API response payload, represented as a protocol buffer. This is used to log some \"soft errors\", where the response is valid but we consider there are some quality issues like unjoined events. The following API responses are supported, and no PII is included: * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent`", "type": "object" }, -"serviceContext": { -"$ref": "GoogleCloudDiscoveryengineLoggingServiceContext", -"description": "The service context in which this error has occurred." -}, -"status": { -"$ref": "GoogleRpcStatus", -"description": "The RPC status associated with the error log." +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { +"description": "Configuration for chunking config.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", +"properties": { +"layoutBasedChunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"description": "Configuration for the layout based chunking." } }, "type": "object" }, -"GoogleCloudDiscoveryengineLoggingHttpRequestContext": { -"description": "HTTP request data that is related to a reported error.", -"id": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { +"description": "Configuration for the layout based chunking.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", "properties": { -"responseStatusCode": { -"description": "The HTTP response status code for the request.", +"chunkSize": { +"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", "format": "int32", "type": "integer" +}, +"includeAncestorHeadings": { +"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineLoggingImportErrorContext": { -"description": "The error payload that is populated on LRO import APIs, including the following: * `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents`", -"id": "GoogleCloudDiscoveryengineLoggingImportErrorContext", +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { +"description": "Related configurations applied to a specific type of document parser.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", "properties": { -"document": { -"description": "The detailed content which caused the error on importing a document.", -"type": "string" -}, -"gcsPath": { -"description": "Google Cloud Storage file path of the import source. Can be set for batch operation error.", -"type": "string" -}, -"lineNumber": { -"description": "Line number of the content in file. Should be empty for permission or batch operation error.", -"type": "string" +"digitalParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", +"description": "Configurations applied to digital parser." }, -"operation": { -"description": "The operation resource name of the LRO.", -"type": "string" +"layoutParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", +"description": "Configurations applied to layout parser." }, -"userEvent": { -"description": "The detailed content which caused the error on importing a user event.", -"type": "string" +"ocrParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", +"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." } }, "type": "object" }, -"GoogleCloudDiscoveryengineLoggingServiceContext": { -"description": "Describes a running service that sends errors.", -"id": "GoogleCloudDiscoveryengineLoggingServiceContext", -"properties": { -"service": { -"description": "An identifier of the service\u2014for example, `discoveryengine.googleapis.com`.", -"type": "string" -} +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig": { +"description": "The digital parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", +"properties": {}, +"type": "object" }, +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { +"description": "The layout parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", +"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineLoggingSourceLocation": { -"description": "Indicates a location in the source code of the service for which errors are reported.", -"id": "GoogleCloudDiscoveryengineLoggingSourceLocation", +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { +"description": "The OCR parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", "properties": { -"functionName": { -"description": "Human-readable name of a function or method\u2014for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.", +"enhancedDocumentElements": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", +"items": { "type": "string" +}, +"type": "array" +}, +"useNativeText": { +"description": "If true, will use native text instead of OCR text on pages containing native text.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -6341,114 +7382,72 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse": { -"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", -"id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse", -"properties": { -"targetSites": { -"description": "TargetSites created.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1TargetSite" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1Condition": { -"description": "Defines circumstances to be checked before allowing a behavior", -"id": "GoogleCloudDiscoveryengineV1Condition", -"properties": { -"activeTimeRange": { -"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1ConditionTimeRange" -}, -"type": "array" -}, -"queryTerms": { -"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm" -}, -"type": "array" -} -}, +"GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse": { +"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", +"id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse", +"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineV1ConditionQueryTerm": { -"description": "Matcher for search request query", -"id": "GoogleCloudDiscoveryengineV1ConditionQueryTerm", +"GoogleCloudDiscoveryengineV1Engine": { +"description": "Metadata that describes the training and serving parameters of an Engine.", +"id": "GoogleCloudDiscoveryengineV1Engine", "properties": { -"fullMatch": { -"description": "Whether the search query needs to exactly match the query term.", -"type": "boolean" -}, -"value": { -"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", -"type": "string" -} +"chatEngineConfig": { +"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", +"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." }, -"type": "object" +"chatEngineMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", +"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", +"readOnly": true }, -"GoogleCloudDiscoveryengineV1ConditionTimeRange": { -"description": "Used for time-dependent conditions.", -"id": "GoogleCloudDiscoveryengineV1ConditionTimeRange", -"properties": { -"endTime": { -"description": "End of time range. Range is inclusive. Must be in the future.", -"format": "google-datetime", -"type": "string" +"commonConfig": { +"$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig", +"description": "Common config spec that specifies the metadata of the engine." }, -"startTime": { -"description": "Start of time range. Range is inclusive.", +"createTime": { +"description": "Output only. Timestamp the Recommendation Engine was created at.", "format": "google-datetime", +"readOnly": true, "type": "string" -} }, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1Control": { -"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", -"id": "GoogleCloudDiscoveryengineV1Control", -"properties": { -"associatedServingConfigIds": { -"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"dataStoreIds": { +"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", "items": { "type": "string" }, -"readOnly": true, -"type": "array" -}, -"boostAction": { -"$ref": "GoogleCloudDiscoveryengineV1ControlBoostAction", -"description": "Defines a boost-type control" -}, -"conditions": { -"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1Condition" -}, "type": "array" }, "displayName": { -"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, -"filterAction": { -"$ref": "GoogleCloudDiscoveryengineV1ControlFilterAction", -"description": "Defines a filter-type control Currently not supported by Recommendation" +"industryVertical": { +"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", +"enum": [ +"INDUSTRY_VERTICAL_UNSPECIFIED", +"GENERIC", +"MEDIA", +"HEALTHCARE_FHIR" +], +"enumDescriptions": [ +"Value used when unset.", +"The generic vertical for documents that are not specific to any industry vertical.", +"The media industry vertical.", +"The healthcare FHIR vertical." +], +"type": "string" }, "name": { -"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", +"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, -"redirectAction": { -"$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction", -"description": "Defines a redirect-type control." +"searchEngineConfig": { +"$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", +"description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." }, "solutionType": { -"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", +"description": "Required. The solutions of the engine.", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", @@ -6465,131 +7464,128 @@ ], "type": "string" }, -"synonymsAction": { -"$ref": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", -"description": "Treats a group of terms as synonyms of one another." -}, -"useCases": { -"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", -"items": { -"enum": [ -"SEARCH_USE_CASE_UNSPECIFIED", -"SEARCH_USE_CASE_SEARCH", -"SEARCH_USE_CASE_BROWSE" -], -"enumDescriptions": [ -"Value used when unset. Will not occur in CSS.", -"Search use case. Expects the traffic has a non-empty query.", -"Browse use case. Expects the traffic has an empty query." -], +"updateTime": { +"description": "Output only. Timestamp the Recommendation Engine was last updated.", +"format": "google-datetime", +"readOnly": true, "type": "string" -}, -"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ControlBoostAction": { -"description": "Adjusts order of products in returned list.", -"id": "GoogleCloudDiscoveryengineV1ControlBoostAction", +"GoogleCloudDiscoveryengineV1EngineChatEngineConfig": { +"description": "Configurations for a Chat Engine.", +"id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", "properties": { -"boost": { -"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", -"format": "float", -"type": "number" -}, -"dataStore": { -"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", -"type": "string" +"agentCreationConfig": { +"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", +"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." }, -"filter": { -"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"dialogflowAgentToLink": { +"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ControlFilterAction": { -"description": "Specified which products may be included in results. Uses same filter as boost.", -"id": "GoogleCloudDiscoveryengineV1ControlFilterAction", +"GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig": { +"description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", +"id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", "properties": { -"dataStore": { -"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", +"business": { +"description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", "type": "string" }, -"filter": { -"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"defaultLanguageCode": { +"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", +"type": "string" +}, +"location": { +"description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", +"type": "string" +}, +"timeZone": { +"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ControlRedirectAction": { -"description": "Redirects a shopper to the provided URI.", -"id": "GoogleCloudDiscoveryengineV1ControlRedirectAction", +"GoogleCloudDiscoveryengineV1EngineChatEngineMetadata": { +"description": "Additional information of a Chat Engine. Fields in this message are output only.", +"id": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", "properties": { -"redirectUri": { -"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"dialogflowAgent": { +"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ControlSynonymsAction": { -"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", -"id": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", +"GoogleCloudDiscoveryengineV1EngineCommonConfig": { +"description": "Common configurations for an Engine.", +"id": "GoogleCloudDiscoveryengineV1EngineCommonConfig", "properties": { -"synonyms": { -"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", -"items": { +"companyName": { +"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", "type": "string" -}, -"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1CreateDataStoreMetadata": { -"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata", +"GoogleCloudDiscoveryengineV1EngineSearchEngineConfig": { +"description": "Configurations for a Search Engine.", +"id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"searchAddOns": { +"description": "The add-on that this search engine enables.", +"items": { +"enum": [ +"SEARCH_ADD_ON_UNSPECIFIED", +"SEARCH_ADD_ON_LLM" +], +"enumDescriptions": [ +"Default value when the enum is unspecified. This is invalid to use.", +"Large language model add-on." +], "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"type": "array" +}, +"searchTier": { +"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", +"enum": [ +"SEARCH_TIER_UNSPECIFIED", +"SEARCH_TIER_STANDARD", +"SEARCH_TIER_ENTERPRISE" +], +"enumDescriptions": [ +"Default value when the enum is unspecified. This is invalid to use.", +"Standard tier.", +"Enterprise tier." +], "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1CreateEngineMetadata": { -"description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1CreateEngineMetadata", +"GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata": { +"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"failureCount": { +"description": "Count of CompletionSuggestions that failed to be imported.", +"format": "int64", "type": "string" -} -}, -"type": "object" }, -"GoogleCloudDiscoveryengineV1CreateSchemaMetadata": { -"description": "Metadata for Create Schema LRO.", -"id": "GoogleCloudDiscoveryengineV1CreateSchemaMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"successCount": { +"description": "Count of CompletionSuggestions successfully imported.", +"format": "int64", "type": "string" }, "updateTime": { @@ -6600,113 +7596,88 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse": { +"description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", +"description": "The desired location of errors incurred during the Import." }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DataStore": { -"description": "DataStore captures global settings and configs at the DataStore level.", -"id": "GoogleCloudDiscoveryengineV1DataStore", -"properties": { -"contentConfig": { -"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", -"enum": [ -"CONTENT_CONFIG_UNSPECIFIED", -"NO_CONTENT", -"CONTENT_REQUIRED", -"PUBLIC_WEBSITE" -], -"enumDescriptions": [ -"Default value.", -"Only contains documents without any Document.content.", -"Only contains documents with Document.content.", -"The data store is used for public website search." -], -"type": "string" -}, +"GoogleCloudDiscoveryengineV1ImportDocumentsMetadata": { +"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata", +"properties": { "createTime": { -"description": "Output only. Timestamp the DataStore was created at.", +"description": "Operation create time.", "format": "google-datetime", -"readOnly": true, "type": "string" }, -"defaultSchemaId": { -"description": "Output only. The id of the default Schema asscociated to this data store.", -"readOnly": true, +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", "type": "string" }, -"displayName": { -"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", +"successCount": { +"description": "Count of entries that were processed successfully.", +"format": "int64", "type": "string" }, -"documentProcessingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", -"description": "Configuration for Document understanding and enrichment." -}, -"industryVertical": { -"description": "Immutable. The industry vertical that the data store registers.", -"enum": [ -"INDUSTRY_VERTICAL_UNSPECIFIED", -"GENERIC", -"MEDIA", -"HEALTHCARE_FHIR" -], -"enumDescriptions": [ -"Value used when unset.", -"The generic vertical for documents that are not specific to any industry vertical.", -"The media industry vertical.", -"The healthcare FHIR vertical." -], +"totalCount": { +"description": "Total count of entries that were processed.", +"format": "int64", "type": "string" }, -"name": { -"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" +} }, -"solutionTypes": { -"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ImportDocumentsResponse": { +"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", +"id": "GoogleCloudDiscoveryengineV1ImportDocumentsResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", +"description": "Echoes the destination for the complete errors in the request if set." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", "items": { -"enum": [ -"SOLUTION_TYPE_UNSPECIFIED", -"SOLUTION_TYPE_RECOMMENDATION", -"SOLUTION_TYPE_SEARCH", -"SOLUTION_TYPE_CHAT", -"SOLUTION_TYPE_GENERATIVE_CHAT" -], -"enumDescriptions": [ -"Default value.", -"Used for Recommendations AI.", -"Used for Discovery Search.", -"Used for use cases related to the Generative AI agent.", -"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." -], -"type": "string" +"$ref": "GoogleRpcStatus" }, "type": "array" +} }, -"startingSchema": { -"$ref": "GoogleCloudDiscoveryengineV1Schema", -"description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ImportErrorConfig": { +"description": "Configuration of destination for Import related errors.", +"id": "GoogleCloudDiscoveryengineV1ImportErrorConfig", +"properties": { +"gcsPrefix": { +"description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { -"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", +"GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -6721,32 +7692,49 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DeleteEngineMetadata": { -"description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1DeleteEngineMetadata", +"GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"failedEntriesCount": { +"description": "Count of deny list entries that failed to be imported.", +"format": "int64", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"importedEntriesCount": { +"description": "Count of deny list entries successfully imported.", +"format": "int64", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DeleteSchemaMetadata": { -"description": "Metadata for DeleteSchema LRO.", -"id": "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata", +"GoogleCloudDiscoveryengineV1ImportUserEventsMetadata": { +"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of entries that were processed successfully.", +"format": "int64", +"type": "string" +}, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -6755,152 +7743,202 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1ImportUserEventsResponse": { +"description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", +"id": "GoogleCloudDiscoveryengineV1ImportUserEventsResponse", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", +"description": "Echoes the destination for the complete errors if this field was set in the request." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"joinedEventsCount": { +"description": "Count of user events imported with complete existing Documents.", +"format": "int64", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"unjoinedEventsCount": { +"description": "Count of user events imported, but with Document information not found in the existing Branch.", +"format": "int64", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata", +"GoogleCloudDiscoveryengineV1Project": { +"description": "Metadata and configurations for a Google Cloud project in the service.", +"id": "GoogleCloudDiscoveryengineV1Project", "properties": { "createTime": { -"description": "Operation create time.", +"description": "Output only. The timestamp when this project is created.", "format": "google-datetime", +"readOnly": true, "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", +"name": { +"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", +"readOnly": true, +"type": "string" +}, +"provisionCompletionTime": { +"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", "format": "google-datetime", +"readOnly": true, "type": "string" -} }, +"serviceTermsMap": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1ProjectServiceTerms" +}, +"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", +"readOnly": true, "type": "object" +} }, -"GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse": { -"description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", -"id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse", -"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineV1DocumentProcessingConfig": { -"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", -"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", +"GoogleCloudDiscoveryengineV1ProjectServiceTerms": { +"description": "Metadata about the terms of service.", +"id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms", "properties": { -"chunkingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", -"description": "Whether chunking mode is enabled." +"acceptTime": { +"description": "The last time when the project agreed to the terms of service.", +"format": "google-datetime", +"type": "string" }, -"defaultParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", -"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." +"declineTime": { +"description": "The last time when the project declined or revoked the agreement to terms of service.", +"format": "google-datetime", +"type": "string" }, -"name": { -"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", +"id": { +"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", "type": "string" }, -"parsingConfigOverrides": { -"additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" +"state": { +"description": "Whether the project has accepted/rejected the service terms or it is still pending.", +"enum": [ +"STATE_UNSPECIFIED", +"TERMS_ACCEPTED", +"TERMS_PENDING", +"TERMS_DECLINED" +], +"enumDescriptions": [ +"The default value of the enum. This value is not actually used.", +"The project has given consent to the terms of service.", +"The project is pending to review and accept the terms of service.", +"The project has declined or revoked the agreement to terms of service." +], +"type": "string" }, -"description": "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.", -"type": "object" +"version": { +"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { -"description": "Configuration for chunking config.", -"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", +"GoogleCloudDiscoveryengineV1ProvisionProjectMetadata": { +"description": "Metadata associated with a project provision operation.", +"id": "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata": { +"description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata", "properties": { -"layoutBasedChunkingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", -"description": "Configuration for the layout based chunking." +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { -"description": "Configuration for the layout based chunking.", -"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse": { +"description": "Response message for CompletionService.PurgeCompletionSuggestions method.", +"id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse", "properties": { -"chunkSize": { -"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", -"format": "int32", -"type": "integer" +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" }, -"includeAncestorHeadings": { -"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", +"type": "array" +}, +"purgeSucceeded": { +"description": "Whether the completion suggestions were successfully purged.", "type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { -"description": "Related configurations applied to a specific type of document parser.", -"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", +"GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": { +"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata", "properties": { -"digitalParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", -"description": "Configurations applied to digital parser." +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" }, -"layoutParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", -"description": "Configurations applied to layout parser." +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", +"type": "string" }, -"ocrParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", -"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." -} +"ignoredCount": { +"description": "Count of entries that were ignored as entries were not found.", +"format": "int64", +"type": "string" }, -"type": "object" +"successCount": { +"description": "Count of entries that were deleted successfully.", +"format": "int64", +"type": "string" }, -"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig": { -"description": "The digital parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", -"properties": {}, -"type": "object" +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} }, -"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { -"description": "The layout parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", -"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { -"description": "The OCR parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", +"GoogleCloudDiscoveryengineV1PurgeDocumentsResponse": { +"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse", "properties": { -"enhancedDocumentElements": { -"deprecated": true, -"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", +"purgeCount": { +"description": "The total count of documents purged as a result of the operation.", +"format": "int64", +"type": "string" +}, +"purgeSample": { +"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", "items": { "type": "string" }, "type": "array" -}, -"useNativeText": { -"description": "If true, will use native text instead of OCR text on pages containing native text.", -"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata", +"GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -6915,90 +7953,148 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse": { -"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", -"id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse", -"properties": {}, +"GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse", +"properties": { +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"purgeCount": { +"description": "Number of suggestion deny list entries purged.", +"format": "int64", +"type": "string" +} +}, "type": "object" }, -"GoogleCloudDiscoveryengineV1Engine": { -"description": "Metadata that describes the training and serving parameters of an Engine.", -"id": "GoogleCloudDiscoveryengineV1Engine", +"GoogleCloudDiscoveryengineV1Schema": { +"description": "Defines the structure and layout of a type of document data.", +"id": "GoogleCloudDiscoveryengineV1Schema", "properties": { -"chatEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", -"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." +"jsonSchema": { +"description": "The JSON representation of the schema.", +"type": "string" }, -"chatEngineMetadata": { -"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", -"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", -"readOnly": true +"name": { +"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" }, -"commonConfig": { -"$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig", -"description": "Common config spec that specifies the metadata of the engine." +"structSchema": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" }, -"createTime": { -"description": "Output only. Timestamp the Recommendation Engine was created at.", -"format": "google-datetime", -"readOnly": true, +"description": "The structured representation of the schema.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1SiteVerificationInfo": { +"description": "Verification information for target sites in advanced site search.", +"id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", +"properties": { +"siteVerificationState": { +"description": "Site verification state indicating the ownership and validity.", +"enum": [ +"SITE_VERIFICATION_STATE_UNSPECIFIED", +"VERIFIED", +"UNVERIFIED", +"EXEMPTED" +], +"enumDescriptions": [ +"Defaults to VERIFIED.", +"Site ownership verified.", +"Site ownership pending verification or verification failed.", +"Site exempt from verification, e.g., a public website that opens to all." +], "type": "string" }, -"dataStoreIds": { -"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", -"items": { +"verifyTime": { +"description": "Latest site verification time.", +"format": "google-datetime", "type": "string" +} }, -"type": "array" +"type": "object" }, -"displayName": { -"description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", +"GoogleCloudDiscoveryengineV1TargetSite": { +"description": "A target site for the SiteSearchEngine.", +"id": "GoogleCloudDiscoveryengineV1TargetSite", +"properties": { +"exactMatch": { +"description": "Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.", +"type": "boolean" +}, +"failureReason": { +"$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", +"description": "Output only. Failure reason.", +"readOnly": true +}, +"generatedUriPattern": { +"description": "Output only. This is system-generated based on the provided_uri_pattern.", +"readOnly": true, "type": "string" }, -"industryVertical": { -"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", +"indexingStatus": { +"description": "Output only. Indexing status.", "enum": [ -"INDUSTRY_VERTICAL_UNSPECIFIED", -"GENERIC", -"MEDIA", -"HEALTHCARE_FHIR" +"INDEXING_STATUS_UNSPECIFIED", +"PENDING", +"FAILED", +"SUCCEEDED", +"DELETING" ], "enumDescriptions": [ -"Value used when unset.", -"The generic vertical for documents that are not specific to any industry vertical.", -"The media industry vertical.", -"The healthcare FHIR vertical." +"Defaults to SUCCEEDED.", +"The target site is in the update queue and will be picked up by indexing pipeline.", +"The target site fails to be indexed.", +"The target site has been indexed.", +"The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails." ], +"readOnly": true, "type": "string" }, "name": { -"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", +"description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", +"readOnly": true, "type": "string" }, -"searchEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", -"description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." +"providedUriPattern": { +"description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", +"type": "string" }, -"solutionType": { -"description": "Required. The solutions of the engine.", +"rootDomainUri": { +"description": "Output only. Root domain of the provided_uri_pattern.", +"readOnly": true, +"type": "string" +}, +"siteVerificationInfo": { +"$ref": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", +"description": "Output only. Site ownership and validity verification status.", +"readOnly": true +}, +"type": { +"description": "The type of the target site, e.g., whether the site is to be included or excluded.", "enum": [ -"SOLUTION_TYPE_UNSPECIFIED", -"SOLUTION_TYPE_RECOMMENDATION", -"SOLUTION_TYPE_SEARCH", -"SOLUTION_TYPE_CHAT", -"SOLUTION_TYPE_GENERATIVE_CHAT" +"TYPE_UNSPECIFIED", +"INCLUDE", +"EXCLUDE" ], "enumDescriptions": [ -"Default value.", -"Used for Recommendations AI.", -"Used for Discovery Search.", -"Used for use cases related to the Generative AI agent.", -"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +"This value is unused. In this case, server behavior defaults to Type.INCLUDE.", +"Include the target site.", +"Exclude the target site." ], "type": "string" }, "updateTime": { -"description": "Output only. Timestamp the Recommendation Engine was last updated.", +"description": "Output only. The target site's last updated time.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -7006,386 +8102,525 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1EngineChatEngineConfig": { -"description": "Configurations for a Chat Engine.", -"id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", +"GoogleCloudDiscoveryengineV1TargetSiteFailureReason": { +"description": "Site search indexing failure reasons.", +"id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", "properties": { -"agentCreationConfig": { -"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", -"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." -}, -"dialogflowAgentToLink": { -"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", -"type": "string" +"quotaFailure": { +"$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", +"description": "Failed due to insufficient quota." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig": { -"description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", -"id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", +"GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure": { +"description": "Failed due to insufficient quota.", +"id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", "properties": { -"business": { -"description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", +"totalRequiredQuota": { +"description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", +"format": "int64", "type": "string" +} }, -"defaultLanguageCode": { -"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", -"type": "string" +"type": "object" }, -"location": { -"description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", +"GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { +"description": "Metadata for UpdateSchema LRO.", +"id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"timeZone": { -"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1EngineChatEngineMetadata": { -"description": "Additional information of a Chat Engine. Fields in this message are output only.", -"id": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", +"GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata", "properties": { -"dialogflowAgent": { -"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1EngineCommonConfig": { -"description": "Common configurations for an Engine.", -"id": "GoogleCloudDiscoveryengineV1EngineCommonConfig", +"GoogleCloudDiscoveryengineV1alphaAclConfig": { +"description": "Access Control Configuration.", +"id": "GoogleCloudDiscoveryengineV1alphaAclConfig", "properties": { -"companyName": { -"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", +"idpConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", +"description": "Identity provider config." +}, +"name": { +"description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1EngineSearchEngineConfig": { -"description": "Configurations for a Search Engine.", -"id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", +"GoogleCloudDiscoveryengineV1alphaAnswer": { +"description": "Defines an answer.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswer", "properties": { -"searchAddOns": { -"description": "The add-on that this search engine enables.", +"answerSkippedReasons": { +"description": "Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", "items": { "enum": [ -"SEARCH_ADD_ON_UNSPECIFIED", -"SEARCH_ADD_ON_LLM" +"ANSWER_SKIPPED_REASON_UNSPECIFIED", +"ADVERSARIAL_QUERY_IGNORED", +"NON_ANSWER_SEEKING_QUERY_IGNORED", +"OUT_OF_DOMAIN_QUERY_IGNORED", +"POTENTIAL_POLICY_VIOLATION", +"NO_RELEVANT_CONTENT" ], "enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Large language model add-on." +"Default value. The answer skipped reason is not specified.", +"The adversarial query ignored case.", +"The non-answer seeking query ignored case.", +"The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", +"The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", +"The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results." ], "type": "string" }, "type": "array" }, -"searchTier": { -"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", +"answerText": { +"description": "The textual answer.", +"type": "string" +}, +"citations": { +"description": "Citations.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitation" +}, +"type": "array" +}, +"completeTime": { +"description": "Output only. Answer completed timestamp.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. Answer creation timestamp.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", +"type": "string" +}, +"queryUnderstandingInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", +"description": "Query understanding information." +}, +"references": { +"description": "References.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReference" +}, +"type": "array" +}, +"relatedQuestions": { +"description": "Suggested related questions.", +"items": { +"type": "string" +}, +"type": "array" +}, +"state": { +"description": "The state of the answer generation.", "enum": [ -"SEARCH_TIER_UNSPECIFIED", -"SEARCH_TIER_STANDARD", -"SEARCH_TIER_ENTERPRISE" +"STATE_UNSPECIFIED", +"IN_PROGRESS", +"FAILED", +"SUCCEEDED" ], "enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Standard tier.", -"Enterprise tier." +"Unknown.", +"Answer generation is currently in progress.", +"Answer generation currently failed.", +"Answer generation has succeeded." ], "type": "string" +}, +"steps": { +"description": "Answer generation steps.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStep" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata": { -"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata", +"GoogleCloudDiscoveryengineV1alphaAnswerCitation": { +"description": "Citation info for a segment.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"endIndex": { +"description": "End of the attributed segment, exclusive.", +"format": "int64", "type": "string" }, -"failureCount": { -"description": "Count of CompletionSuggestions that failed to be imported.", +"sources": { +"description": "Citation sources for the attributed segment.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource" +}, +"type": "array" +}, +"startIndex": { +"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", "format": "int64", "type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": { +"description": "Citation source.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource", +"properties": { +"referenceId": { +"description": "ID of the citation source.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": { +"description": "Query understanding information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", +"properties": { +"queryClassificationInfo": { +"description": "Query classification information.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": { +"description": "Query classification information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo", +"properties": { +"positive": { +"description": "Classification output.", +"type": "boolean" +}, +"type": { +"description": "Query classification type.", +"enum": [ +"TYPE_UNSPECIFIED", +"ADVERSARIAL_QUERY", +"NON_ANSWER_SEEKING_QUERY" +], +"enumDescriptions": [ +"Unspecified query classification type.", +"Adversarial query classification type.", +"Non-answer-seeking query classification type." +], +"type": "string" +} }, -"successCount": { -"description": "Count of CompletionSuggestions successfully imported.", -"format": "int64", -"type": "string" +"type": "object" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"GoogleCloudDiscoveryengineV1alphaAnswerReference": { +"description": "Reference.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReference", +"properties": { +"chunkInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", +"description": "Chunk information." +}, +"unstructuredDocumentInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", +"description": "Unstructured document information." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse": { -"description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", -"id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse", +"GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": { +"description": "Chunk information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", -"description": "The desired location of errors incurred during the Import." +"chunk": { +"description": "Chunk resource name.", +"type": "string" }, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"content": { +"description": "Chunk textual content.", +"type": "string" }, -"type": "array" +"documentMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", +"description": "Document metadata." +}, +"relevanceScore": { +"description": "Relevance score.", +"format": "float", +"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportDocumentsMetadata": { -"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata", +"GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": { +"description": "Document metadata.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"document": { +"description": "Document resource name.", "type": "string" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", +"pageIdentifier": { +"description": "Page identifier.", "type": "string" }, -"successCount": { -"description": "Count of entries that were processed successfully.", -"format": "int64", -"type": "string" +"structData": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" }, -"totalCount": { -"description": "Total count of entries that were processed.", -"format": "int64", +"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", +"type": "object" +}, +"title": { +"description": "Title.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"uri": { +"description": "URI for the document.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportDocumentsResponse": { -"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", -"id": "GoogleCloudDiscoveryengineV1ImportDocumentsResponse", +"GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { +"description": "Unstructured document information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", -"description": "Echoes the destination for the complete errors in the request if set." -}, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"chunkContents": { +"description": "List of cited chunk contents derived from document content.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent" }, "type": "array" -} }, +"document": { +"description": "Document resource name.", +"type": "string" +}, +"structData": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportErrorConfig": { -"description": "Configuration of destination for Import related errors.", -"id": "GoogleCloudDiscoveryengineV1ImportErrorConfig", -"properties": { -"gcsPrefix": { -"description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", +"title": { +"description": "Title.", +"type": "string" +}, +"uri": { +"description": "URI for the document.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata", +"GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent": { +"description": "Chunk content.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"content": { +"description": "Chunk textual content.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"pageIdentifier": { +"description": "Page identifier.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse", +"GoogleCloudDiscoveryengineV1alphaAnswerStep": { +"description": "Step information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStep", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"actions": { +"description": "Actions.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction" }, "type": "array" }, -"failedEntriesCount": { -"description": "Count of deny list entries that failed to be imported.", -"format": "int64", +"description": { +"description": "The description of the step.", "type": "string" }, -"importedEntriesCount": { -"description": "Count of deny list entries successfully imported.", -"format": "int64", +"state": { +"description": "The state of the step.", +"enum": [ +"STATE_UNSPECIFIED", +"IN_PROGRESS", +"FAILED", +"SUCCEEDED" +], +"enumDescriptions": [ +"Unknown.", +"Step is currently in progress.", +"Step currently failed.", +"Step has succeeded." +], +"type": "string" +}, +"thought": { +"description": "The thought of the step.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportUserEventsMetadata": { -"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata", +"GoogleCloudDiscoveryengineV1alphaAnswerStepAction": { +"description": "Action.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" -}, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", -"type": "string" -}, -"successCount": { -"description": "Count of entries that were processed successfully.", -"format": "int64", -"type": "string" +"observation": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", +"description": "Observation." }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"searchAction": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", +"description": "Search action." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportUserEventsResponse": { -"description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", -"id": "GoogleCloudDiscoveryengineV1ImportUserEventsResponse", +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { +"description": "Observation.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", -"description": "Echoes the destination for the complete errors if this field was set in the request." -}, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"searchResults": { +"description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult" }, "type": "array" -}, -"joinedEventsCount": { -"description": "Count of user events imported with complete existing Documents.", -"format": "int64", -"type": "string" -}, -"unjoinedEventsCount": { -"description": "Count of user events imported, but with Document information not found in the existing Branch.", -"format": "int64", -"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1Project": { -"description": "Metadata and configurations for a Google Cloud project in the service.", -"id": "GoogleCloudDiscoveryengineV1Project", +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", "properties": { -"createTime": { -"description": "Output only. The timestamp when this project is created.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"chunkInfo": { +"description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo" }, -"name": { -"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", -"readOnly": true, +"type": "array" +}, +"document": { +"description": "Document resource name.", "type": "string" }, -"provisionCompletionTime": { -"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"snippetInfo": { +"description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo" }, -"serviceTermsMap": { +"type": "array" +}, +"structData": { "additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1ProjectServiceTerms" +"description": "Properties of the object.", +"type": "any" }, -"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", -"readOnly": true, +"description": "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 .", "type": "object" +}, +"title": { +"description": "Title.", +"type": "string" +}, +"uri": { +"description": "URI for the document.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ProjectServiceTerms": { -"description": "Metadata about the terms of service.", -"id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms", +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { +"description": "Chunk information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo", "properties": { -"acceptTime": { -"description": "The last time when the project agreed to the terms of service.", -"format": "google-datetime", +"chunk": { +"description": "Chunk resource name.", "type": "string" }, -"declineTime": { -"description": "The last time when the project declined or revoked the agreement to terms of service.", -"format": "google-datetime", +"content": { +"description": "Chunk textual content.", "type": "string" }, -"id": { -"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", -"type": "string" +"relevanceScore": { +"description": "Relevance score.", +"format": "float", +"type": "number" +} }, -"state": { -"description": "Whether the project has accepted/rejected the service terms or it is still pending.", -"enum": [ -"STATE_UNSPECIFIED", -"TERMS_ACCEPTED", -"TERMS_PENDING", -"TERMS_DECLINED" -], -"enumDescriptions": [ -"The default value of the enum. This value is not actually used.", -"The project has given consent to the terms of service.", -"The project is pending to review and accept the terms of service.", -"The project has declined or revoked the agreement to terms of service." -], +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { +"description": "Snippet information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", +"properties": { +"snippet": { +"description": "Snippet content.", "type": "string" }, -"version": { -"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", +"snippetStatus": { +"description": "Status of the snippet defined by the search team.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ProvisionProjectMetadata": { -"description": "Metadata associated with a project provision operation.", -"id": "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata", -"properties": {}, +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { +"description": "Search action.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", +"properties": { +"query": { +"description": "The query to search.", +"type": "string" +} +}, "type": "object" }, -"GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata": { -"description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata", +"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -7400,267 +8635,257 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse": { -"description": "Response message for CompletionService.PurgeCompletionSuggestions method.", -"id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse", +"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": { +"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", +"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"targetSites": { +"description": "TargetSites created.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" }, "type": "array" +} }, -"purgeSucceeded": { -"description": "Whether the completion suggestions were successfully purged.", -"type": "boolean" +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaCondition": { +"description": "Defines circumstances to be checked before allowing a behavior", +"id": "GoogleCloudDiscoveryengineV1alphaCondition", +"properties": { +"activeTimeRange": { +"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange" +}, +"type": "array" +}, +"queryTerms": { +"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": { -"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata", +"GoogleCloudDiscoveryengineV1alphaConditionQueryTerm": { +"description": "Matcher for search request query", +"id": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"fullMatch": { +"description": "Whether the search query needs to exactly match the query term.", +"type": "boolean" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", +"value": { +"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", "type": "string" +} }, -"ignoredCount": { -"description": "Count of entries that were ignored as entries were not found.", -"format": "int64", -"type": "string" +"type": "object" }, -"successCount": { -"description": "Count of entries that were deleted successfully.", -"format": "int64", +"GoogleCloudDiscoveryengineV1alphaConditionTimeRange": { +"description": "Used for time-dependent conditions.", +"id": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange", +"properties": { +"endTime": { +"description": "End of time range. Range is inclusive. Must be in the future.", +"format": "google-datetime", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", +"startTime": { +"description": "Start of time range. Range is inclusive.", "format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1PurgeDocumentsResponse": { -"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse", +"GoogleCloudDiscoveryengineV1alphaControl": { +"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", +"id": "GoogleCloudDiscoveryengineV1alphaControl", "properties": { -"purgeCount": { -"description": "The total count of documents purged as a result of the operation.", -"format": "int64", +"associatedServingConfigIds": { +"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"items": { "type": "string" }, -"purgeSample": { -"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", +"readOnly": true, +"type": "array" +}, +"boostAction": { +"$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", +"description": "Defines a boost-type control" +}, +"conditions": { +"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", "items": { -"type": "string" +"$ref": "GoogleCloudDiscoveryengineV1alphaCondition" }, "type": "array" -} }, -"type": "object" +"displayName": { +"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"type": "string" }, -"GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"filterAction": { +"$ref": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", +"description": "Defines a filter-type control Currently not supported by Recommendation" +}, +"name": { +"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"redirectAction": { +"$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", +"description": "Defines a redirect-type control." +}, +"solutionType": { +"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", +"enum": [ +"SOLUTION_TYPE_UNSPECIFIED", +"SOLUTION_TYPE_RECOMMENDATION", +"SOLUTION_TYPE_SEARCH", +"SOLUTION_TYPE_CHAT", +"SOLUTION_TYPE_GENERATIVE_CHAT" +], +"enumDescriptions": [ +"Default value.", +"Used for Recommendations AI.", +"Used for Discovery Search.", +"Used for use cases related to the Generative AI agent.", +"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +], "type": "string" -} }, -"type": "object" +"synonymsAction": { +"$ref": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", +"description": "Treats a group of terms as synonyms of one another." }, -"GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse", -"properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"useCases": { +"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", "items": { -"$ref": "GoogleRpcStatus" +"enum": [ +"SEARCH_USE_CASE_UNSPECIFIED", +"SEARCH_USE_CASE_SEARCH", +"SEARCH_USE_CASE_BROWSE" +], +"enumDescriptions": [ +"Value used when unset. Will not occur in CSS.", +"Search use case. Expects the traffic has a non-empty query.", +"Browse use case. Expects the traffic has an empty query." +], +"type": "string" }, "type": "array" -}, -"purgeCount": { -"description": "Number of suggestion deny list entries purged.", -"format": "int64", -"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1Schema": { -"description": "Defines the structure and layout of a type of document data.", -"id": "GoogleCloudDiscoveryengineV1Schema", +"GoogleCloudDiscoveryengineV1alphaControlBoostAction": { +"description": "Adjusts order of products in returned list.", +"id": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", "properties": { -"jsonSchema": { -"description": "The JSON representation of the schema.", -"type": "string" +"boost": { +"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", +"format": "float", +"type": "number" }, -"name": { -"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"dataStore": { +"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", "type": "string" }, -"structSchema": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "The structured representation of the schema.", -"type": "object" +"filter": { +"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1SiteVerificationInfo": { -"description": "Verification information for target sites in advanced site search.", -"id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", +"GoogleCloudDiscoveryengineV1alphaControlFilterAction": { +"description": "Specified which products may be included in results. Uses same filter as boost.", +"id": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", "properties": { -"siteVerificationState": { -"description": "Site verification state indicating the ownership and validity.", -"enum": [ -"SITE_VERIFICATION_STATE_UNSPECIFIED", -"VERIFIED", -"UNVERIFIED", -"EXEMPTED" -], -"enumDescriptions": [ -"Defaults to VERIFIED.", -"Site ownership verified.", -"Site ownership pending verification or verification failed.", -"Site exempt from verification, e.g., a public website that opens to all." -], +"dataStore": { +"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", "type": "string" }, -"verifyTime": { -"description": "Latest site verification time.", -"format": "google-datetime", +"filter": { +"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1TargetSite": { -"description": "A target site for the SiteSearchEngine.", -"id": "GoogleCloudDiscoveryengineV1TargetSite", +"GoogleCloudDiscoveryengineV1alphaControlRedirectAction": { +"description": "Redirects a shopper to the provided URI.", +"id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", "properties": { -"exactMatch": { -"description": "Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.", -"type": "boolean" -}, -"failureReason": { -"$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", -"description": "Output only. Failure reason.", -"readOnly": true -}, -"generatedUriPattern": { -"description": "Output only. This is system-generated based on the provided_uri_pattern.", -"readOnly": true, -"type": "string" -}, -"indexingStatus": { -"description": "Output only. Indexing status.", -"enum": [ -"INDEXING_STATUS_UNSPECIFIED", -"PENDING", -"FAILED", -"SUCCEEDED", -"DELETING" -], -"enumDescriptions": [ -"Defaults to SUCCEEDED.", -"The target site is in the update queue and will be picked up by indexing pipeline.", -"The target site fails to be indexed.", -"The target site has been indexed.", -"The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails." -], -"readOnly": true, +"redirectUri": { +"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" +} }, -"name": { -"description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", -"readOnly": true, -"type": "string" +"type": "object" }, -"providedUriPattern": { -"description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", +"GoogleCloudDiscoveryengineV1alphaControlSynonymsAction": { +"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", +"id": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", +"properties": { +"synonyms": { +"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", +"items": { "type": "string" }, -"rootDomainUri": { -"description": "Output only. Root domain of the provided_uri_pattern.", -"readOnly": true, -"type": "string" +"type": "array" +} }, -"siteVerificationInfo": { -"$ref": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", -"description": "Output only. Site ownership and validity verification status.", -"readOnly": true +"type": "object" }, -"type": { -"description": "The type of the target site, e.g., whether the site is to be included or excluded.", -"enum": [ -"TYPE_UNSPECIFIED", -"INCLUDE", -"EXCLUDE" -], -"enumDescriptions": [ -"This value is unused. In this case, server behavior defaults to Type.INCLUDE.", -"Include the target site.", -"Exclude the target site." -], +"GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata": { +"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, "updateTime": { -"description": "Output only. The target site's last updated time.", +"description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", -"readOnly": true, "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1TargetSiteFailureReason": { -"description": "Site search indexing failure reasons.", -"id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", +"GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata": { +"description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata", "properties": { -"quotaFailure": { -"$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", -"description": "Failed due to insufficient quota." -} -}, -"type": "object" +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" }, -"GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure": { -"description": "Failed due to insufficient quota.", -"id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", -"properties": { -"totalRequiredQuota": { -"description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", -"format": "int64", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { -"description": "Metadata for UpdateSchema LRO.", -"id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", +"GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata": { +"description": "Metadata for EvaluationService.CreateEvaluation method.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { +"description": "Metadata for Create Schema LRO.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -7675,9 +8900,9 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -7692,744 +8917,816 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAclConfig": { -"description": "Access Control Configuration.", -"id": "GoogleCloudDiscoveryengineV1alphaAclConfig", +"GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec": { +"description": "Defines custom fine tuning spec.", +"id": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", "properties": { -"idpConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", -"description": "Identity provider config." +"enableSearchAdaptor": { +"description": "Whether or not to enable and include custom fine tuned search adaptor model.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaCustomTuningModel": { +"description": "Metadata that describes a custom tuned model.", +"id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel", +"properties": { +"createTime": { +"deprecated": true, +"description": "Timestamp the Model was created at.", +"format": "google-datetime", +"type": "string" +}, +"displayName": { +"description": "The display name of the model.", +"type": "string" +}, +"metrics": { +"additionalProperties": { +"format": "double", +"type": "number" +}, +"description": "The metrics of the trained model.", +"type": "object" +}, +"modelState": { +"description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", +"enum": [ +"MODEL_STATE_UNSPECIFIED", +"TRAINING_PAUSED", +"TRAINING", +"TRAINING_COMPLETE", +"READY_FOR_SERVING", +"TRAINING_FAILED", +"NO_IMPROVEMENT" +], +"enumDescriptions": [ +"Default value.", +"The model is in a paused training state.", +"The model is currently training.", +"The model has successfully completed training.", +"The model is ready for serving.", +"The model training failed.", +"The model training finished successfully but metrics did not improve." +], +"type": "string" +}, +"modelVersion": { +"description": "The version of the model.", +"format": "int64", +"type": "string" }, "name": { -"description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", +"type": "string" +}, +"trainingStartTime": { +"description": "Timestamp the model training was initiated.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswer": { -"description": "Defines an answer.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswer", +"GoogleCloudDiscoveryengineV1alphaDataStore": { +"description": "DataStore captures global settings and configs at the DataStore level.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStore", "properties": { -"answerSkippedReasons": { -"description": "Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", -"items": { +"aclEnabled": { +"description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.", +"type": "boolean" +}, +"contentConfig": { +"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ -"ANSWER_SKIPPED_REASON_UNSPECIFIED", -"ADVERSARIAL_QUERY_IGNORED", -"NON_ANSWER_SEEKING_QUERY_IGNORED", -"OUT_OF_DOMAIN_QUERY_IGNORED", -"POTENTIAL_POLICY_VIOLATION", -"NO_RELEVANT_CONTENT" +"CONTENT_CONFIG_UNSPECIFIED", +"NO_CONTENT", +"CONTENT_REQUIRED", +"PUBLIC_WEBSITE" ], "enumDescriptions": [ -"Default value. The answer skipped reason is not specified.", -"The adversarial query ignored case.", -"The non-answer seeking query ignored case.", -"The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", -"The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", -"The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results." +"Default value.", +"Only contains documents without any Document.content.", +"Only contains documents with Document.content.", +"The data store is used for public website search." ], "type": "string" }, -"type": "array" -}, -"answerText": { -"description": "The textual answer.", -"type": "string" -}, -"citations": { -"description": "Citations.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitation" -}, -"type": "array" -}, -"completeTime": { -"description": "Output only. Answer completed timestamp.", +"createTime": { +"description": "Output only. Timestamp the DataStore was created at.", "format": "google-datetime", "readOnly": true, "type": "string" }, -"createTime": { -"description": "Output only. Answer creation timestamp.", -"format": "google-datetime", +"defaultSchemaId": { +"description": "Output only. The id of the default Schema asscociated to this data store.", "readOnly": true, "type": "string" }, -"name": { -"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", +"displayName": { +"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, -"queryUnderstandingInfo": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", -"description": "Query understanding information." -}, -"references": { -"description": "References.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReference" -}, -"type": "array" -}, -"relatedQuestions": { -"description": "Suggested related questions.", -"items": { -"type": "string" +"documentProcessingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", +"description": "Configuration for Document understanding and enrichment." }, -"type": "array" +"idpConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", +"description": "Output only. Data store level identity provider config.", +"readOnly": true }, -"state": { -"description": "The state of the answer generation.", +"industryVertical": { +"description": "Immutable. The industry vertical that the data store registers.", "enum": [ -"STATE_UNSPECIFIED", -"IN_PROGRESS", -"FAILED", -"SUCCEEDED" +"INDUSTRY_VERTICAL_UNSPECIFIED", +"GENERIC", +"MEDIA", +"HEALTHCARE_FHIR" ], "enumDescriptions": [ -"Unknown.", -"Answer generation is currently in progress.", -"Answer generation currently failed.", -"Answer generation has succeeded." +"Value used when unset.", +"The generic vertical for documents that are not specific to any industry vertical.", +"The media industry vertical.", +"The healthcare FHIR vertical." ], "type": "string" }, -"steps": { -"description": "Answer generation steps.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStep" -}, -"type": "array" -} -}, -"type": "object" +"languageInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", +"description": "Language info for DataStore." }, -"GoogleCloudDiscoveryengineV1alphaAnswerCitation": { -"description": "Citation info for a segment.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", -"properties": { -"endIndex": { -"description": "End of the attributed segment, exclusive.", -"format": "int64", +"name": { +"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, -"sources": { -"description": "Citation sources for the attributed segment.", +"solutionTypes": { +"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource" +"enum": [ +"SOLUTION_TYPE_UNSPECIFIED", +"SOLUTION_TYPE_RECOMMENDATION", +"SOLUTION_TYPE_SEARCH", +"SOLUTION_TYPE_CHAT", +"SOLUTION_TYPE_GENERATIVE_CHAT" +], +"enumDescriptions": [ +"Default value.", +"Used for Recommendations AI.", +"Used for Discovery Search.", +"Used for use cases related to the Generative AI agent.", +"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +], +"type": "string" }, "type": "array" }, -"startIndex": { -"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", -"format": "int64", -"type": "string" +"startingSchema": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSchema", +"description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": { -"description": "Citation source.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource", +"GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { +"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata", "properties": { -"referenceId": { -"description": "ID of the citation source.", +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": { -"description": "Query understanding information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", -"properties": { -"queryClassificationInfo": { -"description": "Query classification information.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": { -"description": "Query classification information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo", -"properties": { -"positive": { -"description": "Classification output.", -"type": "boolean" }, -"type": { -"description": "Query classification type.", -"enum": [ -"TYPE_UNSPECIFIED", -"ADVERSARIAL_QUERY", -"NON_ANSWER_SEEKING_QUERY" -], -"enumDescriptions": [ -"Unspecified query classification type.", -"Adversarial query classification type.", -"Non-answer-seeking query classification type." -], +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerReference": { -"description": "Reference.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerReference", +"GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata": { +"description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata", "properties": { -"chunkInfo": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", -"description": "Chunk information." +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" }, -"unstructuredDocumentInfo": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", -"description": "Unstructured document information." +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": { -"description": "Chunk information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", +"GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { +"description": "Metadata for DeleteSchema LRO.", +"id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", "properties": { -"chunk": { -"description": "Chunk resource name.", +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"content": { -"description": "Chunk textual content.", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" -}, -"documentMetadata": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", -"description": "Document metadata." -}, -"relevanceScore": { -"description": "Relevance score.", -"format": "float", -"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": { -"description": "Document metadata.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", +"GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata", "properties": { -"document": { -"description": "Document resource name.", +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"pageIdentifier": { -"description": "Page identifier.", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" +} }, -"structData": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", "type": "object" }, -"title": { -"description": "Title.", +"GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"uri": { -"description": "URI for the document.", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { -"description": "Unstructured document information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", +"GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse": { +"description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", +"id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig": { +"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", "properties": { -"chunkContents": { -"description": "List of cited chunk contents derived from document content.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent" +"chunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", +"description": "Whether chunking mode is enabled." }, -"type": "array" +"defaultParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", +"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." }, -"document": { -"description": "Document resource name.", +"name": { +"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "type": "string" }, -"structData": { +"parsingConfigOverrides": { "additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" }, -"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", +"description": "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.", "type": "object" +} }, -"title": { -"description": "Title.", -"type": "string" +"type": "object" }, -"uri": { -"description": "URI for the document.", -"type": "string" +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { +"description": "Configuration for chunking config.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", +"properties": { +"layoutBasedChunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"description": "Configuration for the layout based chunking." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent": { -"description": "Chunk content.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent", +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { +"description": "Configuration for the layout based chunking.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", "properties": { -"content": { -"description": "Chunk textual content.", -"type": "string" +"chunkSize": { +"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", +"format": "int32", +"type": "integer" }, -"pageIdentifier": { -"description": "Page identifier.", -"type": "string" +"includeAncestorHeadings": { +"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStep": { -"description": "Step information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStep", +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { +"description": "Related configurations applied to a specific type of document parser.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", "properties": { -"actions": { -"description": "Actions.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction" +"digitalParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", +"description": "Configurations applied to digital parser." }, -"type": "array" +"layoutParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", +"description": "Configurations applied to layout parser." }, -"description": { -"description": "The description of the step.", -"type": "string" +"ocrParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", +"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." +} }, -"state": { -"description": "The state of the step.", -"enum": [ -"STATE_UNSPECIFIED", -"IN_PROGRESS", -"FAILED", -"SUCCEEDED" -], -"enumDescriptions": [ -"Unknown.", -"Step is currently in progress.", -"Step currently failed.", -"Step has succeeded." -], -"type": "string" +"type": "object" }, -"thought": { -"description": "The thought of the step.", -"type": "string" -} +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { +"description": "The digital parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", +"properties": {}, +"type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { +"description": "The layout parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", +"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepAction": { -"description": "Action.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction", +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { +"description": "The OCR parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", "properties": { -"observation": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", -"description": "Observation." +"enhancedDocumentElements": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", +"items": { +"type": "string" }, -"searchAction": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", -"description": "Search action." +"type": "array" +}, +"useNativeText": { +"description": "If true, will use native text instead of OCR text on pages containing native text.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { -"description": "Observation.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", +"GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata", "properties": { -"searchResults": { -"description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult" +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" }, -"type": "array" +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", +"GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse": { +"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", +"id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaEngine": { +"description": "Metadata that describes the training and serving parameters of an Engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngine", "properties": { -"chunkInfo": { -"description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", +"chatEngineConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", +"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." +}, +"chatEngineMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", +"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", +"readOnly": true +}, +"commonConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", +"description": "Common config spec that specifies the metadata of the engine." +}, +"createTime": { +"description": "Output only. Timestamp the Recommendation Engine was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"dataStoreIds": { +"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo" +"type": "string" }, "type": "array" }, -"document": { -"description": "Document resource name.", +"displayName": { +"description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, -"snippetInfo": { -"description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo" +"industryVertical": { +"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", +"enum": [ +"INDUSTRY_VERTICAL_UNSPECIFIED", +"GENERIC", +"MEDIA", +"HEALTHCARE_FHIR" +], +"enumDescriptions": [ +"Value used when unset.", +"The generic vertical for documents that are not specific to any industry vertical.", +"The media industry vertical.", +"The healthcare FHIR vertical." +], +"type": "string" +}, +"mediaRecommendationEngineConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", +"description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." +}, +"name": { +"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", +"type": "string" }, -"type": "array" +"recommendationMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", +"description": "Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.", +"readOnly": true }, -"structData": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"searchEngineConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", +"description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." }, -"description": "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).", -"type": "object" +"similarDocumentsConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", +"description": "Additional config specs for a `similar-items` engine." }, -"title": { -"description": "Title.", +"solutionType": { +"description": "Required. The solutions of the engine.", +"enum": [ +"SOLUTION_TYPE_UNSPECIFIED", +"SOLUTION_TYPE_RECOMMENDATION", +"SOLUTION_TYPE_SEARCH", +"SOLUTION_TYPE_CHAT", +"SOLUTION_TYPE_GENERATIVE_CHAT" +], +"enumDescriptions": [ +"Default value.", +"Used for Recommendations AI.", +"Used for Discovery Search.", +"Used for use cases related to the Generative AI agent.", +"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +], "type": "string" }, -"uri": { -"description": "URI for the document.", +"updateTime": { +"description": "Output only. Timestamp the Recommendation Engine was last updated.", +"format": "google-datetime", +"readOnly": true, "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { -"description": "Chunk information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo", +"GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig": { +"description": "Configurations for a Chat Engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", "properties": { -"chunk": { -"description": "Chunk resource name.", -"type": "string" +"agentCreationConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", +"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." }, -"content": { -"description": "Chunk textual content.", +"dialogflowAgentToLink": { +"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", "type": "string" -}, -"relevanceScore": { -"description": "Relevance score.", -"format": "float", -"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { -"description": "Snippet information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", +"GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig": { +"description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", "properties": { -"snippet": { -"description": "Snippet content.", +"business": { +"description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", "type": "string" }, -"snippetStatus": { -"description": "Status of the snippet defined by the search team.", +"defaultLanguageCode": { +"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", "type": "string" -} }, -"type": "object" +"location": { +"description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", +"type": "string" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { -"description": "Search action.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", -"properties": { -"query": { -"description": "The query to search.", +"timeZone": { +"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata": { +"description": "Additional information of a Chat Engine. Fields in this message are output only.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" -}, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"dialogflowAgent": { +"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": { -"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", -"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse", +"GoogleCloudDiscoveryengineV1alphaEngineCommonConfig": { +"description": "Common configurations for an Engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", "properties": { -"targetSites": { -"description": "TargetSites created.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" -}, -"type": "array" +"companyName": { +"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaCondition": { -"description": "Defines circumstances to be checked before allowing a behavior", -"id": "GoogleCloudDiscoveryengineV1alphaCondition", +"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { +"description": "Additional config specs for a Media Recommendation engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", "properties": { -"activeTimeRange": { -"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange" -}, -"type": "array" -}, -"queryTerms": { -"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" -}, -"type": "array" -} +"optimizationObjective": { +"description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`", +"type": "string" }, -"type": "object" +"optimizationObjectiveConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", +"description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)." }, -"GoogleCloudDiscoveryengineV1alphaConditionQueryTerm": { -"description": "Matcher for search request query", -"id": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm", -"properties": { -"fullMatch": { -"description": "Whether the search query needs to exactly match the query term.", -"type": "boolean" +"trainingState": { +"description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.", +"enum": [ +"TRAINING_STATE_UNSPECIFIED", +"PAUSED", +"TRAINING" +], +"enumDescriptions": [ +"Unspecified training state.", +"The engine training is paused.", +"The engine is training." +], +"type": "string" }, -"value": { -"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", +"type": { +"description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaConditionTimeRange": { -"description": "Used for time-dependent conditions.", -"id": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange", +"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { +"description": "Custom threshold for `cvr` optimization_objective.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", "properties": { -"endTime": { -"description": "End of time range. Range is inclusive. Must be in the future.", -"format": "google-datetime", +"targetField": { +"description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", "type": "string" }, -"startTime": { -"description": "Start of time range. Range is inclusive.", -"format": "google-datetime", -"type": "string" +"targetFieldValueFloat": { +"description": "Required. The threshold to be applied to the target (e.g., 0.5).", +"format": "float", +"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaControl": { -"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", -"id": "GoogleCloudDiscoveryengineV1alphaControl", +"GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { +"description": "Additional information of a recommendation engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", "properties": { -"associatedServingConfigIds": { -"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", -"items": { +"dataState": { +"description": "Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.", +"enum": [ +"DATA_STATE_UNSPECIFIED", +"DATA_OK", +"DATA_ERROR" +], +"enumDescriptions": [ +"Unspecified default value, should never be explicitly set.", +"The engine has sufficient training data.", +"The engine does not have sufficient training data. Error messages can be queried via Stackdriver." +], +"readOnly": true, "type": "string" }, +"lastTuneTime": { +"description": "Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.", +"format": "google-datetime", "readOnly": true, -"type": "array" -}, -"boostAction": { -"$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", -"description": "Defines a boost-type control" -}, -"conditions": { -"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaCondition" -}, -"type": "array" -}, -"displayName": { -"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" }, -"filterAction": { -"$ref": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", -"description": "Defines a filter-type control Currently not supported by Recommendation" +"servingState": { +"description": "Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.", +"enum": [ +"SERVING_STATE_UNSPECIFIED", +"INACTIVE", +"ACTIVE", +"TUNED" +], +"enumDescriptions": [ +"Unspecified serving state.", +"The engine is not serving.", +"The engine is serving and can be queried.", +"The engine is trained on tuned hyperparameters and can be queried." +], +"readOnly": true, +"type": "string" }, -"name": { -"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", +"tuningOperation": { +"description": "Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty.", +"readOnly": true, "type": "string" +} }, -"redirectAction": { -"$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", -"description": "Defines a redirect-type control." +"type": "object" }, -"solutionType": { -"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", +"GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig": { +"description": "Configurations for a Search Engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", +"properties": { +"searchAddOns": { +"description": "The add-on that this search engine enables.", +"items": { "enum": [ -"SOLUTION_TYPE_UNSPECIFIED", -"SOLUTION_TYPE_RECOMMENDATION", -"SOLUTION_TYPE_SEARCH", -"SOLUTION_TYPE_CHAT", -"SOLUTION_TYPE_GENERATIVE_CHAT" +"SEARCH_ADD_ON_UNSPECIFIED", +"SEARCH_ADD_ON_LLM" ], "enumDescriptions": [ -"Default value.", -"Used for Recommendations AI.", -"Used for Discovery Search.", -"Used for use cases related to the Generative AI agent.", -"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +"Default value when the enum is unspecified. This is invalid to use.", +"Large language model add-on." ], "type": "string" }, -"synonymsAction": { -"$ref": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", -"description": "Treats a group of terms as synonyms of one another." +"type": "array" }, -"useCases": { -"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", -"items": { +"searchTier": { +"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", "enum": [ -"SEARCH_USE_CASE_UNSPECIFIED", -"SEARCH_USE_CASE_SEARCH", -"SEARCH_USE_CASE_BROWSE" +"SEARCH_TIER_UNSPECIFIED", +"SEARCH_TIER_STANDARD", +"SEARCH_TIER_ENTERPRISE" ], "enumDescriptions": [ -"Value used when unset. Will not occur in CSS.", -"Search use case. Expects the traffic has a non-empty query.", -"Browse use case. Expects the traffic has an empty query." +"Default value when the enum is unspecified. This is invalid to use.", +"Standard tier.", +"Enterprise tier." ], "type": "string" -}, -"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaControlBoostAction": { -"description": "Adjusts order of products in returned list.", -"id": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", -"properties": { -"boost": { -"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", -"format": "float", -"type": "number" -}, -"dataStore": { -"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", -"type": "string" +"GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig": { +"description": "Additional config specs for a `similar-items` engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", +"properties": {}, +"type": "object" }, -"filter": { -"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata": { +"description": "Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaControlFilterAction": { -"description": "Specified which products may be included in results. Uses same filter as boost.", -"id": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", +"GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse": { +"description": "Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", +"id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse", "properties": { -"dataStore": { -"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", +"dataSizeBytes": { +"description": "Data size in terms of bytes.", +"format": "int64", "type": "string" }, -"filter": { -"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"documentCount": { +"description": "Total number of documents.", +"format": "int64", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaControlRedirectAction": { -"description": "Redirects a shopper to the provided URI.", -"id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", +"GoogleCloudDiscoveryengineV1alphaEvaluation": { +"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluation", "properties": { -"redirectUri": { -"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"createTime": { +"description": "Output only. Timestamp the Evaluation was created at.", +"format": "google-datetime", +"readOnly": true, "type": "string" -} }, -"type": "object" +"endTime": { +"description": "Output only. Timestamp the Evaluation was completed at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" }, -"GoogleCloudDiscoveryengineV1alphaControlSynonymsAction": { -"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", -"id": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", -"properties": { -"synonyms": { -"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", +"readOnly": true +}, +"errorSamples": { +"description": "Output only. A sample of errors encountered while processing the request.", "items": { -"type": "string" +"$ref": "GoogleRpcStatus" }, +"readOnly": true, "type": "array" -} }, -"type": "object" +"evaluationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", +"description": "Required. The specification of the evaluation." }, -"GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata": { -"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"name": { +"description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", +"readOnly": true +}, +"state": { +"description": "Output only. The state of the evaluation.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The evaluation is unspecified.", +"The service is preparing to run the evaluation.", +"The evaluation is in progress.", +"The evaluation completed successfully.", +"The evaluation failed." +], +"readOnly": true, "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata": { -"description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata", +"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec": { +"description": "Describes the specification of the evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"querySetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", +"description": "Required. The specification of the query set." }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"searchRequest": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest", +"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { -"description": "Metadata for Create Schema LRO.", -"id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", +"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec": { +"description": "Describes the specification of the query set.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" -}, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"sampleQuerySet": { +"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": { +"description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -8444,193 +9741,245 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaCustomTuningModel": { -"description": "Metadata that describes a custom tuned model.", -"id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel", +"GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse": { +"description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse", "properties": { -"createTime": { -"deprecated": true, -"description": "Timestamp the Model was created at.", -"format": "google-datetime", -"type": "string" +"outputResult": { +"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResult", +"description": "Output result indicating where the data were exported to." }, -"displayName": { -"description": "The display name of the model.", +"status": { +"$ref": "GoogleRpcStatus", +"description": "The status of the export operation." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaFieldConfig": { +"description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", +"id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", +"properties": { +"advancedSiteSearchDataSources": { +"description": "If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.", +"items": { +"enum": [ +"ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED", +"METATAGS", +"PAGEMAP", +"SCHEMA_ORG" +], +"enumDescriptions": [ +"Value used when unset.", +"Retrieve value from meta tag.", +"Retrieve value from page map.", +"Retrieve value from schema.org data." +], "type": "string" }, -"metrics": { -"additionalProperties": { -"format": "double", -"type": "number" +"type": "array" }, -"description": "The metrics of the trained model.", -"type": "object" +"completableOption": { +"description": "If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.", +"enum": [ +"COMPLETABLE_OPTION_UNSPECIFIED", +"COMPLETABLE_ENABLED", +"COMPLETABLE_DISABLED" +], +"enumDescriptions": [ +"Value used when unset.", +"Completable option enabled for a schema field.", +"Completable option disabled for a schema field." +], +"type": "string" }, -"modelState": { -"description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", +"dynamicFacetableOption": { +"description": "If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.", "enum": [ -"MODEL_STATE_UNSPECIFIED", -"TRAINING_PAUSED", -"TRAINING", -"TRAINING_COMPLETE", -"READY_FOR_SERVING", -"TRAINING_FAILED", -"NO_IMPROVEMENT" +"DYNAMIC_FACETABLE_OPTION_UNSPECIFIED", +"DYNAMIC_FACETABLE_ENABLED", +"DYNAMIC_FACETABLE_DISABLED" ], "enumDescriptions": [ -"Default value.", -"The model is in a paused training state.", -"The model is currently training.", -"The model has successfully completed training.", -"The model is ready for serving.", -"The model training failed.", -"The model training finished successfully but metrics did not improve." +"Value used when unset.", +"Dynamic facetable option enabled for a schema field.", +"Dynamic facetable option disabled for a schema field." ], "type": "string" }, -"modelVersion": { -"description": "The version of the model.", -"format": "int64", -"type": "string" -}, -"name": { -"description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", -"type": "string" -}, -"trainingStartTime": { -"description": "Timestamp the model training was initiated.", -"format": "google-datetime", +"fieldPath": { +"description": "Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.", "type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaDataStore": { -"description": "DataStore captures global settings and configs at the DataStore level.", -"id": "GoogleCloudDiscoveryengineV1alphaDataStore", -"properties": { -"aclEnabled": { -"description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.", -"type": "boolean" }, -"contentConfig": { -"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", +"fieldType": { +"description": "Output only. Raw type of the field.", "enum": [ -"CONTENT_CONFIG_UNSPECIFIED", -"NO_CONTENT", -"CONTENT_REQUIRED", -"PUBLIC_WEBSITE" +"FIELD_TYPE_UNSPECIFIED", +"OBJECT", +"STRING", +"NUMBER", +"INTEGER", +"BOOLEAN", +"GEOLOCATION", +"DATETIME" ], "enumDescriptions": [ -"Default value.", -"Only contains documents without any Document.content.", -"Only contains documents with Document.content.", -"The data store is used for public website search." +"Field type is unspecified.", +"Field value type is Object.", +"Field value type is String.", +"Field value type is Number.", +"Field value type is Integer.", +"Field value type is Boolean.", +"Field value type is Geolocation. Geolocation is expressed as an object with the following keys: * `id`: a string representing the location id * `longitude`: a number representing the longitude coordinate of the location * `latitude`: a number repesenting the latitude coordinate of the location * `address`: a string representing the full address of the location `latitude` and `longitude` must always be provided together. At least one of a) `address` or b) `latitude`-`longitude` pair must be provided.", +"Field value type is Datetime. Datetime can be expressed as either: * a number representing milliseconds-since-the-epoch * a string representing milliseconds-since-the-epoch. e.g. `\"1420070400001\"` * a string representing the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and time. e.g. `\"2015-01-01\"` or `\"2015-01-01T12:10:30Z\"`" ], +"readOnly": true, "type": "string" }, -"createTime": { -"description": "Output only. Timestamp the DataStore was created at.", -"format": "google-datetime", -"readOnly": true, +"indexableOption": { +"description": "If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.", +"enum": [ +"INDEXABLE_OPTION_UNSPECIFIED", +"INDEXABLE_ENABLED", +"INDEXABLE_DISABLED" +], +"enumDescriptions": [ +"Value used when unset.", +"Indexable option enabled for a schema field.", +"Indexable option disabled for a schema field." +], "type": "string" }, -"defaultSchemaId": { -"description": "Output only. The id of the default Schema asscociated to this data store.", +"keyPropertyType": { +"description": "Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.", "readOnly": true, "type": "string" }, -"displayName": { -"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", +"recsFilterableOption": { +"description": "If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.", +"enum": [ +"FILTERABLE_OPTION_UNSPECIFIED", +"FILTERABLE_ENABLED", +"FILTERABLE_DISABLED" +], +"enumDescriptions": [ +"Value used when unset.", +"Filterable option enabled for a schema field.", +"Filterable option disabled for a schema field." +], "type": "string" }, -"documentProcessingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", -"description": "Configuration for Document understanding and enrichment." -}, -"idpConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", -"description": "Output only. Data store level identity provider config.", -"readOnly": true -}, -"industryVertical": { -"description": "Immutable. The industry vertical that the data store registers.", +"retrievableOption": { +"description": "If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.", "enum": [ -"INDUSTRY_VERTICAL_UNSPECIFIED", -"GENERIC", -"MEDIA", -"HEALTHCARE_FHIR" +"RETRIEVABLE_OPTION_UNSPECIFIED", +"RETRIEVABLE_ENABLED", +"RETRIEVABLE_DISABLED" ], "enumDescriptions": [ "Value used when unset.", -"The generic vertical for documents that are not specific to any industry vertical.", -"The media industry vertical.", -"The healthcare FHIR vertical." +"Retrievable option enabled for a schema field.", +"Retrievable option disabled for a schema field." ], "type": "string" }, -"languageInfo": { -"$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", -"description": "Language info for DataStore." -}, -"name": { -"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"schemaOrgPaths": { +"description": "Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished", +"items": { "type": "string" }, -"solutionTypes": { -"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", -"items": { +"type": "array" +}, +"searchableOption": { +"description": "If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.", "enum": [ -"SOLUTION_TYPE_UNSPECIFIED", -"SOLUTION_TYPE_RECOMMENDATION", -"SOLUTION_TYPE_SEARCH", -"SOLUTION_TYPE_CHAT", -"SOLUTION_TYPE_GENERATIVE_CHAT" +"SEARCHABLE_OPTION_UNSPECIFIED", +"SEARCHABLE_ENABLED", +"SEARCHABLE_DISABLED" ], "enumDescriptions": [ -"Default value.", -"Used for Recommendations AI.", -"Used for Discovery Search.", -"Used for use cases related to the Generative AI agent.", -"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +"Value used when unset.", +"Searchable option enabled for a schema field.", +"Searchable option disabled for a schema field." ], "type": "string" +} }, -"type": "array" +"type": "object" }, -"startingSchema": { -"$ref": "GoogleCloudDiscoveryengineV1alphaSchema", -"description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." +"GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": { +"description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.", +"id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse", +"properties": { +"documentDataMap": { +"additionalProperties": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"description": "Document data keyed by URI pattern. For example: document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }", +"type": "object" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { -"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata", +"GoogleCloudDiscoveryengineV1alphaIdpConfig": { +"description": "Identity Provider Config.", +"id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"externalIdpConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", +"description": "External Identity provider config." +}, +"idpType": { +"description": "Identity provider type configured.", +"enum": [ +"IDP_TYPE_UNSPECIFIED", +"GSUITE", +"THIRD_PARTY" +], +"enumDescriptions": [ +"Default value. ACL search not enabled.", +"Google 1P provider.", +"Third party provider." +], "type": "string" +} }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { +"description": "Third party IDP Config.", +"id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", +"properties": { +"workforcePoolName": { +"description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata": { -"description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata", +"GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata": { +"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, +"failureCount": { +"description": "Count of CompletionSuggestions that failed to be imported.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of CompletionSuggestions successfully imported.", +"format": "int64", +"type": "string" +}, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -8639,47 +9988,46 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { -"description": "Metadata for DeleteSchema LRO.", -"id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", +"GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse": { +"description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": { +"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", "type": "string" -} }, -"type": "object" +"successCount": { +"description": "Count of entries that were processed successfully.", +"format": "int64", +"type": "string" }, -"GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"totalCount": { +"description": "Total count of entries that were processed.", +"format": "int64", "type": "string" }, "updateTime": { @@ -8690,118 +10038,88 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse": { -"description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", -"id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig": { -"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", +"GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse": { +"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", +"id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse", "properties": { -"chunkingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", -"description": "Whether chunking mode is enabled." -}, -"defaultParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", -"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." -}, -"name": { -"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", -"type": "string" +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "Echoes the destination for the complete errors in the request if set." }, -"parsingConfigOverrides": { -"additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" }, -"description": "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.", -"type": "object" +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { -"description": "Configuration for chunking config.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", +"GoogleCloudDiscoveryengineV1alphaImportErrorConfig": { +"description": "Configuration of destination for Import related errors.", +"id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", "properties": { -"layoutBasedChunkingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", -"description": "Configuration for the layout based chunking." +"gcsPrefix": { +"description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { -"description": "Configuration for the layout based chunking.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": { +"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata", "properties": { -"chunkSize": { -"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", -"format": "int32", -"type": "integer" -}, -"includeAncestorHeadings": { -"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", -"type": "boolean" -} +"createTime": { +"description": "ImportSampleQueries operation create time.", +"format": "google-datetime", +"type": "string" }, -"type": "object" +"failureCount": { +"description": "Count of SampleQuerys that failed to be imported.", +"format": "int64", +"type": "string" }, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { -"description": "Related configurations applied to a specific type of document parser.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", -"properties": { -"digitalParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", -"description": "Configurations applied to digital parser." +"successCount": { +"description": "Count of SampleQuerys successfully imported.", +"format": "int64", +"type": "string" }, -"layoutParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", -"description": "Configurations applied to layout parser." +"totalCount": { +"description": "Total count of SampleQuerys that were processed.", +"format": "int64", +"type": "string" }, -"ocrParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", -"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." +"updateTime": { +"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { -"description": "The digital parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { -"description": "The layout parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { -"description": "The OCR parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse": { +"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse", "properties": { -"enhancedDocumentElements": { -"deprecated": true, -"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", "items": { -"type": "string" +"$ref": "GoogleRpcStatus" }, "type": "array" -}, -"useNativeText": { -"description": "If true, will use native text instead of OCR text on pages containing native text.", -"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata", +"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -8816,343 +10134,346 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse": { -"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", -"id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaEngine": { -"description": "Metadata that describes the training and serving parameters of an Engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngine", +"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", "properties": { -"chatEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", -"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." -}, -"chatEngineMetadata": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", -"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", -"readOnly": true +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" }, -"commonConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", -"description": "Common config spec that specifies the metadata of the engine." +"type": "array" }, -"createTime": { -"description": "Output only. Timestamp the Recommendation Engine was created at.", -"format": "google-datetime", -"readOnly": true, +"failedEntriesCount": { +"description": "Count of deny list entries that failed to be imported.", +"format": "int64", "type": "string" }, -"dataStoreIds": { -"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", -"items": { +"importedEntriesCount": { +"description": "Count of deny list entries successfully imported.", +"format": "int64", "type": "string" +} }, -"type": "array" +"type": "object" }, -"displayName": { -"description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", +"GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata": { +"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"industryVertical": { -"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", -"enum": [ -"INDUSTRY_VERTICAL_UNSPECIFIED", -"GENERIC", -"MEDIA", -"HEALTHCARE_FHIR" -], -"enumDescriptions": [ -"Value used when unset.", -"The generic vertical for documents that are not specific to any industry vertical.", -"The media industry vertical.", -"The healthcare FHIR vertical." -], +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", "type": "string" }, -"mediaRecommendationEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", -"description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." +"successCount": { +"description": "Count of entries that were processed successfully.", +"format": "int64", +"type": "string" }, -"name": { -"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" +} }, -"recommendationMetadata": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", -"description": "Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.", -"readOnly": true +"type": "object" }, -"searchEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", -"description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." +"GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse": { +"description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", +"id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "Echoes the destination for the complete errors if this field was set in the request." }, -"similarDocumentsConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", -"description": "Additional config specs for a `similar-items` engine." +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" }, -"solutionType": { -"description": "Required. The solutions of the engine.", -"enum": [ -"SOLUTION_TYPE_UNSPECIFIED", -"SOLUTION_TYPE_RECOMMENDATION", -"SOLUTION_TYPE_SEARCH", -"SOLUTION_TYPE_CHAT", -"SOLUTION_TYPE_GENERATIVE_CHAT" -], -"enumDescriptions": [ -"Default value.", -"Used for Recommendations AI.", -"Used for Discovery Search.", -"Used for use cases related to the Generative AI agent.", -"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." -], +"type": "array" +}, +"joinedEventsCount": { +"description": "Count of user events imported with complete existing Documents.", +"format": "int64", "type": "string" }, -"updateTime": { -"description": "Output only. Timestamp the Recommendation Engine was last updated.", -"format": "google-datetime", -"readOnly": true, +"unjoinedEventsCount": { +"description": "Count of user events imported, but with Document information not found in the existing Branch.", +"format": "int64", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig": { -"description": "Configurations for a Chat Engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", +"GoogleCloudDiscoveryengineV1alphaInterval": { +"description": "A floating point interval.", +"id": "GoogleCloudDiscoveryengineV1alphaInterval", "properties": { -"agentCreationConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", -"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." +"exclusiveMaximum": { +"description": "Exclusive upper bound.", +"format": "double", +"type": "number" }, -"dialogflowAgentToLink": { -"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", -"type": "string" +"exclusiveMinimum": { +"description": "Exclusive lower bound.", +"format": "double", +"type": "number" +}, +"maximum": { +"description": "Inclusive upper bound.", +"format": "double", +"type": "number" +}, +"minimum": { +"description": "Inclusive lower bound.", +"format": "double", +"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig": { -"description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", +"GoogleCloudDiscoveryengineV1alphaLanguageInfo": { +"description": "Language info for DataStore.", +"id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", "properties": { -"business": { -"description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", +"language": { +"description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", +"readOnly": true, "type": "string" }, -"defaultLanguageCode": { -"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", +"languageCode": { +"description": "The language code for the DataStore.", "type": "string" }, -"location": { -"description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", +"normalizedLanguageCode": { +"description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", +"readOnly": true, "type": "string" }, -"timeZone": { -"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", +"region": { +"description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", +"readOnly": true, "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata": { -"description": "Additional information of a Chat Engine. Fields in this message are output only.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", +"GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse": { +"description": "Response message for SearchTuningService.ListCustomModels method.", +"id": "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse", "properties": { -"dialogflowAgent": { -"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", -"type": "string" +"models": { +"description": "List of custom tuning models.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineCommonConfig": { -"description": "Common configurations for an Engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", +"GoogleCloudDiscoveryengineV1alphaOutputResult": { +"description": "Output result that stores the information about where the exported data is stored.", +"id": "GoogleCloudDiscoveryengineV1alphaOutputResult", "properties": { -"companyName": { -"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", -"type": "string" +"bigqueryResult": { +"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", +"description": "The BigQuery location where the result is stored." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { -"description": "Additional config specs for a Media Recommendation engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", +"GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult": { +"description": "A BigQuery output result.", +"id": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", "properties": { -"optimizationObjective": { -"description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`", -"type": "string" -}, -"optimizationObjectiveConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", -"description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)." -}, -"trainingState": { -"description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.", -"enum": [ -"TRAINING_STATE_UNSPECIFIED", -"PAUSED", -"TRAINING" -], -"enumDescriptions": [ -"Unspecified training state.", -"The engine training is paused.", -"The engine is training." -], +"datasetId": { +"description": "The ID of a BigQuery Dataset.", "type": "string" }, -"type": { -"description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.", +"tableId": { +"description": "The ID of a BigQuery Table.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { -"description": "Custom threshold for `cvr` optimization_objective.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", +"GoogleCloudDiscoveryengineV1alphaProject": { +"description": "Metadata and configurations for a Google Cloud project in the service.", +"id": "GoogleCloudDiscoveryengineV1alphaProject", "properties": { -"targetField": { -"description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", +"createTime": { +"description": "Output only. The timestamp when this project is created.", +"format": "google-datetime", +"readOnly": true, "type": "string" }, -"targetFieldValueFloat": { -"description": "Required. The threshold to be applied to the target (e.g., 0.5).", -"format": "float", -"type": "number" +"name": { +"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", +"readOnly": true, +"type": "string" +}, +"provisionCompletionTime": { +"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"serviceTermsMap": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms" +}, +"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", +"readOnly": true, +"type": "object" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { -"description": "Additional information of a recommendation engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", +"GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": { +"description": "Metadata about the terms of service.", +"id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms", "properties": { -"dataState": { -"description": "Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.", -"enum": [ -"DATA_STATE_UNSPECIFIED", -"DATA_OK", -"DATA_ERROR" -], -"enumDescriptions": [ -"Unspecified default value, should never be explicitly set.", -"The engine has sufficient training data.", -"The engine does not have sufficient training data. Error messages can be queried via Stackdriver." -], -"readOnly": true, +"acceptTime": { +"description": "The last time when the project agreed to the terms of service.", +"format": "google-datetime", "type": "string" }, -"lastTuneTime": { -"description": "Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.", +"declineTime": { +"description": "The last time when the project declined or revoked the agreement to terms of service.", "format": "google-datetime", -"readOnly": true, "type": "string" }, -"servingState": { -"description": "Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.", +"id": { +"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", +"type": "string" +}, +"state": { +"description": "Whether the project has accepted/rejected the service terms or it is still pending.", "enum": [ -"SERVING_STATE_UNSPECIFIED", -"INACTIVE", -"ACTIVE", -"TUNED" +"STATE_UNSPECIFIED", +"TERMS_ACCEPTED", +"TERMS_PENDING", +"TERMS_DECLINED" ], "enumDescriptions": [ -"Unspecified serving state.", -"The engine is not serving.", -"The engine is serving and can be queried.", -"The engine is trained on tuned hyperparameters and can be queried." +"The default value of the enum. This value is not actually used.", +"The project has given consent to the terms of service.", +"The project is pending to review and accept the terms of service.", +"The project has declined or revoked the agreement to terms of service." ], -"readOnly": true, "type": "string" }, -"tuningOperation": { -"description": "Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty.", -"readOnly": true, +"version": { +"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig": { -"description": "Configurations for a Search Engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", +"GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata": { +"description": "Metadata associated with a project provision operation.", +"id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata": { +"description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata", "properties": { -"searchAddOns": { -"description": "The add-on that this search engine enables.", -"items": { -"enum": [ -"SEARCH_ADD_ON_UNSPECIFIED", -"SEARCH_ADD_ON_LLM" -], -"enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Large language model add-on." -], +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"type": "array" -}, -"searchTier": { -"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", -"enum": [ -"SEARCH_TIER_UNSPECIFIED", -"SEARCH_TIER_STANDARD", -"SEARCH_TIER_ENTERPRISE" -], -"enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Standard tier.", -"Enterprise tier." -], +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig": { -"description": "Additional config specs for a `similar-items` engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", -"properties": {}, +"GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse": { +"description": "Response message for CompletionService.PurgeCompletionSuggestions method.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse", +"properties": { +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"purgeSucceeded": { +"description": "Whether the completion suggestions were successfully purged.", +"type": "boolean" +} +}, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata": { -"description": "Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata", +"GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata": { +"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" +}, +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", +"type": "string" +}, +"ignoredCount": { +"description": "Count of entries that were ignored as entries were not found.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of entries that were deleted successfully.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse": { -"description": "Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", -"id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse", +"GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse": { +"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse", "properties": { -"dataSizeBytes": { -"description": "Data size in terms of bytes.", +"purgeCount": { +"description": "The total count of documents purged as a result of the operation.", "format": "int64", "type": "string" }, -"documentCount": { -"description": "Total number of documents.", -"format": "int64", +"purgeSample": { +"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", +"items": { "type": "string" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": { -"description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata", +"GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -9167,866 +10488,930 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse": { -"description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse", +"GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse", "properties": { -"outputResult": { -"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResult", -"description": "Output result indicating where the data were exported to." +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" }, -"status": { -"$ref": "GoogleRpcStatus", -"description": "The status of the export operation." +"type": "array" +}, +"purgeCount": { +"description": "Number of suggestion deny list entries purged.", +"format": "int64", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaFieldConfig": { -"description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", -"id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", +"GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata": { +"description": "Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata", "properties": { -"advancedSiteSearchDataSources": { -"description": "If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.", -"items": { -"enum": [ -"ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED", -"METATAGS", -"PAGEMAP", -"SCHEMA_ORG" -], -"enumDescriptions": [ -"Value used when unset.", -"Retrieve value from meta tag.", -"Retrieve value from page map.", -"Retrieve value from schema.org data." -], +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"type": "array" -}, -"completableOption": { -"description": "If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.", -"enum": [ -"COMPLETABLE_OPTION_UNSPECIFIED", -"COMPLETABLE_ENABLED", -"COMPLETABLE_DISABLED" -], -"enumDescriptions": [ -"Value used when unset.", -"Completable option enabled for a schema field.", -"Completable option disabled for a schema field." -], +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", "type": "string" }, -"dynamicFacetableOption": { -"description": "If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.", -"enum": [ -"DYNAMIC_FACETABLE_OPTION_UNSPECIFIED", -"DYNAMIC_FACETABLE_ENABLED", -"DYNAMIC_FACETABLE_DISABLED" -], -"enumDescriptions": [ -"Value used when unset.", -"Dynamic facetable option enabled for a schema field.", -"Dynamic facetable option disabled for a schema field." -], +"successCount": { +"description": "Count of entries that were deleted successfully.", +"format": "int64", "type": "string" }, -"fieldPath": { -"description": "Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" +} }, -"fieldType": { -"description": "Output only. Raw type of the field.", -"enum": [ -"FIELD_TYPE_UNSPECIFIED", -"OBJECT", -"STRING", -"NUMBER", -"INTEGER", -"BOOLEAN", -"GEOLOCATION", -"DATETIME" -], -"enumDescriptions": [ -"Field type is unspecified.", -"Field value type is Object.", -"Field value type is String.", -"Field value type is Number.", -"Field value type is Integer.", -"Field value type is Boolean.", -"Field value type is Geolocation. Geolocation is expressed as an object with the following keys: * `id`: a string representing the location id * `longitude`: a number representing the longitude coordinate of the location * `latitude`: a number repesenting the latitude coordinate of the location * `address`: a string representing the full address of the location `latitude` and `longitude` must always be provided together. At least one of a) `address` or b) `latitude`-`longitude` pair must be provided.", -"Field value type is Datetime. Datetime can be expressed as either: * a number representing milliseconds-since-the-epoch * a string representing milliseconds-since-the-epoch. e.g. `\"1420070400001\"` * a string representing the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and time. e.g. `\"2015-01-01\"` or `\"2015-01-01T12:10:30Z\"`" -], -"readOnly": true, -"type": "string" +"type": "object" }, -"indexableOption": { -"description": "If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.", -"enum": [ -"INDEXABLE_OPTION_UNSPECIFIED", -"INDEXABLE_ENABLED", -"INDEXABLE_DISABLED" -], -"enumDescriptions": [ -"Value used when unset.", -"Indexable option enabled for a schema field.", -"Indexable option disabled for a schema field." -], +"GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse": { +"description": "Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse", +"properties": { +"purgeCount": { +"description": "The total count of events purged as a result of the operation.", +"format": "int64", "type": "string" +} }, -"keyPropertyType": { -"description": "Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.", -"readOnly": true, -"type": "string" +"type": "object" }, -"recsFilterableOption": { -"description": "If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.", -"enum": [ -"FILTERABLE_OPTION_UNSPECIFIED", -"FILTERABLE_ENABLED", -"FILTERABLE_DISABLED" -], -"enumDescriptions": [ -"Value used when unset.", -"Filterable option enabled for a schema field.", -"Filterable option disabled for a schema field." -], -"type": "string" +"GoogleCloudDiscoveryengineV1alphaQualityMetrics": { +"description": "Describes the metrics produced by the evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", +"properties": { +"docNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" }, -"retrievableOption": { -"description": "If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.", -"enum": [ -"RETRIEVABLE_OPTION_UNSPECIFIED", -"RETRIEVABLE_ENABLED", -"RETRIEVABLE_DISABLED" -], -"enumDescriptions": [ -"Value used when unset.", -"Retrievable option enabled for a schema field.", -"Retrievable option disabled for a schema field." -], -"type": "string" +"docPrecision": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" }, -"schemaOrgPaths": { -"description": "Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished", -"items": { -"type": "string" +"docRecall": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" }, -"type": "array" +"pageNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" }, -"searchableOption": { -"description": "If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.", -"enum": [ -"SEARCHABLE_OPTION_UNSPECIFIED", -"SEARCHABLE_ENABLED", -"SEARCHABLE_DISABLED" -], -"enumDescriptions": [ -"Value used when unset.", -"Searchable option enabled for a schema field.", -"Searchable option disabled for a schema field." -], -"type": "string" +"pageRecall": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" } }, -"type": "object" +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics": { +"description": "Stores the metric values at specific top-k levels.", +"id": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"properties": { +"top1": { +"description": "The top-1 value.", +"format": "double", +"type": "number" +}, +"top10": { +"description": "The top-10 value.", +"format": "double", +"type": "number" }, -"GoogleCloudDiscoveryengineV1alphaIdpConfig": { -"description": "Identity Provider Config.", -"id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", -"properties": { -"externalIdpConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", -"description": "External Identity provider config." +"top3": { +"description": "The top-3 value.", +"format": "double", +"type": "number" }, -"idpType": { -"description": "Identity provider type configured.", -"enum": [ -"IDP_TYPE_UNSPECIFIED", -"GSUITE", -"THIRD_PARTY" -], -"enumDescriptions": [ -"Default value. ACL search not enabled.", -"Google 1P provider.", -"Third party provider." -], -"type": "string" +"top5": { +"description": "The top-5 value.", +"format": "double", +"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { -"description": "Third party IDP Config.", -"id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", +"GoogleCloudDiscoveryengineV1alphaQuery": { +"description": "Defines a user inputed query.", +"id": "GoogleCloudDiscoveryengineV1alphaQuery", "properties": { -"workforcePoolName": { -"description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", +"queryId": { +"description": "Unique Id for the query.", +"type": "string" +}, +"text": { +"description": "Plain text.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata": { -"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata", +"GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, -"failureCount": { -"description": "Count of CompletionSuggestions that failed to be imported.", -"format": "int64", +"invalidUris": { +"description": "Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.", +"items": { "type": "string" }, +"type": "array" +}, +"pendingCount": { +"description": "Total number of URIs that have yet to be crawled.", +"format": "int32", +"type": "integer" +}, +"quotaExceededCount": { +"description": "Total number of URIs that were rejected due to insufficient indexing resources.", +"format": "int32", +"type": "integer" +}, "successCount": { -"description": "Count of CompletionSuggestions successfully imported.", -"format": "int64", -"type": "string" +"description": "Total number of URIs that have been crawled so far.", +"format": "int32", +"type": "integer" }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" +}, +"validUrisCount": { +"description": "Total number of unique URIs in the request that are not in invalid_uris.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse": { -"description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", -"id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse", +"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { +"description": "Response message for SiteSearchEngineService.RecrawlUris method.", +"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", -"description": "The desired location of errors incurred during the Import." +"failedUris": { +"description": "URIs that were not crawled before the LRO terminated.", +"items": { +"type": "string" }, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"type": "array" +}, +"failureSamples": { +"description": "Details for a sample of up to 10 `failed_uris`.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": { -"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata", +"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo": { +"description": "Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.", +"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"failureReasons": { +"description": "List of failure reasons by corpus type (e.g. desktop, mobile).", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", -"type": "string" +"type": "array" }, -"successCount": { -"description": "Count of entries that were processed successfully.", -"format": "int64", +"uri": { +"description": "URI that failed to be crawled.", "type": "string" +} }, -"totalCount": { -"description": "Total count of entries that were processed.", -"format": "int64", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason": { +"description": "Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.", +"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason", +"properties": { +"corpusType": { +"description": "DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.", +"enum": [ +"CORPUS_TYPE_UNSPECIFIED", +"DESKTOP", +"MOBILE" +], +"enumDescriptions": [ +"Default value.", +"Denotes a crawling attempt for the desktop version of a page.", +"Denotes a crawling attempt for the mobile version of a page." +], "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"errorMessage": { +"description": "Reason why the URI was not crawled.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse": { -"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", -"id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse", +"GoogleCloudDiscoveryengineV1alphaSchema": { +"description": "Defines the structure and layout of a type of document data.", +"id": "GoogleCloudDiscoveryengineV1alphaSchema", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", -"description": "Echoes the destination for the complete errors in the request if set." -}, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"fieldConfigs": { +"description": "Output only. Configurations for fields of the schema.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaFieldConfig" }, +"readOnly": true, "type": "array" -} }, -"type": "object" +"jsonSchema": { +"description": "The JSON representation of the schema.", +"type": "string" }, -"GoogleCloudDiscoveryengineV1alphaImportErrorConfig": { -"description": "Configuration of destination for Import related errors.", -"id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", -"properties": { -"gcsPrefix": { -"description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", +"name": { +"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" +}, +"structSchema": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The structured representation of the schema.", +"type": "object" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequest": { +"description": "Request message for SearchService.Search method.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequest", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"boostSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", +"description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" +}, +"branch": { +"description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"canonicalFilter": { +"description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", "type": "string" -} }, -"type": "object" +"contentSearchSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", +"description": "A specification for configuring the behavior of content search." }, -"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", -"properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"customFineTuningSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", +"description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec." +}, +"dataStoreSpecs": { +"description": "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.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" }, "type": "array" }, -"failedEntriesCount": { -"description": "Count of deny list entries that failed to be imported.", -"format": "int64", +"embeddingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", +"description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." +}, +"facetSpecs": { +"description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec" +}, +"type": "array" +}, +"filter": { +"description": "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. 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 customer 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)", +"type": "string" +}, +"imageQuery": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", +"description": "Raw image query." +}, +"languageCode": { +"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", +"type": "string" +}, +"naturalLanguageQueryUnderstandingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", +"description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." +}, +"offset": { +"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" +}, +"orderBy": { +"description": "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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, -"importedEntriesCount": { -"description": "Count of deny list entries successfully imported.", -"format": "int64", +"pageSize": { +"description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" -} }, +"params": { +"additionalProperties": { +"type": "any" +}, +"description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata": { -"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"query": { +"description": "Raw search query.", "type": "string" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", -"type": "string" +"queryExpansionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", +"description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, -"successCount": { -"description": "Count of entries that were processed successfully.", -"format": "int64", +"rankingExpression": { +"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"regionCode": { +"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", "type": "string" -} -}, -"type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse": { -"description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", -"id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse", -"properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", -"description": "Echoes the destination for the complete errors if this field was set in the request." +"relevanceThreshold": { +"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.", +"enum": [ +"RELEVANCE_THRESHOLD_UNSPECIFIED", +"LOWEST", +"LOW", +"MEDIUM", +"HIGH" +], +"enumDescriptions": [ +"Default value. In this case, server behavior defaults to Google defined threshold.", +"Lowest relevance threshold.", +"Low relevance threshold.", +"Medium relevance threshold.", +"High relevance threshold." +], +"type": "string" }, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"safeSearch": { +"description": "Whether to turn on safe search. This is only supported for website search.", +"type": "boolean" }, -"type": "array" +"searchAsYouTypeSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", +"description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." }, -"joinedEventsCount": { -"description": "Count of user events imported with complete existing Documents.", -"format": "int64", +"servingConfig": { +"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", "type": "string" }, -"unjoinedEventsCount": { -"description": "Count of user events imported, but with Document information not found in the existing Branch.", -"format": "int64", +"session": { +"description": "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.", "type": "string" -} }, -"type": "object" +"sessionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", +"description": "Session specification. Can be used only when `session` is set." }, -"GoogleCloudDiscoveryengineV1alphaLanguageInfo": { -"description": "Language info for DataStore.", -"id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", -"properties": { -"language": { -"description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", -"readOnly": true, -"type": "string" +"spellCorrectionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", +"description": "The spell correction specification that specifies the mode under which spell correction takes effect." }, -"languageCode": { -"description": "The language code for the DataStore.", -"type": "string" +"userInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", +"description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." }, -"normalizedLanguageCode": { -"description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", -"readOnly": true, +"userLabels": { +"additionalProperties": { "type": "string" }, -"region": { -"description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", -"readOnly": true, +"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", +"type": "object" +}, +"userPseudoId": { +"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse": { -"description": "Response message for SearchTuningService.ListCustomModels method.", -"id": "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec": { +"description": "Boost specification to boost certain documents.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", "properties": { -"models": { -"description": "List of custom tuning models.", +"conditionBoostSpecs": { +"description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel" +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaOutputResult": { -"description": "Output result that stores the information about where the exported data is stored.", -"id": "GoogleCloudDiscoveryengineV1alphaOutputResult", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec": { +"description": "Boost applies to documents which match a condition.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec", "properties": { -"bigqueryResult": { -"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", -"description": "The BigQuery location where the result is stored." -} -}, -"type": "object" +"boost": { +"description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.", +"format": "float", +"type": "number" }, -"GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult": { -"description": "A BigQuery output result.", -"id": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", -"properties": { -"datasetId": { -"description": "The ID of a BigQuery Dataset.", -"type": "string" +"boostControlSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", +"description": "Complex specification for custom ranking based on customer defined attribute value." }, -"tableId": { -"description": "The ID of a BigQuery Table.", +"condition": { +"description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaProject": { -"description": "Metadata and configurations for a Google Cloud project in the service.", -"id": "GoogleCloudDiscoveryengineV1alphaProject", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { +"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", "properties": { -"createTime": { -"description": "Output only. The timestamp when this project is created.", -"format": "google-datetime", -"readOnly": true, +"attributeType": { +"description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", +"enum": [ +"ATTRIBUTE_TYPE_UNSPECIFIED", +"NUMERICAL", +"FRESHNESS" +], +"enumDescriptions": [ +"Unspecified AttributeType.", +"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", +"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." +], "type": "string" }, -"name": { -"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", -"readOnly": true, -"type": "string" +"controlPoints": { +"description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" }, -"provisionCompletionTime": { -"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"type": "array" }, -"serviceTermsMap": { -"additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms" +"fieldName": { +"description": "The name of the field whose value will be used to determine the boost amount.", +"type": "string" }, -"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", -"readOnly": true, -"type": "object" +"interpolationType": { +"description": "The interpolation type to be applied to connect the control points listed below.", +"enum": [ +"INTERPOLATION_TYPE_UNSPECIFIED", +"LINEAR" +], +"enumDescriptions": [ +"Interpolation type is unspecified. In this case, it defaults to Linear.", +"Piecewise linear interpolation will be applied." +], +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": { -"description": "Metadata about the terms of service.", -"id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { +"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "properties": { -"acceptTime": { -"description": "The last time when the project agreed to the terms of service.", -"format": "google-datetime", +"attributeValue": { +"description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", "type": "string" }, -"declineTime": { -"description": "The last time when the project declined or revoked the agreement to terms of service.", -"format": "google-datetime", -"type": "string" +"boostAmount": { +"description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", +"format": "float", +"type": "number" +} }, -"id": { -"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", -"type": "string" +"type": "object" }, -"state": { -"description": "Whether the project has accepted/rejected the service terms or it is still pending.", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec": { +"description": "A specification for configuring the behavior of content search.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", +"properties": { +"chunkSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" +}, +"extractiveContentSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", +"description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." +}, +"searchResultMode": { +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ -"STATE_UNSPECIFIED", -"TERMS_ACCEPTED", -"TERMS_PENDING", -"TERMS_DECLINED" +"SEARCH_RESULT_MODE_UNSPECIFIED", +"DOCUMENTS", +"CHUNKS" ], "enumDescriptions": [ -"The default value of the enum. This value is not actually used.", -"The project has given consent to the terms of service.", -"The project is pending to review and accept the terms of service.", -"The project has declined or revoked the agreement to terms of service." +"Default value.", +"Returns documents in the search result.", +"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." ], "type": "string" }, -"version": { -"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", -"type": "string" +"snippetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", +"description": "If `snippetSpec` is not specified, snippets are not included in the search response." +}, +"summarySpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", +"description": "If `summarySpec` is not specified, summaries are not included in the search response." } }, -"type": "object" +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec": { +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", +"properties": { +"numNextChunks": { +"description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.", +"format": "int32", +"type": "integer" +}, +"numPreviousChunks": { +"description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.", +"format": "int32", +"type": "integer" +} }, -"GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata": { -"description": "Metadata associated with a project provision operation.", -"id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata", -"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata": { -"description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec": { +"description": "A specification for configuring the extractive content in a search response.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"maxExtractiveAnswerCount": { +"description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.", +"format": "int32", +"type": "integer" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"maxExtractiveSegmentCount": { +"description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.", +"format": "int32", +"type": "integer" +}, +"numNextSegments": { +"description": "Return at most `num_next_segments` segments after each selected segments.", +"format": "int32", +"type": "integer" +}, +"numPreviousSegments": { +"description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", +"format": "int32", +"type": "integer" +}, +"returnExtractiveSegmentScore": { +"description": "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`.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse": { -"description": "Response message for CompletionService.PurgeCompletionSuggestions method.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec": { +"description": "A specification for configuring snippets in a search response.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"maxSnippetCount": { +"deprecated": true, +"description": "[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.", +"format": "int32", +"type": "integer" }, -"type": "array" +"referenceOnly": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", +"type": "boolean" }, -"purgeSucceeded": { -"description": "Whether the completion suggestions were successfully purged.", +"returnSnippet": { +"description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.", "type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata": { -"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec": { +"description": "A specification for configuring a summary returned in a search response.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"ignoreAdversarialQuery": { +"description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", +"type": "boolean" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", -"type": "string" +"ignoreNonSummarySeekingQuery": { +"description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", +"type": "boolean" }, -"ignoredCount": { -"description": "Count of entries that were ignored as entries were not found.", -"format": "int64", -"type": "string" +"includeCitations": { +"description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.", +"type": "boolean" }, -"successCount": { -"description": "Count of entries that were deleted successfully.", -"format": "int64", +"languageCode": { +"description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"modelPromptSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", +"description": "If specified, the spec will be used to modify the prompt provided to the LLM." +}, +"modelSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", +"description": "If specified, the spec will be used to modify the model specification provided to the LLM." +}, +"summaryResultCount": { +"description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.", +"format": "int32", +"type": "integer" +}, +"useSemanticChunks": { +"description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse": { -"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { +"description": "Specification of the prompt to use with the model.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", "properties": { -"purgeCount": { -"description": "The total count of documents purged as a result of the operation.", -"format": "int64", -"type": "string" -}, -"purgeSample": { -"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", -"items": { +"preamble": { +"description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", "type": "string" -}, -"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec": { +"description": "Specification of the model.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"version": { +"description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).", "type": "string" +} }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": { +"description": "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.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse", +"GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": { +"description": "The specification that uses customized query embedding vector to do semantic document retrieval.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"embeddingVectors": { +"description": "The embedding vector used for retrieval. Limit to 1.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector" }, "type": "array" -}, -"purgeCount": { -"description": "Number of suggestion deny list entries purged.", -"format": "int64", -"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata": { -"description": "Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector": { +"description": "Embedding vector.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" -}, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", +"fieldPath": { +"description": "Embedding field path in schema.", "type": "string" }, -"successCount": { -"description": "Count of entries that were deleted successfully.", -"format": "int64", -"type": "string" +"vector": { +"description": "Query embedding vector.", +"items": { +"format": "float", +"type": "number" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse": { -"description": "Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse", +"GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec": { +"description": "A facet specification to perform faceted search.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec", "properties": { -"purgeCount": { -"description": "The total count of events purged as a result of the operation.", -"format": "int64", +"enableDynamicPosition": { +"description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.", +"type": "boolean" +}, +"excludedFilterKeys": { +"description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { "type": "string" -} }, -"type": "object" +"type": "array" }, -"GoogleCloudDiscoveryengineV1alphaQuery": { -"description": "Defines a user inputed query.", -"id": "GoogleCloudDiscoveryengineV1alphaQuery", -"properties": { -"queryId": { -"description": "Unique Id for the query.", -"type": "string" +"facetKey": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", +"description": "Required. The facet key specification." }, -"text": { -"description": "Plain text.", -"type": "string" +"limit": { +"description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey": { +"description": "Specifies how a facet is computed.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"caseInsensitive": { +"description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", +"type": "boolean" }, -"invalidUris": { -"description": "Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.", +"contains": { +"description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", "items": { "type": "string" }, "type": "array" }, -"pendingCount": { -"description": "Total number of URIs that have yet to be crawled.", -"format": "int32", -"type": "integer" -}, -"quotaExceededCount": { -"description": "Total number of URIs that were rejected due to insufficient indexing resources.", -"format": "int32", -"type": "integer" -}, -"successCount": { -"description": "Total number of URIs that have been crawled so far.", -"format": "int32", -"type": "integer" +"intervals": { +"description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaInterval" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"type": "array" }, -"validUrisCount": { -"description": "Total number of unique URIs in the request that are not in invalid_uris.", -"format": "int32", -"type": "integer" -} +"key": { +"description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.", +"type": "string" }, -"type": "object" +"orderBy": { +"description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", +"type": "string" }, -"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { -"description": "Response message for SiteSearchEngineService.RecrawlUris method.", -"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", -"properties": { -"failedUris": { -"description": "URIs that were not crawled before the LRO terminated.", +"prefixes": { +"description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.", "items": { "type": "string" }, "type": "array" }, -"failureSamples": { -"description": "Details for a sample of up to 10 `failed_uris`.", +"restrictedValues": { +"description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" +"type": "string" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo": { -"description": "Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.", -"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo", +"GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery": { +"description": "Specifies the image query input.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", "properties": { -"failureReasons": { -"description": "List of failure reasons by corpus type (e.g. desktop, mobile).", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason" -}, -"type": "array" -}, -"uri": { -"description": "URI that failed to be crawled.", +"imageBytes": { +"description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason": { -"description": "Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.", -"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason", +"GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec": { +"description": "Specification to enable natural language understanding capabilities for search requests.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { -"corpusType": { -"description": "DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.", +"filterExtractionCondition": { +"description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", "enum": [ -"CORPUS_TYPE_UNSPECIFIED", -"DESKTOP", -"MOBILE" +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" ], "enumDescriptions": [ -"Default value.", -"Denotes a crawling attempt for the desktop version of a page.", -"Denotes a crawling attempt for the mobile version of a page." +"Server behavior defaults to Condition.DISABLED.", +"Disables NL filter extraction.", +"Enables NL filter extraction." ], "type": "string" }, -"errorMessage": { -"description": "Reason why the URI was not crawled.", +"geoSearchQueryDetectionFieldNames": { +"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", +"items": { "type": "string" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaSchema": { -"description": "Defines the structure and layout of a type of document data.", -"id": "GoogleCloudDiscoveryengineV1alphaSchema", +"GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": { +"description": "Specification to determine under which conditions query expansion should occur.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", "properties": { -"fieldConfigs": { -"description": "Output only. Configurations for fields of the schema.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaFieldConfig" +"condition": { +"description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"AUTO" +], +"enumDescriptions": [ +"Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.", +"Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.", +"Automatic query expansion built by the Search API." +], +"type": "string" }, -"readOnly": true, -"type": "array" +"pinUnexpandedResults": { +"description": "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.", +"type": "boolean" +} }, -"jsonSchema": { -"description": "The JSON representation of the schema.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { +"description": "Specification for search as you type in search requests.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", +"properties": { +"condition": { +"description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Server behavior defaults to Condition.DISABLED.", +"Disables Search As You Type.", +"Enables Search As You Type." +], "type": "string" +} }, -"name": { -"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec": { +"description": "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.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", +"properties": { +"queryId": { +"description": "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.", "type": "string" }, -"structSchema": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"searchResultPersistenceCount": { +"description": "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.", +"format": "int32", +"type": "integer" +} }, -"description": "The structured representation of the schema.", "type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec": { +"description": "The specification for query spell correction.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", +"properties": { +"mode": { +"description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", +"enum": [ +"MODE_UNSPECIFIED", +"SUGGESTION_ONLY", +"AUTO" +], +"enumDescriptions": [ +"Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", +"Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", +"Automatic spell correction built by the Search API. Search will be based on the corrected query if found." +], +"type": "string" } }, "type": "object" @@ -10092,6 +11477,29 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse": { +"description": "Response message for SiteSearchEngineService.SetUriPatternDocumentData method.", +"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { "description": "Verification information for target sites in advanced site search.", "id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", @@ -10324,6 +11732,21 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaUserInfo": { +"description": "Information of an end user.", +"id": "GoogleCloudDiscoveryengineV1alphaUserInfo", +"properties": { +"userAgent": { +"description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.", +"type": "string" +}, +"userId": { +"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaAlloyDbSource": { "description": "AlloyDB source import data from.", "id": "GoogleCloudDiscoveryengineV1betaAlloyDbSource", @@ -10716,7 +12139,7 @@ "type": "string" }, "searchResultMode": { -"description": "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)", +"description": "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)", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -10867,7 +12290,7 @@ "properties": { "answer": { "$ref": "GoogleCloudDiscoveryengineV1betaAnswer", -"description": "Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." +"description": "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." }, "answerQueryToken": { "description": "A global unique ID used for logging.", @@ -11131,7 +12554,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "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).", +"description": "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 .", "type": "object" }, "title": { @@ -12142,6 +13565,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata": { +"description": "Metadata for EvaluationService.CreateEvaluation method.", +"id": "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { "description": "Metadata for Create Schema LRO.", "id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", @@ -12857,50 +14286,140 @@ "type": "string" } }, -"type": "object" +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { +"description": "Common configurations for an Engine.", +"id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", +"properties": { +"companyName": { +"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { +"description": "Configurations for a Search Engine.", +"id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", +"properties": { +"searchAddOns": { +"description": "The add-on that this search engine enables.", +"items": { +"enum": [ +"SEARCH_ADD_ON_UNSPECIFIED", +"SEARCH_ADD_ON_LLM" +], +"enumDescriptions": [ +"Default value when the enum is unspecified. This is invalid to use.", +"Large language model add-on." +], +"type": "string" +}, +"type": "array" +}, +"searchTier": { +"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", +"enum": [ +"SEARCH_TIER_UNSPECIFIED", +"SEARCH_TIER_STANDARD", +"SEARCH_TIER_ENTERPRISE" +], +"enumDescriptions": [ +"Default value when the enum is unspecified. This is invalid to use.", +"Standard tier.", +"Enterprise tier." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEvaluation": { +"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluation", +"properties": { +"createTime": { +"description": "Output only. Timestamp the Evaluation was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. Timestamp the Evaluation was completed at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", +"readOnly": true +}, +"errorSamples": { +"description": "Output only. A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"readOnly": true, +"type": "array" +}, +"evaluationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", +"description": "Required. The specification of the evaluation." }, -"GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { -"description": "Common configurations for an Engine.", -"id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", -"properties": { -"companyName": { -"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", +"name": { +"description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" -} }, -"type": "object" +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", +"readOnly": true }, -"GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { -"description": "Configurations for a Search Engine.", -"id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", -"properties": { -"searchAddOns": { -"description": "The add-on that this search engine enables.", -"items": { +"state": { +"description": "Output only. The state of the evaluation.", "enum": [ -"SEARCH_ADD_ON_UNSPECIFIED", -"SEARCH_ADD_ON_LLM" +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" ], "enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Large language model add-on." +"The evaluation is unspecified.", +"The service is preparing to run the evaluation.", +"The evaluation is in progress.", +"The evaluation completed successfully.", +"The evaluation failed." ], +"readOnly": true, "type": "string" +} }, -"type": "array" +"type": "object" }, -"searchTier": { -"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", -"enum": [ -"SEARCH_TIER_UNSPECIFIED", -"SEARCH_TIER_STANDARD", -"SEARCH_TIER_ENTERPRISE" -], -"enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Standard tier.", -"Enterprise tier." -], +"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec": { +"description": "Describes the specification of the evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", +"properties": { +"querySetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", +"description": "Required. The specification of the query set." +}, +"searchRequest": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest", +"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec": { +"description": "Describes the specification of the query set.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", +"properties": { +"sampleQuerySet": { +"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", "type": "string" } }, @@ -13261,6 +14780,93 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata": { +"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata", +"properties": { +"createTime": { +"description": "ImportSampleQueries operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of SampleQuerys that failed to be imported.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of SampleQuerys successfully imported.", +"format": "int64", +"type": "string" +}, +"totalCount": { +"description": "Total count of SampleQuerys that were processed.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest": { +"description": "Request message for SampleQueryService.ImportSampleQueries method.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest", +"properties": { +"bigquerySource": { +"$ref": "GoogleCloudDiscoveryengineV1betaBigQuerySource", +"description": "BigQuery input source." +}, +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"gcsSource": { +"$ref": "GoogleCloudDiscoveryengineV1betaGcsSource", +"description": "Cloud Storage location for the input content." +}, +"inlineSource": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource", +"description": "The Inline source for sample query entries." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource": { +"description": "The inline source for SampleQuerys.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource", +"properties": { +"sampleQueries": { +"description": "Required. A list of SampleQuerys to import. Max of 1000 items.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse": { +"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", @@ -13580,6 +15186,95 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse": { +"description": "Response message for EvaluationService.ListEvaluationResults method.", +"id": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse", +"properties": { +"evaluationResults": { +"description": "The EvaluationResults.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult": { +"description": "Represents the results of an evaluation for a single SampleQuery.", +"id": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult", +"properties": { +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, for a given SampleQuery.", +"readOnly": true +}, +"sampleQuery": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery", +"description": "Output only. The SampleQuery that was evaluated.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaListEvaluationsResponse": { +"description": "Response message for EvaluationService.ListEvaluations method.", +"id": "GoogleCloudDiscoveryengineV1betaListEvaluationsResponse", +"properties": { +"evaluations": { +"description": "The Evaluations.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluation" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse": { +"description": "Response message for SampleQueryService.ListSampleQueries method.", +"id": "GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse", +"properties": { +"nextPageToken": { +"description": "A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"sampleQueries": { +"description": "The SampleQuerys.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse": { +"description": "Response message for SampleQuerySetService.ListSampleQuerySets method.", +"id": "GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse", +"properties": { +"nextPageToken": { +"description": "A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"sampleQuerySets": { +"description": "The SampleQuerySets.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaListSchemasResponse": { "description": "Response message for SchemaService.ListSchemas method.", "id": "GoogleCloudDiscoveryengineV1betaListSchemasResponse", @@ -13936,6 +15631,60 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaQualityMetrics": { +"description": "Describes the metrics produced by the evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaQualityMetrics", +"properties": { +"docNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"docPrecision": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" +}, +"docRecall": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" +}, +"pageNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"pageRecall": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics": { +"description": "Stores the metric values at specific top-k levels.", +"id": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"properties": { +"top1": { +"description": "The top-1 value.", +"format": "double", +"type": "number" +}, +"top10": { +"description": "The top-10 value.", +"format": "double", +"type": "number" +}, +"top3": { +"description": "The top-3 value.", +"format": "double", +"type": "number" +}, +"top5": { +"description": "The top-5 value.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaQuery": { "description": "Defines a user inputed query.", "id": "GoogleCloudDiscoveryengineV1betaQuery", @@ -14186,6 +15935,94 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaSampleQuery": { +"description": "Sample Query captures metadata to be used for evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaSampleQuery", +"properties": { +"createTime": { +"description": "Output only. Timestamp the SampleQuery was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"queryEntry": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry", +"description": "The query entry." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry": { +"description": "Query Entry captures metadata to be used for search evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry", +"properties": { +"query": { +"description": "Required. The query.", +"type": "string" +}, +"targets": { +"description": "List of targets for the query.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget": { +"description": "Defines the parameters of the query's expected outcome.", +"id": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget", +"properties": { +"pageNumbers": { +"description": "Expected page numbers of the target. Each page number must be non negative.", +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, +"score": { +"description": "Relevance score of the target.", +"format": "double", +"type": "number" +}, +"uri": { +"description": "Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSampleQuerySet": { +"description": "A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.", +"id": "GoogleCloudDiscoveryengineV1betaSampleQuerySet", +"properties": { +"createTime": { +"description": "Output only. Timestamp the SampleQuerySet was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "The description of the SampleQuerySet.", +"type": "string" +}, +"displayName": { +"description": "Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.", +"type": "string" +}, +"name": { +"description": "Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaSchema": { "description": "Defines the structure and layout of a type of document data.", "id": "GoogleCloudDiscoveryengineV1betaSchema", @@ -14332,6 +16169,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." }, +"servingConfig": { +"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", +"type": "string" +}, "session": { "description": "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.", "type": "string" @@ -14469,7 +16310,7 @@ "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, "searchResultMode": { -"description": "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`.", +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -14773,7 +16614,7 @@ "type": "string" }, "geoSearchQueryDetectionFieldNames": { -"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names.", +"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", "items": { "type": "string" },