Cette page a été traduite par l'API Cloud Translation.

Obtenir des recommandations

Cette page explique comment prévisualiser les recommandations à l'aide de la console Google Cloud et obtenir les résultats des recommandations à l'aide de l'API. Consultez l'onglet "REST" pour obtenir des exemples d'appels d'API qui peuvent vous aider à intégrer des recommandations dans votre application.

La procédure à suivre dépend du type de données que vous avez : données média ou données personnalisées.

Obtenir des recommandations de contenus multimédias
Obtenir des recommandations personnalisées pour une application avec des données structurées

Obtenir des recommandations de contenus multimédias

Console

Pour prévisualiser les recommandations de contenus multimédias à l'aide de la console Google Cloud , procédez comme suit :

Dans la console Google Cloud , accédez à la page Applications d'IA.

AI Applications
Cliquez sur le nom de l'application pour laquelle vous souhaitez prévisualiser les recommandations.
Cliquez sur Configurations > Training (Configurations > Entraînement). Si la valeur Prêt à interroger est "Oui", l'application est prête à être prévisualisée.
Cliquez sur Aperçu.
Cliquez sur le champ ID du document. La liste des ID des documents s'affiche.
Cliquez sur l'ID du document pour lequel vous souhaitez obtenir des recommandations. Vous pouvez également saisir un ID de document dans le champ ID du document.
Cliquez sur Sélectionner une configuration de diffusion, puis sélectionnez la configuration de diffusion à prévisualiser.
Facultatif : Saisissez l'ID de visiteur (également appelé pseudo-ID utilisateur) d'un utilisateur pour lequel vous avez collecté des événements utilisateur. Si vous laissez ce champ vide ou saisissez un ID de visiteur inexistant, vous prévisualiserez les recommandations en tant que nouvel utilisateur.
Cliquez sur Obtenir des recommandations. Une liste de documents recommandés s'affiche.
Cliquez sur un document pour afficher les détails le concernant.

REST

Pour utiliser l'API afin d'obtenir des recommandations de contenus multimédias, utilisez la méthode servingConfigs.recommend :

Trouvez l'ID de votre moteur et l'ID de configuration de diffusion. Si vous disposez déjà de votre ID de moteur et de vos ID de configuration de diffusion, passez à l'étape 2.
1. Dans la console Google Cloud , accédez à la page Applications d'IA.
  
  AI Applications
2. Cliquez sur le nom de l'application.
3. Dans le volet de navigation, cliquez sur Configurations.
4. Si vous ne disposez que d'une seule configuration de diffusion, récupérez l'ID de configuration de diffusion affiché dans l'onglet Diffusion.
  
  Si plusieurs configurations de diffusion sont listées dans l'onglet Diffusion, recherchez celle à partir de laquelle vous souhaitez obtenir des recommandations. L'ID de votre configuration de diffusion correspond à la valeur de la colonne ID.
5. Cliquez sur l'onglet Entraînement. L'ID du moteur correspond à la valeur de la ligne ID de l'application.
Assurez-vous que l'application est prête à être prévisualisée :
1. Dans la console Google Cloud , accédez à la page Applications d'IA.
  
  AI Applications
2. Cliquez sur le nom de l'application.
3. Cliquez sur Configurations > Training (Configurations > Entraînement). Si la valeur Prêt à interroger est "Oui", l'application est prête à être prévisualisée.
Obtenez des recommandations.

Remarque : Si votre recommandation n'est pas encore active ou si vous souhaitez tester votre appel de méthode, vous pouvez appeler cette méthode avec l'option validateOnly définie sur true. Cet appel renvoie un résultat d'espace réservé et n'entraîne aucuns frais.
```
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d  '{
        "validateOnly": false,
        "userEvent": {
            "eventType": "view-item",
            "userPseudoId": "USER_PSEUDO_ID",
            "documents": [{
              "id": "DOCUMENT_ID"
            }],
        "filter": "FILTER_STRING"            }
    }' \
  "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/servingConfigs/SERVING_CONFIG_ID:recommend"
```
Remplacez les éléments suivants :
- PROJECT_ID : par l'ID du projet.
- DATA_STORE_ID : ID de votre data store.
- DOCUMENT_ID : ID du document pour lequel vous souhaitez prévisualiser les recommandations. Utilisez l'ID que vous avez utilisé pour ce document au moment de l'ingestion de vos données.
- USER_PSEUDO_ID : chaîne encodée en UTF-8, qui sert d'identifiant pseudonymisé unique pour suivre les utilisateurs. Il peut comporter jusqu'à 128 caractères. Google vous recommande vivement d'utiliser ce champ, car il améliore les performances du modèle et la qualité de la personnalisation. Vous pouvez utiliser un cookie HTTP pour ce champ, qui identifie de manière unique un visiteur sur un seul appareil. Voici quelques points importants à prendre en compte :
  - Cet identifiant ne change pas lorsque le visiteur se connecte ou se déconnecte d'un site Web.
  - Ce champ ne doit pas être défini sur le même identifiant pour plusieurs utilisateurs. Sinon, le même ID utilisateur peut combiner les historiques d'événements de différents utilisateurs et nuire à la qualité du modèle.
  - Ce champ ne doit pas inclure d'informations permettant d'identifier personnellement l'utilisateur.
  Pour en savoir plus, consultez les sections sur userPseudoId
- SERVING_CONFIG_ID : ID de votre configuration de diffusion.
- FILTER (facultatif) : Champ de texte qui vous permet de filtrer un ensemble de champs spécifié à l'aide de la syntaxe des expressions de filtre. La valeur par défaut est une chaîne vide, ce qui signifie qu'aucun filtre n'est appliqué. Pour en savoir plus, consultez Filtrer les recommandations.

Un résultat semblable aux lignes suivantes doit s'afficher :

{
  "results": [{"id": "sample-id-1"}, {"id": "sample-id-2"}],
  "attributionToken": "abc123"
}

Google recommande d'associer les jetons d'attribution, que nous incluons dans chaque réponse de recherche et recommandation, aux actions effectuées par un utilisateur en réponse à ces réponses de recherche et recommandations. Cela peut améliorer la qualité de vos réponses et recommandations de recherche au fil du temps. Pour ce faire, ajoutez des valeurs attributionToken aux URL de chacun des liens que vous affichez sur votre site Web pour les réponses ou les recommandations de recherche. Par exemple, https://www.example.com/54321/?rtoken=abc123. Lorsqu'un utilisateur clique sur l'un de ces liens, incluez la valeur attributionToken dans l'événement utilisateur que vous enregistrez.

Obtenir des recommandations pour une application avec des données structurées personnalisées

Console

Pour prévisualiser les recommandations personnalisées pour votre application structurée à l'aide de la console Google Cloud , procédez comme suit :

Dans la console Google Cloud , accédez à la page Applications d'IA.

AI Applications
Cliquez sur le nom de l'application pour laquelle vous souhaitez prévisualiser les recommandations.
Cliquez sur Aperçu.
Cliquez sur le champ ID du document. La liste des ID des documents s'affiche.
Cliquez sur l'ID du document pour lequel vous souhaitez obtenir des recommandations. Vous pouvez également saisir un ID de document dans le champ ID du document.
Cliquez sur Obtenir des recommandations. Une liste de documents recommandés s'affiche.
Cliquez sur un document pour afficher les détails le concernant.

REST

Pour utiliser l'API afin d'obtenir des recommandations personnalisées pour une application avec des données structurées, utilisez la méthode servingConfigs.recommend :

Trouvez l'ID de votre moteur. Si vous disposez déjà de votre ID de moteur, passez à l'étape 2.
1. Dans la console Google Cloud , accédez à la page Applications d'IA.
  
  AI Applications
2. Cliquez sur le nom de l'application.
3. Obtenez l'ID du moteur à partir de l'URL de la console Google Cloud . Il s'agit du texte entre engines/ et /data. Par exemple, si l'URL contient
```
gen-app-builder/engines/demo_1234567890123/data/records
```
  L'ID du moteur est alors demo_1234567890123.
Trouvez l'ID de votre data store. Si vous disposez déjà de l'ID de votre data store, passez à l'étape suivante.
1. Dans la console Google Cloud , accédez à la page Applications d'IA, puis cliquez sur Data stores dans le menu de navigation.
  
  Accéder à la page "Data stores"
2. Cliquez sur le nom de votre data store.
3. Sur la page Données de votre datastore, obtenez l'ID du datastore.
Assurez-vous que votre moteur est prêt à être prévisualisé en interrogeant la méthode GetEngine jusqu'à ce qu'elle renvoie "servingState":"ACTIVE". À ce moment-là, le moteur est prêt à être prévisualisé.
```
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/ENGINE_ID
```
Remplacez les éléments suivants :
- PROJECT_ID : par l'ID du projet.
- ENGINE_ID : ID de votre moteur.
Obtenez des recommandations.
```
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{
  "userEvent": { "eventType":"view-item", "userPseudoId":"USER_PSEUDO_ID", "documents":[{"id":"DOCUMENT_ID"}]}}' \
  "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/servingConfigs/SERVING_CONFIG_ID:recommend"
```
Remplacez les éléments suivants :
- PROJECT_ID : par l'ID du projet.
- DATA_STORE_ID : ID de votre data store.
- DOCUMENT_ID : ID du document pour lequel vous souhaitez prévisualiser les recommandations. Utilisez l'ID que vous avez utilisé pour ce document au moment de l'ingestion de vos données.
- USER_PSEUDO_ID : chaîne encodée en UTF-8, qui sert d'identifiant pseudonymisé unique pour suivre les utilisateurs. Il peut comporter jusqu'à 128 caractères. Google vous recommande vivement d'utiliser ce champ, car il améliore les performances du modèle et la qualité de la personnalisation. Vous pouvez utiliser un cookie HTTP pour ce champ, qui identifie de manière unique un visiteur sur un seul appareil. Voici quelques points importants à prendre en compte :
  - Cet identifiant ne change pas lorsque le visiteur se connecte ou se déconnecte d'un site Web.
  - Ce champ ne doit pas être défini sur le même identifiant pour plusieurs utilisateurs. Sinon, le même ID utilisateur peut combiner les historiques d'événements de différents utilisateurs et nuire à la qualité du modèle.
  - Ce champ ne doit pas inclure d'informations permettant d'identifier personnellement l'utilisateur.
  Pour en savoir plus, consultez les sections sur userPseudoId
- SERVING_CONFIG_ID : ID de votre configuration de diffusion. L'ID de configuration de diffusion est le même que l'ID du moteur. Utilisez donc l'ID du moteur ici.
Remarque : Vous n'avez pas besoin d'événements utilisateur dans votre data store pour obtenir des recommandations personnalisées. Toutefois, vous devez fournir l'objet d'événement utilisateur, y compris un type d'événement et une valeur pour le pseudo-ID utilisateur.

C#

Pour en savoir plus, consultez la documentation de référence de l'API AI Applications C#.

Pour vous authentifier auprès des applications d'IA, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

using Google.Cloud.DiscoveryEngine.V1Beta;
using Google.Protobuf.WellKnownTypes;

public sealed partial class GeneratedRecommendationServiceClientSnippets
{
    /// <summary>Snippet for Recommend</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void RecommendRequestObject()
    {
        // Create client
        RecommendationServiceClient recommendationServiceClient = RecommendationServiceClient.Create();
        // Initialize request argument(s)
        RecommendRequest request = new RecommendRequest
        {
            ServingConfigAsServingConfigName = ServingConfigName.FromProjectLocationDataStoreServingConfig("[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]"),
            UserEvent = new UserEvent(),
            PageSize = 0,
            Filter = "",
            ValidateOnly = false,
            Params = { { "", new Value() }, },
            UserLabels = { { "", "" }, },
        };
        // Make the request
        RecommendResponse response = recommendationServiceClient.Recommend(request);
    }
}

Go

Pour en savoir plus, consultez la documentation de référence de l'API AI Applications Go.


package main

import (
	"context"

	discoveryengine "cloud.google.com/go/discoveryengine/apiv1beta"
	discoveryenginepb "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := discoveryengine.NewRecommendationClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &discoveryenginepb.RecommendRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb#RecommendRequest.
	}
	resp, err := c.Recommend(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

Pour en savoir plus, consultez la documentation de référence de l'API AI Applications Java.

import com.google.cloud.discoveryengine.v1beta.RecommendRequest;
import com.google.cloud.discoveryengine.v1beta.RecommendResponse;
import com.google.cloud.discoveryengine.v1beta.RecommendationServiceClient;
import com.google.cloud.discoveryengine.v1beta.ServingConfigName;
import com.google.cloud.discoveryengine.v1beta.UserEvent;
import com.google.protobuf.Value;
import java.util.HashMap;

public class SyncRecommend {

  public static void main(String[] args) throws Exception {
    syncRecommend();
  }

  public static void syncRecommend() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (RecommendationServiceClient recommendationServiceClient =
        RecommendationServiceClient.create()) {
      RecommendRequest request =
          RecommendRequest.newBuilder()
              .setServingConfig(
                  ServingConfigName.ofProjectLocationDataStoreServingConfigName(
                          "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
                      .toString())
              .setUserEvent(UserEvent.newBuilder().build())
              .setPageSize(883849137)
              .setFilter("filter-1274492040")
              .setValidateOnly(true)
              .putAllParams(new HashMap<String, Value>())
              .putAllUserLabels(new HashMap<String, String>())
              .build();
      RecommendResponse response = recommendationServiceClient.recommend(request);
    }
  }
}

Node.js

Pour en savoir plus, consultez la documentation de référence de l'API AI Applications Node.js.

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. Full resource name of a
 *  ServingConfig google.cloud.discoveryengine.v1beta.ServingConfig:
 *  `projects/* /locations/global/collections/* /engines/* /servingConfigs/*`, or
 *  `projects/* /locations/global/collections/* /dataStores/* /servingConfigs/*`
 *  One default serving config is created along with your recommendation engine
 *  creation. The engine ID is used as the ID of the default serving
 *  config. For example, for Engine
 *  `projects/* /locations/global/collections/* /engines/my-engine`, you can use
 *  `projects/* /locations/global/collections/* /engines/my-engine/servingConfigs/my-engine`
 *  for your
 *  RecommendationService.Recommend google.cloud.discoveryengine.v1beta.RecommendationService.Recommend 
 *  requests.
 */
// const servingConfig = 'abc123'
/**
 *  Required. Context about the user, what they are looking at and what action
 *  they took to trigger the Recommend request. Note that this user event
 *  detail won't be ingested to userEvent logs. Thus, a separate userEvent
 *  write request is required for event logging.
 *  Don't set
 *  UserEvent.user_pseudo_id google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id 
 *  or
 *  UserEvent.user_info.user_id google.cloud.discoveryengine.v1beta.UserInfo.user_id 
 *  to the same fixed ID for different users. If you are trying to receive
 *  non-personalized recommendations (not recommended; this can negatively
 *  impact model performance), instead set
 *  UserEvent.user_pseudo_id google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id 
 *  to a random unique ID and leave
 *  UserEvent.user_info.user_id google.cloud.discoveryengine.v1beta.UserInfo.user_id 
 *  unset.
 */
// const userEvent = {}
/**
 *  Maximum number of results to return. Set this property
 *  to the number of recommendation results needed. If zero, the service
 *  chooses a reasonable default. The maximum allowed value is 100. Values
 *  above 100 are set to 100.
 */
// const pageSize = 1234
/**
 *  Filter for restricting recommendation results with a length limit of 5,000
 *  characters. Currently, only filter expressions on the `filter_tags`
 *  attribute is supported.
 *  Examples:
 *   * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
 *   * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`
 *  If `attributeFilteringSyntax` is set to true under the `params` field, then
 *  attribute-based expressions are expected instead of the above described
 *  tag-based syntax. Examples:
 *   * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
 *   * (available: true) AND
 *     (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))
 *  If your filter blocks all results, the API returns generic
 *  (unfiltered) popular Documents. If you only want results strictly matching
 *  the filters, set `strictFiltering` to `true` in
 *  RecommendRequest.params google.cloud.discoveryengine.v1beta.RecommendRequest.params 
 *  to receive empty results instead.
 *  Note that the API never returns
 *  Document google.cloud.discoveryengine.v1beta.Document s with
 *  `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.
 */
// const filter = 'abc123'
/**
 *  Use validate only mode for this recommendation query. If set to `true`, a
 *  fake model is used that returns arbitrary Document IDs.
 *  Note that the validate only mode should only be used for testing the API,
 *  or if the model is not ready.
 */
// const validateOnly = true
/**
 *  Additional domain specific parameters for the recommendations.
 *  Allowed values:
 *  * `returnDocument`: Boolean. If set to `true`, the associated Document
 *     object is returned in
 *     RecommendResponse.RecommendationResult.document google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document.
 *  * `returnScore`: Boolean. If set to true, the recommendation score
 *     corresponding to each returned Document is set in
 *     RecommendResponse.RecommendationResult.metadata google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata.
 *     The given score indicates the probability of a Document conversion given
 *     the user's context and history.
 *  * `strictFiltering`: Boolean. True by default. If set to `false`, the
 *  service
 *     returns generic (unfiltered) popular Documents instead of empty if
 *     your filter blocks all recommendation results.
 *  * `diversityLevel`: String. Default empty. If set to be non-empty, then
 *     it needs to be one of:
 *      *  `no-diversity`
 *      *  `low-diversity`
 *      *  `medium-diversity`
 *      *  `high-diversity`
 *      *  `auto-diversity`
 *     This gives request-level control and adjusts recommendation results
 *     based on Document category.
 *  * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
 *     the `filter` field is interpreted according to the new,
 *     attribute-based syntax.
 */
// const params = [1,2,3,4]
/**
 *  The user labels applied to a resource must meet the following requirements:
 *  * Each resource can have multiple labels, up to a maximum of 64.
 *  * Each label must be a key-value pair.
 *  * Keys have a minimum length of 1 character and a maximum length of 63
 *    characters and cannot be empty. Values can be empty and have a maximum
 *    length of 63 characters.
 *  * Keys and values can contain only lowercase letters, numeric characters,
 *    underscores, and dashes. All characters must use UTF-8 encoding, and
 *    international characters are allowed.
 *  * The key portion of a label must be unique. However, you can use the same
 *    key with multiple resources.
 *  * Keys must start with a lowercase letter or international character.
 *  See Requirements for
 *  labels (https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 *  for more details.
 */
// const userLabels = [1,2,3,4]

// Imports the Discoveryengine library
const {RecommendationServiceClient} = require('@google-cloud/discoveryengine').v1beta;

// Instantiates a client
const discoveryengineClient = new RecommendationServiceClient();

async function callRecommend() {
  // Construct request
  const request = {
    servingConfig,
    userEvent,
  };

  // Run request
  const response = await discoveryengineClient.recommend(request);
  console.log(response);
}

callRecommend();

PHP

Pour en savoir plus, consultez la documentation de référence de l'API AI Applications PHP.

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1beta\Client\RecommendationServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\RecommendRequest;
use Google\Cloud\DiscoveryEngine\V1beta\RecommendResponse;
use Google\Cloud\DiscoveryEngine\V1beta\UserEvent;

/**
 * Makes a recommendation, which requires a contextual user event.
 *
 * @param string $formattedServingConfig Full resource name of a
 *                                       [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig]:
 *                                       `projects/&#42;/locations/global/collections/&#42;/engines/&#42;/servingConfigs/*`, or
 *                                       `projects/&#42;/locations/global/collections/&#42;/dataStores/&#42;/servingConfigs/*`
 *
 *                                       One default serving config is created along with your recommendation engine
 *                                       creation. The engine ID is used as the ID of the default serving
 *                                       config. For example, for Engine
 *                                       `projects/&#42;/locations/global/collections/&#42;/engines/my-engine`, you can use
 *                                       `projects/&#42;/locations/global/collections/&#42;/engines/my-engine/servingConfigs/my-engine`
 *                                       for your
 *                                       [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend]
 *                                       requests. Please see
 *                                       {@see RecommendationServiceClient::servingConfigName()} for help formatting this field.
 * @param string $userEventEventType     User event type. Allowed values are:
 *
 *                                       Generic values:
 *
 *                                       * `search`: Search for Documents.
 *                                       * `view-item`: Detailed page view of a Document.
 *                                       * `view-item-list`: View of a panel or ordered list of Documents.
 *                                       * `view-home-page`: View of the home page.
 *                                       * `view-category-page`: View of a category page, e.g. Home > Men > Jeans
 *
 *                                       Retail-related values:
 *
 *                                       * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping
 *                                       * `purchase`: Purchase an item(s)
 *
 *                                       Media-related values:
 *
 *                                       * `media-play`: Start/resume watching a video, playing a song, etc.
 *                                       * `media-complete`: Finished or stopped midway through a video, song, etc.
 * @param string $userEventUserPseudoId  A unique identifier for tracking visitors.
 *
 *                                       For example, this could be implemented with an HTTP cookie, which should be
 *                                       able to uniquely identify a visitor on a single device. This unique
 *                                       identifier should not change if the visitor log in/out of the website.
 *
 *                                       Do not set the field to the same fixed ID for different users. This mixes
 *                                       the event history of those users together, which results in degraded model
 *                                       quality.
 *
 *                                       The field must be a UTF-8 encoded string with a length limit of 128
 *                                       characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
 *
 *                                       The field should not contain PII or user-data. We recommend to use Google
 *                                       Analytics [Client
 *                                       ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId)
 *                                       for this field.
 */
function recommend_sample(
    string $formattedServingConfig,
    string $userEventEventType,
    string $userEventUserPseudoId
): void {
    // Create a client.
    $recommendationServiceClient = new RecommendationServiceClient();

    // Prepare the request message.
    $userEvent = (new UserEvent())
        ->setEventType($userEventEventType)
        ->setUserPseudoId($userEventUserPseudoId);
    $request = (new RecommendRequest())
        ->setServingConfig($formattedServingConfig)
        ->setUserEvent($userEvent);

    // Call the API and handle any network failures.
    try {
        /** @var RecommendResponse $response */
        $response = $recommendationServiceClient->recommend($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedServingConfig = RecommendationServiceClient::servingConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]',
        '[SERVING_CONFIG]'
    );
    $userEventEventType = '[EVENT_TYPE]';
    $userEventUserPseudoId = '[USER_PSEUDO_ID]';

    recommend_sample($formattedServingConfig, $userEventEventType, $userEventUserPseudoId);
}

Python

Pour en savoir plus, consultez la documentation de référence de l'API AI Applications Python.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import discoveryengine_v1beta


def sample_recommend():
    # Create a client
    client = discoveryengine_v1beta.RecommendationServiceClient()

    # Initialize request argument(s)
    user_event = discoveryengine_v1beta.UserEvent()
    user_event.event_type = "event_type_value"
    user_event.user_pseudo_id = "user_pseudo_id_value"

    request = discoveryengine_v1beta.RecommendRequest(
        serving_config="serving_config_value",
        user_event=user_event,
    )

    # Make the request
    response = client.recommend(request=request)

    # Handle the response
    print(response)

Ruby

Pour en savoir plus, consultez la documentation de référence de l'API AI Applications Ruby.

require "google/cloud/discovery_engine/v1beta"

##
# Snippet for the recommend call in the RecommendationService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::DiscoveryEngine::V1beta::RecommendationService::Client#recommend.
#
def recommend
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::DiscoveryEngine::V1beta::RecommendationService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest.new

  # Call the recommend method.
  result = client.recommend request

  # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse.
  p result
end

Obtenir des recommandations Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Obtenir des recommandations de contenus multimédias

Console

REST

Obtenir des recommandations pour une application avec des données structurées personnalisées

Console

REST

C#

Go

Java

Node.js

PHP

Python

Ruby

Obtenir des recommandations