Go to Product
Creates a model response for the given chat conversation. Learn more in the [text generation](/docs/guides/text-generation), [vision](/docs/guides/vision), and [audio](/docs/guides/audio) guides. Parameter support can differ depending on the model used to generate the response, particularly for newer reasoning models. Parameters that are only supported for reasoning models are noted below. For the current state of unsupported parameters in reasoning models, [refer to the reasoning guide](/docs/guides/reasoning).
Options
- Body
Request body which must comply to the following JSON Schema:
{ "required" : [ "messages", "model" ], "type" : "object", "properties" : { "messages" : { "minItems" : 1, "type" : "array", "description" : "A list of messages comprising the conversation so far. Depending on the\n[model](/docs/models) you use, different message types (modalities) are\nsupported, like [text](/docs/guides/text-generation),\n[images](/docs/guides/vision), and [audio](/docs/guides/audio).\n", "items" : { "oneOf" : [ { "title" : "Developer message", "required" : [ "content", "role" ], "type" : "object", "properties" : { "content" : { "description" : "The contents of the developer message.", "oneOf" : [ { "title" : "Text content", "type" : "string", "description" : "The contents of the developer message." }, { "title" : "Array of content parts", "minItems" : 1, "type" : "array", "description" : "An array of content parts with a defined type. For developer messages, only type `text` is supported.", "items" : { "title" : "Text content part", "required" : [ "text", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of the content part.", "enum" : [ "text" ] }, "text" : { "type" : "string", "description" : "The text content." } }, "description" : "Learn about [text inputs](/docs/guides/text-generation).\n" } } ] }, "role" : { "type" : "string", "description" : "The role of the messages author, in this case `developer`.", "enum" : [ "developer" ] }, "name" : { "type" : "string", "description" : "An optional name for the participant. Provides the model information to differentiate between participants of the same role." } }, "description" : "Developer-provided instructions that the model should follow, regardless of\nmessages sent by the user. With o1 models and newer, `developer` messages\nreplace the previous `system` messages.\n" }, { "title" : "System message", "required" : [ "content", "role" ], "type" : "object", "properties" : { "content" : { "description" : "The contents of the system message.", "oneOf" : [ { "title" : "Text content", "type" : "string", "description" : "The contents of the system message." }, { "title" : "Array of content parts", "minItems" : 1, "type" : "array", "description" : "An array of content parts with a defined type. For system messages, only type `text` is supported.", "items" : { "oneOf" : [ { "title" : "Text content part", "required" : [ "text", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of the content part.", "enum" : [ "text" ] }, "text" : { "type" : "string", "description" : "The text content." } }, "description" : "Learn about [text inputs](/docs/guides/text-generation).\n" } ], "x-oaiExpandable" : true } } ] }, "role" : { "type" : "string", "description" : "The role of the messages author, in this case `system`.", "enum" : [ "system" ] }, "name" : { "type" : "string", "description" : "An optional name for the participant. Provides the model information to differentiate between participants of the same role." } }, "description" : "Developer-provided instructions that the model should follow, regardless of\nmessages sent by the user. With o1 models and newer, use `developer` messages\nfor this purpose instead.\n" }, { "title" : "User message", "required" : [ "content", "role" ], "type" : "object", "properties" : { "content" : { "description" : "The contents of the user message.\n", "oneOf" : [ { "title" : "Text content", "type" : "string", "description" : "The text contents of the message." }, { "title" : "Array of content parts", "minItems" : 1, "type" : "array", "description" : "An array of content parts with a defined type. Supported options differ based on the [model](/docs/models) being used to generate the response. Can contain text, image, or audio inputs.", "items" : { "oneOf" : [ { "title" : "Text content part", "required" : [ "text", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of the content part.", "enum" : [ "text" ] }, "text" : { "type" : "string", "description" : "The text content." } }, "description" : "Learn about [text inputs](/docs/guides/text-generation).\n" }, { "title" : "Image content part", "required" : [ "image_url", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of the content part.", "enum" : [ "image_url" ] }, "image_url" : { "required" : [ "url" ], "type" : "object", "properties" : { "url" : { "type" : "string", "description" : "Either a URL of the image or the base64 encoded image data.", "format" : "uri" }, "detail" : { "type" : "string", "description" : "Specifies the detail level of the image. Learn more in the [Vision guide](/docs/guides/vision#low-or-high-fidelity-image-understanding).", "default" : "auto", "enum" : [ "auto", "low", "high" ] } } } }, "description" : "Learn about [image inputs](/docs/guides/vision).\n" }, { "title" : "Audio content part", "required" : [ "input_audio", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of the content part. Always `input_audio`.", "enum" : [ "input_audio" ] }, "input_audio" : { "required" : [ "data", "format" ], "type" : "object", "properties" : { "data" : { "type" : "string", "description" : "Base64 encoded audio data." }, "format" : { "type" : "string", "description" : "The format of the encoded audio data. Currently supports \"wav\" and \"mp3\".\n", "enum" : [ "wav", "mp3" ] } } } }, "description" : "Learn about [audio inputs](/docs/guides/audio).\n" } ], "x-oaiExpandable" : true } } ], "x-oaiExpandable" : true }, "role" : { "type" : "string", "description" : "The role of the messages author, in this case `user`.", "enum" : [ "user" ] }, "name" : { "type" : "string", "description" : "An optional name for the participant. Provides the model information to differentiate between participants of the same role." } }, "description" : "Messages sent by an end user, containing prompts or additional context\ninformation.\n" }, { "title" : "Assistant message", "required" : [ "role" ], "type" : "object", "properties" : { "content" : { "description" : "The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.\n", "nullable" : true, "oneOf" : [ { "title" : "Text content", "type" : "string", "description" : "The contents of the assistant message." }, { "title" : "Array of content parts", "minItems" : 1, "type" : "array", "description" : "An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`.", "items" : { "oneOf" : [ { "title" : "Text content part", "required" : [ "text", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of the content part.", "enum" : [ "text" ] }, "text" : { "type" : "string", "description" : "The text content." } }, "description" : "Learn about [text inputs](/docs/guides/text-generation).\n" }, { "title" : "Refusal content part", "required" : [ "refusal", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of the content part.", "enum" : [ "refusal" ] }, "refusal" : { "type" : "string", "description" : "The refusal message generated by the model." } } } ], "x-oaiExpandable" : true } } ], "x-oaiExpandable" : true }, "refusal" : { "type" : "string", "description" : "The refusal message by the assistant.", "nullable" : true }, "role" : { "type" : "string", "description" : "The role of the messages author, in this case `assistant`.", "enum" : [ "assistant" ] }, "name" : { "type" : "string", "description" : "An optional name for the participant. Provides the model information to differentiate between participants of the same role." }, "audio" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Unique identifier for a previous audio response from the model.\n" } }, "description" : "Data about a previous audio response from the model. \n[Learn more](/docs/guides/audio).\n", "nullable" : true, "x-oaiExpandable" : true }, "tool_calls" : { "type" : "array", "description" : "The tool calls generated by the model, such as function calls.", "items" : { "required" : [ "function", "id", "type" ], "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The ID of the tool call." }, "type" : { "type" : "string", "description" : "The type of the tool. Currently, only `function` is supported.", "enum" : [ "function" ] }, "function" : { "required" : [ "arguments", "name" ], "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "The name of the function to call." }, "arguments" : { "type" : "string", "description" : "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." } }, "description" : "The function that the model called." } } } }, "function_call" : { "required" : [ "arguments", "name" ], "type" : "object", "properties" : { "arguments" : { "type" : "string", "description" : "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function." }, "name" : { "type" : "string", "description" : "The name of the function to call." } }, "description" : "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.", "nullable" : true, "deprecated" : true } }, "description" : "Messages sent by the model in response to user messages.\n" }, { "title" : "Tool message", "required" : [ "content", "role", "tool_call_id" ], "type" : "object", "properties" : { "role" : { "type" : "string", "description" : "The role of the messages author, in this case `tool`.", "enum" : [ "tool" ] }, "content" : { "description" : "The contents of the tool message.", "oneOf" : [ { "title" : "Text content", "type" : "string", "description" : "The contents of the tool message." }, { "title" : "Array of content parts", "minItems" : 1, "type" : "array", "description" : "An array of content parts with a defined type. For tool messages, only type `text` is supported.", "items" : { "oneOf" : [ { "title" : "Text content part", "required" : [ "text", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of the content part.", "enum" : [ "text" ] }, "text" : { "type" : "string", "description" : "The text content." } }, "description" : "Learn about [text inputs](/docs/guides/text-generation).\n" } ], "x-oaiExpandable" : true } } ] }, "tool_call_id" : { "type" : "string", "description" : "Tool call that this message is responding to." } } }, { "title" : "Function message", "required" : [ "content", "name", "role" ], "type" : "object", "properties" : { "role" : { "type" : "string", "description" : "The role of the messages author, in this case `function`.", "enum" : [ "function" ] }, "content" : { "type" : "string", "description" : "The contents of the function message.", "nullable" : true }, "name" : { "type" : "string", "description" : "The name of the function to call." } }, "deprecated" : true } ], "x-oaiExpandable" : true } }, "model" : { "description" : "ID of the model to use. See the [model endpoint compatibility](/docs/models#model-endpoint-compatibility) table for details on which models work with the Chat API.", "example" : "gpt-4o", "anyOf" : [ { "type" : "string" }, { "type" : "string", "enum" : [ "o1", "o1-2024-12-17", "o1-preview", "o1-preview-2024-09-12", "o1-mini", "o1-mini-2024-09-12", "gpt-4o", "gpt-4o-2024-11-20", "gpt-4o-2024-08-06", "gpt-4o-2024-05-13", "gpt-4o-audio-preview", "gpt-4o-audio-preview-2024-10-01", "gpt-4o-audio-preview-2024-12-17", "gpt-4o-mini-audio-preview", "gpt-4o-mini-audio-preview-2024-12-17", "chatgpt-4o-latest", "gpt-4o-mini", "gpt-4o-mini-2024-07-18", "gpt-4-turbo", "gpt-4-turbo-2024-04-09", "gpt-4-0125-preview", "gpt-4-turbo-preview", "gpt-4-1106-preview", "gpt-4-vision-preview", "gpt-4", "gpt-4-0314", "gpt-4-0613", "gpt-4-32k", "gpt-4-32k-0314", "gpt-4-32k-0613", "gpt-3.5-turbo", "gpt-3.5-turbo-16k", "gpt-3.5-turbo-0301", "gpt-3.5-turbo-0613", "gpt-3.5-turbo-1106", "gpt-3.5-turbo-0125", "gpt-3.5-turbo-16k-0613" ] } ], "x-oaiTypeLabel" : "string" }, "store" : { "type" : "boolean", "description" : "Whether or not to store the output of this chat completion request for \nuse in our [model distillation](/docs/guides/distillation) or\n[evals](/docs/guides/evals) products.\n", "nullable" : true, "default" : false }, "reasoning_effort" : { "type" : "string", "description" : "**o1 models only** \n\nConstrains effort on reasoning for \n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\nCurrently supported values are `low`, `medium`, and `high`. Reducing\nreasoning effort can result in faster responses and fewer tokens used\non reasoning in a response.\n", "default" : "medium", "enum" : [ "low", "medium", "high" ] }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "string" }, "description" : "Developer-defined tags and values used for filtering completions\nin the [dashboard](https://platform.openai.com/chat-completions).\n", "nullable" : true }, "frequency_penalty" : { "maximum" : 2, "minimum" : -2, "type" : "number", "description" : "Number between -2.0 and 2.0. Positive values penalize new tokens based on\ntheir existing frequency in the text so far, decreasing the model's\nlikelihood to repeat the same line verbatim.\n", "nullable" : true, "default" : 0 }, "logit_bias" : { "type" : "object", "additionalProperties" : { "type" : "integer" }, "description" : "Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a JSON object that maps tokens (specified by their token ID in the\ntokenizer) to an associated bias value from -100 to 100. Mathematically,\nthe bias is added to the logits generated by the model prior to sampling.\nThe exact effect will vary per model, but values between -1 and 1 should\ndecrease or increase likelihood of selection; values like -100 or 100\nshould result in a ban or exclusive selection of the relevant token.\n", "nullable" : true, "x-oaiTypeLabel" : "map" }, "logprobs" : { "type" : "boolean", "description" : "Whether to return log probabilities of the output tokens or not. If true,\nreturns the log probabilities of each output token returned in the\n`content` of `message`.\n", "nullable" : true, "default" : false }, "top_logprobs" : { "maximum" : 20, "minimum" : 0, "type" : "integer", "description" : "An integer between 0 and 20 specifying the number of most likely tokens to\nreturn at each token position, each with an associated log probability.\n`logprobs` must be set to `true` if this parameter is used.\n", "nullable" : true }, "max_tokens" : { "type" : "integer", "description" : "The maximum number of [tokens](/tokenizer) that can be generated in the\nchat completion. This value can be used to control\n[costs](https://openai.com/api/pricing/) for text generated via API.\n\nThis value is now deprecated in favor of `max_completion_tokens`, and is\nnot compatible with [o1 series models](/docs/guides/reasoning).\n", "nullable" : true, "deprecated" : true }, "max_completion_tokens" : { "type" : "integer", "description" : "An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).\n", "nullable" : true }, "n" : { "maximum" : 128, "minimum" : 1, "type" : "integer", "description" : "How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs.", "nullable" : true, "example" : 1, "default" : 1 }, "modalities" : { "type" : "array", "description" : "Output types that you would like the model to generate for this request.\nMost models are capable of generating text, which is the default:\n\n`[\"text\"]`\n\nThe `gpt-4o-audio-preview` model can also be used to [generate audio](/docs/guides/audio). To\nrequest that this model generate both text and audio responses, you can\nuse:\n\n`[\"text\", \"audio\"]`\n", "nullable" : true, "items" : { "type" : "string", "enum" : [ "text", "audio" ] } }, "prediction" : { "description" : "Configuration for a [Predicted Output](/docs/guides/predicted-outputs),\nwhich can greatly improve response times when large parts of the model\nresponse are known ahead of time. This is most common when you are\nregenerating a file with only minor changes to most of the content.\n", "nullable" : true, "oneOf" : [ { "title" : "Static Content", "required" : [ "content", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of the predicted content you want to provide. This type is\ncurrently always `content`.\n", "enum" : [ "content" ] }, "content" : { "description" : "The content that should be matched when generating a model response.\nIf generated tokens would match this content, the entire model response\ncan be returned much more quickly.\n", "oneOf" : [ { "title" : "Text content", "type" : "string", "description" : "The content used for a Predicted Output. This is often the\ntext of a file you are regenerating with minor changes.\n" }, { "title" : "Array of content parts", "minItems" : 1, "type" : "array", "description" : "An array of content parts with a defined type. Supported options differ based on the [model](/docs/models) being used to generate the response. Can contain text inputs.", "items" : { "title" : "Text content part", "required" : [ "text", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of the content part.", "enum" : [ "text" ] }, "text" : { "type" : "string", "description" : "The text content." } }, "description" : "Learn about [text inputs](/docs/guides/text-generation).\n" } } ], "x-oaiExpandable" : true } }, "description" : "Static predicted output content, such as the content of a text file that is\nbeing regenerated.\n" } ], "x-oaiExpandable" : true }, "audio" : { "required" : [ "format", "voice" ], "type" : "object", "properties" : { "voice" : { "type" : "string", "description" : "The voice the model uses to respond. Supported voices are `ash`, `ballad`, `coral`, `sage`, and `verse` (also supported but not recommended are `alloy`, `echo`, and `shimmer`; these voices are less expressive).\n", "enum" : [ "alloy", "ash", "ballad", "coral", "echo", "sage", "shimmer", "verse" ] }, "format" : { "type" : "string", "description" : "Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`,\n`opus`, or `pcm16`.\n", "enum" : [ "wav", "mp3", "flac", "opus", "pcm16" ] } }, "description" : "Parameters for audio output. Required when audio output is requested with\n`modalities: [\"audio\"]`. [Learn more](/docs/guides/audio).\n", "nullable" : true, "x-oaiExpandable" : true }, "presence_penalty" : { "maximum" : 2, "minimum" : -2, "type" : "number", "description" : "Number between -2.0 and 2.0. Positive values penalize new tokens based on\nwhether they appear in the text so far, increasing the model's likelihood\nto talk about new topics.\n", "nullable" : true, "default" : 0 }, "response_format" : { "description" : "An object specifying the format that the model must output.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables\nStructured Outputs which ensures the model will match your supplied JSON\nschema. Learn more in the [Structured Outputs\nguide](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures\nthe message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model\nto produce JSON yourself via a system or user message. Without this, the\nmodel may generate an unending stream of whitespace until the generation\nreaches the token limit, resulting in a long-running and seemingly \"stuck\"\nrequest. Also note that the message content may be partially cut off if\n`finish_reason=\"length\"`, which indicates the generation exceeded\n`max_tokens` or the conversation exceeded the max context length.\n", "oneOf" : [ { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of response format being defined: `text`", "enum" : [ "text" ] } } }, { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of response format being defined: `json_object`", "enum" : [ "json_object" ] } } }, { "required" : [ "json_schema", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of response format being defined: `json_schema`", "enum" : [ "json_schema" ] }, "json_schema" : { "required" : [ "name", "type" ], "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "A description of what the response format is for, used by the model to determine how to respond in the format." }, "name" : { "type" : "string", "description" : "The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." }, "schema" : { "type" : "object", "additionalProperties" : true, "description" : "The schema for the response format, described as a JSON Schema object." }, "strict" : { "type" : "boolean", "description" : "Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the `schema` field. Only a subset of JSON Schema is supported when `strict` is `true`. To learn more, read the [Structured Outputs guide](/docs/guides/structured-outputs).", "nullable" : true, "default" : false } } } } } ], "x-oaiExpandable" : true }, "seed" : { "maximum" : 9223372036854776000, "minimum" : -9223372036854776000, "type" : "integer", "description" : "This feature is in Beta.\nIf specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\nDeterminism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n", "nullable" : true, "x-oaiMeta" : { "beta" : true } }, "service_tier" : { "type" : "string", "description" : "Specifies the latency tier to use for processing the request. This parameter is relevant for customers subscribed to the scale tier service:\n - If set to 'auto', and the Project is Scale tier enabled, the system will utilize scale tier credits until they are exhausted.\n - If set to 'auto', and the Project is not Scale tier enabled, the request will be processed using the default service tier with a lower uptime SLA and no latency guarentee.\n - If set to 'default', the request will be processed using the default service tier with a lower uptime SLA and no latency guarentee.\n - When not set, the default behavior is 'auto'.\n\n When this parameter is set, the response body will include the `service_tier` utilized.\n", "nullable" : true, "default" : "auto", "enum" : [ "auto", "default" ] }, "stop" : { "description" : "Up to 4 sequences where the API will stop generating further tokens.\n", "oneOf" : [ { "type" : "string", "nullable" : true }, { "maxItems" : 4, "minItems" : 1, "type" : "array", "items" : { "type" : "string" } } ] }, "stream" : { "type" : "boolean", "description" : "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n", "nullable" : true, "default" : false }, "stream_options" : { "type" : "object", "properties" : { "include_usage" : { "type" : "boolean", "description" : "If set, an additional chunk will be streamed before the `data: [DONE]` message. The `usage` field on this chunk shows the token usage statistics for the entire request, and the `choices` field will always be an empty array. All other chunks will also include a `usage` field, but with a null value.\n" } }, "description" : "Options for streaming response. Only set this when you set `stream: true`.\n", "nullable" : true }, "temperature" : { "maximum" : 2, "minimum" : 0, "type" : "number", "description" : "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nWe generally recommend altering this or `top_p` but not both.\n", "nullable" : true, "example" : 1, "default" : 1 }, "top_p" : { "maximum" : 1, "minimum" : 0, "type" : "number", "description" : "An alternative to sampling with temperature, called nucleus sampling,\nwhere the model considers the results of the tokens with top_p probability\nmass. So 0.1 means only the tokens comprising the top 10% probability mass\nare considered.\n\nWe generally recommend altering this or `temperature` but not both.\n", "nullable" : true, "example" : 1, "default" : 1 }, "tools" : { "type" : "array", "description" : "A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.\n", "items" : { "required" : [ "function", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of the tool. Currently, only `function` is supported.", "enum" : [ "function" ] }, "function" : { "required" : [ "name" ], "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "A description of what the function does, used by the model to choose when and how to call the function." }, "name" : { "type" : "string", "description" : "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." }, "parameters" : { "type" : "object", "additionalProperties" : true, "description" : "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list." }, "strict" : { "type" : "boolean", "description" : "Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](docs/guides/function-calling).", "nullable" : true, "default" : false } } } } } }, "tool_choice" : { "description" : "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tool and instead generates a message.\n`auto` means the model can pick between generating a message or calling one or more tools.\n`required` means the model must call one or more tools.\nSpecifying a particular tool via `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n\n`none` is the default when no tools are present. `auto` is the default if tools are present.\n", "oneOf" : [ { "type" : "string", "description" : "`none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `required` means the model must call one or more tools.\n", "enum" : [ "none", "auto", "required" ] }, { "required" : [ "function", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of the tool. Currently, only `function` is supported.", "enum" : [ "function" ] }, "function" : { "required" : [ "name" ], "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "The name of the function to call." } } } }, "description" : "Specifies a tool the model should use. Use to force the model to call a specific function." } ], "x-oaiExpandable" : true }, "parallel_tool_calls" : { "type" : "boolean", "description" : "Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.", "default" : true }, "user" : { "type" : "string", "description" : "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).\n", "example" : "user-1234" }, "function_call" : { "description" : "Deprecated in favor of `tool_choice`.\n\nControls which (if any) function is called by the model.\n\n`none` means the model will not call a function and instead generates a\nmessage.\n\n`auto` means the model can pick between generating a message or calling a\nfunction.\n\nSpecifying a particular function via `{\"name\": \"my_function\"}` forces the\nmodel to call that function.\n\n`none` is the default when no functions are present. `auto` is the default\nif functions are present.\n", "deprecated" : true, "oneOf" : [ { "type" : "string", "description" : "`none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.\n", "enum" : [ "none", "auto" ] }, { "required" : [ "name" ], "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "The name of the function to call." } }, "description" : "Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.\n" } ], "x-oaiExpandable" : true }, "functions" : { "maxItems" : 128, "minItems" : 1, "type" : "array", "description" : "Deprecated in favor of `tools`.\n\nA list of functions the model may generate JSON inputs for.\n", "deprecated" : true, "items" : { "required" : [ "name" ], "type" : "object", "properties" : { "description" : { "type" : "string", "description" : "A description of what the function does, used by the model to choose when and how to call the function." }, "name" : { "type" : "string", "description" : "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64." }, "parameters" : { "type" : "object", "additionalProperties" : true, "description" : "The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. \n\nOmitting `parameters` defines a function with an empty parameter list." } }, "deprecated" : true } } } }- Result Format
Specify how the response should be mapped to the table output. The following formats are available:
Raw Response: Returns the raw response in a single row with the following columns:
- body: Response body
- status: HTTP status code
Views
- This node has no views
Workflows
Links
- No links available
Developers
You want to see the source code for this node? Click the following button and we’ll use our super-powers to find it for you.
Go to Product
To use this node in KNIME, install the extension OpenAI Nodes from the below update site following our NodePit Product and Node Installation Guide:
v5.4
A zipped version of the software site can be downloaded here.
Plugin provider: NodePit
Plugin version: 2.2.0.202501140945
On NodePit since: 2024-12-06
Last update: 2025-02-04
KNIME versions: Since v4.7
NodePit ExclusiveOnly available on NodePit
Deploy, schedule, execute, and monitor your KNIME workflows locally, in the cloud or on-premises – with our brand new NodePit Runner.
Try NodePit Runner!Contact
Do you have feedback, questions, comments about NodePit, want to support this platform, or want your own nodes or workflows listed here as well? Do you think, the search results could be improved or something is missing? Then please get in touch! Alternatively, you can send us an email to mail@nodepit.com.
Please note that this is only about NodePit. We do not provide general support for KNIME — please use the KNIME forums instead.