View a markdown version of this page

Usar um modelo reclassificador no Amazon Bedrock - Amazon Bedrock

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Usar um modelo reclassificador no Amazon Bedrock

É possível usar um modelo reclassificador diretamente ou ao recuperar resultados durante consultas à base de conhecimento. Escolha a guia correspondente ao método de sua preferência e siga as etapas:

Console

Você não pode usar um modelo de reclassificação diretamente no Console de gerenciamento da AWS, mas você pode usar um modelo de reclassificação ao consultar sua base de conhecimento fazendo o seguinte:

  1. Ao consultar uma base de conhecimento, abra o painel Configurações escolhendo o ícone Icon showing three horizontal sliders at different positions for adjusting settings. .

  2. Expanda a seção Reclassificação.

  3. Escolha Selecionar modelo e escolha um modelo reclassificador.

  4. Se seu perfil de serviço das Bases de Conhecimento do Amazon Bedrock não tiver permissões para usar o modelo reclassificador, selecione Atualizar perfil de serviço para modificar o perfil com as permissões adequadas.

  5. (Opcional) Na seção Opções adicionais de reclassificação, modifique as opções necessárias.

  6. Insira um prompt e selecione Executar. A resposta é o resultado obtido após a aplicação do modelo reclassificador.

Para obter instruções mais detalhadas sobre como realizar consultas à base de conhecimento, consulte Consultar uma base de conhecimento e recuperar dados e Consultar uma base de conhecimento e gerar respostas com base nos dados recuperados.

API

Para obter instruções sobre como usar um modelo reclassificador durante a consulta à base de conhecimento, consulte Consultar uma base de conhecimento e recuperar dados e Consultar uma base de conhecimento e gerar respostas com base nos dados recuperados.

Para usar um modelo reclassificador diretamente com a API do Amazon Bedrock, envie uma solicitação Rerank com um endpoint de runtime do recurso Agentes para Amazon Bedrock.

Os seguintes campos são obrigatórios:

Campo Descrição básica
queries Uma matriz de um RerankQueryobjeto. Especifique TEXT como type e inclua a consulta no campo textQuery.
sources Uma matriz de RerankSourceobjetos a serem enviados ao modelo de reclassificação. Para cada umRerankSource, especifique INLINE como type e inclua um RerankDocumentobjeto no inlineDocumentSource campo. Consulte abaixo para obter detalhes RerankDocument.
rerankingConfiguration Inclui o nome do recurso da Amazon (ARN) do modelo reclassificador a ser usado, o número de resultados a serem obtidos após a reclassificação e, opcionalmente, as configurações de inferência do modelo. Especifique as configurações adicionais do modelo como pares de chave-valor. Para ter mais informações, consulte Rerank no site de documentação da Cohere.

Os seguintes campos são opcionais:

Campo Caso de uso
nextToken Um token exibido em uma resposta anterior que você pode incluir para fornecer o próximo lote de resultados.

O formato do objeto RerankSource que você inclui depende do formato do documento. Para ver o formato dos diferentes tipos de RerankSource, escolha a guia que corresponde ao formato do documento:

StringJSON object
String

Se o documento for uma string, especifique o valor do type campo do RerankDocumentobjeto como TEXT e inclua o documento no text campo. Por exemplo:

{
    "inlineDocumentSource": {
        "textDocument": {
            "text": "string"
        },
        "type": "TEXT"
    },
    "type": "INLINE"
}
JSON object

Se o documento for um objeto JSON, especifique o valor do type campo no RerankDocumentobjeto como JSON e inclua o documento no jsonDocument campo. Por exemplo:

{
    "inlineDocumentSource": {
        "jsonDocument": JSON value,
        "type": "JSON"
    },
    "type": "INLINE"
}

A resposta à sua Rerank solicitação retorna uma lista de RerankResultobjetos no results campo. Cada objeto contém os seguintes campos:

  • document: inclui informações sobre o documento que você enviou.

  • relevanceScore: uma pontuação de relevância para o documento, atribuída pelo modelo reclassificador.

  • index: indica a classificação do documento em relação aos outros documentos na lista. Quanto menor a pontuação, maior a classificação.

Se houver muitos resultados para exibir, a resposta exibirá um valor no campo nextToken. Nesse caso, para ver o próximo lote de resultados, inclua esse token em uma solicitação subsequente.

Exemplos de código

Os exemplos a seguir mostram como chamar a API Rerank usando os AWS SDKs.

PythonNode.js
Python
import boto3

client = boto3.client('bedrock-agent-runtime', region_name='us-east-1')
response = client.rerank(
    queries=[{
        'type': 'TEXT',
        'textQuery': {'text': 'What is Amazon Bedrock?'}
    }],
    sources=[
        {
            'type': 'INLINE',
            'inlineDocumentSource': {
                'type': 'TEXT',
                'textDocument': {'text': 'Amazon Bedrock is a fully managed service for foundation models.'}
            }
        },
        {
            'type': 'INLINE',
            'inlineDocumentSource': {
                'type': 'TEXT',
                'textDocument': {'text': 'Amazon S3 is an object storage service.'}
            }
        }
    ],
    rerankingConfiguration={
        'type': 'BEDROCK_RERANKING_MODEL',
        'bedrockRerankingConfiguration': {
            'modelConfiguration': {
                'modelArn': 'arn:aws:bedrock:us-east-1::foundation-model/cohere.rerank-v3-5:0'
            },
            'numberOfResults': 2
        }
    }
)
for result in response['results']:
    print(f'Index: {result["index"]}, Score: {result["relevanceScore"]}')
Node.js
import { BedrockAgentRuntimeClient, RerankCommand } from "@aws-sdk/client-bedrock-agent-runtime";

const client = new BedrockAgentRuntimeClient({ region: "us-east-1" });
const response = await client.send(new RerankCommand({
    queries: [{
        type: "TEXT",
        textQuery: { text: "What is Amazon Bedrock?" }
    }],
    sources: [
        {
            type: "INLINE",
            inlineDocumentSource: {
                type: "TEXT",
                textDocument: { text: "Amazon Bedrock is a fully managed service for foundation models." }
            }
        },
        {
            type: "INLINE",
            inlineDocumentSource: {
                type: "TEXT",
                textDocument: { text: "Amazon S3 is an object storage service." }
            }
        }
    ],
    rerankingConfiguration: {
        type: "BEDROCK_RERANKING_MODEL",
        bedrockRerankingConfiguration: {
            modelConfiguration: {
                modelArn: "arn:aws:bedrock:us-east-1::foundation-model/cohere.rerank-v3-5:0"
            },
            numberOfResults: 2
        }
    }
}));
for (const result of response.results) {
    console.log(`Index: ${result.index}, Score: ${result.relevanceScore}`);
}