Usar o Pinecone com o mecanismo RAG

Nesta página, mostramos como conectar seu corpus RAG ao banco de dados do Pinecone.

Você também pode acompanhar usando o notebook Mecanismo de RAG com Pinecone.

É possível usar sua instância de banco de dados do Pinecone com o mecanismo RAG para indexar e realizar uma pesquisa de similaridade baseada em vetores. Uma pesquisa de similaridade é uma maneira de encontrar trechos de texto semelhantes ao que você está procurando, o que requer o uso de um modelo de embedding. O modelo de embedding produz dados vetoriais para cada trecho de texto que está sendo comparado. A pesquisa de similaridade é usada para recuperar contextos semânticos para embasamento e retornar o conteúdo mais preciso do LLM.

Com o mecanismo RAG, você pode continuar usando sua instância de banco de dados de vetores totalmente gerenciada, que é de sua responsabilidade provisionar. O RAG Engine usa seu banco de dados vetorial para armazenamento, gerenciamento de índices e pesquisa.

Considere usar o Pinecone com o mecanismo RAG

Para saber se o banco de dados do Pinecone é a melhor opção para seu aplicativo de RAG, considere o seguinte:

  • É necessário criar, configurar e gerenciar o escalonamento da instância do banco de dados do Pinecone.

  • O mecanismo RAG usa o namespace padrão no seu índice. Verifique se esse namespace não pode ser modificado por mais nada.

  • É necessário fornecer uma chave de API do Pinecone, que permite que o RAG Engine interaja com o banco de dados do Pinecone. O RAG Engine não armazena nem gerencia sua chave de API do Pinecone. Em vez disso, faça o seguinte:

    • Armazene sua chave no Google Cloud Secret Manager.
    • Conceda permissões à conta de serviço do projeto para acessar o secret.
    • Forneça ao RAG Engine acesso ao nome do recurso do secret.

    • Quando você interage com o corpus de RAG, o RAG Engine acessa o recurso de secret usando sua conta de serviço.

    • O corpus RAG e o índice do Pinecone têm um mapeamento de um para um. Essa associação é feita como parte do método ragCorpora.create ou do método ragCorpora.patch.

Criar o índice do Pinecone

Para criar o índice do Pinecone, siga estas etapas:

  1. Consulte o guia de início rápido do Pinecone para conferir as configurações que precisam ser especificadas no índice para que ele seja compatível com o corpus de RAG.

  2. É importante garantir que o local do índice do Pinecone seja o mesmo ou próximo de onde você usa o mecanismo de RAG pelos seguintes motivos:

    • Você quer manter as latências reduzidas.
    • Você quer atender aos requisitos de residência de dados definidos pelas leis aplicáveis.

  3. Durante a criação do índice do Pinecone, especifique a dimensão de embedding a ser usada com o RAG Engine. Esta tabela mostra os tamanhos das dimensões ou o local deles:

    Modelo Tamanho da dimensão
    Gecko próprio 768
    Gecko próprio ajustado 768
    E5 Consulte Usar modelos de embedding do OSS.

  4. Escolha uma das seguintes métricas de distância compatíveis:

    • cosine
    • dotproduct
    • euclidean

  5. Opcional: ao criar um índice baseado em pod, é preciso especificar o file_id no campo pod.metadata_config.indexed. Para mais informações, consulte Indexação seletiva de metadados.

Criar sua chave de API do Pinecone

O RAG Engine só pode se conectar ao índice do Pinecone usando sua chave de API para autenticação e autorização. Siga o guia oficial do Pinecone para configurar a autenticação baseada em chave de API no seu projeto do Pinecone.

Armazenar a chave de API no Secret Manager

Uma chave de API contém informações sensíveis de identificação pessoal (SPII, na sigla em inglês), que estão sujeitas a requisitos legais. Se os dados de SPII forem comprometidos ou usados de maneira indevida, um indivíduo poderá sofrer um risco ou dano significativo. Para minimizar os riscos para um indivíduo ao usar o mecanismo RAG, não armazene nem gerencie sua chave de API e evite compartilhar a chave de API não criptografada.

Para proteger as SPII, faça o seguinte:

  1. Armazene sua chave de API no Secret Manager.

  2. Conceda à conta de serviço do RAG Engine as permissões para os secrets e gerencie o controle de acesso no nível do recurso do secret.

    1. Acesse as permissões do projeto.

    2. Ative a opção Incluir concessões de papel fornecidas pelo Google.

    3. Encontre a conta de serviço, que tem o formato:

      service-{project number}@gcp-sa-vertex-rag.iam.gserviceaccount.com

    4. Edite os principais da conta de serviço.

    5. Adicione o papel Secret Manager Secret Accessor à conta de serviço.

  3. Durante a criação ou atualização do corpus de RAG, transmita o nome do recurso do secret para o mecanismo de RAG e armazene o nome do recurso do secret.

Ao fazer solicitações de API para seus índices do Pinecone, o RAG Engine usa cada conta de serviço para ler a chave de API que corresponde aos recursos de secret no Secret Manager dos seus projetos.

Provisionar sua conta de serviço do RAG Engine

Quando você cria o primeiro corpus de RAG no projeto, o RAG Engine cria uma conta de serviço dedicada. Encontre sua conta de serviço na página do Identity and Access Management do projeto.

A conta de serviço segue este formato fixo:

service-{project number}@gcp-sa-vertex-rag.iam.gserviceaccount.com

Por exemplo,

service-123456789@gcp-sa-vertex-rag.iam.gserviceaccount.com

Preparar o corpus de RAG

Para usar o índice do Pinecone com o mecanismo RAG, é preciso associar o índice a um corpus de RAG durante a fase de criação. Depois que a associação é feita, essa vinculação é permanente durante a vida útil do corpus do RAG. A associação pode ser feita usando a API CreateRagCorpus ou UpdateRagCorpus.

Para que a associação seja considerada concluída, é necessário definir três campos principais no corpus de RAG:

  • rag_vector_db_config.pinecone: esse campo ajuda a definir a escolha de um banco de dados vetorial que você quer associar ao seu corpus de RAG e precisa ser definido durante a chamada de API CreateRagCorpus. Se não estiver definido, a opção padrão de banco de dados vetorial RagManagedDb será atribuída ao corpus RAG.

  • rag_vector_db_config.pinecone.index_name: é o nome usado para criar o índice do Pinecone que é usado com o corpus RAG. É possível definir o nome durante a chamada CreateRagCorpus ou especificá-lo ao chamar a API UpdateRagCorpus.

  • rag_vector_db_config.api_auth.api_key_config.api_key_secret_version: o nome completo do recurso do secret armazenado no Secret Manager, que contém sua chave de API do Pinecone. É possível definir o nome durante a chamada CreateRagCorpus ou especificá-lo ao chamar a API UpdateRagCorpus. Até que você especifique esse campo, não será possível importar dados para o corpus de RAG.

    Este campo precisa ter o seguinte formato:

    projects/{PROJECT_NUMBER}/secrets/{SECRET_ID}/versions/{VERSION_ID}

Criar seu corpus de RAG

Se você tiver acesso ao nome do índice do Pinecone e ao nome do recurso secreto com seu conjunto de permissões, poderá criar seu corpus de RAG e associá-lo ao índice do Pinecone, conforme demonstrado neste exemplo de código.

Quando você cria um corpus de RAG pela primeira vez, as informações da conta de serviço não estão prontas. No entanto, os campos são opcionais e podem ser associados ao corpus de RAG usando a API UpdateRagCorpus.

Para ver um exemplo de como criar o corpus de RAG sem fornecer as informações da conta de serviço, consulte Criar corpus de RAG sem um nome de índice ou uma chave de API.

Python

Antes de testar este exemplo, siga as instruções de configuração do Python no Guia de início rápido da plataforma de agentes: como usar bibliotecas de cliente.

Para autenticar na Plataforma de Agentes, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local. 


import agentplatform
from agentplatform import types

# TODO(developer): Update and un-comment below lines
# PROJECT_ID = "your-project-id"
# pinecone_index_name = "pinecone-index-name"
# display_name = "test_corpus"
# description = "Corpus Description"

# Initialize Agent Platform client once per session.
# See https://docs.cloud.google.com/gemini-enterprise-agent-platform/build/rag-engine/rag-overview#supported-regions
client = agentplatform.Client(project=PROJECT_ID, location="us-east5")

# Configure embedding model (Optional)
embedding_model_config = types.RagEmbeddingModelConfig(
    vertex_prediction_endpoint=types.RagEmbeddingModelConfigVertexPredictionEndpoint(
        endpoint="publishers/google/models/text-embedding-005"
    )
)

# Configure Vector DB
vector_db = types.RagVectorDbConfig(
    pinecone=types.RagVectorDbConfigPinecone(
        index_name=pinecone_index_name,
    ),
    api_auth=types.ApiAuth(
        api_key_config=types.ApiAuthApiKeyConfig(
            api_key_secret_version=pinecone_api_key_secret_manager_version
        )
    ),
    rag_embedding_model_config=embedding_model_config,
)

corpus = client.rag.create_corpus(
    rag_corpus=types.RagCorpus(
        display_name=display_name,
        description=description,
        rag_vector_db_config=vector_db,
    )
)
print(corpus)
# Example response:
# RagCorpus(name='projects/1234567890/locations/us-central1/ragCorpora/1234567890',
# display_name='test_corpus', description='Corpus Description', embedding_model_config=...
# ...

REST

   # Set your project ID under which you want to create the corpus
   PROJECT_ID = "YOUR_PROJECT_ID"

   # Choose a display name for your corpus
   CORPUS_DISPLAY_NAME=YOUR_CORPUS_DISPLAY_NAME

   # Set your Pinecone index name
   PINECONE_INDEX_NAME=YOUR_INDEX_NAME

   # Set the full resource name of your secret. Follows the format
   # projects/{PROJECT_NUMER}/secrets/{SECRET_ID}/versions/{VERSION_ID}
   SECRET_RESOURCE_NAME=YOUR_SECRET_RESOURCE_NAME

   # Call CreateRagCorpus API with all the Vector DB information.
   # You can also add the embedding model choice or set other RAG corpus parameters on
   # this call per your choice.
   curl -X POST \
   -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   https://us-central1-aiplatform.googleapis.com}/v1beta1/projects/${PROJECT_ID}/locations/us-central1/ragCorpora -d '{
         "display_name" : '\""${CORPUS_DISPLAY_NAME}"\"',
         "rag_vector_db_config" : {
            "pinecone": {"index_name": '\""${PINECONE_INDEX_NAME}"\"'},
            "api_auth": {"api_key_config":
                  {"api_key_secret_version": '\""${SECRET_RESOURCE_NAME}"\"'}
            }
         }
      }'

   # To poll the status of your RAG corpus creation, get the operation_id returned in
   # response of your CreateRagCorpus call.
   OPERATION_ID="YOUR_OPERATION_ID"

   # Poll Operation status until done = true in the response.
   # The response to this call will contain the ID for your created RAG corpus
   curl -X GET \
   -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   https://us-central1-aiplatform.googleapis.com/v1beta1/projects/${PROJECT_ID}/locations/us-central1/operations/${OPERATION_ID}

Criar um corpus RAG sem um nome de índice ou uma chave de API

Se este for seu primeiro corpus RAG e você não tiver acesso aos detalhes da sua conta de serviço ou não tiver concluído as etapas de provisionamento para o índice do Pinecone, ainda será possível criar o corpus RAG. Em seguida, associe o corpus de RAG a uma configuração vazia do Pinecone e adicione os detalhes mais tarde.

É preciso considerar o seguinte:

  • Quando você não fornece o nome do índice e o nome do secret da chave de API, os arquivos não podem ser importados para o corpus de RAG.

  • Se você escolher o Pinecone como o banco de dados vetorial para seu corpus de RAG, não será possível mudar para outro banco de dados depois.

Este exemplo de código demonstra como criar um corpus RAG com o Pinecone sem fornecer um nome de índice do Pinecone ou um nome de chave secreta da API. Use a API UpdateRagCorpus para especificar as informações ausentes mais tarde.

Python 

import vertexai
from vertexai.preview import rag

# Set Project
PROJECT_ID = "YOUR_PROJECT_ID"
vertexai.init(project=PROJECT_ID, location="us-central1")

# Configure the Pinecone vector DB information
vector_db = rag.Pinecone()

# Name your corpus
DISPLAY_NAME = "YOUR_CORPUS_NAME"

rag_corpus = rag.create_corpus(display_name=DISPLAY_NAME, vector_db=vector_db)

REST 

# Set your project ID under which you want to create the corpus
PROJECT_ID = "YOUR_PROJECT_ID"

# Choose a display name for your corpus
CORPUS_DISPLAY_NAME=YOUR_CORPUS_DISPLAY_NAME

# Call CreateRagCorpus API with all the Vector DB information.
# You can also add the embedding model choice or set other RAG corpus parameters on
# this call per your choice.
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
https://us-central1-aiplatform.googleapis.com}/v1beta1/projects/${PROJECT_ID}/locations/us-central1/ragCorpora -d '{
      "display_name" : '\""${CORPUS_DISPLAY_NAME}"\"',
      "rag_vector_db_config" : {
         "pinecone": {}
      }
   }'

# To poll the status of your RAG corpus creation, get the operation_id returned in
# response of your CreateRagCorpus call.
OPERATION_ID="YOUR_OPERATION_ID"

# Poll Operation status until done = true in the response.
# The response to this call will contain the ID for your created RAG corpus
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
https://us-central1-aiplatform.googleapis.com/v1beta1/projects/${PROJECT_ID}/locations/us-central1/operations/${OPERATION_ID}

Atualizar o corpus de RAG

A API UpdateRagCorpus permite atualizar a configuração do banco de dados vetorial. Se o nome do índice do Pinecone e a versão do secret da chave de API não estiverem definidos, use a API Pinecone para atualizar os campos. A escolha de um banco de dados vetorial não pode ser atualizada. É opcional fornecer o secret da chave de API. No entanto, se você não especificar o secret da chave de API, poderá importar dados para o corpus da RAG.

Campo Mutabilidade Obrigatório ou opcional
rag_vector_db_config.vector_db Imutável depois que você faz uma escolha. Obrigatório
rag_vector_db_config.pinecone.index_name Imutável depois de definir o campo no corpus de RAG. Obrigatório
rag_vector_db_config.api_auth.api_key_config.api_key_secret_version Mutável. Depois de definir a chave de API, não é possível descartá-la. Opcional

Python 

import vertexai
from vertexai.preview import rag

# Set Project
PROJECT_ID = "YOUR_PROJECT_ID"
vertexai.init(project=PROJECT_ID, location="us-central1")

# Configure the Pinecone vector DB information
vector_db = rag.Pinecone(index_name=)

# Name your corpus
DISPLAY_NAME = "YOUR_CORPUS_NAME"

rag_corpus = rag.create_corpus(display_name=DISPLAY_NAME, vector_db=vector_db)

REST 

# Set your project ID for the corpus that you want to create.
PROJECT_ID = "YOUR_PROJECT_ID"

# Set your Pinecone index name
PINECONE_INDEX_NAME=YOUR_INDEX_NAME

# Set the full resource name of your secret. Follows the format
# projects/{PROJECT_NUMER}/secrets/{SECRET_ID}/versions/{VERSION_ID}
SECRET_RESOURCE_NAME=YOUR_SECRET_RESOURCE_NAME

# Call UpdateRagCorpus API with the Vector DB information.
curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
https://us-central1-aiplatform.googleapis.com}/v1beta1/projects/${PROJECT_ID}/locations/us-central1/ragCorpora -d '{
      "rag_vector_db_config" : {
         "pinecone": {"index_name": '\""${PINECONE_INDEX_NAME}"\"'},
         "api_auth": {"api_key_config":
               {"api_key_secret_version": '\""${SECRET_RESOURCE_NAME}"\"'}
         }
      }
   }'

# To poll the status of your RAG corpus creation, get the operation_id returned in
# response of your CreateRagCorpus call.
OPERATION_ID="YOUR_OPERATION_ID"

# Poll Operation status until done = true in the response.
# The response to this call will contain the ID for your created RAG corpus
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
https://us-central1-aiplatform.googleapis.com/v1beta1/projects/${PROJECT_ID}/locations/us-central1/operations/${OPERATION_ID}

A seguir