Reclassificação para o mecanismo de RAG da Vertex AI

A página explica o reclassificação e os tipos de classificadores. A página também demonstra como usar a API de classificação da Vertex AI para reclassificar as respostas recuperadas.

Reclassificadores disponíveis

Opções de classificação Descrição Latência Precisão Preços
API Vertex AI Ranking A API Vertex AI Ranking é um reranker semântico independente projetado para pontuação de relevância altamente precisa e baixa latência.

Para mais informações sobre a API Ranking da Vertex AI, consulte Melhorar a qualidade da pesquisa e da RAG com a API Ranking.		 Muito baixa (menos de 100 milissegundos) Desempenho de última geração Por solicitação do mecanismo de RAG da Vertex AI
Reclassificador de LLM O reranker de LLM usa uma chamada separada para o Gemini para avaliar a relevância dos trechos em relação a uma consulta. Alta (1 a 2 segundos) Dependente do modelo Preços de token de LLM

Usar a API de classificação da Vertex AI

Para usar a API Vertex AI Ranking, é necessário ativar a API Discovery Engine. Todos os modelos compatíveis podem ser encontrados em Melhorar a qualidade da pesquisa e da RAG com a API Ranking.

Esses exemplos de código demonstram como ativar o reclassificação com a API Vertex AI Ranking na configuração da ferramenta.

Python

Para saber como instalar ou atualizar o SDK da Vertex AI para Python, consulte Instalar o SDK da Vertex AI para Python. Para mais informações, consulte a documentação de referência da API Python.

Substitua as seguintes variáveis usadas no exemplo de código:

  • PROJECT_ID: o ID do seu projeto do Google Cloud .
  • LOCATION: a região para processar a solicitação.
  • MODEL_NAME: modelo LLM para geração de conteúdo. Por exemplo, gemini-2.0-flash.
  • INPUT_PROMPT: o texto enviado ao LLM para geração de conteúdo.
  • RAG_CORPUS_RESOURCE: o nome do recurso do corpus da RAG.
    Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}.
  • SIMILARITY_TOP_K: opcional: o número dos principais contextos a serem recuperados.
  • RANKER_MODEL_NAME: o nome do modelo usado para reclassificação. Por exemplo, semantic-ranker-default@latest.
from vertexai import rag
from vertexai.generative_models import GenerativeModel, Tool
import vertexai

PROJECT_ID = "PROJECT_ID"
CORPUS_NAME = "projects/{PROJECT_ID}/locations/LOCATION/ragCorpora/RAG_CORPUS_RESOURCE"

# Initialize Vertex AI API once per session
vertexai.init(project=PROJECT_ID, location="LOCATION")

config = rag.RagRetrievalConfig(
    top_k=10,
    ranking=rag.Ranking(
        rank_service=rag.RankService(
            model_name=RANKER_MODEL_NAME
        )
    )
)

rag_retrieval_tool = Tool.from_retrieval(
    retrieval=rag.Retrieval(
        source=rag.VertexRagStore(
            rag_resources=[
                rag.RagResource(
                    rag_corpus=CORPUS_NAME,
                )
            ],
            rag_retrieval_config=config
        ),
    )
)

rag_model = GenerativeModel(
    model_name="MODEL_NAME", tools=[rag_retrieval_tool]
)
response = rag_model.generate_content("INPUT_PROMPT")
print(response.text)
# Example response:
#   The sky appears blue due to a phenomenon called Rayleigh scattering.
#   Sunlight, which contains all colors of the rainbow, is scattered
#   by the tiny particles in the Earth's atmosphere....
#   ...

REST

Para gerar conteúdo usando modelos do Gemini, faça uma chamada para a API GenerateContent da Vertex AI. Ao especificar o RAG_CORPUS_RESOURCE ao fazer a solicitação, o modelo recupera automaticamente os dados do mecanismo RAG da Vertex AI.

Substitua as seguintes variáveis usadas no exemplo de código:

  • PROJECT_ID: o ID do seu projeto do Google Cloud .
  • LOCATION: a região para processar a solicitação.
  • MODEL_NAME: modelo LLM para geração de conteúdo. Por exemplo, gemini-2.0-flash.
  • GENERATION_METHOD: método LLM para geração de conteúdo. As opções incluem generateContent e streamGenerateContent.
  • INPUT_PROMPT: o texto enviado ao LLM para geração de conteúdo.
  • RAG_CORPUS_RESOURCE: o nome do recurso do corpus da RAG.
    Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}.
  • SIMILARITY_TOP_K: opcional: o número dos principais contextos a serem recuperados.
  • RANKER_MODEL_NAME: o nome do modelo usado para reclassificação. Por exemplo, semantic-ranker-default@latest.
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/publishers/google/models/MODEL_NAME:GENERATION_METHOD" \
-d '{
  "contents": {
    "role": "user",
    "parts": {
      "text": "INPUT_PROMPT"
    }
  },
  "tools": {
    "retrieval": {
      "disable_attribution": false,
      "vertex_rag_store": {
        "rag_resources": {
            "rag_corpus": "RAG_CORPUS_RESOURCE"
          },
        "rag_retrieval_config": {
          "top_k": SIMILARITY_TOP_K,
          "ranking": {
            "rank_service": {
              "model_name": "RANKER_MODEL_NAME"
            }
          }
        }
      }
    }
  }
}'

Usar o reranker de LLM no mecanismo de RAG da Vertex AI

Esta seção apresenta os pré-requisitos e exemplos de código para usar um reranker de LLM.

O reranker de LLM só é compatível com modelos do Gemini, que podem ser acessados quando a API do mecanismo RAG da Vertex AI está ativada. Para conferir a lista de modelos compatíveis, consulte Modelos do Gemini.

Para recuperar contextos relevantes usando a API do mecanismo RAG da Vertex AI, faça o seguinte:

Python

Para saber como instalar ou atualizar o SDK da Vertex AI para Python, consulte Instalar o SDK da Vertex AI para Python. Para mais informações, consulte a documentação de referência da API Python.

Substitua as seguintes variáveis usadas no exemplo de código:

  • PROJECT_ID: o ID do seu projeto do Google Cloud .
  • LOCATION: a região para processar a solicitação.
  • RAG_CORPUS_RESOURCE: o nome do recurso de corpus RAG. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}.
  • TEXT: o texto da consulta para receber contextos relevantes.
  • MODEL_NAME: o nome do modelo usado para reclassificação.
from vertexai import rag
import vertexai

PROJECT_ID = "PROJECT_ID"
CORPUS_NAME = "projects/[PROJECT_ID]/locations/LOCATION/ragCorpora/RAG_CORPUS_RESOURCE"
MODEL_NAME= "MODEL_NAME"

# Initialize Vertex AI API once per session
vertexai.init(project=PROJECT_ID, location="LOCATION")

rag_retrieval_config = rag.RagRetrievalConfig(
    top_k=10,
    ranking=rag.Ranking(
        llm_ranker=rag.LlmRanker(
            model_name=MODEL_NAME
        )
    )
)

response = rag.retrieval_query(
    rag_resources=[
        rag.RagResource(
            rag_corpus=CORPUS_NAME,
        )
    ],
    text="TEXT",
    rag_retrieval_config=rag_retrieval_config,
)
print(response)
# Example response:
# contexts {
#   contexts {
#     source_uri: "gs://your-bucket-name/file.txt"
#     text: "....
#   ....

REST

Substitua as seguintes variáveis usadas no exemplo de código:

  • PROJECT_ID: o ID do seu projeto do Google Cloud .
  • LOCATION: a região para processar a solicitação.
  • RAG_CORPUS_RESOURCE: o nome do recurso de corpus RAG. Formato: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}.
  • TEXT: o texto da consulta para receber contextos relevantes.
  • MODEL_NAME: o nome do modelo usado para reclassificação.
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION:retrieveContexts" \
  -d '{
    "vertex_rag_store": {
      "rag_resources": {
          "rag_corpus": "RAG_CORPUS_RESOURCE"
        }
    },
    "query": {
      "text": "TEXT",
      "rag_retrieval_config": {
        "top_k": 10,
        "ranking": {
          "llm_ranker": {
            "model_name": "MODEL_NAME"
          }
        }
      }
    }
  }'

A seguir