Crea o reutiliza una instancia de Example Store

En esta página, se muestra cómo crear una instancia nueva de Example Store o reutilizar una existente. Puedes almacenar tus ejemplos en un almacén de ejemplos cuando desarrolles tu aplicación basada en LLM y recuperarlos de forma dinámica para usarlos en tus instrucciones de LLM.

Para enseñarle a un LLM o a un agente con ejemplos de aprendizaje con pocos ejemplos, primero debes crear o reutilizar una instancia de Example Store para tu proyecto y ubicación, y, luego, subir ejemplos a ella.

Para cada proyecto y ubicación, puedes tener un máximo de 50 instancias de Example Store. Después de crear una instancia de Example Store, puedes compartirla en varias aplicaciones y agentes de LLM.

Existen dos formas de aprovisionar una instancia de Example Store:

  • Crea una instancia nueva de Example Store: Cuando creas una instancia nueva de Example Store, debes especificar el modelo de incorporación, que Example Store usa para determinar qué ejemplos son relevantes para las búsquedas de los usuarios. Example Store admite los siguientes modelos de embedding:

    • text-embedding-005

    • text-multilingual-embedding-002

    No puedes cambiar un modelo de incorporación después de crear la instancia de Example Store. Si deseas usar un modelo de incorporación diferente, debes crear otro almacén de ejemplos. Para obtener más información sobre las incorporaciones de texto, consulta Obtén incorporaciones de texto.

  • Reutiliza una instancia existente de Example Store: Las instancias de Example Store están diseñadas para que las usen varios agentes, por lo que puedes acceder a los ejemplos almacenados en todas las aplicaciones de LLM. No puedes cambiar el modelo de incorporación cuando reutilizas una instancia existente de Example Store.

Requisitos previos

Antes de usar las muestras de Python en esta página, instala e inicializa el SDK de Vertex AI para Python en tu entorno local de Python.

  1. Ejecuta el siguiente comando para instalar el SDK de Vertex AI para Python para Example Store.

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

  2. Usa el siguiente muestra de código para importar y, luego, inicializar el SDK de Example Store.

    import vertexai
from vertexai.preview import example_stores

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

    Reemplaza lo siguiente:

    • PROJECT_ID: ID del proyecto

    • LOCATION: Tu región. Solo se admite us-central1.

Crea una instancia de Example Store

Usa las siguientes muestras para crear una instancia de Example Store para un proyecto y una ubicación especificados. Ten en cuenta que la creación de una instancia de Example Store tarda unos minutos.

Python

Antes de probar este ejemplo, sigue las instrucciones de configuración para Python incluidas en la guía de inicio rápido de Vertex AI sobre cómo usar bibliotecas cliente. Para obtener más información, consulta la documentación de referencia de la API de Vertex AI Python.

Para autenticarte en Vertex AI, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo 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"
    )
)

Reemplaza lo siguiente:

  • PROJECT_ID: ID del proyecto
  • LOCATION: Es la región en la que deseas crear la tienda de ejemplo. La única región admitida es us-central1.
  • EMBEDDING_MODEL: Es el modelo de embedding que usa la instancia de Example Store para determinar qué ejemplos son relevantes para las búsquedas de los usuarios. Example Store admite los siguientes modelos de embedding:
    • text-embedding-004
    • text-multilingual-embedding-002

REST

Para crear un recurso ExampleStore, envía una solicitud POST con el método exampleStores.create.

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

  • PROJECT_ID: ID del proyecto
  • LOCATION: Es la región en la que deseas crear la instancia de Example Store. La única región admitida es us-central1.
  • DISPLAY_NAME: Es el nombre de la instancia de Example Store.
  • EMBEDDING_MODEL: Es el modelo de embedding que usa la instancia de Example Store para determinar qué ejemplos son relevantes para las búsquedas de los usuarios. Example Store admite los siguientes modelos de embedding:
    • textembedding-gecko@003
    • text-embedding-004
    • text-multilingual-embedding-002

Método HTTP y URL: 

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

Cuerpo JSON de la solicitud:

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

Para enviar tu solicitud, elige una de estas opciones:

curl

Guarda el cuerpo de la solicitud en un archivo llamado request.json y ejecuta el siguiente comando:

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

Guarda el cuerpo de la solicitud en un archivo llamado request.json y ejecuta el siguiente comando:

$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

Deberías recibir una respuesta JSON similar a la siguiente, en la que EXAMPLE_STORE_ID representa el ID de la instancia de Example Store.

Cómo reutilizar una instancia existente de Example Store

Usa la siguiente muestra para reutilizar una instancia de Example Store existente para un proyecto y una ubicación especificados.

Python

Antes de probar este ejemplo, sigue las instrucciones de configuración para Python incluidas en la guía de inicio rápido de Vertex AI sobre cómo usar bibliotecas cliente. Para obtener más información, consulta la documentación de referencia de la API de Vertex AI Python.

Para autenticarte en Vertex AI, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local. 

import vertexai
from vertexai.preview import example_stores

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

example_store = example_stores.ExampleStore(
    "EXAMPLE_STORE_NAME")

Reemplaza lo siguiente:

  • PROJECT_ID: ID del proyecto
  • LOCATION: Es la región en la que deseas crear la tienda de ejemplo. La única región admitida es us-central1.
  • EXAMPLE_STORE_NAME: Nombre de la instancia de Example Store que deseas reutilizar.

¿Qué sigue?