304 lines
11 KiB
TypeScript
304 lines
11 KiB
TypeScript
import { AzureOpenAIInput, AzureChatOpenAI as LangchainAzureChatOpenAI, ChatOpenAIFields } from '@langchain/openai'
|
|
import { BaseCache } from '@langchain/core/caches'
|
|
import { ICommonObject, IMultiModalOption, INode, INodeData, INodeOptionsValue, INodeParams } from '../../../src/Interface'
|
|
import { getBaseClasses, getCredentialData, getCredentialParam } from '../../../src/utils'
|
|
import { getModels, MODEL_TYPE } from '../../../src/modelLoader'
|
|
import { AzureChatOpenAI } from './FlowiseAzureChatOpenAI'
|
|
import { OpenAI as OpenAIClient } from 'openai'
|
|
|
|
const serverCredentialsExists =
|
|
!!process.env.AZURE_OPENAI_API_KEY &&
|
|
!!process.env.AZURE_OPENAI_API_INSTANCE_NAME &&
|
|
!!process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME &&
|
|
!!process.env.AZURE_OPENAI_API_VERSION
|
|
|
|
class AzureChatOpenAI_ChatModels implements INode {
|
|
label: string
|
|
name: string
|
|
version: number
|
|
type: string
|
|
icon: string
|
|
category: string
|
|
description: string
|
|
baseClasses: string[]
|
|
credential: INodeParams
|
|
inputs: INodeParams[]
|
|
|
|
constructor() {
|
|
this.label = 'Azure ChatOpenAI'
|
|
this.name = 'azureChatOpenAI'
|
|
this.version = 7.1
|
|
this.type = 'AzureChatOpenAI'
|
|
this.icon = 'Azure.svg'
|
|
this.category = 'Chat Models'
|
|
this.description = 'Wrapper around Azure OpenAI large language models that use the Chat endpoint'
|
|
this.baseClasses = [this.type, ...getBaseClasses(LangchainAzureChatOpenAI)]
|
|
this.credential = {
|
|
label: 'Connect Credential',
|
|
name: 'credential',
|
|
type: 'credential',
|
|
credentialNames: ['azureOpenAIApi'],
|
|
optional: serverCredentialsExists
|
|
}
|
|
this.inputs = [
|
|
{
|
|
label: 'Cache',
|
|
name: 'cache',
|
|
type: 'BaseCache',
|
|
optional: true
|
|
},
|
|
{
|
|
label: 'Model Name',
|
|
name: 'modelName',
|
|
type: 'asyncOptions',
|
|
loadMethod: 'listModels'
|
|
},
|
|
{
|
|
label: 'Temperature',
|
|
name: 'temperature',
|
|
type: 'number',
|
|
step: 0.1,
|
|
default: 0.9,
|
|
optional: true
|
|
},
|
|
{
|
|
label: 'Max Tokens',
|
|
name: 'maxTokens',
|
|
type: 'number',
|
|
step: 1,
|
|
optional: true,
|
|
additionalParams: true
|
|
},
|
|
{
|
|
label: 'Streaming',
|
|
name: 'streaming',
|
|
type: 'boolean',
|
|
default: true,
|
|
optional: true,
|
|
additionalParams: true
|
|
},
|
|
{
|
|
label: 'Top Probability',
|
|
name: 'topP',
|
|
type: 'number',
|
|
step: 0.1,
|
|
optional: true,
|
|
additionalParams: true
|
|
},
|
|
{
|
|
label: 'Frequency Penalty',
|
|
name: 'frequencyPenalty',
|
|
type: 'number',
|
|
step: 0.1,
|
|
optional: true,
|
|
additionalParams: true
|
|
},
|
|
{
|
|
label: 'Presence Penalty',
|
|
name: 'presencePenalty',
|
|
type: 'number',
|
|
step: 0.1,
|
|
optional: true,
|
|
additionalParams: true
|
|
},
|
|
{
|
|
label: 'Timeout',
|
|
name: 'timeout',
|
|
type: 'number',
|
|
step: 1,
|
|
optional: true,
|
|
additionalParams: true
|
|
},
|
|
{
|
|
label: 'BasePath',
|
|
name: 'basepath',
|
|
type: 'string',
|
|
optional: true,
|
|
additionalParams: true
|
|
},
|
|
{
|
|
label: 'BaseOptions',
|
|
name: 'baseOptions',
|
|
type: 'json',
|
|
optional: true,
|
|
additionalParams: true
|
|
},
|
|
{
|
|
label: 'Allow Image Uploads',
|
|
name: 'allowImageUploads',
|
|
type: 'boolean',
|
|
description:
|
|
'Allow image input. Refer to the <a href="https://docs.flowiseai.com/using-flowise/uploads#image" target="_blank">docs</a> for more details.',
|
|
default: false,
|
|
optional: true
|
|
},
|
|
{
|
|
label: 'Image Resolution',
|
|
description: 'This parameter controls the resolution in which the model views the image.',
|
|
name: 'imageResolution',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
label: 'Low',
|
|
name: 'low'
|
|
},
|
|
{
|
|
label: 'High',
|
|
name: 'high'
|
|
},
|
|
{
|
|
label: 'Auto',
|
|
name: 'auto'
|
|
}
|
|
],
|
|
default: 'low',
|
|
optional: false,
|
|
additionalParams: true
|
|
},
|
|
{
|
|
label: 'Reasoning',
|
|
description: 'Whether the model supports reasoning. Only applicable for reasoning models.',
|
|
name: 'reasoning',
|
|
type: 'boolean',
|
|
default: false,
|
|
optional: true,
|
|
additionalParams: true
|
|
},
|
|
{
|
|
label: 'Reasoning Effort',
|
|
description: 'Constrains effort on reasoning for reasoning models. Only applicable for o1 and o3 models.',
|
|
name: 'reasoningEffort',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
label: 'Low',
|
|
name: 'low'
|
|
},
|
|
{
|
|
label: 'Medium',
|
|
name: 'medium'
|
|
},
|
|
{
|
|
label: 'High',
|
|
name: 'high'
|
|
}
|
|
],
|
|
additionalParams: true,
|
|
show: {
|
|
reasoning: true
|
|
}
|
|
},
|
|
{
|
|
label: 'Reasoning Summary',
|
|
description: `A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process`,
|
|
name: 'reasoningSummary',
|
|
type: 'options',
|
|
options: [
|
|
{
|
|
label: 'Auto',
|
|
name: 'auto'
|
|
},
|
|
{
|
|
label: 'Concise',
|
|
name: 'concise'
|
|
},
|
|
{
|
|
label: 'Detailed',
|
|
name: 'detailed'
|
|
}
|
|
],
|
|
additionalParams: true,
|
|
show: {
|
|
reasoning: true
|
|
}
|
|
}
|
|
]
|
|
}
|
|
|
|
//@ts-ignore
|
|
loadMethods = {
|
|
async listModels(): Promise<INodeOptionsValue[]> {
|
|
return await getModels(MODEL_TYPE.CHAT, 'azureChatOpenAI')
|
|
}
|
|
}
|
|
|
|
async init(nodeData: INodeData, _: string, options: ICommonObject): Promise<any> {
|
|
const modelName = nodeData.inputs?.modelName as string
|
|
const temperature = nodeData.inputs?.temperature as string
|
|
const maxTokens = nodeData.inputs?.maxTokens as string
|
|
const frequencyPenalty = nodeData.inputs?.frequencyPenalty as string
|
|
const presencePenalty = nodeData.inputs?.presencePenalty as string
|
|
const timeout = nodeData.inputs?.timeout as string
|
|
const streaming = nodeData.inputs?.streaming as boolean
|
|
const cache = nodeData.inputs?.cache as BaseCache
|
|
const topP = nodeData.inputs?.topP as string
|
|
const basePath = nodeData.inputs?.basepath as string
|
|
const baseOptions = nodeData.inputs?.baseOptions
|
|
const reasoningEffort = nodeData.inputs?.reasoningEffort as OpenAIClient.Chat.ChatCompletionReasoningEffort | null
|
|
const reasoningSummary = nodeData.inputs?.reasoningSummary as 'auto' | 'concise' | 'detailed' | null
|
|
|
|
const credentialData = await getCredentialData(nodeData.credential ?? '', options)
|
|
const azureOpenAIApiKey = getCredentialParam('azureOpenAIApiKey', credentialData, nodeData)
|
|
const azureOpenAIApiInstanceName = getCredentialParam('azureOpenAIApiInstanceName', credentialData, nodeData)
|
|
const azureOpenAIApiDeploymentName = getCredentialParam('azureOpenAIApiDeploymentName', credentialData, nodeData)
|
|
const azureOpenAIApiVersion = getCredentialParam('azureOpenAIApiVersion', credentialData, nodeData)
|
|
|
|
const allowImageUploads = nodeData.inputs?.allowImageUploads as boolean
|
|
const imageResolution = nodeData.inputs?.imageResolution as string
|
|
|
|
const obj: ChatOpenAIFields & Partial<AzureOpenAIInput> = {
|
|
temperature: parseFloat(temperature),
|
|
modelName,
|
|
azureOpenAIApiKey,
|
|
azureOpenAIApiInstanceName,
|
|
azureOpenAIApiDeploymentName,
|
|
azureOpenAIApiVersion,
|
|
streaming: streaming ?? true
|
|
}
|
|
|
|
if (maxTokens) obj.maxTokens = parseInt(maxTokens, 10)
|
|
if (frequencyPenalty) obj.frequencyPenalty = parseFloat(frequencyPenalty)
|
|
if (presencePenalty) obj.presencePenalty = parseFloat(presencePenalty)
|
|
if (timeout) obj.timeout = parseInt(timeout, 10)
|
|
if (cache) obj.cache = cache
|
|
if (topP) obj.topP = parseFloat(topP)
|
|
if (basePath) obj.azureOpenAIBasePath = basePath
|
|
if (baseOptions) {
|
|
try {
|
|
const parsedBaseOptions = typeof baseOptions === 'object' ? baseOptions : JSON.parse(baseOptions)
|
|
obj.configuration = {
|
|
defaultHeaders: parsedBaseOptions
|
|
}
|
|
} catch (exception) {
|
|
console.error('Error parsing base options', exception)
|
|
}
|
|
}
|
|
if (modelName === 'o3-mini' || modelName.includes('o1')) {
|
|
delete obj.temperature
|
|
}
|
|
if (modelName.includes('o1') || modelName.includes('o3')) {
|
|
const reasoning: OpenAIClient.Reasoning = {}
|
|
if (reasoningEffort) {
|
|
reasoning.effort = reasoningEffort
|
|
}
|
|
if (reasoningSummary) {
|
|
reasoning.summary = reasoningSummary
|
|
}
|
|
obj.reasoning = reasoning
|
|
}
|
|
|
|
const multiModalOption: IMultiModalOption = {
|
|
image: {
|
|
allowImageUploads: allowImageUploads ?? false,
|
|
imageResolution
|
|
}
|
|
}
|
|
|
|
const model = new AzureChatOpenAI(nodeData.id, obj)
|
|
model.setMultiModalOption(multiModalOption)
|
|
return model
|
|
}
|
|
}
|
|
|
|
module.exports = { nodeClass: AzureChatOpenAI_ChatModels }
|