Discovery Engine v1beta API - Class SearchRequest.Types.DataStoreSpec (1.0.0-beta24) 

public sealed class SearchRequest.Types.DataStoreSpec : IMessage<SearchRequest.Types.DataStoreSpec>, IEquatable<SearchRequest.Types.DataStoreSpec>, IDeepCloneable<SearchRequest.Types.DataStoreSpec>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1beta API class SearchRequest.Types.DataStoreSpec.

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.

Inheritance

object > SearchRequest.Types.DataStoreSpec

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

DataStoreSpec()

public DataStoreSpec()

DataStoreSpec(DataStoreSpec)

public DataStoreSpec(SearchRequest.Types.DataStoreSpec other)
Parameter
Name Description
other SearchRequestTypesDataStoreSpec

Properties

BoostSpec

public SearchRequest.Types.BoostSpec BoostSpec { get; set; }

Optional. Boost specification to boost certain documents. For more information on boosting, see Boosting

Property Value
Type Description
SearchRequestTypesBoostSpec

CustomSearchOperators

public string CustomSearchOperators { get; set; }

Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see SearchOperators.

Property Value
Type Description
string

DataStore

public string DataStore { get; set; }

Required. Full resource name of [DataStore][google.cloud.discoveryengine.v1beta.DataStore], such as projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. The path must include the project number, project id is not supported for this field.

Property Value
Type Description
string

DataStoreAsDataStoreName

public DataStoreName DataStoreAsDataStoreName { get; set; }

DataStoreName-typed view over the DataStore resource name property.

Property Value
Type Description
DataStoreName

Filter

public string Filter { get; set; }

Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see Filtering

Property Value
Type Description
string

NumResults

public int NumResults { get; set; }

Optional. The maximum number of results to retrieve from this data store. If not specified, it will use the [SearchRequest.num_results_per_data_store][google.cloud.discoveryengine.v1beta.SearchRequest.num_results_per_data_store] if provided, otherwise there is no limit. If both this field and [SearchRequest.num_results_per_data_store][google.cloud.discoveryengine.v1beta.SearchRequest.num_results_per_data_store] are specified, this field will be used.

Property Value
Type Description
int