Ir para o conteúdo

Referência de API

Duas referências complementares são publicadas aqui: a referência do SDK Python, gerada a partir do código-fonte de cada biblioteca do wittgenstein-core, e os endpoints OpenAPI da plataforma.

Referência do SDK Python

A aba SDK Reference documenta cada biblioteca wittgenstein-*: todos os módulos, classes e funções públicos, com assinaturas e docstrings extraídas diretamente do código. Não existe cópia mantida à mão que possa divergir.

  • Autenticação

    Verificação de JWT, checagem de papéis e o endpoint de tokens no mesmo origin.

    oidc_backend

  • Roteamento de LLMs

    Roteamento agnóstico de provedor para chamadas de modelos.

    llm_router

  • Observabilidade

    Helpers de tracing e telemetria compartilhados por todos os serviços.

    observability

  • Pipelines

    Pipelines composáveis de dados e agentes.

    pipelines

Como é gerada

A cada build, o site de documentação clona o wittgenstein-core e executa o mkapi sobre cada biblioteca em libs/. A geração tem cache por biblioteca: cada lib é identificada pelo último commit que tocou seu diretório, e apenas as libs com commits novos são regeneradas. O restante vem da execução anterior.

$ make build
[sync-core-api] fetching new wittgenstein-core commits
[sync-core-api] core@8f7bfa93: 21 libs, 2 to regenerate (oidc-backend, pipelines)
[sync-core-api] wrote 21 packages to docs/reference/
INFO    -  Building documentation to directory: site
INFO    -  Documentation built in 14.20 seconds
$ make build
[sync-core-api] wittgenstein-core has no new commits, skipping fetch
[sync-core-api] core@8f7bfa93: 21 libs, 0 to regenerate — everything served from cache
[sync-core-api] wrote 21 packages to docs/reference/

Para forçar uma regeneração completa, defina FORCE_API_REBUILD=1. Apenas a árvore libs/ é obtida e as bibliotecas são analisadas, nunca importadas, então o build da documentação não precisa de nenhuma de suas dependências de runtime.

Escreva bons docstrings

A referência é tão boa quanto os docstrings que ela lê. Documente o porquê no docstring do módulo, liste argumentos e retornos no estilo Google e adicione um exemplo curto para tudo que não for óbvio.

OpenAPI da Plataforma

A especificação da Core API é exposta dinamicamente.