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

Cria 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:CreateKnowledgeBase

create

*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
KnowledgeBaseName	string	Sim	O nome da base de conhecimento. O nome deve ser exclusivo dentro do mesmo namespace.	product-docs
Description	string	Não	A descrição da base de conhecimento.	Product documentation knowledge base
MetadataSchema	array<object>	Sim	Declara os campos de metadados para a base de conhecimento. Ao fazer upload de documentos, os metadados podem conter apenas os campos declarados aqui. Este parâmetro não pode ser modificado após a criação da base de conhecimento.	[{"Name":"department","Type":"STRING"}]
	object	Não	O campo de metadados.
Name	string	Sim	O nome do campo.	department
Type	string	Sim	O tipo do campo. Valores válidos: STRING, LONG, DOUBLE, BOOLEAN e DATETIME.	STRING
Value	string	Não	A configuração de valor. Se ValueMode estiver definido como CONSTANT, este parâmetro especifica um valor fixo. Se for deixado vazio, você pode atribuir um valor durante o upload. Se ValueMode estiver definido como SYSTEM_VARIABLE, este parâmetro especifica um nome de variável do sistema, como DOCUMENT_NAME, FILE_TYPE, FILE_SIZE, DOCUMENT_UPLOAD_TIME, SOURCE_TYPE, SOURCE_URI ou SOURCE_MODIFIED_TIME.	EventHouse
ValueMode	string	Sim	O modo de valor. CONSTANT indica uma constante. Se Value não estiver vazio, todos os documentos usarão o valor fixo. Se Value estiver vazio, você pode atribuir um valor durante o upload. SYSTEM_VARIABLE indica uma variável do sistema. Value especifica o nome da variável, que é gerado automaticamente pelo sistema e não pode ser substituído durante o upload.	CONSTANT
Catalog	string	Sim	O catálogo EventHouse ao qual a base de conhecimento pertence. Este parâmetro, juntamente com Namespace e KnowledgeBaseName, identifica exclusivamente a base de conhecimento. Este parâmetro não pode ser modificado após a criação da base de conhecimento. Você não pode vincular um catálogo do sistema.	my_catalog
Namespace	string	Sim	O namespace EventHouse ao qual a base de conhecimento pertence. O namespace deve pertencer ao catálogo especificado. Este parâmetro, juntamente com Catalog e KnowledgeBaseName, identifica exclusivamente a base de conhecimento. Este parâmetro não pode ser modificado após a criação da base de conhecimento.	my_namespace
EmbeddingModel	string	Não	Opcional. O modelo de embedding. Este parâmetro não pode ser modificado após a criação da base de conhecimento. Valores válidos: text-embedding-v3, text-embedding-v4, qwen3.7-text-embedding e qwen3.7-text-embedding-flash. Apenas os modelos Qwen fornecidos pelo Model Studio são suportados. Modelos de terceiros não são suportados. Valor padrão: text-embedding-v4.	text-embedding-v4
EmbeddingDimension	integer	Não	Opcional. As dimensões do vetor. Este parâmetro é anexado ao modelo de embedding para validação. Valores válidos para text-embedding-v3: 64, 128, 256, 512, 768 e 1024. Valores válidos para text-embedding-v4: 64, 128, 256, 512, 768, 1024, 1536 e 2048. Valores válidos para qwen3.7-text-embedding: 256, 512, 768, 1024, 1536, 2048 e 2560. Valores válidos para qwen3.7-text-embedding-flash: 256, 512, 768 e 1024. Se este parâmetro não for especificado, a dimensão padrão do modelo, 1024, será usada. Este parâmetro não pode ser modificado após a criação da base de conhecimento. Para alterar o modelo, você deve reconstruir a base de conhecimento, mesmo que as dimensões permaneçam as mesmas.	1024
ChunkConfiguration	object	Não	Opcional. A estratégia padrão de fragmentação para a base de conhecimento. Esta estratégia se aplica apenas a documentos enviados por upload após a configuração. Se este parâmetro não for especificado, a estratégia padrão de fragmentação do sistema será usada.
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 fragmentação. Por exemplo, se você definir este parâmetro como 2, tanto os títulos H1 quanto H2 serão usados como limites. Títulos de nível inferior não são usados como limites e são mantidos no texto do fragmento. Se o conteúdo da seção exceder MaxChunkSize, o sistema recorrerá à fragmentação por parágrafo ou frase. Para documentos sem títulos, o sistema recorrerá à fragmentação inteligente.	2
MaxChunkSize	integer	Não	O número máximo de caracteres em um único fragmento. Valores válidos: 1 a 6000. Um erro é relatado se o limite for excedido.	512
OverlapSize	integer	Não	Aplica-se apenas à estratégia BY_LENGTH. Este parâmetro é ignorado para outras estratégias. O tamanho da sobreposição entre fragmentos adjacentes, em caracteres. Se o valor for maior que 0, o início do próximo fragmento repetirá o conteúdo no final do fragmento anterior dentro desta janela. A sobreposição não faz com que o fragmento exceda MaxChunkSize. Valor padrão: 0, o que indica nenhuma sobreposição.	40
PreprocessRules	object	Não	As regras de pré-processamento.
RemoveUrlsAndEmails	boolean	Não	Especifica se URLs e endereços de e-mail devem ser removidos durante a análise.	false
ReplaceConsecutiveWhitespace	boolean	Não	Especifica se 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	Obrigatório para a estratégia BY_SEPARATOR. Este parâmetro é ignorado para outras estratégias. A string literal usada para dividir o texto. Expressões regulares não são suportadas. O comprimento máximo é de 32 caracteres. Exemplo: \n\n para quebras de parágrafo.	\\n\\n
Strategy	string	Sim	A estratégia de fragmentação. AUTO indica fragmentação inteligente, que reconhece títulos e agrupa parágrafos. BY_LENGTH indica fragmentação por janela deslizante por comprimento, onde você pode especificar OverlapSize. BY_SEPARATOR indica fragmentação por separador, onde você deve especificar Separator. BY_HEADING indica fragmentação por nível de título, onde você deve especificar HeadingLevel. Valores válidos: AUTO, BY_LENGTH, BY_SEPARATOR e BY_HEADING.	BY_SEPARATOR
SearchConfiguration	object	Não	Opcional. A configuração de pesquisa padrão no nível da base de conhecimento. Esta configuração entra em vigor quando os parâmetros correspondentes não são especificados em uma solicitação de pesquisa. Você pode modificar esta configuração chamando UpdateKnowledgeBase após a criação da base de conhecimento.
Mode	string	Não	O modo de pesquisa. KEYWORD indica recuperação por palavra-chave. VECTOR indica AISearch. HYBRID indica recuperação híbrida. Valores válidos: KEYWORD, VECTOR e HYBRID.	HYBRID
RankAlgorithm	string	Não	Aplica-se apenas ao modo de pesquisa híbrida. RRF indica fusão de classificação recíproca. WEIGHTED indica fusão de normalização ponderada, que é usada em conjunto com VectorWeight. Valor padrão: RRF.	RRF
RerankEnabled	boolean	Não	Aplica-se apenas ao modo de pesquisa híbrida. Especifica se a reclassificação deve ser ativada por padrão 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. Valor válido: 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 a serem retornados.	20
VectorWeight	number	Não	O peso do vetor para o algoritmo de fusão WEIGHTED. Valores válidos: 0 a 1. O peso da 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. 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 da base de conhecimento criada, incluindo o nome, o status e as informações de configuração.
Message	string	A mensagem de resposta. Operation success é retornado se a chamada for bem-sucedida. Uma descrição de erro específica é retornada 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. Um valor true indica sucesso.	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
400	InvalidMetadata	The specified metadata is invalid or contains fields not declared in the knowledge base schema
400	InvalidMetadataSchema	The specified metadata schema is invalid
400	QuotaExceeded	The quota is exceeded
400	InvalidCatalog	The specified catalog is a system catalog and cannot be bound
403	ServiceNotEnable	Service not enable
404	CatalogNotFound	The specified catalog does not exist
404	NamespaceNotFound	The specified namespace does not exist

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.