SearchLumaKnowledgeBase - EventBridge: Central de Documentação do Alibaba Cloud

Obtém conteúdo na base de conhecimento vinculada a um agente Luma e retorna trechos de texto relevantes junto com suas pontuações de relevância.

Descrição da operação

Obtém conteúdo na base de conhecimento vinculada a um agente Luma e retorna trechos de texto relevantes junto com suas pontuações de relevância.

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

eventbridge:SearchLumaKnowledgeBase

get

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AgentName	string	Sim	O nome do agente.	my_agent
Catalog	string	Sim	O nome do catálogo de dados vinculado ao agente. Você pode chamar ListLumaCatalogs para obter esse valor.	my_catalog
Namespace	string	Sim	O nome do namespace vinculado ao agente. Você pode chamar ListLumaNamespaces para obter esse valor.	my_namespace
KnowledgeBaseName	string	Sim	O nome da base de conhecimento vinculada ao agente. Você pode chamar ListLumaKnowledgeBases para obter esse valor.	my-knowledge-base
Query	string	Sim	A consulta de pesquisa em linguagem natural.	How to configure event rules
Mode	string	Não	O modo de recuperação. Valores válidos: vector (AISearch), keyword (recuperação por palavra-chave) e hybrid (recuperação híbrida). Se você não especificar este parâmetro, a configuração de recuperação da base de conhecimento será usada.	hybrid
TopK	integer	Não	O número de trechos de texto a serem retornados. Valores válidos: 1 a 100. Se você não especificar este parâmetro, a configuração de pesquisa da base de conhecimento será usada.	5
Rerank	boolean	Não	Especifica se a reclassificação deve ser ativada. Se ativada, os resultados recuperados são reclassificados para melhorar a precisão ao custo de uma maior duração de execução. Se você não especificar este parâmetro, a configuração de pesquisa da base de conhecimento será usada.	true
MetadataFilter	string	Não	As condições de filtro de metadados. O valor é uma string JSON usada para filtrar o escopo de recuperação com base nos metadados do documento. Para os campos disponíveis, consulte o MetadataSchema da base de conhecimento.	{"category":"faq"}

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Message	string	A mensagem de resposta. O valor é Operation success se a chamada for bem-sucedida, ou uma descrição de erro específica se a chamada falhar.	Operation success
RequestId	string	O identificador exclusivo da solicitação. Você pode usar este ID para solução de problemas e envio de tickets.	34AD682D-5B91-5773-8132-AA38C130****
Data	object	Os resultados da pesquisa da base de conhecimento vinculada ao agente.
Chunks	array	A lista de trechos de texto correspondentes à pesquisa, classificados por relevância.	[{"DocumentId":"doc-bp1xxxxxxxxxxxx","ChunkSeq":3,"Content":"EventBridge supports event routing"}]
	KnowledgeBaseSearchChunk	Os detalhes de um único trecho de texto correspondente, incluindo a pontuação de relevância, o conteúdo do trecho e as informações de localização.
TimeSpent	integer	A duração da pesquisa, em milissegundos.	1200
Code	string	O código de resposta. O valor é Success se a chamada for bem-sucedida, ou um código de erro específico se a chamada falhar.	Success
Success	boolean	Indica se a chamada foi bem-sucedida. Um valor true indica que a chamada foi bem-sucedida.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Message": "Operation success",
  "RequestId": "34AD682D-5B91-5773-8132-AA38C130****",
  "Data": {
    "Chunks": [
      {
        "Score": 0.92,
        "DocumentId": "doc-bp1xxxxxxxxxxxx",
        "FileName": "product-handbook.pdf",
        "ChunkSeq": 12,
        "Content": "O EventBridge oferece suporte ao roteamento de eventos para vários serviços de destino",
        "TitlePath": "Guia de instalação>Pré-requisitos",
        "SourceLocation": "p.3",
        "Scores": {
          "Vector": 0.85,
          "Keyword": 0.62,
          "Fusion": 0.78,
          "Rerank": 0.91
        }
      }
    ],
    "TimeSpent": 1200
  },
  "Code": "Success",
  "Success": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	InvalidParameter	The specified parameter is invalid
403	ServiceNotEnable	Service not enable
404	AgentNotFound	Agent not found
404	ResourceNotFound	The specified resource is not bound to the agent

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.