Créer ou réutiliser une instance de magasin exemple

Cette page explique comment créer une instance de magasin d'exemples ou réutiliser une instance existante. Vous pouvez stocker vos exemples dans un magasin d'exemples lorsque vous développez votre application LLM et les récupérer de manière dynamique pour les utiliser dans vos invites LLM.

Pour entraîner un LLM ou un agent à l'aide d'exemples few-shot, vous devez d'abord créer ou réutiliser une instance de magasin d'exemples pour votre projet et votre emplacement, puis y importer des exemples.

Pour chaque projet et chaque emplacement, vous pouvez disposer d'un maximum de 50 instances de magasin d'exemples. Une fois que vous avez créé une instance de magasin d'exemples, vous pouvez la partager entre plusieurs applications et agents LLM.

Vous pouvez provisionner une instance de magasin d'exemples de deux manières :

  • Créer une instance de magasin d'exemples : lorsque vous créez une instance de magasin d'exemples , vous devez spécifier le modèle d'embedding que le magasin d'exemples utilise pour déterminer les exemples pertinents pour les requêtes des utilisateurs. Le magasin d'exemples est compatible avec les modèles d'embedding suivants :

    • text-embedding-005

    • text-multilingual-embedding-002

    Vous ne pouvez pas modifier un modèle d'encapsulation après avoir créé l'instance Example Store. Si vous souhaitez utiliser un autre modèle d'encapsulation, vous devez créer un autre magasin d'exemples. Pour en savoir plus sur les embeddings de texte, consultez Obtenir des embeddings de texte.

  • Réutiliser une instance de magasin d'exemples existante : les instances de magasin d'exemples sont conçues pour être utilisées par plusieurs agents. Vous pouvez donc accéder aux exemples stockés dans les applications LLM. Vous ne pouvez pas modifier le modèle d'embedding lorsque vous réutilisez une instance de magasin d'exemples existante.

Prérequis

Avant d'utiliser les exemples Python de cette page, installez et initialisez le SDK Vertex AI pour Python dans votre environnement Python local.

  1. Exécutez la commande suivante pour installer le SDK Vertex AI pour Python pour le magasin d'exemples.

    pip install --upgrade google-cloud-aiplatform>=1.87.0

  2. Utilisez l'exemple de code suivant pour importer et initialiser le SDK pour le magasin d'exemples.

    import vertexai
from vertexai.preview import example_stores

vertexai.init(
  project="PROJECT_ID",
  location="LOCATION"
)

    Remplacez les éléments suivants :

    • PROJECT_ID : ID de votre projet

    • LOCATION : votre région. Seule la région us-central1 est compatible.

Créer une instance de magasin d'exemples

Utilisez les exemples suivants pour créer une instance de magasin d'exemples pour un projet et un emplacement spécifiés. Notez que la création d'une instance de magasin d'exemples peut prendre quelques minutes.

Python

Avant d'essayer cet exemple, suivez les instructions de configuration Python décrites dans le guide de démarrage rapide de Vertex AI Agent Builder à l'aide des bibliothèques clientes.

Pour vous authentifier auprès de Vertex AI Agent Builder, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local. 

import vertexai
from vertexai.preview import example_stores

vertexai.init(
    project="PROJECT_ID",
    location="LOCATION"
)

my_example_store = example_stores.ExampleStore.create(
    example_store_config=example_stores.ExampleStoreConfig(
        vertex_embedding_model="EMBEDDING_MODEL"
    )
)

Remplacez les éléments suivants :

  • PROJECT_ID : ID de votre projet
  • LOCATION : région dans laquelle vous souhaitez créer le magasin d'exemples. La seule région compatible est us-central1.
  • EMBEDDING_MODEL : modèle d'embedding que l'instance de magasin d'exemples utilise pour déterminer les exemples pertinents pour les requêtes des utilisateurs. Le magasin d'exemples est compatible avec les modèles d'embedding suivants :
    • text-embedding-004
    • text-multilingual-embedding-002

REST

Pour créer une ExampleStore ressource, envoyez une requête POST à l'aide de la exampleStores.create méthode.

Avant d'utiliser les données de requête ci-dessous, effectuez les remplacements suivants :

  • PROJECT_ID : ID de votre projet
  • LOCATION : région dans laquelle vous souhaitez créer l'instance de magasin d'exemples. La seule région compatible est us-central1.
  • DISPLAY_NAME : nom de l'instance de magasin d'exemples.
  • EMBEDDING_MODEL : modèle d'embedding que l'instance de magasin d'exemples utilise pour déterminer les exemples pertinents pour les requêtes des utilisateurs. Le magasin d'exemples est compatible avec les modèles d'embedding suivants :
    • textembedding-gecko@003
    • text-embedding-004
    • text-multilingual-embedding-002

Méthode HTTP et URL : 

POST https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/exampleStores

Corps JSON de la requête : 

{
  "display_name": "DISPLAY_NAME",
  "example_store_config": {"vertex_embedding_model": EMBEDDING_MODEL}
}

Pour envoyer votre requête, choisissez l'une des options suivantes :

curl

Enregistrez le corps de la requête dans un fichier nommé request.json, puis exécutez la commande suivante : 

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/exampleStores"

PowerShell

Enregistrez le corps de la requête dans un fichier nommé request.json, et exécutez la commande suivante : 

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/exampleStores" | Select-Object -Expand Content

Vous devriez recevoir une réponse JSON semblable à la suivante, où EXAMPLE_STORE_ID représente l'ID de l'instance de magasin d'exemples.

Réutiliser une instance de magasin d'exemples existante

Utilisez l'exemple suivant pour réutiliser une instance de magasin d'exemples existante pour un projet et un emplacement spécifiés.

Python

Avant d'essayer cet exemple, suivez les instructions de configuration Python décrites dans le guide de démarrage rapide de Vertex AI Agent Builder à l'aide des bibliothèques clientes.

Pour vous authentifier auprès de Vertex AI Agent Builder, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local. 

import vertexai
from vertexai.preview import example_stores

vertexai.init(
    project="PROJECT_ID",
    location="LOCATION"
)

example_store = example_stores.ExampleStore(
    "EXAMPLE_STORE_NAME")

Remplacez les éléments suivants :

  • PROJECT_ID : ID de votre projet
  • LOCATION : région dans laquelle vous souhaitez créer le magasin d'exemples. La seule région compatible est us-central1.
  • EXAMPLE_STORE_NAME : nom de l'instance de magasin d'exemples que vous souhaitez réutiliser.

Étape suivante