REST Resource: projects.locations.collections.engines.servingConfigs

Ressource : ServingConfig

Configure les métadonnées utilisées pour générer des résultats au moment de la diffusion (par exemple, des résultats de recherche ou des prédictions de recommandations). La ServingConfig est transmise dans la requête de recherche et de prédiction, et génère des résultats.

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "solutionType": enum (SolutionType),
  "modelId": string,
  "diversityLevel": string,
  "rankingExpression": string,
  "createTime": string,
  "updateTime": string,
  "filterControlIds": [
    string
  ],
  "boostControlIds": [
    string
  ],
  "redirectControlIds": [
    string
  ],
  "synonymsControlIds": [
    string
  ],
  "onewaySynonymsControlIds": [
    string
  ],
  "dissociateControlIds": [
    string
  ],
  "replacementControlIds": [
    string
  ],
  "ignoreControlIds": [
    string
  ],
  "promoteControlIds": [
    string
  ],
  "answerGenerationSpec": {
    object (AnswerGenerationSpec)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "mediaConfig": {
    object (MediaConfig)
  },
  "genericConfig": {
    object (GenericConfig)
  }
  // End of mutually exclusive fields.
}
Champs
name

string

Immuable. Nom complet : projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}/servingConfigs/{servingConfigId}
displayName

string

Obligatoire. Nom d'affichage de la configuration de diffusion, lisible par l'humain. Utilisé dans l'UI Discovery.

Ce champ doit être une chaîne encodée au format UTF-8 d'une longueur maximale de 128 caractères. Dans le cas contraire, une erreur INVALID_ARGUMENT est renvoyée.
solutionType

enum (SolutionType)

Obligatoire. Immuable. Spécifie le type de solution auquel une configuration de diffusion peut être associée.
modelId

string

ID du modèle à utiliser au moment de la diffusion. Actuellement, seuls les RecommendationModels sont compatibles. Peut être modifié, mais uniquement pour un modèle compatible (par exemple, le CTR "Autres articles susceptibles de vous intéresser" peut être remplacé par le CVR "Autres articles susceptibles de vous intéresser").

Obligatoire lorsque SolutionType est SOLUTION_TYPE_RECOMMENDATION.
diversityLevel

string

Niveau de diversité à utiliser dans les résultats du modèle de recommandation, par exemple medium-diversity ou high-diversity. Valeurs actuellement compatibles :

  • no-diversity
  • low-diversity
  • medium-diversity
  • high-diversity
  • auto-diversity

Si aucune valeur n'est spécifiée, nous choisissons la valeur par défaut en fonction du type de modèle de recommandation. Valeur par défaut : no-diversity.

Ne peut être défini que si SolutionType est SOLUTION_TYPE_RECOMMENDATION.
rankingExpression

string

L'expression de classement contrôle le classement personnalisé des documents récupérés. Pour en tirer parti, l'embedding de document est obligatoire. Le paramètre d'expression de classement dans ServingConfig s'applique à toutes les requêtes de recherche traitées par la configuration de diffusion. Toutefois, si SearchRequest.ranking_expression est spécifié, il remplace l'expression de classement ServingConfig.

L'expression de classement est une fonction unique ou plusieurs fonctions jointes par "+".

  • rankingExpression = function, { " + ", function };

Fonctions compatibles :

  • double * relevanceScore
  • double * dotProduct(embedding_field_path)

Variables de fonction :

  • relevanceScore : mots clés prédéfinis, utilisés pour mesurer la pertinence entre la requête et le document.
  • embedding_field_path : champ d'embedding de document utilisé avec le vecteur d'embedding de requête.
  • dotProduct : fonction d'embedding entre embedding_field_path et le vecteur d'embedding de requête.

Exemple d'expression de classement :

Si le document comporte un champ d'embedding doc_embedding, l'expression de classement peut être 0.5 * relevanceScore + 0.3 * dotProduct(doc_embedding).
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de création de ServingConfig.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de mise à jour de ServingConfig.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
filterControlIds[]

string

Commandes de filtrage à utiliser dans le chemin de diffusion. Toutes les commandes de filtrage déclenchées seront appliquées. Les commandes de filtrage doivent se trouver dans le même data store que la configuration de diffusion. 20 commandes de filtrage maximum.
boostControlIds[]

string

Commandes de boost à utiliser dans le chemin de diffusion. Toutes les commandes de boost déclenchées seront appliquées. Les commandes de boost doivent se trouver dans le même data store que la configuration de diffusion. 20 commandes de boost maximum.
redirectControlIds[]

string

ID des commandes de redirection. Seule la première action de redirection déclenchée est appliquée, même si plusieurs s'appliquent. Nombre maximal de spécifications : 100.

Ne peut être défini que si SolutionType est SOLUTION_TYPE_SEARCH.
synonymsControlIds[]

string

Spécifications des synonymes de condition. Si plusieurs conditions de synonymes correspondent, toutes les commandes de synonymes correspondantes de la liste seront exécutées. Nombre maximal de spécifications : 100.

Ne peut être défini que si SolutionType est SOLUTION_TYPE_SEARCH.
onewaySynonymsControlIds[]

string

Spécifications des synonymes unidirectionnels de condition. Si plusieurs conditions de synonymes unidirectionnels correspondent, toutes les commandes de synonymes unidirectionnels correspondantes de la liste seront exécutées. Nombre maximal de spécifications : 100.

Ne peut être défini que si SolutionType est SOLUTION_TYPE_SEARCH.
dissociateControlIds[]

string

Spécifications des conditions de non-association. Si plusieurs conditions de non-association correspondent, toutes les commandes de non-association correspondantes de la liste seront exécutées. L'ordre n'a pas d'importance. Nombre maximal de spécifications : 100.

Ne peut être défini que si SolutionType est SOLUTION_TYPE_SEARCH.
replacementControlIds[]

string

Spécifications des conditions de remplacement. Appliquées selon l'ordre de la liste. Un terme précédemment remplacé ne peut pas être remplacé à nouveau. Nombre maximal de spécifications : 100.

Ne peut être défini que si SolutionType est SOLUTION_TYPE_SEARCH.
ignoreControlIds[]

string

Spécifications des conditions d'ignorance. Si plusieurs conditions d'ignorance correspondent, toutes les commandes d'ignorance correspondantes de la liste seront exécutées. L'ordre n'a pas d'importance. Nombre maximal de spécifications : 100.
promoteControlIds[]

string

Spécifications des conditions de promotion.

Nombre maximal de spécifications : 100.
answerGenerationSpec

object (AnswerGenerationSpec)

Facultatif. Spécification pour la génération de réponses.
Configuration spécifique à la verticale d'activité. Voici une liste de champs mutuellement exclusifs. Au maximum, un seul de ces champs sera défini dans une réponse :
mediaConfig

object (MediaConfig)

MediaConfig de la configuration de diffusion.
genericConfig

object (GenericConfig)

GenericConfig de la configuration de diffusion.
Fin des champs mutuellement exclusifs.

Méthodes

answer

 Méthode de requête de réponse.

create

 Crée une ServingConfig.

delete

 Supprime une ServingConfig.

get

 Obtient une ServingConfig.

list

 Répertorie toutes les ServingConfigs associées à ce dataStore.

patch

 Met à jour une ServingConfig.

recommend

 Fait une recommandation, ce qui nécessite un événement utilisateur contextuel.
Effectue une recherche.

searchLite

 Effectue une recherche.

streamAnswer

 Méthode de requête de réponse (streaming).