Requesting structured chat completions outputs

import os

from openai import OpenAI
from pydantic import BaseModel

client = OpenAI(base_url="https://api.seltz.ai/v1", api_key=os.environ["SELTZ_API_KEY"])


class Candidate(BaseModel):
    name: str
    rationale: str


class SuccessionOutlook(BaseModel):
    company: str
    leading_candidate: str
    candidates: list[Candidate]


completion = client.chat.completions.parse(
    model="seltz-base",
    messages=[
        {"role": "user", "content": "Who is going to be Apple's next CEO?"},
    ],
    response_format=SuccessionOutlook,
)

outlook = completion.choices[0].message.parsed
print(outlook.leading_candidate)
for candidate in outlook.candidates:
    print(f"{candidate.name}: {candidate.rationale}")

# Citations are still returned as the top-level extension
for citation in completion.citations:
    print(citation["url"])

import OpenAI from "openai";
import { zodResponseFormat } from "openai/helpers/zod";
import { z } from "zod";

const client = new OpenAI({
  baseURL: "https://api.seltz.ai/v1",
  apiKey: process.env.SELTZ_API_KEY,
});

const Candidate = z.object({
  name: z.string(),
  rationale: z.string(),
});

const SuccessionOutlook = z.object({
  company: z.string(),
  leading_candidate: z.string(),
  candidates: z.array(Candidate),
});

const completion = await client.chat.completions.parse({
  model: "seltz-base",
  messages: [
    { role: "user", content: "Who is going to be Apple's next CEO?" },
  ],
  response_format: zodResponseFormat(SuccessionOutlook, "succession_outlook"),
});

const outlook = completion.choices[0].message.parsed;
console.log(outlook.leading_candidate);
for (const candidate of outlook.candidates) {
  console.log(`${candidate.name}: ${candidate.rationale}`);
}

// Citations are still returned as the top-level extension
for (const citation of completion.citations) {
  console.log(citation.url);
}

curl -X POST https://api.seltz.ai/v1/chat/completions \
  -H "Authorization: Bearer $SELTZ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "seltz-base",
    "messages": [
      {"role": "user", "content": "Who is going to be Apple'\''s next CEO?"}
    ],
    "response_format": {
      "type": "json_schema",
      "json_schema": {
        "name": "succession_outlook",
        "strict": true,
        "schema": {
          "type": "object",
          "properties": {
            "company": {"type": "string"},
            "leading_candidate": {"type": "string"},
            "candidates": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "name": {"type": "string"},
                  "rationale": {"type": "string"}
                },
                "required": ["name", "rationale"],
                "additionalProperties": false
              }
            }
          },
          "required": ["company", "leading_candidate", "candidates"],
          "additionalProperties": false
        }
      }
    }
  }'