Den vollständigen Index der Dokumentation findest du in llms.txt. Die Markdown-Version einer Dokumentationsseite erhältst du, indem du .md an die URL der Seite anhängst.
Hauptnavigation
Design

Prompts generieren

Generiere Prompts und Schemas im Playground.

Mit der Schaltfläche „Generate“ im Playground kannst du Prompts, Funktionen und Schemas generieren. Dafür genügt eine Beschreibung deiner Aufgabe. Dieser Leitfaden zeigt dir, wie das funktioniert.

Überblick

Prompts und Schemas von Grund auf zu erstellen, kann viel Zeit kosten. Wenn du sie generieren lässt, kommst du schneller zum ersten Entwurf. Die Schaltfläche „Generate“ nutzt dafür zwei Verfahren:

  1. Prompts: Wir verwenden Meta-Prompts, die bewährte Vorgehensweisen berücksichtigen, um Prompts zu erstellen oder zu verbessern.
  2. Schemas: Wir verwenden Meta-Schemas, mit denen sich gültiges JSON und syntaktisch korrekte Funktionsdefinitionen erzeugen lassen.

Derzeit nutzen wir Meta-Prompts und Meta-Schemas. Künftig könnten wir auch fortgeschrittene Verfahren wie DSPy und das „Gradientenabstiegsverfahren“ einsetzen.

Prompts

Ein Meta-Prompt weist das Modell an, anhand deiner Aufgabenbeschreibung einen guten Prompt zu erstellen oder einen vorhandenen Prompt zu verbessern. Die Meta-Prompts im Playground beruhen auf unseren bewährten Methoden für Prompt Engineering und auf Erfahrungen aus der Zusammenarbeit mit Menschen, die unsere Modelle nutzen.

Für verschiedene Ausgabetypen, etwa Audio, verwenden wir jeweils eigene Meta-Prompts. So stellen wir sicher, dass die generierten Prompts dem erwarteten Format entsprechen.

Meta-Prompts

Meta-Prompt für Textausgaben
import OpenAI from "openai";

const client = new OpenAI();

const metaPrompt = `Given a task description or existing prompt, produce a detailed system prompt to guide a language model in completing the task effectively.

# Guidelines

- Understand the Task: Grasp the main objective, goals, requirements, constraints, and expected output.
- Minimal Changes: If an existing prompt is provided, improve it only if it's simple. For complex prompts, enhance clarity and add missing elements without altering the original structure.
- Reasoning Before Conclusions**: Encourage reasoning steps before any conclusions are reached. ATTENTION! If the user provides examples where the reasoning happens afterward, REVERSE the order! NEVER START EXAMPLES WITH CONCLUSIONS!
    - Reasoning Order: Call out reasoning portions of the prompt and conclusion parts (specific fields by name). For each, determine the ORDER in which this is done, and whether it needs to be reversed.
    - Conclusion, classifications, or results should ALWAYS appear last.
- Examples: Include high-quality examples if helpful, using placeholders [in brackets] for complex elements.
   - What kinds of examples may need to be included, how many, and whether they are complex enough to benefit from placeholders.
- Clarity and Conciseness: Use clear, specific language. Avoid unnecessary instructions or bland statements.
- Formatting: Use markdown features for readability. DO NOT USE \`\`\` CODE BLOCKS UNLESS SPECIFICALLY REQUESTED.
- Preserve User Content: If the input task or prompt includes extensive guidelines or examples, preserve them entirely, or as closely as possible. If they are vague, consider breaking down into sub-steps. Keep any details, guidelines, examples, variables, or placeholders provided by the user.
- Constants: DO include constants in the prompt, as they are not susceptible to prompt injection. Such as guides, rubrics, and examples.
- Output Format: Explicitly the most appropriate output format, in detail. This should include length and syntax (e.g. short sentence, paragraph, JSON, etc.)
    - For tasks outputting well-defined or structured data (classification, JSON, etc.) bias toward outputting a JSON.
    - JSON should never be wrapped in code blocks (\`\`\`) unless explicitly requested.

The final prompt you output should adhere to the following structure below. Do not include any additional commentary, only output the completed system prompt. SPECIFICALLY, do not include any additional messages at the start or end of the prompt. (e.g. no "---")

[Concise instruction describing the task - this should be the first line in the prompt, no section header]

[Additional details as needed.]

[Optional sections with headings or bullet points for detailed steps.]

# Steps [optional]

[optional: a detailed breakdown of the steps necessary to accomplish the task]

# Output Format

[Specifically call out how the output should be formatted, be it response length, structure e.g. JSON, markdown, etc]

# Examples [optional]

[Optional: 1-3 well-defined examples with placeholders if necessary. Clearly mark where examples start and end, and what the input and output are. User placeholders as necessary.]
[If the examples are shorter than what a realistic example is expected to be, make a reference with () explaining how real examples should be longer / shorter / different. AND USE PLACEHOLDERS! ]

# Notes [optional]

[optional: edge cases, details, and an area to call or repeat out specific important considerations]`;

async function generatePrompt(taskOrPrompt: string) {
  const completion = await client.chat.completions.create({
    model: "gpt-6-astra",
    messages: [
      { role: "system", content: metaPrompt },
      {
        role: "user",
        content: "Task, Goal, or Current Prompt:\n" + taskOrPrompt,
      },
    ],
  });

  return completion.choices[0].message.content;
}

console.log(
  await generatePrompt("Write a concise product launch announcement.")
);

Prompts überarbeiten

Zum Überarbeiten von Prompts verwenden wir einen leicht abgewandelten Meta-Prompt. Konkrete Änderungswünsche lassen sich leicht umsetzen. Bei offener formulierten Aufträgen ist es schwieriger zu erkennen, welche Änderungen nötig sind. Deshalb beginnt die Antwort mit einem Reasoning-Abschnitt. Darin prüft das Modell unter anderem, wie klar und konkret der vorhandene Prompt formuliert ist, in welcher Reihenfolge die Schritte der Gedankenkette stehen und wie der Prompt insgesamt aufgebaut ist. So ermittelt das Modell den Änderungsbedarf und schlägt Verbesserungen vor. Anschließend entfernen wir diesen Abschnitt beim Parsen aus der endgültigen Antwort.

Meta-Prompt zum Überarbeiten von Prompts für Textausgaben
import OpenAI from "openai";

const client = new OpenAI();

const metaPrompt = `Given a current prompt and a change description, produce a detailed system prompt to guide a language model in completing the task effectively.

Your final output will be the full corrected prompt verbatim. However, before that, at the very beginning of your response, use <reasoning> tags to analyze the prompt and determine the following, explicitly:
<reasoning>
- Simple Change: (yes/no) Is the change description explicit and simple? (If so, skip the rest of these questions.)
- Reasoning: (yes/no) Does the current prompt use reasoning, analysis, or chain of thought?
    - Identify: (max 10 words) if so, which section(s) utilize reasoning?
    - Conclusion: (yes/no) is the chain of thought used to determine a conclusion?
    - Ordering: (before/after) is the chain of though located before or after
- Structure: (yes/no) does the input prompt have a well defined structure
- Examples: (yes/no) does the input prompt have few-shot examples
    - Representative: (1-5) if present, how representative are the examples?
- Complexity: (1-5) how complex is the input prompt?
    - Task: (1-5) how complex is the implied task?
    - Necessity: ()
- Specificity: (1-5) how detailed and specific is the prompt? (not to be confused with length)
- Prioritization: (list) what 1-3 categories are the MOST important to address.
- Conclusion: (max 30 words) given the previous assessment, give a very concise, imperative description of what should be changed and how. this does not have to adhere strictly to only the categories listed
</reasoning>

# Guidelines

- Understand the Task: Grasp the main objective, goals, requirements, constraints, and expected output.
- Minimal Changes: If an existing prompt is provided, improve it only if it's simple. For complex prompts, enhance clarity and add missing elements without altering the original structure.
- Reasoning Before Conclusions**: Encourage reasoning steps before any conclusions are reached. ATTENTION! If the user provides examples where the reasoning happens afterward, REVERSE the order! NEVER START EXAMPLES WITH CONCLUSIONS!
    - Reasoning Order: Call out reasoning portions of the prompt and conclusion parts (specific fields by name). For each, determine the ORDER in which this is done, and whether it needs to be reversed.
    - Conclusion, classifications, or results should ALWAYS appear last.
- Examples: Include high-quality examples if helpful, using placeholders [in brackets] for complex elements.
   - What kinds of examples may need to be included, how many, and whether they are complex enough to benefit from placeholders.
- Clarity and Conciseness: Use clear, specific language. Avoid unnecessary instructions or bland statements.
- Formatting: Use markdown features for readability. DO NOT USE \`\`\` CODE BLOCKS UNLESS SPECIFICALLY REQUESTED.
- Preserve User Content: If the input task or prompt includes extensive guidelines or examples, preserve them entirely, or as closely as possible. If they are vague, consider breaking down into sub-steps. Keep any details, guidelines, examples, variables, or placeholders provided by the user.
- Constants: DO include constants in the prompt, as they are not susceptible to prompt injection. Such as guides, rubrics, and examples.
- Output Format: Explicitly the most appropriate output format, in detail. This should include length and syntax (e.g. short sentence, paragraph, JSON, etc.)
    - For tasks outputting well-defined or structured data (classification, JSON, etc.) bias toward outputting a JSON.
    - JSON should never be wrapped in code blocks (\`\`\`) unless explicitly requested.

The final prompt you output should adhere to the following structure below. Do not include any additional commentary, only output the completed system prompt. SPECIFICALLY, do not include any additional messages at the start or end of the prompt. (e.g. no "---")

[Concise instruction describing the task - this should be the first line in the prompt, no section header]

[Additional details as needed.]

[Optional sections with headings or bullet points for detailed steps.]

# Steps [optional]

[optional: a detailed breakdown of the steps necessary to accomplish the task]

# Output Format

[Specifically call out how the output should be formatted, be it response length, structure e.g. JSON, markdown, etc]

# Examples [optional]

[Optional: 1-3 well-defined examples with placeholders if necessary. Clearly mark where examples start and end, and what the input and output are. User placeholders as necessary.]
[If the examples are shorter than what a realistic example is expected to be, make a reference with () explaining how real examples should be longer / shorter / different. AND USE PLACEHOLDERS! ]

# Notes [optional]

[optional: edge cases, details, and an area to call or repeat out specific important considerations]
[NOTE: you must start with a <reasoning> section. the immediate next token you produce should be <reasoning>]`;

async function generatePrompt(taskOrPrompt: string) {
  const completion = await client.chat.completions.create({
    model: "gpt-6-astra",
    messages: [
      { role: "system", content: metaPrompt },
      {
        role: "user",
        content: "Task, Goal, or Current Prompt:\n" + taskOrPrompt,
      },
    ],
  });

  return completion.choices[0].message.content;
}

console.log(
  await generatePrompt("Make this support prompt more concise and empathetic.")
);

Schemas

Schemas für strukturierte Ausgaben und Funktionsschemas sind selbst JSON-Objekte. Deshalb können wir sie mithilfe strukturierter Ausgaben generieren. Dafür müssen wir ein Schema für die gewünschte Ausgabe definieren. In diesem Fall ist die Ausgabe selbst ein Schema. Wir verwenden dafür ein Schema, das sich selbst beschreibt: ein Meta-Schema.

Da das Feld parameters in einem Funktionsschema selbst ein Schema ist, verwenden wir dasselbe Meta-Schema auch zum Generieren von Funktionen.

Ein Meta-Schema mit Einschränkungen definieren

Für strukturierte Ausgaben gibt es zwei Modi: strict=true und strict=false. In beiden Modi kommt dasselbe Modell zum Einsatz. Es wurde darauf trainiert, das vorgegebene Schema einzuhalten. Nur im „strikten Modus“ garantiert eingeschränktes Sampling, dass die Ausgabe dem Schema exakt entspricht.

Wir möchten Schemas für den strikten Modus generieren und dafür den strikten Modus selbst verwenden. Die offiziellen Meta-Schemas der JSON-Schema-Spezifikation setzen jedoch Funktionen voraus, die der strikte Modus derzeit nicht unterstützt. Das betrifft sowohl das Eingabe- als auch das Ausgabeschema:

  1. Eingabeschema: Beim Beschreiben des Ausgabeschemas müssen wir im Eingabeschema auf nicht unterstützte Funktionen verzichten.
  2. Ausgabeschema: Das generierte Schema darf keine nicht unterstützten Funktionen enthalten.

Da wir im Ausgabeschema neue Schlüssel generieren müssen, muss das Meta-Schema für die Eingabe additionalProperties verwenden. Deshalb können wir Schemas derzeit nicht im strikten Modus generieren. Das generierte Schema soll die Vorgaben des strikten Modus dennoch erfüllen.

Um diese Einschränkung zu umgehen, definieren wir ein Pseudo-Meta-Schema. Es verwendet Funktionen, die der strikte Modus nicht unterstützt, beschreibt damit aber ausschließlich die unterstützten Funktionen. So können wir das Meta-Schema außerhalb des strikten Modus definieren und trotzdem sicherstellen, dass die generierten Schemas dessen Vorgaben erfüllen.

Vertiefung
So haben wir das Pseudo-Meta-Schema entwickelt

Ausgabe bereinigen

Im strikten Modus entspricht die Ausgabe garantiert exakt dem Schema. Da wir diesen Modus beim Generieren nicht verwenden können, müssen wir die Ausgabe anschließend prüfen und anpassen.

Nach dem Generieren eines Schemas gehen wir so vor:

  1. Wir setzen additionalProperties auf false, und zwar für alle Objekte.
  2. Wir kennzeichnen alle Eigenschaften als erforderlich.
  3. Schemas für strukturierte Ausgaben betten wir in ein json_schema-Objekt ein.
  4. Funktionen betten wir in ein function-Objekt ein.

Das function-Objekt der Realtime API unterscheidet sich geringfügig von dem der Chat Completions API, verwendet aber dasselbe Schema.

Meta-Schemas

Zu jedem Meta-Schema gehört ein Prompt mit Few-Shot-Beispielen. Mit diesen Prompts konnten wir dank der Zuverlässigkeit strukturierter Ausgaben auch ohne strikten Modus Schemas generieren.

Meta-Schema für strukturierte Ausgaben
import OpenAI from "openai";

const client = new OpenAI();

const schemaDefinition = {
  type: "object",
  properties: {
    description: { type: "string" },
    type: {
      type: "string",
      enum: ["object", "array", "string", "number", "boolean", "null"],
    },
    properties: {
      type: "object",
      additionalProperties: { $ref: "#/$defs/schema_definition" },
    },
    items: {
      anyOf: [
        { $ref: "#/$defs/schema_definition" },
        { type: "array", items: { $ref: "#/$defs/schema_definition" } },
      ],
    },
    required: { type: "array", items: { type: "string" } },
    additionalProperties: { type: "boolean" },
    enum: { type: "array", minItems: 1, uniqueItems: true },
    $ref: { type: "string" },
    $defs: {
      type: "object",
      additionalProperties: { $ref: "#/$defs/schema_definition" },
    },
    anyOf: {
      type: "array",
      minItems: 1,
      items: { $ref: "#/$defs/schema_definition" },
    },
  },
  additionalProperties: false,
  if: { required: ["type"], properties: { type: { const: "object" } } },
  then: { required: ["properties"] },
};

const metaSchema = {
  name: "metaschema",
  schema: {
    ...schemaDefinition,
    required: ["type"],
    properties: {
      name: { type: "string", description: "The name of the schema" },
      ...schemaDefinition.properties,
    },
    $defs: {
      schema_definition: {
        ...schemaDefinition,
        anyOf: [
          { required: ["type"] },
          { required: ["$ref"] },
          { required: ["anyOf"] },
        ],
      },
    },
  },
};

const metaPrompt = `# Instructions
Return a valid schema for the described JSON.

You must also make sure:
- all fields in an object are set as required
- I REPEAT, ALL FIELDS MUST BE MARKED AS REQUIRED
- all objects must have additionalProperties set to false
    - because of this, some cases like "attributes" or "metadata" properties that would normally allow additional properties should instead have a fixed set of properties
- all objects must have properties defined
- field order matters. any form of "thinking" or "explanation" should come before the conclusion
- $defs must be defined under the schema param

Notable keywords NOT supported include:
- For objects: unevaluatedProperties, propertyNames, minProperties, maxProperties
- For arrays: unevaluatedItems, contains, minContains, maxContains, uniqueItems

Other notes:
- definitions and recursion are supported
- only if necessary to include references e.g. "$defs", it must be inside the "schema" object

# Examples
Input: Generate a math reasoning schema with steps and a final answer.
Output: {
    "name": "math_reasoning",
    "type": "object",
    "properties": {
        "steps": {
            "type": "array",
            "description": "A sequence of steps involved in solving the math problem.",
            "items": {
                "type": "object",
                "properties": {
                    "explanation": {
                        "type": "string",
                        "description": "Description of the reasoning or method used in this step."
                    },
                    "output": {
                        "type": "string",
                        "description": "Result or outcome of this specific step."
                    }
                },
                "required": [
                    "explanation",
                    "output"
                ],
                "additionalProperties": false
            }
        },
        "final_answer": {
            "type": "string",
            "description": "The final solution or answer to the math problem."
        }
    },
    "required": [
        "steps",
        "final_answer"
    ],
    "additionalProperties": false
}

Input: Give me a linked list
Output: {
    "name": "linked_list",
    "type": "object",
    "properties": {
        "linked_list": {
            "$ref": "#/$defs/linked_list_node",
            "description": "The head node of the linked list."
        }
    },
    "$defs": {
        "linked_list_node": {
            "type": "object",
            "description": "Defines a node in a singly linked list.",
            "properties": {
                "value": {
                    "type": "number",
                    "description": "The value stored in this node."
                },
                "next": {
                    "anyOf": [
                        {
                            "$ref": "#/$defs/linked_list_node"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "Reference to the next node; null if it is the last node."
                }
            },
            "required": [
                "value",
                "next"
            ],
            "additionalProperties": false
        }
    },
    "required": [
        "linked_list"
    ],
    "additionalProperties": false
}

Input: Dynamically generated UI
Output: {
    "name": "ui",
    "type": "object",
    "properties": {
        "type": {
            "type": "string",
            "description": "The type of the UI component",
            "enum": [
                "div",
                "button",
                "header",
                "section",
                "field",
                "form"
            ]
        },
        "label": {
            "type": "string",
            "description": "The label of the UI component, used for buttons or form fields"
        },
        "children": {
            "type": "array",
            "description": "Nested UI components",
            "items": {
                "$ref": "#"
            }
        },
        "attributes": {
            "type": "array",
            "description": "Arbitrary attributes for the UI component, suitable for any element",
            "items": {
                "type": "object",
                "properties": {
                    "name": {
                        "type": "string",
                        "description": "The name of the attribute, for example onClick or className"
                    },
                    "value": {
                        "type": "string",
                        "description": "The value of the attribute"
                    }
                },
                "required": [
                    "name",
                    "value"
                ],
                "additionalProperties": false
            }
        }
    },
    "required": [
        "type",
        "label",
        "children",
        "attributes"
    ],
    "additionalProperties": false
}`;

async function generateSchema(description: string) {
  const completion = await client.chat.completions.create({
    model: "gpt-5.6-terra",
    response_format: { type: "json_schema", json_schema: metaSchema },
    messages: [
      { role: "system", content: metaPrompt },
      { role: "user", content: "Description:\n" + description },
    ],
  });

  const content = completion.choices[0].message.content;
  if (!content) throw new Error("The model did not return a schema.");
  return JSON.parse(content);
}

console.log(
  JSON.stringify(await generateSchema("Describe a calendar event."), null, 2)
);