Realizar uploads de novos conteúdos em datasets e subjects específicos.

Este endpoint permite criar registros para realizar uploads de novos conteúdos em datasets e subjects específicos. Ele suporta envio de conteúdo por meio de URLs públicas ou diretamente em texto. É possível registrar um único conteúdo ou enviar dados em lote.

Corpo da Requisição

  • Estrutura Geral

O corpo da requisição deve ser um objeto JSON contendo os detalhes do upload.

CampoTipoObrigatórioDescrição
namestringSimNome descritivo do registro de upload. Será exibido ao listar registros.
uploadsarraySimLista de objetos que descrevem os conteúdos a serem registrados.
  • Estrutura do Objeto uploads

Cada objeto dentro do array uploads deve seguir uma das duas estruturas:

Upload via URL

CampoTipoObrigatórioDescrição
dataset_namestringNãoNome do dataset onde o conteúdo será registrado. Deve ser único. Se ausente, será criado como "Default".
urlstringSimURL pública do arquivo que contém o conteúdo.
subject_namestringNãoNome do subject onde o conteúdo será registrado. Se ausente, será criado como "Default".
content_namestringSimNome do conteúdo a ser registrado. Deve ser único dentro do subject.
source_linkstringNãoLink da fonte de referência para o conteúdo.

Upload Direto via Texto

CampoTipoObrigatórioDescrição
dataset_namestringNãoNome do dataset onde o conteúdo será registrado. Deve ser único. Se ausente, será criado como "Default".
textstringSimTexto do conteúdo a ser registrado.
subject_namestringNãoNome do subject onde o conteúdo será registrado. Se ausente, será criado como "Default".
content_namestringSimNome do conteúdo a ser registrado. Deve ser único dentro do subject.
source_linkstringNãoLink da fonte de referência para o conteúdo.

Exemplo de Requisição

Upload via URL

{
    "name": "Obras de J.R.R Tolkien",
    "uploads": [
        {
            "dataset_name": "Livros Tolkien",
            "url": "https://example-storage.com/public/files/Contos-Inacabados-Tolkien.txt",
            "subject_name": "J.R.R Tolkien",
            "content_name": "Aventuras de Tom Bombadil",
            "source_link": "https://example-storage.com/public/files/Contos-Inacabados-Tolkien.txt"
        },
        {
            "dataset_name": "Livros",
            "url": "https://example-storage.com/public/files/Contos-Inacabados-Tolkien.txt",
            "subject_name": "J.R.R Tolkien",
            "content_name": "Contos Inacabados",
            "source_link": "https://example-cloud-storage.com/resources/Contos-Inacabados-Tolkien.txt"
        }
    ]
}

Upload Direto via Texto

{
    "name": "Informações sobre a trilogia O Senhor dos Anéis",
    "uploads": [
        {
            "dataset_name": "Filmes",
            "text": "O Senhor dos Anéis é uma trilogia cinematográfica baseada na obra de J.R.R Tolkien...",
            "subject_name": "O Senhor dos Anéis (Filmes)",
            "content_name": "Comentários",
            "source_link": "https://exemplo.com/origem-do-conteudo"
        }
    ]
}

Resposta

Sucesso (201 Created)


Formatos de Arquivo Suportados

FormatoDescriçãoSuporte a Upload em Lote
.txtArquivo de texto simplesNão aplicável
.zipArquivo compactadoSim, suporta todos os formatos descritos
.pdfDocumento em formato PDFNão aplicável
.csvArquivo de valores separados por vírgulaSim, desde que siga o template de indexação da Nama
.xlsxPlanilha do Microsoft ExcelSim, desde que siga o template de indexação da Nama
.pptxApresentação do Microsoft PowerPointNão aplicável
.docxDocumento do Microsoft WordNão aplicável

Observações

  • Nomes de dataset: são únicos
  • Nomes de subject: são únicos dentro de cada dataset
  • Nomes de content: Se usado o mesmo nome de content dentro de determinado dataset o conteúdo novo sera somado ao existente.
  • URL precisa ser pública: Ao fazer upload via URL, certifique-se de que o arquivo esteja acessível publicamente.
  • Campos content_name e url ou text são obrigatórios: Sem eles, a API não poderá criar o registro.

Informações relevantes sobre o Processo de Indexação

A criação de um registro no upload não garante o sucesso imediato na indexação do conteúdo. Após o registro, o conteúdo é processado em uma fila com os seguintes possíveis status:

  • DONE: O conteúdo foi indexado com sucesso.
  • IMPORTING: O conteúdo está sendo importado.
  • ENQUEUED: O conteúdo foi enfileirado para processamento.
  • UPLOADING: O conteúdo está sendo carregado para a plataforma.
  • ERROR: Ocorreu um erro durante o processo de indexação.
Language
Click Try It! to start a request and see the response here!