Skip to main content
The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

Supported Types

models.OpenAIResponsesToolChoiceAuto

const value: models.OpenAIResponsesToolChoiceAuto = "auto";

models.OpenAIResponsesToolChoiceNone

const value: models.OpenAIResponsesToolChoiceNone = "none";

models.OpenAIResponsesToolChoiceRequired

const value: models.OpenAIResponsesToolChoiceRequired = "required";

models.OpenAIResponsesToolChoiceFunction

const value: models.OpenAIResponsesToolChoiceFunction = {
  name: "<value>",
  type: "function",
};

models.OpenAIResponsesToolChoice

const value: models.OpenAIResponsesToolChoice = {
  type: "web_search_preview",
};

models.ToolChoiceAllowed

const value: models.ToolChoiceAllowed = {
  mode: "auto",
  tools: [
    {
      "name": "get_weather",
      "type": "function",
    },
  ],
  type: "allowed_tools",
};

models.OpenAIResponsesToolChoiceApplyPatch

const value: models.OpenAIResponsesToolChoiceApplyPatch = {
  type: "apply_patch",
};

models.OpenAIResponsesToolChoiceShell

const value: models.OpenAIResponsesToolChoiceShell = {
  type: "shell",
};