Rerank - AnalyticDB: Central de Documentação do Alibaba Cloud

A operação Rerank resolve o problema de classificação imprecisa de resultados de pesquisa vetorial e de texto completo. Ela recalcula a pontuação e reordena os dados recuperados por meio de compreensão semântica para melhorar significativamente a relevância e a precisão dos resultados. O AnalyticDB for PostgreSQL permite reclassificar os resultados da pesquisa usando modelos Rerank, mas não fornece esses modelos.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

gpdb:Rerank

list

*DBInstance

acs:gpdb:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBInstanceId	string	Sim	O ID da instância. Nota Você pode chamar a API DescribeDBInstances para visualizar os detalhes de todas as instâncias do AnalyticDB for PostgreSQL na região de destino, incluindo o ID da instância.	gp-xxxxxxxxx
RegionId	string	Sim	O ID da região onde a instância está localizada.	cn-hangzhou
Query	string	Não	A instrução de consulta para o Rerank.	What is ADBPG?
Documents	array	Não	A lista de documentos a serem reordenados.	ADBPG is an Alibaba Cloud OLAP database.
	string	Não	O conteúdo de um único documento.	ADBPG是阿里云OLAP数据库。
Model	string	Não	O modelo Rerank. Atualmente, suporta: bge-reranker-v2-m3: (padrão) melhor desempenho, suporta 8192 tokens por inferência. Se esse limite for excedido, o texto será dividido, o que pode reduzir a eficácia. bge-reranker-v2-minicpm-layerwise: melhor desempenho que o v2-m3, suporta 2048 tokens por inferência. Se esse limite for excedido, o texto será dividido, o que pode reduzir a eficácia.	bge-reranker-v2-m3
Instruct	string	Não	O número de documentos mais relevantes a serem retornados.	Given a web search query, retrieve relevant passages that answer the query
TopK	integer	Não	Se definido como false, não retorna o texto de Documents, retornando apenas o índice de ordem do documento e a pontuação do rerank.	3
ReturnDocuments	boolean	Não	O número máximo de chunks permitidos quando o texto excede a janela do modelo: bge-reranker-v2-m3: o valor padrão é 10. bge-reranker-v2-minicpm-layerwise: o valor padrão é 5. Nota Exemplo de divisão Ao usar o modelo bge-reranker-v2-minicpm-layerwise, a janela máxima de inferência única é de 2048 tokens. Se a consulta tiver 48 tokens e o conteúdo de um único documento no parâmetro for de 9000 tokens, ele será dividido da seguinte forma: de 1 a 2000 para o primeiro, de 2001 a 4000 para o segundo, e assim por diante. Se o número de divisões exceder MaxChunksPerDoc, as sentenças restantes serão descartadas.	false
MaxChunksPerDoc	integer	Não	Maximum number of chunks allowed when the text exceeds the model window: bge-reranker-v2-m3: default value is 10. bge-reranker-v2-minicpm-layerwise: default value is 5: Nota Example of splitting If using the bge-reranker-v2-minicpm-layerwise model, the maximum single inference window is 2048 tokens. If the query is 48 tokens and the content of a single document parameter is 9000 tokens, it will be divided as follows: 1-2000 for the first, 2001-4000 for the second, and so on. If the number of splits exceeds MaxChunksPerDoc, the remaining sentences will be discarded.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	As informações detalhadas retornadas pela API.	success
Status	string	O status de execução da API. Valores válidos: success: Execução bem-sucedida. fail: Falha na execução.	success
Tokens	integer	O número de tokens consumidos.	100
Results	object
Results	array<object>	Os resultados do rerank.
	object	Os detalhes dos resultados.
Document	string	Re-ordered document information.	ADBPG is an Alibaba Cloud OLAP database.
Index	integer	Index of this document in the request parameter Documents, starting from 0.	1
RelevanceScore	number	Rerank similarity score.	2.31412

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "Tokens": 100,
  "Results": {
    "Results": [
      {
        "Document": "ADBPG is an Alibaba Cloud OLAP database.",
        "Index": 1,
        "RelevanceScore": 2.31412
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.