Class ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource

The "servingConfigs" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.DiscoveryEngine.v1beta

Assembly: Google.Apis.DiscoveryEngine.v1beta.dll

Syntax

public class ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource

Constructors

ServingConfigsResource(IClientService)

Constructs a new resource.

Declaration

public ServingConfigsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Answer(GoogleCloudDiscoveryengineV1betaAnswerQueryRequest, string)

Answer query method.

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.AnswerRequest Answer(GoogleCloudDiscoveryengineV1betaAnswerQueryRequest body, string servingConfig)

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1betaAnswerQueryRequest	body	The body of the request.
string	servingConfig	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/*/servingConfigs/default_serving_config. This field is used to identify the serving configuration name, set of models used to make the search.

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.AnswerRequest

Get(string)

Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The resource name of the ServingConfig to get. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.GetRequest

List(string)

Lists all ServingConfigs linked to this dataStore.

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. Full resource name of the parent resource. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.ListRequest

Patch(GoogleCloudDiscoveryengineV1betaServingConfig, string)

Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.PatchRequest Patch(GoogleCloudDiscoveryengineV1betaServingConfig body, string name)

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1betaServingConfig	body	The body of the request.
string	name	Immutable. Fully qualified name projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.PatchRequest

Recommend(GoogleCloudDiscoveryengineV1betaRecommendRequest, string)

Makes a recommendation, which requires a contextual user event.

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.RecommendRequest Recommend(GoogleCloudDiscoveryengineV1betaRecommendRequest body, string servingConfig)

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1betaRecommendRequest	body	The body of the request.
string	servingConfig	Required. Full resource name of a ServingConfig: projects/*/locations/global/collections/*/engines/*/servingConfigs/*, or projects/*/locations/global/collections/*/dataStores/*/servingConfigs/* One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine projects/*/locations/global/collections/*/engines/my-engine, you can use projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine for your RecommendationService.Recommend requests.

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.RecommendRequest

Search(GoogleCloudDiscoveryengineV1betaSearchRequest, string)

Performs a search.

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.SearchRequest Search(GoogleCloudDiscoveryengineV1betaSearchRequest body, string servingConfig)

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1betaSearchRequest	body	The body of the request.
string	servingConfig	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.

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.SearchRequest

SearchLite(GoogleCloudDiscoveryengineV1betaSearchRequest, string)

Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a FAILED_PRECONDITION error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security.

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.SearchLiteRequest SearchLite(GoogleCloudDiscoveryengineV1betaSearchRequest body, string servingConfig)

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1betaSearchRequest	body	The body of the request.
string	servingConfig	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.

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.SearchLiteRequest

StreamAnswer(GoogleCloudDiscoveryengineV1betaAnswerQueryRequest, string)

Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.

Declaration

public virtual ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.StreamAnswerRequest StreamAnswer(GoogleCloudDiscoveryengineV1betaAnswerQueryRequest body, string servingConfig)

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1betaAnswerQueryRequest	body	The body of the request.
string	servingConfig	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/*/servingConfigs/default_serving_config. This field is used to identify the serving configuration name, set of models used to make the search.

Returns

Type	Description
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.ServingConfigsResource.StreamAnswerRequest