Azure OpenAI ChatGPT

The Azure OpenAI ChatGPT Node sends a message to an Azure-hosted OpenAI (ChatGPT) model and returns the response.
It supports advanced scenarios such as chat history, function calling, and tool responses.

Revision History

1.0.0.0 Initial Release

Properties

Connection

Type: Connection Input

Url
Type: String
The full endpoint URL for your Azure OpenAI ChatGPT resource.

ApiVersion
Type: String
The API version to use for the request (e.g., 2023-12-01-preview).

Temperature
Type: Double
Controls the randomness of the response. Higher values like 1.0 make output more random, lower values like 0 make it more focused.

FrequencyPenalty
Type: Double
Penalizes repeated phrases. Values range from 0 to 2.

PresencePenalty
Type: Double
Encourages the model to talk about new topics. Values range from 0 to 2.

TenantId
Type: String
The Azure Entra tenant ID used for certificate-based authentication.

ClientId
Type: String
The Azure Entra client ID used for certificate-based authentication.

Certificate
Type: X509Certificate2 Input
A .pfx certificate for authenticating to Azure. The matching .cer must be uploaded to the Entra App.

AccessToken
Type: Password Output
The access token used for authentication, managed automatically.

SystemMessage

Type: Multiline Text Input
An optional high-level instruction to guide the model's behavior.

PreviousMessages

Type: JSON Input
A JSON array of prior conversation messages to provide context.

[
  {
    "role": "system",
    "content": ""
  },
  {
    "role": "user",
    "content": ""
  },
  {
    "role": "assistant",
    "content": "",
    "tool_calls": ""
  },
  {
    "role": "tool",
    "content": "",
    "tool_call_id": ""
  }
]

UserMessage

Type: Multiline Text Input
The user's new message to send to the model.

ToolCallID

Type: Multiline Text Input
Used when providing the result of a function call back to the model.

ToolMessage

Type: Multiline Text Input
The response message generated by a tool or function.

Tools

Type: Multiline Text Input
Optional JSON array of tools (functions) that the assistant can invoke.

ResponseMessageObject

Type: Multiline Text Output
The raw response message object from OpenAI.

ResponseMessage

Type: Multiline Text Output
The plain text content of the response.

ResponseToolCall

Type: Multiline Text Output
The details of the tool call, if one was returned by the assistant.

Remarks

Authentication

Authentication uses Azure Entra certificate-based authentication.
You must configure an Entra App with the relevant credentials and upload the certificate for access.

Message Formatting

Providing previous messages allows the model to behave conversationally.
If no previous messages are supplied, the response may lack context.

Tool Support

You can define tools (functions) for the assistant to invoke by supplying a valid tools JSON array.
The assistant may return tool calls that you can respond to using the ToolCallID and ToolMessage properties.