Package com.google.cloud.discoveryengine.v1beta

Interface Evaluation.EvaluationSpecOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Evaluation.EvaluationSpec, Evaluation.EvaluationSpec.Builder
Enclosing class:
Evaluation
public static interface Evaluation.EvaluationSpecOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasSearchRequest

      boolean hasSearchRequest()
       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][google.cloud.discoveryengine.v1beta.SearchRequest.serving_config]
 * [SearchRequest.branch][google.cloud.discoveryengine.v1beta.SearchRequest.branch]
 * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1beta.SearchRequest.canonical_filter]
 * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1beta.SearchRequest.query_expansion_spec]
 * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1beta.SearchRequest.spell_correction_spec]
 * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1beta.SearchRequest.content_search_spec]
 * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id]
      .google.cloud.discoveryengine.v1beta.SearchRequest search_request = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the searchRequest field is set.

    • getSearchRequest

      SearchRequest getSearchRequest()
       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][google.cloud.discoveryengine.v1beta.SearchRequest.serving_config]
 * [SearchRequest.branch][google.cloud.discoveryengine.v1beta.SearchRequest.branch]
 * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1beta.SearchRequest.canonical_filter]
 * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1beta.SearchRequest.query_expansion_spec]
 * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1beta.SearchRequest.spell_correction_spec]
 * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1beta.SearchRequest.content_search_spec]
 * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id]
      .google.cloud.discoveryengine.v1beta.SearchRequest search_request = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The searchRequest.

    • getSearchRequestOrBuilder

      SearchRequestOrBuilder getSearchRequestOrBuilder()
       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][google.cloud.discoveryengine.v1beta.SearchRequest.serving_config]
 * [SearchRequest.branch][google.cloud.discoveryengine.v1beta.SearchRequest.branch]
 * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1beta.SearchRequest.canonical_filter]
 * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1beta.SearchRequest.query_expansion_spec]
 * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1beta.SearchRequest.spell_correction_spec]
 * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1beta.SearchRequest.content_search_spec]
 * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id]
      .google.cloud.discoveryengine.v1beta.SearchRequest search_request = 2 [(.google.api.field_behavior) = REQUIRED];

    • hasQuerySetSpec

      boolean hasQuerySetSpec()
       Required. The specification of the query set.
      .google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec.QuerySetSpec query_set_spec = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the querySetSpec field is set.

    • getQuerySetSpec

      Evaluation.EvaluationSpec.QuerySetSpec getQuerySetSpec()
       Required. The specification of the query set.
      .google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec.QuerySetSpec query_set_spec = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The querySetSpec.

    • getQuerySetSpecOrBuilder

      Evaluation.EvaluationSpec.QuerySetSpecOrBuilder getQuerySetSpecOrBuilder()
       Required. The specification of the query set.
      .google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec.QuerySetSpec query_set_spec = 1 [(.google.api.field_behavior) = REQUIRED];

    • getSearchSpecCase

      Evaluation.EvaluationSpec.SearchSpecCase getSearchSpecCase()