REST Resource: projects.locations.collections.dataStores.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 recommandations). 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,
  "guidedSearchSpec": {
    object (GuidedSearchSpec)
  },
  "customFineTuningSpec": {
    object (CustomFineTuningSpec)
  },
  "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 mise en service, lisible par l'utilisateur. Utilisé dans l'UI Discovery.

Ce champ doit être une chaîne encodée en UTF-8 d'une longueur maximale de 128 caractères. Sinon, 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 lors de la diffusion. Actuellement, 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 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).
guidedSearchSpec

object (GuidedSearchSpec)

Configurations de la recherche guidée.
customFineTuningSpec

object (CustomFineTuningSpec)

Configurations de réglage fin personnalisées. Si SearchRequest.custom_fine_tuning_spec est défini, il est prioritaire sur les configurations définies ici.
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 la dernière 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

Contrôles de filtrage à 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 d'amplification 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. Maximum de 20 contrôles d'amplification.
redirectControlIds[]

string

ID des contrôles 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 la condition. Si plusieurs conditions de synonymes unidirectionnels correspondent, toutes les commandes de synonymes unidirectionnels correspondantes de la liste seront exécutées. 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 s'exécutent. 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 des conditions. 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 à la verticale 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.

MediaConfig

Spécifie les configurations requises pour la découverte de contenus multimédias. Nous acceptons actuellement les éléments suivants :

  • demote_content_watched : seuil de rétrogradation du contenu regardé. Les clients peuvent spécifier s'ils utilisent la rétrogradation du contenu regardé ou la page d'informations consultée. Avec la rétrogradation du contenu regardé, les clients doivent spécifier si les minutes ou le pourcentage de contenu regardé dépassent le seuil. Si c'est le cas, le contenu sera rétrogradé dans les résultats de recommandation.
  • promote_fresh_content : nombre de jours au-delà duquel le contenu n'est plus considéré comme récent et n'est donc plus promu. Les clients peuvent spécifier cette valeur s'ils utilisent la promotion de contenu récent. Si le contenu a été publié au cours des jours spécifiés, il sera promu dans le résultat de la recommandation. Cette valeur ne peut être définie que si SolutionType est défini sur SOLUTION_TYPE_RECOMMENDATION.
Représentation JSON 
{
  "demotionEventType": string,
  "demoteContentWatchedPastDays": integer,
  "contentFreshnessCutoffDays": integer,

  // Union field demote_content_watched can be only one of the following:
  "contentWatchedPercentageThreshold": number,
  "contentWatchedSecondsThreshold": number
  // End of list of possible types for union field demote_content_watched.
}
Champs
demotionEventType

string

Spécifie le type d'événement utilisé pour rétrograder le résultat de la recommandation. Valeurs actuellement acceptées :

  • view-item : l'élément a été consulté.
  • media-play : démarrer/reprendre la lecture d'une vidéo, d'un titre, etc.
  • media-complete : vidéo, chanson, etc. terminée ou arrêtée à mi-parcours.

Si cette règle n'est pas configurée, la rétrogradation de l'historique des vidéos regardées ne sera pas appliquée. La rétrogradation de la fraîcheur du contenu sera toujours appliquée.
demoteContentWatchedPastDays

integer

Facultatif. Indique le nombre de jours à remonter pour rétrograder le contenu regardé. Si la valeur est définie sur zéro ou n'est pas définie, la valeur par défaut est de 365 jours.
contentFreshnessCutoffDays

integer

Spécifie la fraîcheur du contenu utilisée pour le résultat de la recommandation. Les contenus seront rétrogradés s'ils ont été publiés depuis plus de jours que la limite de fraîcheur du contenu.
Champ d'union demote_content_watched. Spécifiez le seuil de rétrogradation du contenu regardé. Il peut s'agir d'un pourcentage ou d'une valeur en minutes. Cette valeur doit être définie pour le type d'événement media-complete. La demote_content_watched ne peut être qu'un des éléments suivants :
contentWatchedPercentageThreshold

number

Spécifie le seuil de pourcentage de contenu regardé pour la rétrogradation. La valeur du seuil doit être comprise entre 0 et 1, 0 (inclus).
contentWatchedSecondsThreshold

number

Spécifie le seuil de minutes de visionnage pour la rétrogradation.

GenericConfig

Spécifie les configurations requises pour la découverte générique.Actuellement, nous acceptons les configurations suivantes :

  • contentSearchSpec : configuration pour la recherche de contenu générique.
Représentation JSON 
{
  "contentSearchSpec": {
    object (ContentSearchSpec)
  }
}
Champs
contentSearchSpec

object (ContentSearchSpec)

Spécifie le comportement attendu de la recherche de contenu. Uniquement valide pour les data store compatibles avec la recherche de contenu.

EmbeddingConfig

Définit la configuration d'embedding, utilisée pour la fonctionnalité "Utiliser vos propres embeddings".

Représentation JSON 
{
  "fieldPath": string
}
Champs
fieldPath

string

Chemin d'accès complet au champ dans le schéma mappé en tant que champ d'intégration.

GuidedSearchSpec

Définit les spécifications de la recherche guidée.

Représentation JSON 
{
  "enableRefinementAttributes": boolean,
  "enableRelatedQuestions": boolean,
  "maxRelatedQuestions": integer
}
Champs
enableRefinementAttributes

boolean

Indique si les attributs d'affinage doivent être activés et inclus dans les résultats de recherche guidée.

AnswerGenerationSpec

Spécification pour la génération de réponses.

Représentation JSON 
{
  "userDefinedClassifierSpec": {
    object (UserDefinedClassifierSpec)
  }
}
Champs
userDefinedClassifierSpec

object (UserDefinedClassifierSpec)

Facultatif. Spécification de la spécification du classificateur spécifiée par l'utilisateur.

UserDefinedClassifierSpec

Spécification du classificateur défini par l'utilisateur.

Représentation JSON 
{
  "enableUserDefinedClassifier": boolean,
  "preamble": string,
  "modelId": string,
  "taskMarker": string,
  "topP": number,
  "topK": string,
  "temperature": number,
  "seed": integer
}
Champs
enableUserDefinedClassifier

boolean

Facultatif. Indique s'il faut activer et inclure le classificateur défini par l'utilisateur.
preamble

string

Facultatif. Préambule à utiliser pour le classificateur défini par l'utilisateur.
modelId

string

Facultatif. ID du modèle à utiliser pour le classificateur défini par l'utilisateur.
taskMarker

string

Facultatif. Marqueur de tâche à utiliser pour le classificateur défini par l'utilisateur.
topP

number

Facultatif. Valeur top-p à utiliser pour le classificateur défini par l'utilisateur.
topK

string (int64 format)

Facultatif. Valeur top-k à utiliser pour le classificateur défini par l'utilisateur.
temperature

number

Facultatif. Valeur de température à utiliser pour le classificateur défini par l'utilisateur.
seed

integer

Facultatif. Valeur de départ à utiliser pour le classificateur défini par l'utilisateur.

Méthodes

answer

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

create

 Crée une ServingConfig.

delete

 Supprime un ServingConfig.

get

 Récupère une configuration ServingConfig.

list

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

patch

 Met à jour un ServingConfig.

recommend

 Effectue 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).