Documentação da API

Como funciona

A API do Seven Assistant é totalmente compatível com OpenAI. Isto significa que todas as ferramentas, bibliotecas e SDK que funcionam com a API da OpenAI também funcionam com o Seven Assistant. Só precisa de alterar o URL base.

Primeiro pedido com curl

curl YOUR_DOMAIN/v1/chat/completions \
  -H "Authorization: Bearer sk-educa-YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "educa-ai",
    "messages": [
      {"role": "system", "content": "És um assistente prestável."},
      {"role": "user", "content": "O que é a fotossíntese?"}
    ]
  }'

Obter os modelos através da API

curl YOUR_DOMAIN/v1/models \
  -H "Authorization: Bearer sk-educa-YOUR_API_KEY"

Como funciona o streaming

Defina "stream": true no pedido. A resposta é transmitida como Server-Sent Events (SSE) e cada fragmento contém uma parte do texto. O fluxo termina com data: [DONE].

curl YOUR_DOMAIN/v1/chat/completions \
  -H "Authorization: Bearer sk-educa-YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -N \
  -d '{
    "model": "educa-ai",
    "messages": [{"role": "user", "content": "Conta até 5"}],
    "stream": true
  }'

Fragmentos do fluxo

data: {"id":"chatcmpl-abc","object":"chat.completion.chunk","created":1711900000,"model":"educa-ai","choices":[{"index":0,"delta":{"role":"assistant"},"finish_reason":null}]}

data: {"id":"chatcmpl-abc","object":"chat.completion.chunk","created":1711900000,"model":"educa-ai","choices":[{"index":0,"delta":{"content":"1, "},"finish_reason":null}]}

data: {"id":"chatcmpl-abc","object":"chat.completion.chunk","created":1711900000,"model":"educa-ai","choices":[{"index":0,"delta":{"content":"2, "},"finish_reason":null}]}

data: {"id":"chatcmpl-abc","object":"chat.completion.chunk","created":1711900000,"model":"educa-ai","choices":[{"index":0,"delta":{},"finish_reason":"stop"}]}

data: [DONE]

from openai import OpenAI

client = OpenAI(
    api_key="sk-educa-YOUR_API_KEY",
    base_url="YOUR_DOMAIN/v1/"
)

# Chat Completion
response = client.chat.completions.create(
    model="educa-ai",
    messages=[
        {"role": "system", "content": "És um professor prestável."},
        {"role": "user", "content": "Cria 5 perguntas de quiz sobre a Idade Média."}
    ],
    temperature=0.7,
    max_tokens=1000
)

print(response.choices[0].message.content)

# Streaming
stream = client.chat.completions.create(
    model="educa-ai",
    messages=[{"role": "user", "content": "Explica a democracia."}],
    stream=True
)

for chunk in stream:
    if chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="")

# Embeddings
embedding = client.embeddings.create(
    model="educa-ai",
    input="A fotossíntese explicada às crianças"
)

print(embedding.data[0].embedding[:5])

Instalação: pip install openai

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "sk-educa-YOUR_API_KEY",
  baseURL: "YOUR_DOMAIN/v1/"
});

// Chat Completion
const response = await client.chat.completions.create({
  model: "educa-ai",
  messages: [
    { role: "system", content: "És um professor prestável." },
    { role: "user", content: "O que é a regra de três simples?" }
  ]
});

console.log(response.choices[0].message.content);

// Streaming
const stream = await client.chat.completions.create({
  model: "educa-ai",
  messages: [{ role: "user", content: "Explica o ciclo da água." }],
  stream: true
});

for await (const chunk of stream) {
  const content = chunk.choices[0]?.delta?.content;
  if (content) process.stdout.write(content);
}

Instalação: npm install openai

const response = await fetch("YOUR_DOMAIN/v1/chat/completions", {
  method: "POST",
  headers: {
    "Authorization": "Bearer sk-educa-YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    model: "educa-ai",
    messages: [
      { role: "user", content: "Cria um plano semanal de Matemática para o 5.º ano." }
    ]
  })
});

const data = await response.json();
console.log(data.choices[0].message.content);

using Azure.AI.OpenAI;
using OpenAI.Chat;
using System.ClientModel;

var client = new ChatClient(
    model: "educa-ai",
    credential: new ApiKeyCredential("sk-educa-YOUR_API_KEY"),
    options: new OpenAIClientOptions
    {
        Endpoint = new Uri("YOUR_DOMAIN/v1/")
    }
);

var response = await client.CompleteChatAsync(
    new ChatMessage[]
    {
        new SystemChatMessage("És um professor prestável."),
        new UserChatMessage("O que é uma parábola em Matemática?")
    }
);

Console.WriteLine(response.Value.Content[0].Text);

NuGet: Azure.AI.OpenAI

from langchain_openai import ChatOpenAI

llm = ChatOpenAI(
    model="educa-ai",
    api_key="sk-educa-YOUR_API_KEY",
    base_url="YOUR_DOMAIN/v1/"
)

response = llm.invoke("Cria um resumo da Revolução Francesa.")
print(response.content)

Instalação: pip install langchain-openai

Pode utilizar o Seven Assistant como assistente de IA no seu IDE. Configure o seguinte no config.json do Continue.dev:

{
  "models": [
    {
      "title": "Seven Assistant",
      "provider": "openai",
      "model": "educa-ai",
      "apiKey": "sk-educa-YOUR_API_KEY",
      "apiBase": "YOUR_DOMAIN/v1/"
    }
  ]
}