1. class
  2. Google
  3. \
  4. Service
  5. \
  6. DiscoveryEngine
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsCollectionsEnginesServingConfigs

ProjectsLocationsCollectionsEnginesServingConfigs

class ProjectsLocationsCollectionsEnginesServingConfigs extends Resource (View source)

The "servingConfigs" collection of methods.

Typical usage is:

 $discoveryengineService = new Google\Service\DiscoveryEngine(...);
 $servingConfigs = $discoveryengineService->projects_locations_collections_engines_servingConfigs;

Methods

GoogleCloudDiscoveryengineV1AnswerQueryResponse
answer(string $servingConfig, GoogleCloudDiscoveryengineV1AnswerQueryRequest $postBody, array $optParams = [])

Answer query method. (servingConfigs.answer)

GoogleCloudDiscoveryengineV1RecommendResponse
recommend(string $servingConfig, GoogleCloudDiscoveryengineV1RecommendRequest $postBody, array $optParams = [])

Makes a recommendation, which requires a contextual user event.

GoogleCloudDiscoveryengineV1SearchResponse
search(string $servingConfig, GoogleCloudDiscoveryengineV1SearchRequest $postBody, array $optParams = [])

Performs a search. (servingConfigs.search)

Details

at line 51
GoogleCloudDiscoveryengineV1AnswerQueryResponse answer(string $servingConfig, GoogleCloudDiscoveryengineV1AnswerQueryRequest $postBody, array $optParams = [])

Answer query method. (servingConfigs.answer)

Parameters

string $servingConfig

Required. The resource name of the Search serving config, such as projects/locations/global/collections/default_collec tion/engines/servingConfigs/default_serving_config, or projects/locations/g lobal/collections/default_collection/dataStores/servingConfigs/default_servin g_config. This field is used to identify the serving configuration name, set of models used to make the search.
GoogleCloudDiscoveryengineV1AnswerQueryRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1AnswerQueryResponse

Exceptions

Exception

at line 74
GoogleCloudDiscoveryengineV1RecommendResponse recommend(string $servingConfig, GoogleCloudDiscoveryengineV1RecommendRequest $postBody, array $optParams = [])

Makes a recommendation, which requires a contextual user event.

(servingConfigs.recommend)

Parameters

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.
GoogleCloudDiscoveryengineV1RecommendRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1RecommendResponse

Exceptions

Exception

Performs a search. (servingConfigs.search)

Parameters

string $servingConfig

Required. The resource name of the Search serving config, such as projects/locations/global/collections/default_collec tion/engines/servingConfigs/default_serving_config, or projects/locations/g lobal/collections/default_collection/dataStores/default_data_store/servingCon figs/default_serving_config. This field is used to identify the serving configuration name, set of models used to make the search.
GoogleCloudDiscoveryengineV1SearchRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1SearchResponse

Exceptions

Exception