Melhorar a pesquisa e a qualidade do RAG com a API de classificação

Como parte da sua experiência de Geração Aumentada de Recuperação (RAG) nos aplicativos de IA, é possível classificar um conjunto de documentos com base em uma consulta.

A API de classificação usa uma lista de documentos e os reclassifica com base na relevância deles para uma consulta. Em comparação com os embeddings, que analisam apenas a similaridade semântica de um documento e uma consulta, a API Ranking pode fornecer pontuações precisas sobre a qualidade da resposta de um documento a uma consulta específica. A API de classificação pode ser usada para melhorar a qualidade dos resultados da pesquisa depois de recuperar um conjunto inicial de documentos candidatos.

A API de classificação não tem estado, então não é necessário indexar documentos antes de chamar a API. Basta transmitir a consulta e os documentos. Isso torna a API adequada para reclassificar documentos da pesquisa vetorial e de outras soluções de pesquisa.

Nesta página, descrevemos como usar a API de classificação para classificar um conjunto de documentos com base em uma consulta.

Casos de uso

O principal caso de uso da API Ranking é melhorar a qualidade dos resultados da pesquisa.

No entanto, a API Ranking pode ser útil em qualquer cenário em que você precise encontrar quais partes do conteúdo são mais relevantes para a consulta de um usuário. Por exemplo, a API Ranking pode ajudar você com o seguinte:

• Encontrar o conteúdo certo para embasamento de um LLM

• Melhorar a relevância de uma experiência de pesquisa

• Identificar seções relevantes de um documento

O fluxo a seguir descreve como usar a API Ranking para melhorar a qualidade dos resultados de documentos divididos em partes:

1. Use a API Document AI Layout Parser para dividir um conjunto de documentos em partes.

2. Use uma API de embeddings para criar embeddings para cada um dos blocos.

3. Carregue os embeddings na pesquisa de vetor ou em outra solução de pesquisa.

4. Consulte seu índice de pesquisa e recupere os trechos mais relevantes.

5. Reclassifique os trechos relevantes usando a API Ranking.

Dados de entrada

A API Ranking requer as seguintes entradas:

• A consulta para a qual você está classificando os registros.

  Exemplo:

  "query": "Why is the sky blue?"
  

• Um conjunto de registros relevantes para a consulta. Os registros são fornecidos como uma matriz de objetos. Cada registro pode incluir um ID exclusivo, um título e o conteúdo do documento. Para cada registro, inclua um título, conteúdo ou ambos. O número máximo de tokens aceitos por registro depende da versão do modelo usada. Por exemplo, modelos até a versão 003 aceitam 512 tokens, enquanto a versão 004 aceita 1.024 tokens. Se o comprimento combinado do título e do conteúdo exceder o limite de tokens do modelo, o conteúdo extra será truncado. É possível incluir até 200 registros por solicitação.

  Por exemplo, uma matriz de registros é parecida com esta. Na realidade, muito mais registros seriam incluídos na matriz, e o conteúdo seria muito mais longo:

  "records": [
     {
         "id": "1",
         "title": "The Color of the Sky: A Poem",
         "content": "A canvas stretched across the day,\nWhere sunlight learns to dance and play.\nBlue, a hue of scattered light,\nA gentle whisper, soft and bright."
     },
     {
         "id": "2",
         "title": "The Science of a Blue Sky",
         "content": "The sky appears blue due to a phenomenon called Rayleigh scattering. Sunlight is comprised of all the colors of the rainbow. Blue light has shorter wavelengths than other colors, and is thus scattered more easily."
     }
  ]
  

• Opcional: o número máximo de registros que você quer que a API Ranking retorne. Por padrão, todos os registros são retornados. No entanto, é possível usar o campo topN para retornar menos registros. Todos os registros são classificados, independente do valor definido.

  Por exemplo, isso retorna os 10 principais registros classificados:

  "topN": 10,
  

• Opcional: uma configuração que especifica se você quer apenas o ID do registro retornado pela API ou também o título e o conteúdo do registro. Por padrão, o registro completo é retornado. O principal motivo para definir isso é se você quiser reduzir o tamanho do payload da resposta.

  Por exemplo, definir como true retorna apenas o ID do registro, não o título ou conteúdo:

  "ignoreRecordDetailsInResponse": true,
  

• Opcional: o nome do modelo. Isso especifica o modelo a ser usado para classificar os documentos. Se nenhum modelo for especificado, semantic-ranker-default@latest será usado, que aponta automaticamente para o modelo mais recente disponível. Para apontar para um modelo específico, especifique um dos nomes listados em Modelos compatíveis, por exemplo, semantic-ranker-512-003.

  No exemplo a seguir, model está definido como semantic-ranker-default@latest. Isso significa que a API Ranking sempre vai usar o modelo mais recente disponível.

  "model": "semantic-ranker-default@latest"
  

Dados de saída

A API Ranking retorna uma lista classificada de registros com as seguintes saídas:

• Pontuação: um valor flutuante entre 0 e 1 que indica a relevância do registro.

• ID: o ID exclusivo do registro.

• Se solicitado, o objeto completo: ID, título e conteúdo.

  Exemplo:

{
    "records": [
        {
            "id": "2",
            "score": 0.98,
            "title": "The Science of a Blue Sky",
            "content": "The sky appears blue due to a phenomenon called Rayleigh scattering. Sunlight is comprised of all the colors of the rainbow. Blue light has shorter wavelengths than other colors, and is thus scattered more easily."
        },
        {
            "id": "1",
            "score": 0.64,
            "title": "The Color of the Sky: A Poem",
            "content": "A canvas stretched across the day,\nWhere sunlight learns to dance and play.\nBlue, a hue of scattered light,\nA gentle whisper, soft and bright."
        }
    ]
}

Classificar (ou reclassificar) um conjunto de registros de acordo com uma consulta

Normalmente, você fornece à API de classificação uma consulta e um conjunto de registros relevantes para essa consulta e que já foram classificados por algum outro método, como uma pesquisa de palavra-chave ou uma pesquisa vetorial. Em seguida, use a API Ranking para melhorar a qualidade da classificação e determinar uma pontuação que indique a relevância de cada registro para a consulta.

1. Extraia a consulta e os registros resultantes. Verifique se cada registro tem um ID e um título, conteúdo ou ambos.

   O número máximo de tokens aceitos por registro depende da versão do modelo. Modelos até a versão 003, como semantic-ranker-512-003, aceitam 512 tokens por registro. A partir da versão 004, esse limite aumenta para 1.024 tokens. Se o comprimento combinado do título e do conteúdo exceder o limite de tokens do modelo, o conteúdo extra será truncado.

2. Chame o método rankingConfigs.rank usando o seguinte código:

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/rankingConfigs/default_ranking_config:rank" \
-d '{
"model": "semantic-ranker-default@latest",
"query": "QUERY",
"records": [
    {
        "id": "RECORD_ID_1",
        "title": "TITLE_1",
        "content": "CONTENT_1"
    },
    {
        "id": "RECORD_ID_2",
        "title": "TITLE_2",
        "content": "CONTENT_2"
    },
    {
        "id": "RECORD_ID_3",
        "title": "TITLE_3",
        "content": "CONTENT_3"
    }
]
}'

    curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -H "X-Goog-User-Project: my-project-123" \
    "https://discoveryengine.googleapis.com/v1/projects/my-project-123/locations/global/rankingConfigs/default_ranking_config:rank" \
    -d '{
        "model": "semantic-ranker-default@latest",
        "query": "what is Google gemini?",
        "records": [
            {
                "id": "1",
                "title": "Gemini",
                "content": "The Gemini zodiac symbol often depicts two figures standing side-by-side."
            },
            {
                "id": "2",
                "title": "Gemini",
                "content": "Gemini is a cutting edge large language model created by Google."
            },
            {
                "id": "3",
                "title": "Gemini Constellation",
                "content": "Gemini is a constellation that can be seen in the night sky."
            }
        ]
    }'
    

{
    "records": [
        {
            "id": "2",
            "title": "Gemini",
            "content": "Gemini is a cutting edge large language model created by Google.",
            "score": 0.97
        },
        {
            "id": "3",
            "title": "Gemini Constellation",
            "content": "Gemini is a constellation that can be seen in the night sky.",
            "score": 0.18
        },
        {
            "id": "1",
            "title": "Gemini",
            "content": "The Gemini zodiac symbol often depicts two figures standing side-by-side.",
            "score": 0.05
        }
    ]
}

from google.cloud import discoveryengine_v1 as discoveryengine

# TODO(developer): Uncomment these variables before running the sample.
# project_id = "YOUR_PROJECT_ID"

client = discoveryengine.RankServiceClient()

# The full resource name of the ranking config.
# Format: projects/{project_id}/locations/{location}/rankingConfigs/default_ranking_config
ranking_config = client.ranking_config_path(
    project=project_id,
    location="global",
    ranking_config="default_ranking_config",
)
request = discoveryengine.RankRequest(
    ranking_config=ranking_config,
    model="semantic-ranker-default@latest",
    top_n=10,
    query="What is Google Gemini?",
    records=[
        discoveryengine.RankingRecord(
            id="1",
            title="Gemini",
            content="The Gemini zodiac symbol often depicts two figures standing side-by-side.",
        ),
        discoveryengine.RankingRecord(
            id="2",
            title="Gemini",
            content="Gemini is a cutting edge large language model created by Google.",
        ),
        discoveryengine.RankingRecord(
            id="3",
            title="Gemini Constellation",
            content="Gemini is a constellation that can be seen in the night sky.",
        ),
    ],
)

response = client.rank(request=request)

# Handle the response
print(response)

Modelos compatíveis

Os seguintes modelos estão disponíveis.

A seguir

Aprenda a usar o método de classificação com outras APIs RAG para gerar respostas embasadas com dados não estruturados.