- Requête HTTP
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Niveaux d'accès des autorisations
- Autorisations IAM
Fait une recommandation, ce qui nécessite un événement utilisateur contextuel.
Requête HTTP
POST https://discoveryengine.googleapis.com/v1beta/{servingConfig=projects/*/locations/*/dataStores/*/servingConfigs/*}:recommend Les URL utilisent la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
| Paramètres | |
|---|---|
servingConfig |
Obligatoire. Nom complet de la ressource d'un Une configuration de diffusion par défaut est créée en même temps que votre moteur de recommandations. L'ID du moteur est utilisé comme ID de la configuration de diffusion par défaut. Par exemple, pour le moteur |
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
| Représentation JSON |
|---|
{
"userEvent": {
object ( |
| Champs | |
|---|---|
userEvent |
Obligatoire. Contexte sur l'utilisateur, ce qu'il regarde et l'action qu'il a effectuée pour déclencher la requête servingConfigs.recommend. Notez que ces informations sur l'événement utilisateur ne seront pas ingérées dans les journaux userEvent. Par conséquent, une requête d'écriture userEvent distincte est requise pour la journalisation des événements. Ne définissez pas |
pageSize |
Nombre maximal de résultats sur une page. Définissez cette propriété sur le nombre de résultats de recommandation nécessaires. Si la valeur est zéro, le service choisit une valeur par défaut raisonnable. La valeur maximale autorisée est de 100. Les valeurs supérieures à 100 sont définies sur 100. |
filter |
Filtre permettant de limiter les résultats des recommandations à 5 000 caractères. Pour le moment, seules les expressions de filtre sur l'attribut Exemples :
Si
Si votre filtre bloque tous les résultats, l'API renvoie les documents populaires génériques (non filtrés). Si vous ne souhaitez obtenir que des résultats correspondant strictement aux filtres, définissez Notez que l'API ne renvoie jamais de |
validateOnly |
Utilisez le mode "Valider uniquement" pour cette requête de recommandation. Si la valeur est définie sur |
params |
Paramètres supplémentaires spécifiques au domaine pour les recommandations. Valeurs autorisées :
|
userLabels |
Les libellés utilisateur appliqués à une ressource doivent répondre aux exigences suivantes :
Pour en savoir plus, consultez Exigences relatives aux libellés. |
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient une instance de RecommendResponse.
Niveaux d'accès des autorisations
Nécessite l'un des niveaux d'accès OAuth suivants :
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/discoveryengine.readwritehttps://www.googleapis.com/auth/discoveryengine.serving.readwrite
Pour plus d'informations, consultez la page Authentication Overview.
Autorisations IAM
Nécessite l'autorisation IAM suivante sur la ressource servingConfig :
discoveryengine.servingConfigs.recommend
Pour en savoir plus, consultez la documentation IAM.