com.google.cloud.discoveryengine.v1alpha

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 Summary

Modifier and Type	Method and Description
Evaluation.EvaluationSpec.QuerySetSpec	getQuerySetSpec() Required.
Evaluation.EvaluationSpec.QuerySetSpecOrBuilder	getQuerySetSpecOrBuilder() Required.
SearchRequest	getSearchRequest() Required.
SearchRequestOrBuilder	getSearchRequestOrBuilder() Required.
Evaluation.EvaluationSpec.SearchSpecCase	getSearchSpecCase()
boolean	hasQuerySetSpec() Required.
boolean	hasSearchRequest() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

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.v1alpha.SearchRequest.serving_config]
 * [SearchRequest.branch][google.cloud.discoveryengine.v1alpha.SearchRequest.branch]
 * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1alpha.SearchRequest.canonical_filter]
 * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.query_expansion_spec]
 * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.spell_correction_spec]
 * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.content_search_spec]
 * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1alpha.SearchRequest.user_pseudo_id]
 

.google.cloud.discoveryengine.v1alpha.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.v1alpha.SearchRequest.serving_config]
 * [SearchRequest.branch][google.cloud.discoveryengine.v1alpha.SearchRequest.branch]
 * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1alpha.SearchRequest.canonical_filter]
 * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.query_expansion_spec]
 * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.spell_correction_spec]
 * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.content_search_spec]
 * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1alpha.SearchRequest.user_pseudo_id]
 

.google.cloud.discoveryengine.v1alpha.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.v1alpha.SearchRequest.serving_config]
 * [SearchRequest.branch][google.cloud.discoveryengine.v1alpha.SearchRequest.branch]
 * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1alpha.SearchRequest.canonical_filter]
 * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.query_expansion_spec]
 * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.spell_correction_spec]
 * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.content_search_spec]
 * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1alpha.SearchRequest.user_pseudo_id]
 

.google.cloud.discoveryengine.v1alpha.SearchRequest search_request = 2 [(.google.api.field_behavior) = REQUIRED];

hasQuerySetSpec

boolean hasQuerySetSpec()

 Required. The specification of the query set.
 

.google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.Evaluation.EvaluationSpec.QuerySetSpec query_set_spec = 1 [(.google.api.field_behavior) = REQUIRED];

getSearchSpecCase

Evaluation.EvaluationSpec.SearchSpecCase getSearchSpecCase()