---
title: Manutenção da Base de Conhecimento via API
slug: manutencao-da-base-de-conhecimento-via-api
createdAt: 2024-09-05T20:39:09.607Z
---

**Manutenção da Base de Conhecimento via API**

A autenticação e os métodos de invocação são consistentes com a API de Serviço da aplicação. A diferença é que um único token da API da base de conhecimento pode operar em todas as bases de conhecimento.

### Vantagens de Usar a API da Base de Conhecimento:

- Sincronize seu sistema de dados com as bases de conhecimento do Paragraph para criar fluxos de trabalho poderosos.
- Forneça listas de bases de conhecimento, documentos e consultas de detalhes para facilitar a construção da sua própria página de gerenciamento de dados.
- Suporte upload e atualização de documentos em texto simples ou arquivo, além de adição e modificação em massa ao nível de segmento para simplificar o processo de sincronização.
- Reduza o tempo gasto em processamento e sincronização manual de documentos, aumentando a visibilidade sobre o software e serviços do Paragraph.

### Como Usar

Navegue até a página da base de conhecimento e você poderá alternar para a página **API ACCESS** a partir da navegação à esquerda. Nesta página, você pode visualizar a documentação da API do dataset fornecida pelo Paragraph e gerenciar as credenciais para acessar a API do dataset em **API Keys**.

![](https://api.archbee.com/api/optimize/NB-ulyH02IT7Ep_VosDsd/DVzxZ1Bs5xtcB0NrBS10c_image.png)

***

### Exemplos de Chamadas da API:

**Criar um Dataset Vazio**
Somente usado para criar um dataset vazio.

```bash
curl --location --request POST 'https://api.paragraph.ai/v1/datasets' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: application/json' \
--data-raw '{"name": "name"}'
```

**Lista de Datasets**

```bash
curl --location --request GET 'https://api.paragraph.ai/v1/datasets?page=1&limit=20' \
--header 'Authorization: Bearer {api_key}'
```

**Criar Documento por Texto**

```bash
curl --location --request POST 'https://api.paragraph.ai/v1/datasets/<uuid:dataset_id>/document/create_by_text' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "paragraph",
    "text": "paragraph means Do it for you...",
    "indexing_technique": "high_quality",
    "process_rule": {
        "rules": {
                "pre_processing_rules": [{
                        "id": "remove_extra_spaces",
                        "enabled": true
                }, {
                        "id": "remove_urls_emails",
                        "enabled": true
                }],
                "segmentation": {
                        "separator": "###",
                        "max_tokens": 500
                }
        },
        "mode": "custom"
    }
}'
```

**Criar Documento por Arquivo**

```bash
curl --location POST 'https://api.paragraph.ai/v1/datasets/{dataset_id}/document/create_by_file' \
--header 'Authorization: Bearer {api_key}' \
--form 'data="{
	"name": "paragraph",
	"indexing_technique": "high_quality",
	"process_rule": {
		"rules": {
			"pre_processing_rules": [{
				"id": "remove_extra_spaces",
				"enabled": true
			}, {
				"id": "remove_urls_emails",
				"enabled": true
			}],
			"segmentation": {
				"separator": "###",
				"max_tokens": 500
			}
		},
		"mode": "custom"
	}
    }";
    type=text/plain' \
--form 'file=@"/path/to/file"'
```

**Obter Status de Indexação de Documento (Progresso)**

```bash
curl --location --request GET 'https://api.paragraph.ai/v1/datasets/{dataset_id}/documents/{batch}/indexing-status' \
--header 'Authorization: Bearer {api_key}'
```

**Excluir Documento**

```bash
curl --location --request DELETE 'https://api.paragraph.ai/v1/datasets/{dataset_id}/documents/{document_id}' \
--header 'Authorization: Bearer {api_key}'
```

**Lista de Documentos do Dataset**

```bash
curl --location --request GET 'https://api.paragraph.ai/v1/datasets/{dataset_id}/documents' \
--header 'Authorization: Bearer {api_key}'
```

**Adicionar Segmentos**

```bash
curl --location 'https://api.paragraph.ai/v1/datasets/{dataset_id}/documents/{document_id}/segments' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: application/json' \
--data '{"segments": [{"content": "1","answer": "1","keywords": ["a"]}]}'
```

**Excluir Segmento de Documento**

```bash
curl --location --request DELETE 'https://api.paragraph.ai/v1/datasets/{dataset_id}/segments/{segment_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: application/json'
```

**Mensagens de Erro Comuns:**

- **document\_indexing**: Falha na indexação do documento.
- **provider\_not\_initialize**: Modelo de embedding não configurado.
- **not\_found**: Documento não encontrado.
- **dataset\_name\_duplicate**: Nome do dataset duplicado.
- **provider\_quota\_exceeded**: Limite de uso do modelo excedido.
- **dataset\_not\_initialized**: Dataset não inicializado.
- **unsupported\_file\_type**: Tipo de arquivo não suportado.
- **too\_many\_files**: Muitos arquivos, atualmente apenas upload de arquivo único é suportado.
- **file\_too\_large**: Arquivo muito grande, suporta arquivos abaixo de 15MB.