Adiciona chunks a uma base de conhecimento de busca de documentos (document), consulta de dados (table) ou perguntas e respostas por imagem (image).
Descrição da operação
- Esta operação adiciona conteúdo de chunk a uma base de conhecimento especificada do tipo busca de documentos (document), consulta de dados (table) ou perguntas e respostas por imagem (image). Operações relacionadas em bases de conhecimento de busca multimídia (multimedia) não são suportadas. Para bases de conhecimento de consulta de dados e perguntas e respostas por imagem, esta operação só tem efeito quando a fonte de dados é um conector de planilha (excel).
- Os usuários do Resource Access Management (RAM) devem primeiro obter permissões de API para o Model Studio (requerendo
AliyunBailianDataFullAccess, que inclui a permissão sfm:ChunkList) e ingressar em um workspace antes de invocar esta operação. Contas Alibaba Cloud podem invocar esta operação diretamente sem autorização. Use o mais recente Model Studio SDKModel Studio SDK para invocar esta operação. - Antes de invocar esta operação, certifique-se de que sua base de conhecimento foi criada e não foi excluída (ou seja, o ID da base de conhecimento
IndexIdé válido). - Esta operação possui idempotência.
Limitação de taxa: Esta operação é limitada se chamada com muita frequência. Não exceda 10 chamadas por segundo. Se for limitada, tente novamente mais tarde.
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.
Autorização RAM
Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.
Sintaxe da solicitação
POST /{WorkspaceId}/chunk/create HTTP/1.1
Parâmetros de caminho
Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
| WorkspaceId | string | Sim | O ID do workspace. | llm-19hxxxxx7htdf9lh |
Parâmetros da solicitação
Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
| PipelineId | string | Sim | O ID da base de conhecimento. | 79c0alxxxx |
| dataId | string | Não | O ID do arquivo. | doc_xxx |
| field | object | Não | O conteúdo do chunk a ser inserido, passado como pares chave-valor. Para bases de conhecimento de busca de documentos, use a seguinte lista fixa de chaves:
Para bases de conhecimento de consulta de dados e perguntas e respostas por imagem, as chaves não são fixas e são determinadas pela planilha de origem de dados da base de conhecimento. A chave é o cabeçalho da coluna do Excel, e o valor é o valor correspondente da coluna. | { "content": "The Bailian platform supports parsing multiple document formats including PDF, Word, and PPT.", "title": "Document Parsing and Chunking", "image_urls": [ "https://example.com/images/chunk-flow.png", "https://example.com/images/parsing-result.png" ] } |
any | Não | As informações de campo de cabeçalho para o chunk inserido. Apenas bases de conhecimento de consulta de dados e perguntas e respostas por imagem são suportadas. Cabeçalhos que participam da recuperação ou geração de resposta são obrigatórios. Requisitos de valor para cada tipo:
| {"Product Name": "Wireless Bluetooth Headphones", "Publish Time": 1752624000000, "Stock Quantity": 1580, "Unit Price": 299.99, "image_url":"https://example.com/images/headphones-front.jpg,https://example.com/images/headphones-side.jpg,https://example.com/images/headphones-package.jpg" } |
Elementos de resposta
Elemento | Tipo | Descrição | Exemplo |
|---|---|---|---|
object | Esquema da resposta. | ||
| RequestId | string | O ID da solicitação. | 35A267BF-xxxx-54DB-8394-AA3B0742D833 |
| Code | string | O código de status de erro. | Index.InvalidParameter |
| Message | string | A mensagem de erro. | Required parameter(%s) missing or invalid, please check the request parameters. |
| Success | boolean | Indica se a operação foi bem-sucedida. Valores válidos:
| true |
| Data | boolean | Os dados comerciais retornados após uma solicitação bem-sucedida. Valores válidos:
| true |
| Status | string | O código de status retornado pela operação. | 200 |
Exemplos
Resposta de sucesso
JSON formato
{
"RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
"Code": "Index.InvalidParameter",
"Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
"Success": true,
"Data": true,
"Status": "200"
}
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.