Skip to main content

serving_configs

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

Overview​

Nameserving_configs
TypeResource
Idgoogle.discoveryengine.serving_configs

Fields​

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
projects_locations_collections_data_stores_serving_configs_patchupdateprojectsId, locationsId, collectionsId, dataStoresId, servingConfigsIdupdateMaskUpdates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
projects_locations_collections_engines_serving_configs_patchupdateprojectsId, locationsId, collectionsId, enginesId, servingConfigsIdupdateMaskUpdates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
projects_locations_data_stores_serving_configs_patchupdateprojectsId, locationsId, dataStoresId, servingConfigsIdupdateMaskUpdates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
projects_locations_collections_data_stores_serving_configs_searchexecprojectsId, locationsId, collectionsId, dataStoresId, servingConfigsIdPerforms a search.
projects_locations_collections_data_stores_serving_configs_search_liteexecprojectsId, locationsId, collectionsId, dataStoresId, servingConfigsIdPerforms 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_data_stores_serving_configs_answerexecprojectsId, locationsId, collectionsId, dataStoresId, servingConfigsIdAnswer query method.
projects_locations_collections_data_stores_serving_configs_stream_answerexecprojectsId, locationsId, collectionsId, dataStoresId, servingConfigsIdAnswer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.
projects_locations_collections_data_stores_serving_configs_recommendexecprojectsId, locationsId, collectionsId, dataStoresId, servingConfigsIdMakes a recommendation, which requires a contextual user event.
projects_locations_collections_engines_serving_configs_searchexecprojectsId, locationsId, collectionsId, enginesId, servingConfigsIdPerforms a search.
projects_locations_collections_engines_serving_configs_search_liteexecprojectsId, locationsId, collectionsId, enginesId, servingConfigsIdPerforms 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_answerexecprojectsId, locationsId, collectionsId, enginesId, servingConfigsIdAnswer query method.
projects_locations_collections_engines_serving_configs_stream_answerexecprojectsId, locationsId, collectionsId, enginesId, servingConfigsIdAnswer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.
projects_locations_collections_engines_serving_configs_recommendexecprojectsId, locationsId, collectionsId, enginesId, servingConfigsIdMakes a recommendation, which requires a contextual user event.
projects_locations_data_stores_serving_configs_searchexecprojectsId, locationsId, dataStoresId, servingConfigsIdPerforms a search.
projects_locations_data_stores_serving_configs_search_liteexecprojectsId, locationsId, dataStoresId, servingConfigsIdPerforms 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_answerexecprojectsId, locationsId, dataStoresId, servingConfigsIdAnswer query method.
projects_locations_data_stores_serving_configs_stream_answerexecprojectsId, locationsId, dataStoresId, servingConfigsIdAnswer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream.
projects_locations_data_stores_serving_configs_recommendexecprojectsId, locationsId, dataStoresId, servingConfigsIdMakes a recommendation, which requires a contextual user event.

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.

NameDatatypeDescription
collectionsIdstring
dataStoresIdstring
enginesIdstring
locationsIdstring
projectsIdstring
servingConfigsIdstring
updateMaskstring (google-fieldmask)

UPDATE examples​

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

UPDATE google.discoveryengine.serving_configs
SET 
data__mediaConfig = '{{ mediaConfig }}',
data__genericConfig = '{{ genericConfig }}',
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__solutionType = '{{ solutionType }}',
data__modelId = '{{ modelId }}',
data__diversityLevel = '{{ diversityLevel }}',
data__rankingExpression = '{{ rankingExpression }}',
data__filterControlIds = '{{ filterControlIds }}',
data__boostControlIds = '{{ boostControlIds }}',
data__redirectControlIds = '{{ redirectControlIds }}',
data__synonymsControlIds = '{{ synonymsControlIds }}',
data__onewaySynonymsControlIds = '{{ onewaySynonymsControlIds }}',
data__dissociateControlIds = '{{ dissociateControlIds }}',
data__replacementControlIds = '{{ replacementControlIds }}',
data__ignoreControlIds = '{{ ignoreControlIds }}',
data__promoteControlIds = '{{ promoteControlIds }}',
data__answerGenerationSpec = '{{ answerGenerationSpec }}'
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;

Lifecycle Methods​

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=
'{
"branch": "{{ branch }}", 
"query": "{{ query }}", 
"imageQuery": "{{ imageQuery }}", 
"pageSize": {{ pageSize }}, 
"pageToken": "{{ pageToken }}", 
"offset": {{ offset }}, 
"oneBoxPageSize": {{ oneBoxPageSize }}, 
"dataStoreSpecs": "{{ dataStoreSpecs }}", 
"filter": "{{ filter }}", 
"canonicalFilter": "{{ canonicalFilter }}", 
"orderBy": "{{ orderBy }}", 
"userInfo": "{{ userInfo }}", 
"languageCode": "{{ languageCode }}", 
"facetSpecs": "{{ facetSpecs }}", 
"boostSpec": "{{ boostSpec }}", 
"params": "{{ params }}", 
"queryExpansionSpec": "{{ queryExpansionSpec }}", 
"spellCorrectionSpec": "{{ spellCorrectionSpec }}", 
"userPseudoId": "{{ userPseudoId }}", 
"contentSearchSpec": "{{ contentSearchSpec }}", 
"rankingExpression": "{{ rankingExpression }}", 
"rankingExpressionBackend": "{{ rankingExpressionBackend }}", 
"safeSearch": {{ safeSearch }}, 
"userLabels": "{{ userLabels }}", 
"searchAsYouTypeSpec": "{{ searchAsYouTypeSpec }}", 
"displaySpec": "{{ displaySpec }}", 
"session": "{{ session }}", 
"sessionSpec": "{{ sessionSpec }}", 
"relevanceThreshold": "{{ relevanceThreshold }}", 
"relevanceScoreSpec": "{{ relevanceScoreSpec }}"
}';