Caderno Aberto

Visão Geral

O Caderno Aberto organiza fontes, anotações e conversas de IA em cadernos de pesquisa. Ele suporta vários provedores de IA através do Esperanto, busca de texto completo e vetorial, transformações personalizadas e geração de podcasts com perfis de locutor. O armazenamento da aplicação é auto-hospedado; o conteúdo enviado para modelos de nuvem configurados não é apenas local.

Esta habilidade visa a versão publicada mais recente observada em 30/09/2026, v1.14.0. Os contratos de solicitação/resposta foram verificados em relação à sua fonte oficial e ao commit principal atual 3127f14ea9dbb519f0e4ddc64a0742ca644ba6ef. Os auxiliares empacotados possuem testes de regressão HTTP simulados; implantação, ingestão e chamadas de IA pagas não foram executadas contra uma instância ativa. Exemplos de implantação e fluxo de trabalho remoto são ilustrativos.

Início Rápido

Instalação

Use Docker Desktop/Engine com Compose. O arquivo docker-compose upstream configura SurrealDB v2 e a imagem da aplicação lfnovo/open_notebook:v1-latest. Ele monta ./notebook_data em /app/data e ./surreal_data em /mydata.

curl --fail --location --output docker-compose.yml \
  https://raw.githubusercontent.com/lfnovo/open-notebook/v1.14.0/docker-compose.yml

Antes de iniciar, edite o arquivo Compose baixado: substitua o valor literal OPEN_NOTEBOOK_ENCRYPTION_KEY=change-me-to-a-secret-string, ou altere-o para ${OPEN_NOTEBOOK_ENCRYPTION_KEY:?Set OPEN_NOTEBOOK_ENCRYPTION_KEY} e forneça essa variável. Exportar uma variável de shell sozinha não substitui o literal upstream. Mantenha a chave entre reinícios; ela criptografa as credenciais do provedor, não os documentos de origem. Defina OPEN_NOTEBOOK_PASSWORD no ambiente do contêiner da aplicação quando a proteção por senha for desejada; os clientes então enviam Authorization: Bearer <instance-password>. Para uma implantação reproduzível, resolva e registre um digest de imagem; v1-latest se move.

docker compose up -d
docker compose logs --tail=100 open_notebook

• UI Web: http://localhost:8502
• Backend: http://localhost:5055; base da API: http://localhost:5055/api
• Contratos da instância: /docs, /redoc, /openapi.json

A instalação a partir do código-fonte também é suportada; ela precisa de um worker de processamento separado. Consulte configuração para persistência e configuração do provedor.

Configurar provedores de IA

Em Gerenciar → Modelos, adicione uma configuração/credencial, teste-a, descubra modelos e registre os modelos específicos necessários. Atribua padrões de chat e embedding; atribua modelos de fala separadamente para transcrição/podcasts. OpenAI, Anthropic, Google, Ollama, Groq e Mistral têm modalidades diferentes. Descubra o suporte da instância /api/models/providers; não infira suporte de fala do suporte de LLM.

A descoberta de credenciais retorna discovered[] com name e provider, muitas vezes sem um model_type utilizável. O registro requer models[] contendo name, provider e um model_type escolhido explicitamente. Os quatro tipos são language, embedding, speech_to_text e text_to_speech. Eles não são llm, stt ou tts. Consulte a referência da API e o exemplo de credencial.

Usar os auxiliares empacotados

Resolva o diretório desta habilidade e execute a partir do seu diretório scripts/, ou adicione esse diretório ao caminho de importação do Python. Instale requests em um ambiente dedicado, por exemplo, uv run --isolated --with requests python notebook_management.py --help. Cada CLI lista apenas registros; criação, chamadas de IA e exclusão são funções explícitas. Defina OPEN_NOTEBOOK_URL para a origem do backend (um sufixo /api existente também é aceito). Defina OPEN_NOTEBOOK_PASSWORD apenas se a instância exigir autenticação.

from notebook_management import create_notebook
from source_ingestion import add_text_source, wait_for_processing
from chat_interaction import build_context, create_chat_session, send_chat_message

notebook = create_notebook("Revisão de Métodos", "Comparar desenhos experimentais relatados")
source = add_text_source(
    notebook["id"], "Trecho do estudo piloto",
    "Estudo ilustrativo: 24 amostras foram randomizadas para dois tratamentos.",
    process_async=True, embed=False,
)
wait_for_processing(source["id"])
built = build_context(notebook["id"], source_ids=[source["id"]], note_ids=[])
if not built["context"]["sources"]:
    raise RuntimeError("Nenhum conteúdo de origem foi incluído")
session = create_chat_session(notebook["id"], "Discussão de Métodos")

…