Índice da documentação
Navegue por getting started, primitivos, SDK, referência da API e modelos.
A System One leva julgamentos estruturados de modelos para o fluxo de trabalho da sua aplicação. Envie o contexto a avaliar e as perguntas explícitas; use as escolhas, notas e probabilidades retornadas para rotear tarefas, ordenar resultados e verificar condições no código.
Perguntas frequentes
Q: Onde está o índice de documentação da System One?
A: Ele lista o início rápido, os primitivos, o SDK TypeScript, a extração do Clairic, a referência da API System One, o faturamento e a privacidade.
Onde está o índice da documentação da System One?
O índice lista o início rápido, os primitivos, o SDK TypeScript, a extração com Clairic, a referência da API System One, faturamento e privacidade.
Dois produtos, uma interface de decisão
- SDK da System One é um kit TypeScript open source para definir perguntas, conectar serviços e tratar resultados tipados. Você pode usá-lo de forma independente desta API hospedada. Conexões diretas usam as credenciais, os modelos disponíveis e a cobrança do serviço selecionado.
- API da System One é o nosso serviço HTTP hospedado, com chaves de API, descoberta de modelos, um Playground, registros de requisição e créditos pré-pagos.
- Use os dois juntos conectando o SDK à API da System One com seu endpoint de plataforma e sua chave.
A lista de adaptadores do SDK não é a lista de modelos da API hospedada. Para os modelos atualmente oferecidos, IDs exatos, capacidades, limites e preços em créditos, use o diretório de modelos. A seleção pode crescer e mudar; Escolher um modelo explica como comparar opções.
Três primitivos de decisão
| Primitivo | Use para | Leia o resultado como |
|---|---|---|
| Choice | Selecionar uma ferramenta, categoria ou caminho de tratamento a partir de um conjunto definido | Uma opção, sua distribuição de probabilidade e a confiança |
| Score | Avaliar relevância, urgência ou qualidade contra níveis ordenados | Uma nota ponderada por probabilidade, a distribuição e a confiança |
| Noul | Verificar intenção ou se uma condição foi satisfeita | P(true), um número de 0 a 1 |
Combine os três tipos em uma única requisição. Cada pergunta é avaliada de forma independente contra o mesmo state: o texto ou o contexto estruturado que você fornece. Se uma pergunta posterior precisar de uma resposta anterior, envie essa resposta em uma requisição seguinte. O SDK representa Noul com booleanQuestion() e um resultado probability; a API HTTP nativa usa type: "noul" e noul. Veja Primitivos de decisão para builders, exemplos e semântica dos resultados.
Experimente antes de integrar
Entre e abra o Playground. Escolha um modelo, carregue um exemplo, revise as perguntas e os créditos estimados e então execute. Esse fluxo no navegador não exige instalação nem chave de API; as avaliações usam o saldo da sua conta. Revise as respostas e a atividade de requisições no console.
Para decisões com imagem, escolha uma entrada Clef, Clef Flash ou Clef Omni compatível com imagens, adicione arquivos PNG/JPEG/WebP locais, revise a ordem deles e a estimativa atualizada e remova o que for desnecessário. Os limites de imagem e de requisição completa do modelo se aplicam; Jev permanece apenas texto. O state pode ser vazio, mas continua fazendo parte da requisição. Requisições de decisão com imagem seguem a orientação HTTP/curl porque systemOneAdapter não codifica imagens em evaluate(). A extração com Clairic a partir de texto ou imagens usa o extract() do SDK. Veja capacidades dos modelos, o exemplo de imagem com Fetch e o tratamento de dados.
Seu código continua responsável pelo fluxo de trabalho e por suas ações. Uma probabilidade alta não é garantia de correção nem permissão para executar uma ferramenta. Teste casos representativos, mantenha a revisão humana para decisões incertas ou de impacto, e envie apenas informações que você tem autorização para compartilhar.
Guias de integração
| Guia | O que você vai fazer |
|---|---|
| Documentação do SDK | Instalar o kit, escolher um adaptador e tratar resultados tipados. |
| Extração com Clairic | Chamar extract({ state, fields }) com o nome público de modelo clairic. |
| Início rápido com o SDK hospedado | Configurar endpoint e chave e enviar os três tipos de pergunta. |
| Referência da API | Autenticar requisições, descobrir modelos e usar os endpoints de avaliação e de conta. |
| Escolher um modelo | Comparar modelos atuais, entradas suportadas, limites e preços. |
| Integração de agente | Escolher tarefas adequadas e controlar ações, permissões e recuperação. |
| System One para agentes de código | Instalar o skill de agente e colar prompts de classificação, roteamento de ferramentas e checagem de conclusão. |
| Versões da API | Acompanhar separadamente as versões HTTP, do SDK e dos modelos. |
| Idempotência e novas tentativas | Recuperar uma resposta sem repetir uma avaliação concluída. |
| Créditos e faturamento | Estimar custos da API hospedada e revisar compras de créditos. |
| Dados e privacidade | Entender conteúdo enviado, registros de requisição e retenção. |
Para os conceitos de decisão, consulte os primitivos de decisão e o guia de integração de agente deste site. Use as referências deste site para os contratos do SDK e da API hospedada, as interfaces suportadas e o faturamento.