com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs

java.lang.Object

com.google.api.services.discoveryengine.v1.DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs

Enclosing class:

DiscoveryEngine.Projects.Locations.Collections.Engines

public class DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs
extends Object

The "servingConfigs" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.Answer
class	DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.Recommend
class	DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.Search

Constructor Summary

Constructors

Constructor and Description
ServingConfigs()

Method Summary

Modifier and Type	Method and Description
DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.Answer	answer(String servingConfig, GoogleCloudDiscoveryengineV1AnswerQueryRequest content) Answer query method.
DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.Recommend	recommend(String servingConfig, GoogleCloudDiscoveryengineV1RecommendRequest content) Makes a recommendation, which requires a contextual user event.
DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.Search	search(String servingConfig, GoogleCloudDiscoveryengineV1SearchRequest content) Performs a search.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServingConfigs

public ServingConfigs()

Method Detail

answer

public DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.Answer answer(String servingConfig,
                                                                                           GoogleCloudDiscoveryengineV1AnswerQueryRequest content)
                                                                                    throws IOException

Answer query method. Create a request for the method "servingConfigs.answer". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

servingConfig - Required. The resource name of the Search serving config, such as `projects/locations/global/collect ions/default_collection/engines/servingConfigs/default_serving_config`, or `projects/locat ions/global/collections/default_collection/dataStores/servingConfigs/default_serving_confi g`. This field is used to identify the serving configuration name, set of models used to make the search.

content - the GoogleCloudDiscoveryengineV1AnswerQueryRequest

Returns:

the request

Throws:

IOException

recommend

public DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.Recommend recommend(String servingConfig,
                                                                                                 GoogleCloudDiscoveryengineV1RecommendRequest content)
                                                                                          throws IOException

Makes a recommendation, which requires a contextual user event. Create a request for the method "servingConfigs.recommend". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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.

content - the GoogleCloudDiscoveryengineV1RecommendRequest

Returns:

the request

Throws:

IOException

search

public DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.Search search(String servingConfig,
                                                                                           GoogleCloudDiscoveryengineV1SearchRequest content)
                                                                                    throws IOException

Performs a search. Create a request for the method "servingConfigs.search". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

servingConfig - Required. The resource name of the Search serving config, such as `projects/locations/global/collect ions/default_collection/engines/servingConfigs/default_serving_config`, or `projects/locat ions/global/collections/default_collection/dataStores/default_data_store/servingConfigs/de fault_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.

content - the GoogleCloudDiscoveryengineV1SearchRequest

Returns:

the request

Throws:

IOException