Chat Completions

{
  "$defs": {
    "ChatCompletionRequest": {
      "description": "Request for the chat completions endpoint. Note that all parameters except for `model`, `stream`, and `response_format` are ignored.",
      "properties": {
        "frequency_penalty": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "description": "The frequency penalty to use for chat completions. Unsupported.",
          "title": "Frequency Penalty"
        },
        "max_tokens": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "description": "The maximum number of tokens to generate. Unsupported.",
          "title": "Max Tokens"
        },
        "messages": {
          "description": "The messages to use for chat completions.",
          "items": {
            "$ref": "#/$defs/ChatMessage"
          },
          "title": "Messages",
          "type": "array"
        },
        "model": {
          "description": "The model to use for chat completions.",
          "title": "Model",
          "type": "string"
        },
        "n": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "description": "The number of chat completions to generate. Unsupported.",
          "title": "N"
        },
        "presence_penalty": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "description": "The presence penalty to use for chat completions. Unsupported.",
          "title": "Presence Penalty"
        },
        "previous_interaction_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "Interaction ID from a previous chat completion to use as context.",
          "title": "Previous Interaction Id"
        },
        "response_format": {
          "anyOf": [
            {
              "$ref": "#/$defs/openai__types__shared_params__response_format_text__ResponseFormatText"
            },
            {
              "$ref": "#/$defs/ResponseFormatJSONSchema"
            },
            {
              "$ref": "#/$defs/openai__types__shared_params__response_format_json_object__ResponseFormatJSONObject"
            },
            {
              "type": "null"
            }
          ],
          "description": "The response format to use for chat completions. OpenAI compatible.",
          "title": "Response Format"
        },
        "stream": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "description": "Whether to stream the chat completions.",
          "title": "Stream"
        },
        "temperature": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "description": "The temperature to use for chat completions. Unsupported.",
          "title": "Temperature"
        },
        "top_p": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "description": "The top p to use for chat completions. Unsupported.",
          "title": "Top P"
        }
      },
      "required": [
        "model",
        "messages"
      ],
      "title": "ChatCompletionRequest",
      "type": "object"
    },
    "ChatMessage": {
      "description": "Chat message for OpenAI API.",
      "properties": {
        "content": {
          "description": "The content of the chat message.",
          "title": "Content",
          "type": "string"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "An optional name for the participant. Provides the model information to differentiate between participants of the same role.",
          "title": "Name"
        },
        "role": {
          "description": "The role of the chat message.",
          "enum": [
            "system",
            "user",
            "assistant"
          ],
          "title": "Role",
          "type": "string"
        }
      },
      "required": [
        "role",
        "content"
      ],
      "title": "ChatMessage",
      "type": "object"
    },
    "JSONSchema": {
      "description": "Structured Outputs configuration options, including a JSON Schema.",
      "properties": {
        "description": {
          "title": "Description",
          "type": "string"
        },
        "name": {
          "title": "Name",
          "type": "string"
        },
        "schema": {
          "additionalProperties": false,
          "title": "Schema",
          "type": "object"
        },
        "strict": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "title": "Strict"
        }
      },
      "required": [
        "name"
      ],
      "title": "JSONSchema",
      "type": "object"
    },
    "ResponseFormatJSONSchema": {
      "description": "JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).",
      "properties": {
        "json_schema": {
          "$ref": "#/$defs/JSONSchema"
        },
        "type": {
          "const": "json_schema",
          "title": "Type",
          "type": "string"
        }
      },
      "required": [
        "json_schema",
        "type"
      ],
      "title": "ResponseFormatJSONSchema",
      "type": "object"
    },
    "openai__types__shared_params__response_format_json_object__ResponseFormatJSONObject": {
      "description": "JSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so.",
      "properties": {
        "type": {
          "const": "json_object",
          "title": "Type",
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "title": "ResponseFormatJSONObject",
      "type": "object"
    },
    "openai__types__shared_params__response_format_text__ResponseFormatText": {
      "description": "Default response format. Used to generate text responses.",
      "properties": {
        "type": {
          "const": "text",
          "title": "Type",
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "title": "ResponseFormatText",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "body": {
      "$ref": "#/$defs/ChatCompletionRequest"
    }
  },
  "required": [
    "body"
  ],
  "type": "object"
}