Create Run

Create a run.
Options

OpenAI Beta
Calls to the Assistants API require that you pass a beta HTTP header.
Thread Id
The ID of the thread to run.
Include[] (*)
A list of additional fields to include in the response. Currently the only supported value is step_details.tool_calls[*].file_search.results[*].content to fetch the file search result content.
See the file search tool documentation for more information.
Body
Request body which must comply to the following JSON Schema:
{
  "required" : [ "assistant_id", "thread_id" ],
  "type" : "object",
  "properties" : {
    "assistant_id" : {
      "type" : "string",
      "description" : "The ID of the [assistant](/docs/api-reference/assistants) to use to execute this run."
    },
    "model" : {
      "description" : "The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.",
      "nullable" : true,
      "example" : "gpt-4o",
      "anyOf" : [ {
        "type" : "string"
      }, {
        "type" : "string",
        "enum" : [ "gpt-4o", "gpt-4o-2024-08-06", "gpt-4o-2024-05-13", "gpt-4o-2024-08-06", "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-0613", "gpt-3.5-turbo-1106", "gpt-3.5-turbo-0125", "gpt-3.5-turbo-16k-0613" ]
      } ],
      "x-oaiTypeLabel" : "string"
    },
    "instructions" : {
      "type" : "string",
      "description" : "Overrides the [instructions](/docs/api-reference/assistants/createAssistant) of the assistant. This is useful for modifying the behavior on a per-run basis.",
      "nullable" : true
    },
    "additional_instructions" : {
      "type" : "string",
      "description" : "Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions.",
      "nullable" : true
    },
    "additional_messages" : {
      "type" : "array",
      "description" : "Adds additional messages to the thread before creating the run.",
      "nullable" : true,
      "items" : {
        "required" : [ "content", "role" ],
        "type" : "object",
        "properties" : {
          "role" : {
            "type" : "string",
            "description" : "The role of the entity that is creating the message. Allowed values include:\n- `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages.\n- `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation.\n",
            "enum" : [ "user", "assistant" ]
          },
          "content" : {
            "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 images can be passed with `image_url` or `image_file`. Image types are only supported on [Vision-compatible models](/docs/models/overview).",
              "items" : {
                "oneOf" : [ {
                  "title" : "Image file",
                  "required" : [ "image_file", "type" ],
                  "type" : "object",
                  "properties" : {
                    "type" : {
                      "type" : "string",
                      "description" : "Always `image_file`.",
                      "enum" : [ "image_file" ]
                    },
                    "image_file" : {
                      "required" : [ "file_id" ],
                      "type" : "object",
                      "properties" : {
                        "file_id" : {
                          "type" : "string",
                          "description" : "The [File](/docs/api-reference/files) ID of the image in the message content. Set `purpose=\"vision\"` when uploading the File if you need to later display the file content."
                        },
                        "detail" : {
                          "type" : "string",
                          "description" : "Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`.",
                          "default" : "auto",
                          "enum" : [ "auto", "low", "high" ]
                        }
                      }
                    }
                  },
                  "description" : "References an image [File](/docs/api-reference/files) in the content of a message."
                }, {
                  "title" : "Image URL",
                  "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" : "The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp.",
                          "format" : "uri"
                        },
                        "detail" : {
                          "type" : "string",
                          "description" : "Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto`",
                          "default" : "auto",
                          "enum" : [ "auto", "low", "high" ]
                        }
                      }
                    }
                  },
                  "description" : "References an image URL in the content of a message."
                }, {
                  "title" : "Text",
                  "required" : [ "text", "type" ],
                  "type" : "object",
                  "properties" : {
                    "type" : {
                      "type" : "string",
                      "description" : "Always `text`.",
                      "enum" : [ "text" ]
                    },
                    "text" : {
                      "type" : "string",
                      "description" : "Text content to be sent to the model"
                    }
                  },
                  "description" : "The text content that is part of a message."
                } ],
                "x-oaiExpandable" : true
              }
            } ],
            "x-oaiExpandable" : true
          },
          "attachments" : {
            "required" : [ "file_id", "tools" ],
            "type" : "array",
            "description" : "A list of files attached to the message, and the tools they should be added to.",
            "nullable" : true,
            "items" : {
              "type" : "object",
              "properties" : {
                "file_id" : {
                  "type" : "string",
                  "description" : "The ID of the file to attach to the message."
                },
                "tools" : {
                  "type" : "array",
                  "description" : "The tools to add this file to.",
                  "items" : {
                    "oneOf" : [ {
                      "title" : "Code interpreter tool",
                      "required" : [ "type" ],
                      "type" : "object",
                      "properties" : {
                        "type" : {
                          "type" : "string",
                          "description" : "The type of tool being defined: `code_interpreter`",
                          "enum" : [ "code_interpreter" ]
                        }
                      }
                    }, {
                      "title" : "FileSearch tool",
                      "required" : [ "type" ],
                      "type" : "object",
                      "properties" : {
                        "type" : {
                          "type" : "string",
                          "description" : "The type of tool being defined: `file_search`",
                          "enum" : [ "file_search" ]
                        }
                      }
                    } ],
                    "x-oaiExpandable" : true
                  }
                }
              }
            }
          },
          "metadata" : {
            "type" : "object",
            "description" : "metadata_description",
            "nullable" : true,
            "x-oaiTypeLabel" : "map"
          }
        },
        "additionalProperties" : false
      }
    },
    "tools" : {
      "maxItems" : 20,
      "type" : "array",
      "description" : "Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.",
      "nullable" : true,
      "items" : {
        "oneOf" : [ {
          "title" : "Code interpreter tool",
          "required" : [ "type" ],
          "type" : "object",
          "properties" : {
            "type" : {
              "type" : "string",
              "description" : "The type of tool being defined: `code_interpreter`",
              "enum" : [ "code_interpreter" ]
            }
          }
        }, {
          "title" : "FileSearch tool",
          "required" : [ "type" ],
          "type" : "object",
          "properties" : {
            "type" : {
              "type" : "string",
              "description" : "The type of tool being defined: `file_search`",
              "enum" : [ "file_search" ]
            },
            "file_search" : {
              "type" : "object",
              "properties" : {
                "max_num_results" : {
                  "maximum" : 50,
                  "minimum" : 1,
                  "type" : "integer",
                  "description" : "The maximum number of results the file search tool should output. The default is 20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between 1 and 50 inclusive.\n\nNote that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](/docs/assistants/tools/file-search/customizing-file-search-settings) for more information.\n"
                },
                "ranking_options" : {
                  "title" : "File search tool call ranking options",
                  "required" : [ "score_threshold" ],
                  "type" : "object",
                  "properties" : {
                    "ranker" : {
                      "type" : "string",
                      "description" : "The ranker to use for the file search. If not specified will use the `auto` ranker.",
                      "enum" : [ "auto", "default_2024_08_21" ]
                    },
                    "score_threshold" : {
                      "maximum" : 1,
                      "minimum" : 0,
                      "type" : "number",
                      "description" : "The score threshold for the file search. All values must be a floating point number between 0 and 1."
                    }
                  },
                  "description" : "The ranking options for the file search. If not specified, the file search tool will use the `auto` ranker and a score_threshold of 0.\n\nSee the [file search tool documentation](/docs/assistants/tools/file-search/customizing-file-search-settings) for more information.\n"
                }
              },
              "description" : "Overrides for the file search tool."
            }
          }
        }, {
          "title" : "Function tool",
          "required" : [ "function", "type" ],
          "type" : "object",
          "properties" : {
            "type" : {
              "type" : "string",
              "description" : "The type of tool being defined: `function`",
              "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
                }
              }
            }
          }
        } ],
        "x-oaiExpandable" : true
      }
    },
    "metadata" : {
      "type" : "object",
      "description" : "metadata_description",
      "nullable" : true,
      "x-oaiTypeLabel" : "map"
    },
    "temperature" : {
      "maximum" : 2,
      "minimum" : 0,
      "type" : "number",
      "description" : "run_temperature_description",
      "nullable" : true,
      "example" : 1,
      "default" : 1
    },
    "top_p" : {
      "maximum" : 1,
      "minimum" : 0,
      "type" : "number",
      "description" : "run_top_p_description",
      "nullable" : true,
      "example" : 1,
      "default" : 1
    },
    "stream" : {
      "type" : "boolean",
      "description" : "If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message.\n",
      "nullable" : true
    },
    "max_prompt_tokens" : {
      "minimum" : 256,
      "type" : "integer",
      "description" : "The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n",
      "nullable" : true
    },
    "max_completion_tokens" : {
      "minimum" : 256,
      "type" : "integer",
      "description" : "The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.\n",
      "nullable" : true
    },
    "truncation_strategy" : {
      "title" : "Thread Truncation Controls",
      "required" : [ "type" ],
      "type" : "object",
      "properties" : {
        "type" : {
          "type" : "string",
          "description" : "The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`.",
          "enum" : [ "auto", "last_messages" ]
        },
        "last_messages" : {
          "minimum" : 1,
          "type" : "integer",
          "description" : "The number of most recent messages from the thread when constructing the context for the run.",
          "nullable" : true
        }
      },
      "description" : "Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run."
    },
    "tool_choice" : {
      "description" : "Controls which (if any) tool is called by the model.\n`none` means the model will not call any tools and instead generates a message.\n`auto` is the default value and 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 before responding to the user.\nSpecifying a particular tool like `{\"type\": \"file_search\"}` or `{\"type\": \"function\", \"function\": {\"name\": \"my_function\"}}` forces the model to call that tool.\n",
      "oneOf" : [ {
        "type" : "string",
        "description" : "`none` means the model will not call any tools 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 before responding to the user.\n",
        "enum" : [ "none", "auto", "required" ]
      }, {
        "required" : [ "type" ],
        "type" : "object",
        "properties" : {
          "type" : {
            "type" : "string",
            "description" : "The type of the tool. If type is `function`, the function name must be set",
            "enum" : [ "function", "code_interpreter", "file_search" ]
          },
          "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 tool."
      } ],
      "x-oaiExpandable" : true
    },
    "parallel_tool_calls" : {
      "type" : "boolean",
      "description" : "Whether to enable [parallel function calling](/docs/guides/function-calling/parallel-function-calling) during tool use.",
      "default" : true
    },
    "response_format" : {
      "description" : "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models/gpt-4o), [GPT-4 Turbo](/docs/models/gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures 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",
      "oneOf" : [ {
        "type" : "string",
        "description" : "`auto` is the default value\n",
        "enum" : [ "auto" ]
      }, {
        "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
    }
  },
  "additionalProperties" : false
}
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
Input Ports

: Configuration data.
Output Ports

: Result of the request depending on the selected Result Format.
: Configuration data (this is the same as the input port; it is provided as passthrough for sequentially chaining nodes to declutter your workflow connections).
Popular Predecessors

No recommendations found
Popular Successors

No recommendations found
Views

This node has no views
Workflows

No workflows found
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
Installation

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.3
A zipped version of the software site can be downloaded here.
Plugin provider: NodePit
Plugin version: 2.1.0.202410081415
On NodePit since: 2024-07-09
Last update: 2024-11-21
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!