Azure OpenAI Connector
Interact with Azure OpenAI from your BPMN process
Required inputs
| Key | Label | Type |
|---|---|---|
authentication.value | API key | secret |
completion_resourceName | Resource name | FEEL expression |
completion_deploymentId | Deployment ID | FEEL expression |
completion_apiVersion | API version | FEEL expression |
completion_prompt | Prompt | FEEL expression |
chatCompletion_resourceName | Resource name | FEEL expression |
chatCompletion_deploymentId | Deployment ID | FEEL expression |
chatCompletion_apiVersion | API version | FEEL expression |
chatCompletion_messageContent | Message content | FEEL expression |
completionsExtension_resourceName | Resource name | FEEL expression |
completionsExtension_deploymentId | Deployment ID | FEEL expression |
completionsExtension_apiVersion | API version | FEEL expression |
completionsExtension_messages | Messages | FEEL expression |
Optional inputs
| Key | Label | Type |
|---|---|---|
operation | Operation | string |
completion_maxTokens | Max tokens | secret |
completion_temperature | Temperature | FEEL expression |
completion_topP | Top P | FEEL expression |
completion_logitBias | Logit bias | FEEL expression |
completion_user | User | string |
completion_numberOfCompletions | Number of completions | string |
completion_stream | Stream | string |
completion_logprobs | Log probabilities | string |
completion_suffix | Suffix | string |
completion_echo | Echo | string |
completion_stop | Stop | string |
completion_presencePenalty | Presence penalty | string |
completion_frequencyPenalty | Frequency penalty | string |
completion_bestOf | Best of | string |
chatCompletion_messageRole | Message role | string |
chatCompletion_messages | Messages context | FEEL expression |
chatCompletion_contentPart | Content part | FEEL expression |
chatCompletion_enhancements | Enhancements | FEEL expression |
chatCompletion_temperature | Temperature | FEEL expression |
chatCompletion_n | Number of completions | FEEL expression |
chatCompletion_stream | Stream | string |
chatCompletion_stop | Stop | FEEL expression |
chatCompletion_maxTokens | Max tokens | secret |
chatCompletion_presencePenalty | Presence penalty | FEEL expression |
chatCompletion_frequencyPenalty | Frequency penalty | FEEL expression |
chatCompletion_logitBias | Logit bias | FEEL expression |
chatCompletion_user | User | FEEL expression |
chatCompletion_tools | Tools | FEEL expression |
chatCompletion_dataSources | Data sources | FEEL expression |
completionsExtension_contentPart | Content part | FEEL expression |
completionsExtension_enhancements | Enhancements | FEEL expression |
completionsExtension_temperature | Temperature | FEEL expression |
completionsExtension_n | Number of completions | FEEL expression |
completionsExtension_stream | Stream | string |
completionsExtension_stop | Stop | FEEL expression |
completionsExtension_maxTokens | Max tokens | secret |
completionsExtension_presencePenalty | Presence penalty | FEEL expression |
completionsExtension_frequencyPenalty | Frequency penalty | FEEL expression |
completionsExtension_logitBias | Logit bias | FEEL expression |
completionsExtension_user | User | FEEL expression |
completionsExtension_tools | Tools | FEEL expression |
completionsExtension_dataSources | Data sources | FEEL expression |
resultVariable | Result variable | string |
resultExpression | Result expression | FEEL expression |
errorExpression | Error expression | FEEL expression |
retryCount | Retries | FEEL expression |
retryBackoff | Retry backoff | FEEL expression |
Apply this connector with @bpmnkit/connectors
import { applyConnectorTemplate } from "@bpmnkit/connectors"
const result = applyConnectorTemplate("io.camunda.connectors.AzureOpenAI.outbound.v1", {
"authentication.value": "<your api key>",
"completion_resourceName": "= ...",
"completion_deploymentId": "= ...",
"completion_apiVersion": "= 2024-02-01",
"completion_prompt": "= ...",
"chatCompletion_resourceName": "= ...",
"chatCompletion_deploymentId": "= ...",
"chatCompletion_apiVersion": "= 2024-02-01",
"chatCompletion_messageContent": "= ...",
"completionsExtension_resourceName": "= ...",
"completionsExtension_deploymentId": "= ...",
"completionsExtension_apiVersion": "= 2023-12-01-preview",
"completionsExtension_messages": "= ...",
"operation": "completion",
"completion_maxTokens": "<your max tokens>",
})