Pular para o conteúdo principal

Visão geral

A Batch API da Maritaca oferece operações para:

  • Arquivos – armazenar ou recuperar arquivos usados em requisições.
  • Batch inference – executar jobs assíncronos em lote.

Arquivos /api/files

Método & EndpointDescrição
GET /api/filesListar todos os arquivos.
POST /api/filesFazer upload de um novo arquivo.
GET /api/files/{file_id}Detalhes de um arquivo.
GET /api/files/{file_id}/contentFazer download do conteúdo.
DELETE /api/files/{file_id}Excluir um arquivo.

Base URL: https://chat.maritaca.ai


Listar arquivos

Lista arquivos submetidos.

GET /api/files

Parâmetros de Consulta


limit integer Opcional
Máximo de itens por página.

after string Opcional
Cursor para a próxima página (valor de next_cursor da resposta anterior).

purpose string Opcional
Filtra os arquivos por finalidade (batch_input).

order string Opcional
Ordem dos arquivos.


import openai

client = openai.OpenAI(
api_key="", #Sua API_KEY
base_url="https://chat.maritaca.ai/api",
)

files = client.files.list()
print(files)

Upload de arquivo

Submete o arquivo que contém as requisições.

POST /api/files

Corpo da Requisição


file file Obrigatório
O próprio arquivo a ser enviado. Aceita qualquer tipo binário (.jsonl, .csv, .txt, etc.).

purpose string Obrigatório
Define o uso pretendido do arquivo, por exemplo
atualmente apenas batch_input é aceito


from openai import OpenAI

client = openai.OpenAI(
api_key="", #Sua API_KEY
base_url="https://chat.maritaca.ai/api",
)


batch_input_file = client.files.create(
file=open("batch_input.jsonl", "rb"),
purpose="batch"
)

print(batch_input_file)



Recuperar detalhes de um arquivo

Retorna metadata de um arquivo.

GET /api/files/{file_id}

Parâmetros de Caminho


file_id string Obrigatório

ID do arquivo retornado no upload ou na listagem.
Utilizado para recuperar os metadados completos do arquivo.


metadata = client.files.retrieve("file-1")
print(metadata)


Baixar conteúdo de um arquivo

Retornar o conteúdo de um arquivo.

GET /api/files/{file_id}/content

Parâmetros de Caminho


file_id string Obrigatório

ID do arquivo, obtido durante o upload ou na listagem.


import openai

client = openai.OpenAI(
api_key="", #Sua API_KEY
base_url="https://chat.maritaca.ai/api",
)

metadata = client.files.retrieve("batch_input.jsonl")
print(metadata)



Excluir um arquivo

Excluir um arquivo.

DELETE /api/files/{file_id}

Parâmetros de Caminho


file_id string Obrigatório

ID do arquivo, obtido durante o upload ou na listagem.


client.files.delete("batch_input.jsonl")

Batch Inference /api/batches

Método & EndpointDescrição
GET /api/batchesListar todos os batches.
POST /api/batchesCriar um novo batch de inferência.
GET /api/batches/{batch_id}Detalhes de um batch.
POST /api/batches/{batch_id}/cancelCancelar um batch em execução.

Criar batch

Cria um lote a partir de um arquivo que já foi carregado seguindo as recomendações listadas das operações com arquivos.

POST /api/batches

Corpo da Requisição


input_file_id string Obrigatório
ID do arquivo .jsonl contendo as linhas de entrada para o lote.

endpoint string Obrigatório
Rota de destino que receberá cada requisição, por exemplo /chat/completions.

completion_window string Opcional
Prazo máximo de execução (ex.: 24h, 1h).
Usado para abortar o job automaticamente após esse período.

metadata object Opcional
Qualquer par chave-valor (ex.: {"project":"demo"}).


batch = client.beta.batches.create(
input_file_id="file-1",
endpoint="/v1/chat/completions",
completion_window="24h",
metadata={
"description": "job for marketing data",
"owner": "marketing team"
}
)
print(batch.id)

Listar batches

Liste seus lotes.

GET /api/batches

Corpo da Requisição


limit integer Opcional Máximo de itens por página.

after string Opcional
Cursor para a próxima página (valor de next_cursor da resposta anterior).


batches = client.beta.batches.list(limit=10)
for batch in batches.data:
print(batch.id, batch.status)

Recuperar um batch

Obtém todos os detalhes de um job em lote.

GET /api/batches/{batch_id}

Corpo da Requisição


batch_id string Obrigatório ID retornado na criação ou listagem.


batch = client.batches.retrieve("batch-1")
print(batch)

Cancelar um batch

Interrompe o processamento de um job em lote.

POST /api/batches/{batch_id}/cancel

Corpo da Requisição


batch_id string Obrigatório ID retornado na criação ou listagem.

Exemplo de Request


import openai
cancelled = client.beta.batches.cancel("batch-1")
print(cancelled.status)