Gerenciar Coleções
Coleções são a principal forma de organizar seus documentos no aqoon. Pense nelas como pastas — cada coleção agrupa documentos relacionados e possui seu próprio índice de busca.
Criando uma Coleção
- Clique em Coleções na barra lateral
- Clique em Nova Coleção
- Digite um nome e uma descrição opcional
- Clique em Salvar
Sua nova coleção está pronta. Agora você pode enviar documentos para ela.
Visualizando Suas Coleções
A página de coleções mostra todas as coleções que você possui, além de coleções públicas que você assinou. Cada cartão de coleção mostra:
- Nome da coleção
- Número de documentos
- Um selo Público se a coleção é compartilhada publicamente
- Um selo Inscrito para coleções públicas nas quais você se inscreveu
Clique em qualquer cartão para abrir a página de detalhes da coleção.
Página de Detalhes da Coleção
A página de detalhes lista todos os documentos da coleção em uma tabela com:
| Coluna | Descrição |
|---|---|
| Título | Nome do documento (clique para ver detalhes) |
| Origem | Tipo de envio: PDF, DOCX, Imagem, Markdown, Texto, Planilha ou URL |
| Status | Estado do processamento: Pendente, Processando, Indexado ou Falhou |
| Trechos | Número de segmentos de texto extraídos do documento |
| Tags | Tags atribuídas durante o envio |
| Enviado | Quando o documento foi adicionado |
Editando uma Coleção
Na página de detalhes da coleção, clique em Editar no canto superior direito para alterar o nome ou a descrição da coleção.
Excluindo uma Coleção
Clique em Excluir na página de detalhes da coleção. Isso remove a coleção e todos os seus documentos. Esta ação não pode ser desfeita.
Apenas o proprietário da coleção — ou uma chave de API com permissão de escrita — pode editar, excluir ou enviar documentos. Se você se inscreveu em uma coleção pública de outra pessoa, você tem acesso somente leitura.
Gerenciando Coleções via API
Você pode criar, atualizar e excluir coleções programaticamente usando a API REST ou os SDKs oficiais. Todas as operações de escrita requerem uma chave de API de acesso total ou uma chave restrita com permissão de escrita na coleção.
Criar uma Coleção
curl
curl -X POST https://your-instance/api/v1/collections/ \
-H "Authorization: Bearer aqn_your_api_key" \
-H "Content-Type: application/json" \
-d '{"name": "My Docs", "description": "Optional description"}'
Python SDK
collection = client.create_collection("My Docs", description="Optional description")
print(collection["uuid"]) # use this uuid to upload documents
JavaScript SDK
const collection = await client.createCollection("My Docs", { description: "Optional description" });
console.log(collection.uuid); // use this uuid to upload documents
Atualizar uma Coleção
curl
curl -X PATCH https://your-instance/api/v1/collections/{uuid}/ \
-H "Authorization: Bearer aqn_your_api_key" \
-H "Content-Type: application/json" \
-d '{"name": "Renamed Docs"}'
Python SDK
collection = client.update_collection("collection-uuid", name="Renamed Docs")
print(collection["name"])
JavaScript SDK
const updated = await client.updateCollection("collection-uuid", { name: "Renamed Docs" });
console.log(updated.name);
Excluir uma Coleção
Exclui a coleção e todos os seus documentos. As entradas do índice de busca são removidas imediatamente; os blobs são mantidos por um período de carência de 7 dias. Esta operação não pode ser desfeita.
curl
curl -X DELETE https://your-instance/api/v1/collections/{uuid}/ \
-H "Authorization: Bearer aqn_your_api_key" \
-w "\nHTTP %{http_code}\n"
# HTTP 204
Python SDK
client.delete_collection("collection-uuid")
# Returns None on success (HTTP 204)
JavaScript SDK
await client.deleteCollection("collection-uuid");
// Returns undefined on success (HTTP 204)