Resource: ServingConfig
Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.
JSON representation |
---|
{ "name": string, "displayName": string, "solutionType": enum ( |
Fields | |
---|---|
name |
Immutable. Fully qualified name |
display |
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. |
solution |
Required. Immutable. Specifies the solution type that a serving config can be associated with. |
model |
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 |
diversity |
How much diversity to use in recommendation model results e.g.
If not specified, we choose default based on recommendation model type. Default value: Can only be set if |
embedding |
Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of |
ranking |
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 The ranking expression is a single function or multiple functions that are joined by "+".
Supported functions:
Function variables:
Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be |
create |
Output only. ServingConfig created timestamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
update |
Output only. ServingConfig updated timestamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
filter |
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. |
boost |
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. |
redirect |
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 |
synonyms |
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 |
oneway |
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 |
dissociate |
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 |
replacement |
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 |
ignore |
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. |
personalization |
The specification for personalization spec. Notice that if both |
Union field vertical_config . Industry vertical specific config. vertical_config can be only one of the following: |
|
media |
The MediaConfig of the serving configuration. |
generic |
The GenericConfig of the serving configuration. |
Methods |
|
---|---|
|
Answer query method. |
|
Gets a ServingConfig. |
|
Lists all ServingConfigs linked to this dataStore. |
|
Updates a ServingConfig. |
|
Makes a recommendation, which requires a contextual user event. |
|
Performs a search. |
|
Performs a search. |