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

Atualiza 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:UpdateKnowledgeBase

update

*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. É usado em conjunto com Namespace e KnowledgeBaseName para localizar 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. É usado em conjunto com Catalog e KnowledgeBaseName para localizar 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. É especificado durante a criação e não pode ser modificado.	my-knowledge-base
Description	string	Não	Atualiza a descrição da base de conhecimento. Se este parâmetro não for especificado, a descrição não será modificada.	Product documentation knowledge base
ChunkConfiguration	object	Não	Opcional. Atualiza a estratégia de fragmentação padrão da base de conhecimento. Esta atualização entra em vigor apenas para documentos recém-carregados e não refragmenta os documentos existentes. Se este parâmetro não for especificado, a estratégia não será modificada.
HeadingLevel	integer	Não	Obrigatório para a estratégia BY_HEADING. Valores válidos: 1 a 6. Este parâmetro é ignorado para outras estratégias. Títulos no nível especificado ou acima dele são usados como limites de divisão. Por exemplo, se você definir este parâmetro como 2, tanto os títulos H1 quanto H2 serão usados para a divisão. Títulos de níveis mais profundos não são divididos e são mantidos no texto do fragmento. Se o conteúdo da seção exceder MaxChunkSize, o sistema recorrerá à divisão por parágrafos ou frases. Para documentos sem títulos, o sistema recorrerá à fragmentação inteligente.	2
MaxChunkSize	integer	Não	O comprimento máximo de tokens de um único fragmento.	512
OverlapSize	integer	Não	O comprimento de tokens de sobreposição entre fragmentos adjacentes.	6
PreprocessRules	object	Não	As regras de pré-processamento.
RemoveUrlsAndEmails	boolean	Não	Especifica se devem ser removidos URLs e endereços de e-mail durante a análise.	false
ReplaceConsecutiveWhitespace	boolean	Não	Especifica se os caracteres de espaço em branco consecutivos, como espaços, quebras de linha e tabulações, devem ser substituídos por um único espaço.	true
Separator	string	Não	O identificador de parágrafo para a estratégia LINE_BREAK, como uma quebra de linha.	\\n\\n
Strategy	string	Sim	A estratégia de fragmentação. Valores válidos: AUTO: Fragmentação automática. LINE_BREAK: Fragmentação por identificador de parágrafo.	LINE_BREAK
SearchConfiguration	object	Não	Opcional. Atualiza a configuração de pesquisa padrão no nível da base de conhecimento. A atualização entra em vigor imediatamente para as solicitações de pesquisa subsequentes. Se este parâmetro não for especificado, a configuração não será modificada.
Mode	string	Não	O modo de pesquisa. Valores válidos: KEYWORD: Recuperação por palavra-chave. VECTOR: AISearch. HYBRID: Recuperação híbrida.	HYBRID
RankAlgorithm	string	Não	O algoritmo de fusão de pesquisa híbrida. Este parâmetro entra em vigor apenas no modo de pesquisa híbrida. Valores válidos: RRF: Fusão de classificação recíproca.	RRF
RerankEnabled	boolean	Não	Especifica se a reclassificação deve ser ativada por padrão. Este parâmetro entra em vigor apenas no modo de pesquisa híbrida e é usado quando uma solicitação de pesquisa não especifica o parâmetro Rerank.	false
RerankModel	string	Não	O modelo de reclassificação padrão usado quando uma solicitação de pesquisa não especifica o parâmetro RerankModel. Valores válidos: qwen3-rerank. Valor padrão: qwen3-rerank.	qwen3-rerank
RrfK	integer	Não	O parâmetro k para o algoritmo de fusão RRF. O valor deve ser maior que 0. Valor padrão: 60.	60
TopK	integer	Não	O número padrão de resultados retornados.	20
VectorWeight	number	Não	O peso do caminho vetorial no algoritmo de fusão WEIGHTED. Valores válidos: 0 a 1. O peso do caminho de palavra-chave é 1 menos este valor. Valor padrão: 0,7.	0.7

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O código de resposta. Um valor Success indica que a chamada foi bem-sucedida. Se a chamada falhar, um código de erro específico será retornado.	Success
Data	KnowledgeBase	Os detalhes atualizados da base de conhecimento.
Message	string	A mensagem de resposta. Se a chamada for bem-sucedida, o valor será Operation success. Se a chamada falhar, uma descrição de erro específica será retornada.	Operation success
RequestId	string	O ID da solicitação.	34AD682D-5B91-5773-8132-AA38C130****
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

{
  "Code": "Success",
  "Data": {
    "Catalog": "my_catalog",
    "ChunkConfiguration": {
      "HeadingLevel": 2,
      "MaxChunkSize": 600,
      "OverlapSize": 40,
      "PreprocessRules": {
        "RemoveUrlsAndEmails": false,
        "ReplaceConsecutiveWhitespace": true
      },
      "Separator": "\\\\n\\\\n",
      "Strategy": "BY_SEPARATOR"
    },
    "CreatedAt": "2026-08-24T10:00:00Z",
    "Description": "Base de conhecimento de documentação do produto",
    "EmbeddingDimension": 1024,
    "EmbeddingModel": "text-embedding-v4",
    "FailureReason": "OssException: BucketAlreadyExists .",
    "KnowledgeBaseName": "product-docs",
    "MetadataSchema": [
      {
        "Name": "departamento",
        "Type": "STRING",
        "Value": "EventHouse",
        "ValueMode": "CONSTANT"
      }
    ],
    "Namespace": "my_namespace",
    "SearchConfiguration": {
      "Mode": "HYBRID",
      "RankAlgorithm": "RRF",
      "RerankEnabled": false,
      "RerankModel": "qwen3-rerank",
      "RrfK": 60,
      "TopK": 20,
      "VectorWeight": 0.7
    },
    "Status": "ACTIVE",
    "UpdatedAt": "2026-08-24T10:00:00Z"
  },
  "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.