Go to Product
Creates a model response for the given chat conversation.
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. [Example Python code](https://cookbook.openai.com/examples/how_to_format_inputs_to_chatgpt_models).", "items" : { "oneOf" : [ { "title" : "System message", "required" : [ "content", "role" ], "type" : "object", "properties" : { "content" : { "type" : "string", "description" : "The contents of the system message." }, "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." } } }, { "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, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. Image input is only supported when using the `gpt-4-visual-preview` model.", "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." } } }, { "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" ] } } } } } ], "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." } } }, { "title" : "Assistant message", "required" : [ "role" ], "type" : "object", "properties" : { "content" : { "type" : "string", "description" : "The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified.\n", "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." }, "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.", "deprecated" : true } } }, { "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" : { "type" : "string", "description" : "The contents of the tool message." }, "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-3.5-turbo", "anyOf" : [ { "type" : "string" }, { "type" : "string", "enum" : [ "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-16k-0613" ] } ], "x-oaiTypeLabel" : "string" }, "frequency_penalty" : { "maximum" : 2, "minimum" : -2, "type" : "number", "description" : "completions_frequency_penalty_description", "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 tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should 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, returns the log probabilities of each output token returned in the `content` of `message`. This option is currently not available on the `gpt-4-vision-preview` model.", "nullable" : true, "default" : false }, "top_logprobs" : { "maximum" : 5, "minimum" : 0, "type" : "integer", "description" : "An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used.", "nullable" : true }, "max_tokens" : { "type" : "integer", "description" : "The maximum number of [tokens](/tokenizer) that can be generated in the chat completion.\n\nThe total length of input tokens and generated tokens is limited by the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.\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 }, "presence_penalty" : { "maximum" : 2, "minimum" : -2, "type" : "number", "description" : "completions_presence_penalty_description", "nullable" : true, "default" : 0 }, "response_format" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "Must be one of `text` or `json_object`.", "example" : "json_object", "default" : "text", "enum" : [ "text", "json_object" ] } }, "description" : "An object specifying the format that the model must output. Compatible with `gpt-4-1106-preview` and `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which guarantees the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n" }, "seed" : { "maximum" : 9223372036854775807, "minimum" : -9223372036854775808, "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 } }, "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 }, "temperature" : { "maximum" : 2, "minimum" : 0, "type" : "number", "description" : "completions_temperature_description", "nullable" : true, "example" : 1, "default" : 1 }, "top_p" : { "maximum" : 1, "minimum" : 0, "type" : "number", "description" : "completions_top_p_description", "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.\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/text-generation/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." } } } } } }, "tool_choice" : { "description" : "Controls which (if any) function is called by the model.\n`none` means the model will not call a function and instead generates a message.\n`auto` means the model can pick between generating a message or calling a function.\nSpecifying a particular function via `{\"type: \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that function.\n\n`none` is the default when no functions are present. `auto` is the default if functions are present.\n", "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" : [ "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 }, "function_call" : { "description" : "Deprecated in favor of `tool_choice`.\n\nControls which (if any) function is called by the model.\n`none` means the model will not call a function and instead generates a message.\n`auto` means the model can pick between generating a message or calling a function.\nSpecifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.\n\n`none` is the default when no functions are present. `auto` is the default if 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/text-generation/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
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.2
A zipped version of the software site can be downloaded here.
Plugin provider: NodePit
Plugin version: 1.1.0.202312220918
On NodePit since: 2023-12-06
Last update: 2024-04-30
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, follow @NodePit on Twitter or botsin.space/@nodepit on Mastodon.
Please note that this is only about NodePit. We do not provide general support for KNIME — please use the KNIME forums instead.