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.Create
class	DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.Delete
class	DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.Get
class	DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.List
class	DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.Patch
class	DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.Recommend
class	DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.Search
class	DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.SearchLite
class	DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.StreamAnswer

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.Create	create(String parent, GoogleCloudDiscoveryengineV1ServingConfig content) Creates a ServingConfig.
DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.Delete	delete(String name) Deletes a ServingConfig.
DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.Get	get(String name) Gets a ServingConfig.
DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.List	list(String parent) Lists all ServingConfigs linked to this dataStore.
DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.Patch	patch(String name, GoogleCloudDiscoveryengineV1ServingConfig content) Updates a ServingConfig.
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.
DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.SearchLite	searchLite(String servingConfig, GoogleCloudDiscoveryengineV1SearchRequest content) Performs a search.
DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.StreamAnswer	streamAnswer(String servingConfig, GoogleCloudDiscoveryengineV1AnswerQueryRequest content) Answer query method (streaming).

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`. Or the resource name of the agent engine serving config, such as: `projects/locations/ global/collections/default_collection/engines/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) 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

create

public DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.Create create(String parent,
                                                                                           GoogleCloudDiscoveryengineV1ServingConfig content)
                                                                                    throws IOException

Creates a ServingConfig. Note: The Google Cloud console works only with the default serving config. Additional ServingConfigs can be created and managed only via the API. A maximum of 100 ServingConfigs are allowed in an Engine, otherwise a RESOURCE_EXHAUSTED error is returned. Create a request for the method "servingConfigs.create". 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:

parent - Required. Full resource name of parent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`

content - the GoogleCloudDiscoveryengineV1ServingConfig

Returns:

the request

Throws:

IOException

delete

public DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.Delete delete(String name)
                                                                                    throws IOException

Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. Create a request for the method "servingConfigs.delete". 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:

name - Required. The resource name of the ServingConfig to delete. Format: `projects/{project}/locations/{l ocation}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`

Returns:

the request

Throws:

IOException

get

public DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.Get get(String name)
                                                                              throws IOException

Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. Create a request for the method "servingConfigs.get". 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:

name - Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{loca tion}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`

Returns:

the request

Throws:

IOException

list

public DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.List list(String parent)
                                                                                throws IOException

Lists all ServingConfigs linked to this dataStore. Create a request for the method "servingConfigs.list". 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:

parent - Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`

Returns:

the request

Throws:

IOException

patch

public DiscoveryEngine.Projects.Locations.Collections.Engines.ServingConfigs.Patch patch(String name,
                                                                                         GoogleCloudDiscoveryengineV1ServingConfig content)
                                                                                  throws IOException

Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. Create a request for the method "servingConfigs.patch". 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:

name - Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id} /engines/{engine_id}/servingConfigs/{serving_config_id}`

content - the GoogleCloudDiscoveryengineV1ServingConfig

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

searchLite

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

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. Create a request for the method "servingConfigs.searchLite". 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

streamAnswer

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

Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream. Create a request for the method "servingConfigs.streamAnswer". 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`. Or the resource name of the agent engine serving config, such as: `projects/locations/ global/collections/default_collection/engines/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) 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