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

Ressource : ServingConfig

Configure les métadonnées utilisées pour générer les résultats au moment de la diffusion (par exemple, les résultats de recherche ou les prédictions de recommandation). ServingConfig est transmis 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,
  "embeddingConfig": {
    object (EmbeddingConfig)
  },
  "rankingExpression": string,
  "createTime": string,
  "updateTime": string,
  "filterControlIds": [
    string
  ],
  "boostControlIds": [
    string
  ],
  "redirectControlIds": [
    string
  ],
  "synonymsControlIds": [
    string
  ],
  "onewaySynonymsControlIds": [
    string
  ],
  "dissociateControlIds": [
    string
  ],
  "replacementControlIds": [
    string
  ],
  "ignoreControlIds": [
    string
  ],
  "promoteControlIds": [
    string
  ],
  "personalizationSpec": {
    object (PersonalizationSpec)
  },
  "answerGenerationSpec": {
    object (AnswerGenerationSpec)
  },

  // Union field vertical_config can be only one of the following:
  "mediaConfig": {
    object (MediaConfig)
  },
  "genericConfig": {
    object (GenericConfig)
  }
  // End of list of possible types for union field vertical_config.
}
Champs
name

string

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

string

Obligatoire. Nom à afficher de la configuration de diffusion, lisible par l'utilisateur. Utilisé dans l'UI Discovery.

Ce champ doit être une chaîne encodée au format UTF-8 et ne doit pas dépasser 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. Pour le moment, seuls les RecommendationModels sont acceptés. Peut être modifié, mais uniquement pour un modèle compatible (par exemple, "Autres susceptibles de vous plaire" CTR vers "Autres susceptibles de vous plaire" CVR).

Obligatoire lorsque SolutionType est défini sur SOLUTION_TYPE_RECOMMENDATION.
diversityLevel

string

Le degré de diversité à utiliser dans les résultats du modèle de recommandation (par exemple, medium-diversity ou high-diversity). Valeurs actuellement acceptées :

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

Si ce paramètre n'est pas spécifié, nous choisissons une 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.
embeddingConfig

object (EmbeddingConfig)

Utilisez votre propre configuration d'intégration. La configuration est utilisée pour la récupération sémantique de la recherche. La récupération est basée sur le produit scalaire de SearchRequest.EmbeddingSpec.EmbeddingVector.vector et des embeddings de document fournis par cette EmbeddingConfig. Si SearchRequest.EmbeddingSpec.EmbeddingVector.vector est fourni, il remplace ce ServingConfig.embedding_config.
rankingExpression

string

L'expression de classement contrôle le classement personnalisé des documents récupérés. Pour ce faire, l'intégration de documents est nécessaire. 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 un signe "+".

  • 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 la requête.

Exemple d'expression de classement :

Si le document comporte un champ d'intégration 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. Horodatage 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

Filtrez les contrôles à utiliser dans le chemin de diffusion. Tous les contrôles de filtre déclenchés seront appliqués. Les commandes de filtrage doivent se trouver dans le même data store que la configuration de diffusion. 20 sélecteurs de filtre maximum.
boostControlIds[]

string

Contrôles d'amplification à utiliser dans le chemin de diffusion. Tous les contrôles de boost déclenchés seront appliqués. Les contrôles d'amplification doivent se trouver dans le même data store que la configuration de diffusion. Vous pouvez ajouter jusqu'à 20 commandes de boosting.
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. Le nombre maximal de spécifications est de 100.

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

string

Spécifications des synonymes de conditions. Si plusieurs conditions de synonymes correspondent, tous les contrôles de synonymes correspondants de la liste seront exécutés. Le nombre maximal de spécifications est de 100.

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

string

Spécifications des synonymes unidirectionnels de conditions. Si plusieurs conditions de synonymes unidirectionnels correspondent, tous les contrôles de synonymes unidirectionnels correspondants de la liste seront exécutés. Le nombre maximal de spécifications est de 100.

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

string

La condition n'associe pas de spécifications. 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. Le nombre maximal de spécifications est de 100.

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

string

Spécifications de remplacement des conditions. Elles sont appliquées dans l'ordre indiqué dans la liste. Un terme déjà remplacé ne peut pas l'être à nouveau. Le nombre maximal de spécifications est de 100.

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

string

Spécifications d'ignorance de la condition. Si plusieurs conditions d'ignorance correspondent, tous les contrôles d'ignorance correspondants de la liste seront exécutés. L'ordre n'a pas d'importance. Le nombre maximal de spécifications est de 100.
promoteControlIds[]

string

Spécifications de la promotion conditionnelle.

Le nombre maximal de spécifications est de 100.
personalizationSpec

object (PersonalizationSpec)

Spécification pour la personnalisation.

Notez que si ServingConfig.personalization_spec et SearchRequest.personalization_spec sont définis, SearchRequest.personalization_spec remplace ServingConfig.personalization_spec.
answerGenerationSpec

object (AnswerGenerationSpec)

Facultatif. Spécification pour la génération de réponses.
Champ d'union vertical_config. Configuration spécifique au secteur d'activité. vertical_config ne peut être qu'un des éléments suivants :
mediaConfig

object (MediaConfig)

MediaConfig de la configuration de diffusion.
genericConfig

object (GenericConfig)

GenericConfig de la configuration de diffusion.

Méthodes

answer

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

get

 Permet d'obtenir une instance ServingConfig.

list

 Liste toutes les ServingConfigs associées à ce datastore.

patch

 Met à jour un ServingConfig.

recommend

 Effectue une recommandation, 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).