OpenAIResponsesToolChoiceUnion - TypeScript SDK

OpenAIResponsesToolChoiceUnion type definition

The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

Supported Types

models.OpenAIResponsesToolChoiceAuto

1const value: models.OpenAIResponsesToolChoiceAuto = "auto";

models.OpenAIResponsesToolChoiceNone

1const value: models.OpenAIResponsesToolChoiceNone = "none";

models.OpenAIResponsesToolChoiceRequired

1const value: models.OpenAIResponsesToolChoiceRequired = "required";

models.OpenAIResponsesToolChoiceFunction

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

models.OpenAIResponsesToolChoice

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

models.ToolChoiceAllowed

1const value: models.ToolChoiceAllowed = {
2 mode: "auto",
3 tools: [
4 {
5 "name": "get_weather",
6 "type": "function",
7 },
8 ],
9 type: "allowed_tools",
10};

models.OpenAIResponsesToolChoiceApplyPatch

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

models.OpenAIResponsesToolChoiceShell

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