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

Pesquisa em uma base de conhecimento.

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:SearchKnowledgeBase

get

*KnowledgeBase

acs:eventbridge:{#regionId}:{#accountId}:catalog/{#Catalog}/namespace/{#Namespace}/knowledgebase/{#KnowledgeBaseName}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Catalog	string	Sim	O catálogo de dados ao qual a base de conhecimento pertence. Este parâmetro, juntamente com Namespace e KnowledgeBaseName, identifica exclusivamente a base de conhecimento. Você pode chamar ListCatalogs para obter o valor.	my_catalog
Namespace	string	Sim	O namespace ao qual a base de conhecimento pertence. O namespace deve pertencer ao catálogo de dados especificado. Este parâmetro, juntamente com Catalog e KnowledgeBaseName, identifica exclusivamente a base de conhecimento. Você pode chamar ListNamespaces para obter o valor.	my_namespace
KnowledgeBaseName	string	Sim	O nome da base de conhecimento. O nome deve ser exclusivo dentro do namespace. O nome é especificado na criação e não pode ser modificado.	my-knowledge-base
Query	string	Sim	O texto de recuperação. Tanto a recuperação por palavra-chave quanto a AISearch baseiam-se neste texto.	How to configure event rules
Mode	string	Não	O modo de recuperação. Valores válidos: KEYWORD: recuperação por palavra-chave. VECTOR: AISearch. HYBRID: recuperação híbrida.	HYBRID
TopK	integer	Não	O número de resultados mais relevantes a serem retornados. Valor padrão: 10. Valor máximo: 100.	10
MetadataFilter	string	Não	Filtra os resultados da pesquisa por metadados do documento. O valor é uma árvore de expressões JSON. Os nós são divididos em dois tipos: nós lógicos e condições folha. Os nós lógicos incluem {"AndAll": [nós filhos...]} (todas as condições atendidas), {"OrAll": [nós filhos...]} (qualquer condição atendida) e {"NotAll": [nós filhos...]} (nenhuma condição atendida). O aninhamento arbitrário é suportado. As condições folha estão no formato {"Key": nome do campo, "Operator": operador, "Value": valor}. Para os operadores In e NotIn, use "Values": [valores...]. Valores válidos para Operator: Equals, NotEquals, In, NotIn, GreaterThan, GreaterThanOrEqual, LessThan e LessThanOrEqual (os quatro últimos operadores de intervalo aplicam-se apenas a campos LONG, DOUBLE e DATETIME), StartsWith e StringContains (aplica-se apenas a campos STRING). O campo deve ser declarado no esquema da base de conhecimento. A profundidade de aninhamento não pode exceder 5, e o número total de condições folha não pode exceder 20. Formatos válidos para valores de campo DATETIME: ISO-8601 com fuso horário, yyyy-MM-dd HH:mm:ss ou yyyy-MM-dd.	{"AndAll": [{"Key": "env", "Operator": "In", "Values": ["prod", "staging"]}, {"OrAll": [{"Key": "score", "Operator": "GreaterThan", "Value": "0.8"}, {"Key": "owner", "Operator": "Equals", "Value": "alice"}]}]}
Rerank	boolean	Não	Especifica se o reordenamento dos resultados da pesquisa deve ser ativado. Valor padrão: false.	false
RrfK	integer	Não	Opcional. Substitui o parâmetro de fusão k do RRF configurado para a base de conhecimento nesta solicitação. Este parâmetro entra em vigor apenas no modo de pesquisa HYBRID e deve ser maior que 0.	60
RankAlgorithm	string	Não	Opcional. Substitui o algoritmo de fusão configurado para a base de conhecimento nesta solicitação. Este parâmetro entra em vigor apenas no modo de pesquisa HYBRID. Valores válidos: RRF para fusão de classificação recíproca e WEIGHTED para fusão de normalização ponderada (usado com VectorWeight). Se você definir este parâmetro como WEIGHTED no modo único KEYWORD ou VECTOR, o erro InvalidParameter será retornado.	RRF
VectorWeight	number	Não	Opcional. O peso do caminho vetorial para o algoritmo de fusão WEIGHTED. Valores válidos: 0 a 1. O peso do caminho de palavra-chave é 1 menos este valor. Se este parâmetro não for especificado, o valor configurado para a base de conhecimento será usado. Se nenhum valor estiver configurado, o valor padrão será 0,7.	0.7
RerankModel	string	Não	Opcional. Substitui o modelo de reordenamento configurado para a base de conhecimento nesta solicitação. Este parâmetro entra em vigor quando o reordenamento está ativado em todos os modos de pesquisa. Valores válidos: qwen3-rerank, gte-rerank-v2 e qwen3-vl-rerank. Se este parâmetro não for especificado, o valor configurado para a base de conhecimento será usado. Se nenhum valor estiver configurado, o valor padrão será qwen3-rerank. As distribuições de pontuação de diferentes modelos não podem ser comparadas horizontalmente. Recomendamos que você use um modelo fixo para cada base de conhecimento.	qwen3-rerank

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O código de resposta. O valor Success indica êxito. Se a chamada falhar, um código de erro específico será retornado.	Success
Data	object	Os resultados da pesquisa, que incluem a lista de chunks correspondentes e o tempo gasto.
Chunks	array	A lista de chunks correspondentes, classificados por relevância.	[{"DocumentId":"doc-bp1xxxxxxxxxxxx","ChunkSeq":3,"Content":"EventBridge supports event routing."}]
	KnowledgeBaseSearchChunk	Os detalhes de um único chunk correspondente, incluindo a pontuação de relevância, o texto do chunk e as informações de localização.
TimeSpent	integer	O tempo de processamento no lado do servidor para esta pesquisa, em milissegundos.	128
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 ID da solicitação.	34AD682D-5B91-5773-8132-AA38C130****
Success	boolean	Indica se a chamada foi bem-sucedida. O valor true indica êxito.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "Success",
  "Data": {
    "Chunks": [
      {
        "ChunkSeq": 12,
        "Content": "O EventBridge oferece suporte ao roteamento de eventos para vários serviços de destino",
        "DocumentId": "doc-bp1xxxxxxxxxxxx",
        "FileName": "product-handbook.pdf",
        "Score": 0.92,
        "Scores": {
          "Fusion": 0.78,
          "Keyword": 0.62,
          "Rerank": 0.91,
          "Vector": 0.85
        },
        "SourceLocation": "p.3",
        "TitlePath": "Guia de instalação>Pré-requisitos"
      }
    ],
    "TimeSpent": 128
  },
  "Message": "Operation success",
  "RequestId": "34AD682D-5B91-5773-8132-AA38C130****",
  "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	KnowledgeBaseNotFound	The specified knowledge base does not exist
404	CatalogNotFound	The specified catalog does not exist
404	NamespaceNotFound	The specified namespace does not exist
409	InvalidKnowledgeBaseStatus	The knowledge base status does not support this operation

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.