serving_configs

Creates, updates, deletes, gets or lists a serving_configs resource.

Overview

Name	serving_configs
Type	Resource
Id	google.discoveryengine.serving_configs

Fields

The following fields are returned by SELECT queries:

projects_locations_collections_engines_serving_configs_get

Name	Datatype	Description
name	string	Immutable. Fully qualified name projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}
answerGenerationSpec	object	Optional. The specification for answer generation. (id: GoogleCloudDiscoveryengineV1AnswerGenerationSpec)
boostControlIds	array	Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.
createTime	string (google-datetime)	Output only. ServingConfig created timestamp.
displayName	string	Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
dissociateControlIds	array	Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
diversityLevel	string	How much diversity to use in recommendation model results e.g. medium-diversity or high-diversity. Currently supported values: * no-diversity * low-diversity * medium-diversity * high-diversity * auto-diversity If not specified, we choose default based on recommendation model type. Default value: no-diversity. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
filterControlIds	array	Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.
genericConfig	object	The GenericConfig of the serving configuration. (id: GoogleCloudDiscoveryengineV1ServingConfigGenericConfig)
ignoreControlIds	array	Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.
mediaConfig	object	The MediaConfig of the serving configuration. (id: GoogleCloudDiscoveryengineV1ServingConfigMediaConfig)
modelId	string	The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.
onewaySynonymsControlIds	array	Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
promoteControlIds	array	Condition promote specifications. Maximum number of specifications is 100.
rankingExpression	string	The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * relevance_score: pre-defined keywords, used for measure relevance between query and document. * embedding_field_path: the document embedding field used with query embedding vector. * dotProduct: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).
redirectControlIds	array	IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
replacementControlIds	array	Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
solutionType	string	Required. Immutable. Specifies the solution type that a serving config can be associated with.
synonymsControlIds	array	Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
updateTime	string (google-datetime)	Output only. ServingConfig updated timestamp.

projects_locations_collections_data_stores_serving_configs_get

Name	Datatype	Description
name	string	Immutable. Fully qualified name projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}
answerGenerationSpec	object	Optional. The specification for answer generation. (id: GoogleCloudDiscoveryengineV1AnswerGenerationSpec)
boostControlIds	array	Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.
createTime	string (google-datetime)	Output only. ServingConfig created timestamp.
displayName	string	Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
dissociateControlIds	array	Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
diversityLevel	string	How much diversity to use in recommendation model results e.g. medium-diversity or high-diversity. Currently supported values: * no-diversity * low-diversity * medium-diversity * high-diversity * auto-diversity If not specified, we choose default based on recommendation model type. Default value: no-diversity. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
filterControlIds	array	Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.
genericConfig	object	The GenericConfig of the serving configuration. (id: GoogleCloudDiscoveryengineV1ServingConfigGenericConfig)
ignoreControlIds	array	Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.
mediaConfig	object	The MediaConfig of the serving configuration. (id: GoogleCloudDiscoveryengineV1ServingConfigMediaConfig)
modelId	string	The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.
onewaySynonymsControlIds	array	Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
promoteControlIds	array	Condition promote specifications. Maximum number of specifications is 100.
rankingExpression	string	The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * relevance_score: pre-defined keywords, used for measure relevance between query and document. * embedding_field_path: the document embedding field used with query embedding vector. * dotProduct: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).
redirectControlIds	array	IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
replacementControlIds	array	Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
solutionType	string	Required. Immutable. Specifies the solution type that a serving config can be associated with.
synonymsControlIds	array	Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
updateTime	string (google-datetime)	Output only. ServingConfig updated timestamp.

projects_locations_collections_engines_serving_configs_list

Name	Datatype	Description
name	string	Immutable. Fully qualified name projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}
answerGenerationSpec	object	Optional. The specification for answer generation. (id: GoogleCloudDiscoveryengineV1AnswerGenerationSpec)
boostControlIds	array	Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.
createTime	string (google-datetime)	Output only. ServingConfig created timestamp.
displayName	string	Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
dissociateControlIds	array	Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
diversityLevel	string	How much diversity to use in recommendation model results e.g. medium-diversity or high-diversity. Currently supported values: * no-diversity * low-diversity * medium-diversity * high-diversity * auto-diversity If not specified, we choose default based on recommendation model type. Default value: no-diversity. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
filterControlIds	array	Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.
genericConfig	object	The GenericConfig of the serving configuration. (id: GoogleCloudDiscoveryengineV1ServingConfigGenericConfig)
ignoreControlIds	array	Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.
mediaConfig	object	The MediaConfig of the serving configuration. (id: GoogleCloudDiscoveryengineV1ServingConfigMediaConfig)
modelId	string	The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.
onewaySynonymsControlIds	array	Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
promoteControlIds	array	Condition promote specifications. Maximum number of specifications is 100.
rankingExpression	string	The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * relevance_score: pre-defined keywords, used for measure relevance between query and document. * embedding_field_path: the document embedding field used with query embedding vector. * dotProduct: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).
redirectControlIds	array	IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
replacementControlIds	array	Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
solutionType	string	Required. Immutable. Specifies the solution type that a serving config can be associated with.
synonymsControlIds	array	Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
updateTime	string (google-datetime)	Output only. ServingConfig updated timestamp.

projects_locations_collections_data_stores_serving_configs_list

Name	Datatype	Description
name	string	Immutable. Fully qualified name projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}
answerGenerationSpec	object	Optional. The specification for answer generation. (id: GoogleCloudDiscoveryengineV1AnswerGenerationSpec)
boostControlIds	array	Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.
createTime	string (google-datetime)	Output only. ServingConfig created timestamp.
displayName	string	Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
dissociateControlIds	array	Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
diversityLevel	string	How much diversity to use in recommendation model results e.g. medium-diversity or high-diversity. Currently supported values: * no-diversity * low-diversity * medium-diversity * high-diversity * auto-diversity If not specified, we choose default based on recommendation model type. Default value: no-diversity. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
filterControlIds	array	Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.
genericConfig	object	The GenericConfig of the serving configuration. (id: GoogleCloudDiscoveryengineV1ServingConfigGenericConfig)
ignoreControlIds	array	Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.
mediaConfig	object	The MediaConfig of the serving configuration. (id: GoogleCloudDiscoveryengineV1ServingConfigMediaConfig)
modelId	string	The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.
onewaySynonymsControlIds	array	Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
promoteControlIds	array	Condition promote specifications. Maximum number of specifications is 100.
rankingExpression	string	The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * relevance_score: pre-defined keywords, used for measure relevance between query and document. * embedding_field_path: the document embedding field used with query embedding vector. * dotProduct: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).
redirectControlIds	array	IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
replacementControlIds	array	Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
solutionType	string	Required. Immutable. Specifies the solution type that a serving config can be associated with.
synonymsControlIds	array	Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
updateTime	string (google-datetime)	Output only. ServingConfig updated timestamp.

projects_locations_data_stores_serving_configs_get

Name	Datatype	Description
name	string	Immutable. Fully qualified name projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}
answerGenerationSpec	object	Optional. The specification for answer generation. (id: GoogleCloudDiscoveryengineV1AnswerGenerationSpec)
boostControlIds	array	Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.
createTime	string (google-datetime)	Output only. ServingConfig created timestamp.
displayName	string	Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
dissociateControlIds	array	Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
diversityLevel	string	How much diversity to use in recommendation model results e.g. medium-diversity or high-diversity. Currently supported values: * no-diversity * low-diversity * medium-diversity * high-diversity * auto-diversity If not specified, we choose default based on recommendation model type. Default value: no-diversity. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
filterControlIds	array	Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.
genericConfig	object	The GenericConfig of the serving configuration. (id: GoogleCloudDiscoveryengineV1ServingConfigGenericConfig)
ignoreControlIds	array	Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.
mediaConfig	object	The MediaConfig of the serving configuration. (id: GoogleCloudDiscoveryengineV1ServingConfigMediaConfig)
modelId	string	The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.
onewaySynonymsControlIds	array	Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
promoteControlIds	array	Condition promote specifications. Maximum number of specifications is 100.
rankingExpression	string	The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * relevance_score: pre-defined keywords, used for measure relevance between query and document. * embedding_field_path: the document embedding field used with query embedding vector. * dotProduct: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).
redirectControlIds	array	IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
replacementControlIds	array	Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
solutionType	string	Required. Immutable. Specifies the solution type that a serving config can be associated with.
synonymsControlIds	array	Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
updateTime	string (google-datetime)	Output only. ServingConfig updated timestamp.

projects_locations_data_stores_serving_configs_list

Name	Datatype	Description
name	string	Immutable. Fully qualified name projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}
answerGenerationSpec	object	Optional. The specification for answer generation. (id: GoogleCloudDiscoveryengineV1AnswerGenerationSpec)
boostControlIds	array	Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.
createTime	string (google-datetime)	Output only. ServingConfig created timestamp.
displayName	string	Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
dissociateControlIds	array	Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
diversityLevel	string	How much diversity to use in recommendation model results e.g. medium-diversity or high-diversity. Currently supported values: * no-diversity * low-diversity * medium-diversity * high-diversity * auto-diversity If not specified, we choose default based on recommendation model type. Default value: no-diversity. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
filterControlIds	array	Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.
genericConfig	object	The GenericConfig of the serving configuration. (id: GoogleCloudDiscoveryengineV1ServingConfigGenericConfig)
ignoreControlIds	array	Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.
mediaConfig	object	The MediaConfig of the serving configuration. (id: GoogleCloudDiscoveryengineV1ServingConfigMediaConfig)
modelId	string	The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.
onewaySynonymsControlIds	array	Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
promoteControlIds	array	Condition promote specifications. Maximum number of specifications is 100.
rankingExpression	string	The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * relevance_score: pre-defined keywords, used for measure relevance between query and document. * embedding_field_path: the document embedding field used with query embedding vector. * dotProduct: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).
redirectControlIds	array	IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
replacementControlIds	array	Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
solutionType	string	Required. Immutable. Specifies the solution type that a serving config can be associated with.
synonymsControlIds	array	Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
updateTime	string (google-datetime)	Output only. ServingConfig updated timestamp.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_collections_engines_serving_configs_get	select	projectsId, locationsId, collectionsId, enginesId, servingConfigsId		Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
projects_locations_collections_data_stores_serving_configs_get	select	projectsId, locationsId, collectionsId, dataStoresId, servingConfigsId		Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
projects_locations_collections_engines_serving_configs_list	select	projectsId, locationsId, collectionsId, enginesId	pageToken, pageSize	Lists all ServingConfigs linked to this dataStore.
projects_locations_collections_data_stores_serving_configs_list	select	projectsId, locationsId, collectionsId, dataStoresId	pageToken, pageSize	Lists all ServingConfigs linked to this dataStore.
projects_locations_data_stores_serving_configs_get	select	projectsId, locationsId, dataStoresId, servingConfigsId		Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
projects_locations_data_stores_serving_configs_list	select	projectsId, locationsId, dataStoresId	pageSize, pageToken	Lists all ServingConfigs linked to this dataStore.
projects_locations_collections_engines_serving_configs_patch	update	projectsId, locationsId, collectionsId, enginesId, servingConfigsId	updateMask	Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
projects_locations_collections_data_stores_serving_configs_patch	update	projectsId, locationsId, collectionsId, dataStoresId, servingConfigsId	updateMask	Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
projects_locations_data_stores_serving_configs_patch	update	projectsId, locationsId, dataStoresId, servingConfigsId	updateMask	Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
projects_locations_collections_engines_serving_configs_delete	delete	projectsId, locationsId, collectionsId, enginesId, servingConfigsId		Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
projects_locations_collections_data_stores_serving_configs_delete	delete	projectsId, locationsId, collectionsId, dataStoresId, servingConfigsId		Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
projects_locations_data_stores_serving_configs_delete	delete	projectsId, locationsId, dataStoresId, servingConfigsId		Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
projects_locations_collections_engines_serving_configs_search	exec	projectsId, locationsId, collectionsId, enginesId, servingConfigsId		Performs a search.
projects_locations_collections_engines_serving_configs_stream_answer	exec	projectsId, locationsId, collectionsId, enginesId, servingConfigsId		Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.
projects_locations_collections_engines_serving_configs_answer	exec	projectsId, locationsId, collectionsId, enginesId, servingConfigsId		Answer query method.
projects_locations_collections_engines_serving_configs_search_lite	exec	projectsId, locationsId, collectionsId, enginesId, servingConfigsId		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.
projects_locations_collections_engines_serving_configs_recommend	exec	projectsId, locationsId, collectionsId, enginesId, servingConfigsId		Makes a recommendation, which requires a contextual user event.
projects_locations_collections_data_stores_serving_configs_recommend	exec	projectsId, locationsId, collectionsId, dataStoresId, servingConfigsId		Makes a recommendation, which requires a contextual user event.
projects_locations_collections_data_stores_serving_configs_search	exec	projectsId, locationsId, collectionsId, dataStoresId, servingConfigsId		Performs a search.
projects_locations_collections_data_stores_serving_configs_answer	exec	projectsId, locationsId, collectionsId, dataStoresId, servingConfigsId		Answer query method.
projects_locations_collections_data_stores_serving_configs_stream_answer	exec	projectsId, locationsId, collectionsId, dataStoresId, servingConfigsId		Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.
projects_locations_collections_data_stores_serving_configs_search_lite	exec	projectsId, locationsId, collectionsId, dataStoresId, servingConfigsId		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.
projects_locations_data_stores_serving_configs_search	exec	projectsId, locationsId, dataStoresId, servingConfigsId		Performs a search.
projects_locations_data_stores_serving_configs_recommend	exec	projectsId, locationsId, dataStoresId, servingConfigsId		Makes a recommendation, which requires a contextual user event.
projects_locations_data_stores_serving_configs_stream_answer	exec	projectsId, locationsId, dataStoresId, servingConfigsId		Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.
projects_locations_data_stores_serving_configs_answer	exec	projectsId, locationsId, dataStoresId, servingConfigsId		Answer query method.
projects_locations_data_stores_serving_configs_search_lite	exec	projectsId, locationsId, dataStoresId, servingConfigsId		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
collectionsId	string
dataStoresId	string
enginesId	string
locationsId	string
projectsId	string
servingConfigsId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_collections_engines_serving_configs_get

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

SELECT
name,
answerGenerationSpec,
boostControlIds,
createTime,
displayName,
dissociateControlIds,
diversityLevel,
filterControlIds,
genericConfig,
ignoreControlIds,
mediaConfig,
modelId,
onewaySynonymsControlIds,
promoteControlIds,
rankingExpression,
redirectControlIds,
replacementControlIds,
solutionType,
synonymsControlIds,
updateTime
FROM google.discoveryengine.serving_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND enginesId = '{{ enginesId }}' -- required
AND servingConfigsId = '{{ servingConfigsId }}' -- required
;

projects_locations_collections_data_stores_serving_configs_get

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

SELECT
name,
answerGenerationSpec,
boostControlIds,
createTime,
displayName,
dissociateControlIds,
diversityLevel,
filterControlIds,
genericConfig,
ignoreControlIds,
mediaConfig,
modelId,
onewaySynonymsControlIds,
promoteControlIds,
rankingExpression,
redirectControlIds,
replacementControlIds,
solutionType,
synonymsControlIds,
updateTime
FROM google.discoveryengine.serving_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND servingConfigsId = '{{ servingConfigsId }}' -- required
;

projects_locations_collections_engines_serving_configs_list

Lists all ServingConfigs linked to this dataStore.

SELECT
name,
answerGenerationSpec,
boostControlIds,
createTime,
displayName,
dissociateControlIds,
diversityLevel,
filterControlIds,
genericConfig,
ignoreControlIds,
mediaConfig,
modelId,
onewaySynonymsControlIds,
promoteControlIds,
rankingExpression,
redirectControlIds,
replacementControlIds,
solutionType,
synonymsControlIds,
updateTime
FROM google.discoveryengine.serving_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND enginesId = '{{ enginesId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
;

projects_locations_collections_data_stores_serving_configs_list

Lists all ServingConfigs linked to this dataStore.

SELECT
name,
answerGenerationSpec,
boostControlIds,
createTime,
displayName,
dissociateControlIds,
diversityLevel,
filterControlIds,
genericConfig,
ignoreControlIds,
mediaConfig,
modelId,
onewaySynonymsControlIds,
promoteControlIds,
rankingExpression,
redirectControlIds,
replacementControlIds,
solutionType,
synonymsControlIds,
updateTime
FROM google.discoveryengine.serving_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
;

projects_locations_data_stores_serving_configs_get

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

SELECT
name,
answerGenerationSpec,
boostControlIds,
createTime,
displayName,
dissociateControlIds,
diversityLevel,
filterControlIds,
genericConfig,
ignoreControlIds,
mediaConfig,
modelId,
onewaySynonymsControlIds,
promoteControlIds,
rankingExpression,
redirectControlIds,
replacementControlIds,
solutionType,
synonymsControlIds,
updateTime
FROM google.discoveryengine.serving_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND servingConfigsId = '{{ servingConfigsId }}' -- required
;

projects_locations_data_stores_serving_configs_list

Lists all ServingConfigs linked to this dataStore.

SELECT
name,
answerGenerationSpec,
boostControlIds,
createTime,
displayName,
dissociateControlIds,
diversityLevel,
filterControlIds,
genericConfig,
ignoreControlIds,
mediaConfig,
modelId,
onewaySynonymsControlIds,
promoteControlIds,
rankingExpression,
redirectControlIds,
replacementControlIds,
solutionType,
synonymsControlIds,
updateTime
FROM google.discoveryengine.serving_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

UPDATE examples

projects_locations_collections_engines_serving_configs_patch

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

UPDATE google.discoveryengine.serving_configs
SET 
data__name = '{{ name }}',
data__redirectControlIds = '{{ redirectControlIds }}',
data__synonymsControlIds = '{{ synonymsControlIds }}',
data__genericConfig = '{{ genericConfig }}',
data__mediaConfig = '{{ mediaConfig }}',
data__boostControlIds = '{{ boostControlIds }}',
data__ignoreControlIds = '{{ ignoreControlIds }}',
data__onewaySynonymsControlIds = '{{ onewaySynonymsControlIds }}',
data__solutionType = '{{ solutionType }}',
data__dissociateControlIds = '{{ dissociateControlIds }}',
data__rankingExpression = '{{ rankingExpression }}',
data__promoteControlIds = '{{ promoteControlIds }}',
data__diversityLevel = '{{ diversityLevel }}',
data__displayName = '{{ displayName }}',
data__modelId = '{{ modelId }}',
data__filterControlIds = '{{ filterControlIds }}',
data__answerGenerationSpec = '{{ answerGenerationSpec }}',
data__replacementControlIds = '{{ replacementControlIds }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND collectionsId = '{{ collectionsId }}' --required
AND enginesId = '{{ enginesId }}' --required
AND servingConfigsId = '{{ servingConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
answerGenerationSpec,
boostControlIds,
createTime,
displayName,
dissociateControlIds,
diversityLevel,
filterControlIds,
genericConfig,
ignoreControlIds,
mediaConfig,
modelId,
onewaySynonymsControlIds,
promoteControlIds,
rankingExpression,
redirectControlIds,
replacementControlIds,
solutionType,
synonymsControlIds,
updateTime;

projects_locations_collections_data_stores_serving_configs_patch

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

UPDATE google.discoveryengine.serving_configs
SET 
data__name = '{{ name }}',
data__redirectControlIds = '{{ redirectControlIds }}',
data__synonymsControlIds = '{{ synonymsControlIds }}',
data__genericConfig = '{{ genericConfig }}',
data__mediaConfig = '{{ mediaConfig }}',
data__boostControlIds = '{{ boostControlIds }}',
data__ignoreControlIds = '{{ ignoreControlIds }}',
data__onewaySynonymsControlIds = '{{ onewaySynonymsControlIds }}',
data__solutionType = '{{ solutionType }}',
data__dissociateControlIds = '{{ dissociateControlIds }}',
data__rankingExpression = '{{ rankingExpression }}',
data__promoteControlIds = '{{ promoteControlIds }}',
data__diversityLevel = '{{ diversityLevel }}',
data__displayName = '{{ displayName }}',
data__modelId = '{{ modelId }}',
data__filterControlIds = '{{ filterControlIds }}',
data__answerGenerationSpec = '{{ answerGenerationSpec }}',
data__replacementControlIds = '{{ replacementControlIds }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND collectionsId = '{{ collectionsId }}' --required
AND dataStoresId = '{{ dataStoresId }}' --required
AND servingConfigsId = '{{ servingConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
answerGenerationSpec,
boostControlIds,
createTime,
displayName,
dissociateControlIds,
diversityLevel,
filterControlIds,
genericConfig,
ignoreControlIds,
mediaConfig,
modelId,
onewaySynonymsControlIds,
promoteControlIds,
rankingExpression,
redirectControlIds,
replacementControlIds,
solutionType,
synonymsControlIds,
updateTime;

projects_locations_data_stores_serving_configs_patch

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

UPDATE google.discoveryengine.serving_configs
SET 
data__name = '{{ name }}',
data__redirectControlIds = '{{ redirectControlIds }}',
data__synonymsControlIds = '{{ synonymsControlIds }}',
data__genericConfig = '{{ genericConfig }}',
data__mediaConfig = '{{ mediaConfig }}',
data__boostControlIds = '{{ boostControlIds }}',
data__ignoreControlIds = '{{ ignoreControlIds }}',
data__onewaySynonymsControlIds = '{{ onewaySynonymsControlIds }}',
data__solutionType = '{{ solutionType }}',
data__dissociateControlIds = '{{ dissociateControlIds }}',
data__rankingExpression = '{{ rankingExpression }}',
data__promoteControlIds = '{{ promoteControlIds }}',
data__diversityLevel = '{{ diversityLevel }}',
data__displayName = '{{ displayName }}',
data__modelId = '{{ modelId }}',
data__filterControlIds = '{{ filterControlIds }}',
data__answerGenerationSpec = '{{ answerGenerationSpec }}',
data__replacementControlIds = '{{ replacementControlIds }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dataStoresId = '{{ dataStoresId }}' --required
AND servingConfigsId = '{{ servingConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
answerGenerationSpec,
boostControlIds,
createTime,
displayName,
dissociateControlIds,
diversityLevel,
filterControlIds,
genericConfig,
ignoreControlIds,
mediaConfig,
modelId,
onewaySynonymsControlIds,
promoteControlIds,
rankingExpression,
redirectControlIds,
replacementControlIds,
solutionType,
synonymsControlIds,
updateTime;

DELETE examples

projects_locations_collections_engines_serving_configs_delete

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

DELETE FROM google.discoveryengine.serving_configs
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND collectionsId = '{{ collectionsId }}' --required
AND enginesId = '{{ enginesId }}' --required
AND servingConfigsId = '{{ servingConfigsId }}' --required
;

projects_locations_collections_data_stores_serving_configs_delete

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

DELETE FROM google.discoveryengine.serving_configs
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND collectionsId = '{{ collectionsId }}' --required
AND dataStoresId = '{{ dataStoresId }}' --required
AND servingConfigsId = '{{ servingConfigsId }}' --required
;

projects_locations_data_stores_serving_configs_delete

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

DELETE FROM google.discoveryengine.serving_configs
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dataStoresId = '{{ dataStoresId }}' --required
AND servingConfigsId = '{{ servingConfigsId }}' --required
;

Lifecycle Methods

projects_locations_collections_engines_serving_configs_search

Performs a search.

EXEC google.discoveryengine.serving_configs.projects_locations_collections_engines_serving_configs_search 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectionsId='{{ collectionsId }}' --required, 
@enginesId='{{ enginesId }}' --required, 
@servingConfigsId='{{ servingConfigsId }}' --required 
@@json=
'{
"displaySpec": "{{ displaySpec }}", 
"relevanceThreshold": "{{ relevanceThreshold }}", 
"imageQuery": "{{ imageQuery }}", 
"spellCorrectionSpec": "{{ spellCorrectionSpec }}", 
"safeSearch": {{ safeSearch }}, 
"queryExpansionSpec": "{{ queryExpansionSpec }}", 
"userPseudoId": "{{ userPseudoId }}", 
"rankingExpressionBackend": "{{ rankingExpressionBackend }}", 
"relevanceScoreSpec": "{{ relevanceScoreSpec }}", 
"session": "{{ session }}", 
"searchAsYouTypeSpec": "{{ searchAsYouTypeSpec }}", 
"dataStoreSpecs": "{{ dataStoreSpecs }}", 
"filter": "{{ filter }}", 
"boostSpec": "{{ boostSpec }}", 
"canonicalFilter": "{{ canonicalFilter }}", 
"params": "{{ params }}", 
"crowdingSpecs": "{{ crowdingSpecs }}", 
"userLabels": "{{ userLabels }}", 
"userInfo": "{{ userInfo }}", 
"contentSearchSpec": "{{ contentSearchSpec }}", 
"naturalLanguageQueryUnderstandingSpec": "{{ naturalLanguageQueryUnderstandingSpec }}", 
"query": "{{ query }}", 
"orderBy": "{{ orderBy }}", 
"oneBoxPageSize": {{ oneBoxPageSize }}, 
"pageToken": "{{ pageToken }}", 
"sessionSpec": "{{ sessionSpec }}", 
"rankingExpression": "{{ rankingExpression }}", 
"pageSize": {{ pageSize }}, 
"offset": {{ offset }}, 
"branch": "{{ branch }}", 
"pageCategories": "{{ pageCategories }}", 
"facetSpecs": "{{ facetSpecs }}", 
"languageCode": "{{ languageCode }}"
}'
;

projects_locations_collections_engines_serving_configs_stream_answer

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

EXEC google.discoveryengine.serving_configs.projects_locations_collections_engines_serving_configs_stream_answer 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectionsId='{{ collectionsId }}' --required, 
@enginesId='{{ enginesId }}' --required, 
@servingConfigsId='{{ servingConfigsId }}' --required 
@@json=
'{
"userLabels": "{{ userLabels }}", 
"searchSpec": "{{ searchSpec }}", 
"query": "{{ query }}", 
"endUserSpec": "{{ endUserSpec }}", 
"queryUnderstandingSpec": "{{ queryUnderstandingSpec }}", 
"relatedQuestionsSpec": "{{ relatedQuestionsSpec }}", 
"safetySpec": "{{ safetySpec }}", 
"asynchronousMode": {{ asynchronousMode }}, 
"session": "{{ session }}", 
"userPseudoId": "{{ userPseudoId }}", 
"groundingSpec": "{{ groundingSpec }}", 
"answerGenerationSpec": "{{ answerGenerationSpec }}"
}'
;

projects_locations_collections_engines_serving_configs_answer

Answer query method.

EXEC google.discoveryengine.serving_configs.projects_locations_collections_engines_serving_configs_answer 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectionsId='{{ collectionsId }}' --required, 
@enginesId='{{ enginesId }}' --required, 
@servingConfigsId='{{ servingConfigsId }}' --required 
@@json=
'{
"userLabels": "{{ userLabels }}", 
"searchSpec": "{{ searchSpec }}", 
"query": "{{ query }}", 
"endUserSpec": "{{ endUserSpec }}", 
"queryUnderstandingSpec": "{{ queryUnderstandingSpec }}", 
"relatedQuestionsSpec": "{{ relatedQuestionsSpec }}", 
"safetySpec": "{{ safetySpec }}", 
"asynchronousMode": {{ asynchronousMode }}, 
"session": "{{ session }}", 
"userPseudoId": "{{ userPseudoId }}", 
"groundingSpec": "{{ groundingSpec }}", 
"answerGenerationSpec": "{{ answerGenerationSpec }}"
}'
;

projects_locations_collections_engines_serving_configs_search_lite

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.

EXEC google.discoveryengine.serving_configs.projects_locations_collections_engines_serving_configs_search_lite 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectionsId='{{ collectionsId }}' --required, 
@enginesId='{{ enginesId }}' --required, 
@servingConfigsId='{{ servingConfigsId }}' --required 
@@json=
'{
"displaySpec": "{{ displaySpec }}", 
"relevanceThreshold": "{{ relevanceThreshold }}", 
"imageQuery": "{{ imageQuery }}", 
"spellCorrectionSpec": "{{ spellCorrectionSpec }}", 
"safeSearch": {{ safeSearch }}, 
"queryExpansionSpec": "{{ queryExpansionSpec }}", 
"userPseudoId": "{{ userPseudoId }}", 
"rankingExpressionBackend": "{{ rankingExpressionBackend }}", 
"relevanceScoreSpec": "{{ relevanceScoreSpec }}", 
"session": "{{ session }}", 
"searchAsYouTypeSpec": "{{ searchAsYouTypeSpec }}", 
"dataStoreSpecs": "{{ dataStoreSpecs }}", 
"filter": "{{ filter }}", 
"boostSpec": "{{ boostSpec }}", 
"canonicalFilter": "{{ canonicalFilter }}", 
"params": "{{ params }}", 
"crowdingSpecs": "{{ crowdingSpecs }}", 
"userLabels": "{{ userLabels }}", 
"userInfo": "{{ userInfo }}", 
"contentSearchSpec": "{{ contentSearchSpec }}", 
"naturalLanguageQueryUnderstandingSpec": "{{ naturalLanguageQueryUnderstandingSpec }}", 
"query": "{{ query }}", 
"orderBy": "{{ orderBy }}", 
"oneBoxPageSize": {{ oneBoxPageSize }}, 
"pageToken": "{{ pageToken }}", 
"sessionSpec": "{{ sessionSpec }}", 
"rankingExpression": "{{ rankingExpression }}", 
"pageSize": {{ pageSize }}, 
"offset": {{ offset }}, 
"branch": "{{ branch }}", 
"pageCategories": "{{ pageCategories }}", 
"facetSpecs": "{{ facetSpecs }}", 
"languageCode": "{{ languageCode }}"
}'
;

projects_locations_collections_engines_serving_configs_recommend

Makes a recommendation, which requires a contextual user event.

EXEC google.discoveryengine.serving_configs.projects_locations_collections_engines_serving_configs_recommend 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectionsId='{{ collectionsId }}' --required, 
@enginesId='{{ enginesId }}' --required, 
@servingConfigsId='{{ servingConfigsId }}' --required 
@@json=
'{
"pageSize": {{ pageSize }}, 
"filter": "{{ filter }}", 
"validateOnly": {{ validateOnly }}, 
"params": "{{ params }}", 
"userLabels": "{{ userLabels }}", 
"userEvent": "{{ userEvent }}"
}'
;

projects_locations_collections_data_stores_serving_configs_recommend

Makes a recommendation, which requires a contextual user event.

EXEC google.discoveryengine.serving_configs.projects_locations_collections_data_stores_serving_configs_recommend 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectionsId='{{ collectionsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required, 
@servingConfigsId='{{ servingConfigsId }}' --required 
@@json=
'{
"pageSize": {{ pageSize }}, 
"filter": "{{ filter }}", 
"validateOnly": {{ validateOnly }}, 
"params": "{{ params }}", 
"userLabels": "{{ userLabels }}", 
"userEvent": "{{ userEvent }}"
}'
;

projects_locations_collections_data_stores_serving_configs_search

Performs a search.

EXEC google.discoveryengine.serving_configs.projects_locations_collections_data_stores_serving_configs_search 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectionsId='{{ collectionsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required, 
@servingConfigsId='{{ servingConfigsId }}' --required 
@@json=
'{
"displaySpec": "{{ displaySpec }}", 
"relevanceThreshold": "{{ relevanceThreshold }}", 
"imageQuery": "{{ imageQuery }}", 
"spellCorrectionSpec": "{{ spellCorrectionSpec }}", 
"safeSearch": {{ safeSearch }}, 
"queryExpansionSpec": "{{ queryExpansionSpec }}", 
"userPseudoId": "{{ userPseudoId }}", 
"rankingExpressionBackend": "{{ rankingExpressionBackend }}", 
"relevanceScoreSpec": "{{ relevanceScoreSpec }}", 
"session": "{{ session }}", 
"searchAsYouTypeSpec": "{{ searchAsYouTypeSpec }}", 
"dataStoreSpecs": "{{ dataStoreSpecs }}", 
"filter": "{{ filter }}", 
"boostSpec": "{{ boostSpec }}", 
"canonicalFilter": "{{ canonicalFilter }}", 
"params": "{{ params }}", 
"crowdingSpecs": "{{ crowdingSpecs }}", 
"userLabels": "{{ userLabels }}", 
"userInfo": "{{ userInfo }}", 
"contentSearchSpec": "{{ contentSearchSpec }}", 
"naturalLanguageQueryUnderstandingSpec": "{{ naturalLanguageQueryUnderstandingSpec }}", 
"query": "{{ query }}", 
"orderBy": "{{ orderBy }}", 
"oneBoxPageSize": {{ oneBoxPageSize }}, 
"pageToken": "{{ pageToken }}", 
"sessionSpec": "{{ sessionSpec }}", 
"rankingExpression": "{{ rankingExpression }}", 
"pageSize": {{ pageSize }}, 
"offset": {{ offset }}, 
"branch": "{{ branch }}", 
"pageCategories": "{{ pageCategories }}", 
"facetSpecs": "{{ facetSpecs }}", 
"languageCode": "{{ languageCode }}"
}'
;

projects_locations_collections_data_stores_serving_configs_answer

Answer query method.

EXEC google.discoveryengine.serving_configs.projects_locations_collections_data_stores_serving_configs_answer 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectionsId='{{ collectionsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required, 
@servingConfigsId='{{ servingConfigsId }}' --required 
@@json=
'{
"userLabels": "{{ userLabels }}", 
"searchSpec": "{{ searchSpec }}", 
"query": "{{ query }}", 
"endUserSpec": "{{ endUserSpec }}", 
"queryUnderstandingSpec": "{{ queryUnderstandingSpec }}", 
"relatedQuestionsSpec": "{{ relatedQuestionsSpec }}", 
"safetySpec": "{{ safetySpec }}", 
"asynchronousMode": {{ asynchronousMode }}, 
"session": "{{ session }}", 
"userPseudoId": "{{ userPseudoId }}", 
"groundingSpec": "{{ groundingSpec }}", 
"answerGenerationSpec": "{{ answerGenerationSpec }}"
}'
;

projects_locations_collections_data_stores_serving_configs_stream_answer

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

EXEC google.discoveryengine.serving_configs.projects_locations_collections_data_stores_serving_configs_stream_answer 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectionsId='{{ collectionsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required, 
@servingConfigsId='{{ servingConfigsId }}' --required 
@@json=
'{
"userLabels": "{{ userLabels }}", 
"searchSpec": "{{ searchSpec }}", 
"query": "{{ query }}", 
"endUserSpec": "{{ endUserSpec }}", 
"queryUnderstandingSpec": "{{ queryUnderstandingSpec }}", 
"relatedQuestionsSpec": "{{ relatedQuestionsSpec }}", 
"safetySpec": "{{ safetySpec }}", 
"asynchronousMode": {{ asynchronousMode }}, 
"session": "{{ session }}", 
"userPseudoId": "{{ userPseudoId }}", 
"groundingSpec": "{{ groundingSpec }}", 
"answerGenerationSpec": "{{ answerGenerationSpec }}"
}'
;

projects_locations_collections_data_stores_serving_configs_search_lite

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.

EXEC google.discoveryengine.serving_configs.projects_locations_collections_data_stores_serving_configs_search_lite 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectionsId='{{ collectionsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required, 
@servingConfigsId='{{ servingConfigsId }}' --required 
@@json=
'{
"displaySpec": "{{ displaySpec }}", 
"relevanceThreshold": "{{ relevanceThreshold }}", 
"imageQuery": "{{ imageQuery }}", 
"spellCorrectionSpec": "{{ spellCorrectionSpec }}", 
"safeSearch": {{ safeSearch }}, 
"queryExpansionSpec": "{{ queryExpansionSpec }}", 
"userPseudoId": "{{ userPseudoId }}", 
"rankingExpressionBackend": "{{ rankingExpressionBackend }}", 
"relevanceScoreSpec": "{{ relevanceScoreSpec }}", 
"session": "{{ session }}", 
"searchAsYouTypeSpec": "{{ searchAsYouTypeSpec }}", 
"dataStoreSpecs": "{{ dataStoreSpecs }}", 
"filter": "{{ filter }}", 
"boostSpec": "{{ boostSpec }}", 
"canonicalFilter": "{{ canonicalFilter }}", 
"params": "{{ params }}", 
"crowdingSpecs": "{{ crowdingSpecs }}", 
"userLabels": "{{ userLabels }}", 
"userInfo": "{{ userInfo }}", 
"contentSearchSpec": "{{ contentSearchSpec }}", 
"naturalLanguageQueryUnderstandingSpec": "{{ naturalLanguageQueryUnderstandingSpec }}", 
"query": "{{ query }}", 
"orderBy": "{{ orderBy }}", 
"oneBoxPageSize": {{ oneBoxPageSize }}, 
"pageToken": "{{ pageToken }}", 
"sessionSpec": "{{ sessionSpec }}", 
"rankingExpression": "{{ rankingExpression }}", 
"pageSize": {{ pageSize }}, 
"offset": {{ offset }}, 
"branch": "{{ branch }}", 
"pageCategories": "{{ pageCategories }}", 
"facetSpecs": "{{ facetSpecs }}", 
"languageCode": "{{ languageCode }}"
}'
;

projects_locations_data_stores_serving_configs_search

Performs a search.

EXEC google.discoveryengine.serving_configs.projects_locations_data_stores_serving_configs_search 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required, 
@servingConfigsId='{{ servingConfigsId }}' --required 
@@json=
'{
"displaySpec": "{{ displaySpec }}", 
"relevanceThreshold": "{{ relevanceThreshold }}", 
"imageQuery": "{{ imageQuery }}", 
"spellCorrectionSpec": "{{ spellCorrectionSpec }}", 
"safeSearch": {{ safeSearch }}, 
"queryExpansionSpec": "{{ queryExpansionSpec }}", 
"userPseudoId": "{{ userPseudoId }}", 
"rankingExpressionBackend": "{{ rankingExpressionBackend }}", 
"relevanceScoreSpec": "{{ relevanceScoreSpec }}", 
"session": "{{ session }}", 
"searchAsYouTypeSpec": "{{ searchAsYouTypeSpec }}", 
"dataStoreSpecs": "{{ dataStoreSpecs }}", 
"filter": "{{ filter }}", 
"boostSpec": "{{ boostSpec }}", 
"canonicalFilter": "{{ canonicalFilter }}", 
"params": "{{ params }}", 
"crowdingSpecs": "{{ crowdingSpecs }}", 
"userLabels": "{{ userLabels }}", 
"userInfo": "{{ userInfo }}", 
"contentSearchSpec": "{{ contentSearchSpec }}", 
"naturalLanguageQueryUnderstandingSpec": "{{ naturalLanguageQueryUnderstandingSpec }}", 
"query": "{{ query }}", 
"orderBy": "{{ orderBy }}", 
"oneBoxPageSize": {{ oneBoxPageSize }}, 
"pageToken": "{{ pageToken }}", 
"sessionSpec": "{{ sessionSpec }}", 
"rankingExpression": "{{ rankingExpression }}", 
"pageSize": {{ pageSize }}, 
"offset": {{ offset }}, 
"branch": "{{ branch }}", 
"pageCategories": "{{ pageCategories }}", 
"facetSpecs": "{{ facetSpecs }}", 
"languageCode": "{{ languageCode }}"
}'
;

projects_locations_data_stores_serving_configs_recommend

Makes a recommendation, which requires a contextual user event.

EXEC google.discoveryengine.serving_configs.projects_locations_data_stores_serving_configs_recommend 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required, 
@servingConfigsId='{{ servingConfigsId }}' --required 
@@json=
'{
"pageSize": {{ pageSize }}, 
"filter": "{{ filter }}", 
"validateOnly": {{ validateOnly }}, 
"params": "{{ params }}", 
"userLabels": "{{ userLabels }}", 
"userEvent": "{{ userEvent }}"
}'
;

projects_locations_data_stores_serving_configs_stream_answer

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

EXEC google.discoveryengine.serving_configs.projects_locations_data_stores_serving_configs_stream_answer 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required, 
@servingConfigsId='{{ servingConfigsId }}' --required 
@@json=
'{
"userLabels": "{{ userLabels }}", 
"searchSpec": "{{ searchSpec }}", 
"query": "{{ query }}", 
"endUserSpec": "{{ endUserSpec }}", 
"queryUnderstandingSpec": "{{ queryUnderstandingSpec }}", 
"relatedQuestionsSpec": "{{ relatedQuestionsSpec }}", 
"safetySpec": "{{ safetySpec }}", 
"asynchronousMode": {{ asynchronousMode }}, 
"session": "{{ session }}", 
"userPseudoId": "{{ userPseudoId }}", 
"groundingSpec": "{{ groundingSpec }}", 
"answerGenerationSpec": "{{ answerGenerationSpec }}"
}'
;

projects_locations_data_stores_serving_configs_answer

Answer query method.

EXEC google.discoveryengine.serving_configs.projects_locations_data_stores_serving_configs_answer 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required, 
@servingConfigsId='{{ servingConfigsId }}' --required 
@@json=
'{
"userLabels": "{{ userLabels }}", 
"searchSpec": "{{ searchSpec }}", 
"query": "{{ query }}", 
"endUserSpec": "{{ endUserSpec }}", 
"queryUnderstandingSpec": "{{ queryUnderstandingSpec }}", 
"relatedQuestionsSpec": "{{ relatedQuestionsSpec }}", 
"safetySpec": "{{ safetySpec }}", 
"asynchronousMode": {{ asynchronousMode }}, 
"session": "{{ session }}", 
"userPseudoId": "{{ userPseudoId }}", 
"groundingSpec": "{{ groundingSpec }}", 
"answerGenerationSpec": "{{ answerGenerationSpec }}"
}'
;

projects_locations_data_stores_serving_configs_search_lite

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.

EXEC google.discoveryengine.serving_configs.projects_locations_data_stores_serving_configs_search_lite 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required, 
@servingConfigsId='{{ servingConfigsId }}' --required 
@@json=
'{
"displaySpec": "{{ displaySpec }}", 
"relevanceThreshold": "{{ relevanceThreshold }}", 
"imageQuery": "{{ imageQuery }}", 
"spellCorrectionSpec": "{{ spellCorrectionSpec }}", 
"safeSearch": {{ safeSearch }}, 
"queryExpansionSpec": "{{ queryExpansionSpec }}", 
"userPseudoId": "{{ userPseudoId }}", 
"rankingExpressionBackend": "{{ rankingExpressionBackend }}", 
"relevanceScoreSpec": "{{ relevanceScoreSpec }}", 
"session": "{{ session }}", 
"searchAsYouTypeSpec": "{{ searchAsYouTypeSpec }}", 
"dataStoreSpecs": "{{ dataStoreSpecs }}", 
"filter": "{{ filter }}", 
"boostSpec": "{{ boostSpec }}", 
"canonicalFilter": "{{ canonicalFilter }}", 
"params": "{{ params }}", 
"crowdingSpecs": "{{ crowdingSpecs }}", 
"userLabels": "{{ userLabels }}", 
"userInfo": "{{ userInfo }}", 
"contentSearchSpec": "{{ contentSearchSpec }}", 
"naturalLanguageQueryUnderstandingSpec": "{{ naturalLanguageQueryUnderstandingSpec }}", 
"query": "{{ query }}", 
"orderBy": "{{ orderBy }}", 
"oneBoxPageSize": {{ oneBoxPageSize }}, 
"pageToken": "{{ pageToken }}", 
"sessionSpec": "{{ sessionSpec }}", 
"rankingExpression": "{{ rankingExpression }}", 
"pageSize": {{ pageSize }}, 
"offset": {{ offset }}, 
"branch": "{{ branch }}", 
"pageCategories": "{{ pageCategories }}", 
"facetSpecs": "{{ facetSpecs }}", 
"languageCode": "{{ languageCode }}"
}'
;