nodes/generated

Interface OpenAiAINodeParameters

Source
interface OpenAiAINodeParameters {
    assistantId?: { mode: "id" | "list"; value: string };
    binaryPropertyName?: string;
    codeInterpreter?: boolean;
    description?: string;
    file_ids?: unknown[];
    fileId?: { mode: "id" | "list"; value: string };
    imageUrls?: string;
    input?: string;
    inputType?: "url" | "base64";
    instructions?: string;
    jsonOutput?: boolean;
    knowledgeRetrieval?: boolean;
    memory?: "connector" | "threadId";
    messages?: {
        values: {
            content?: string;
            role?: "system" | "user" | "assistant";
        }[];
    };
    model?: | "tts-1"
    | "tts-1-hd"
    | "dall-e-2"
    | "dall-e-3"
    | "gpt-image-1";
    modelId?: { mode: "id"
    | "list"; value: string };
    name?: string;
    operation?:
        | "create"
        | "update"
        | "list"
        | "deleteFile"
        | "upload"
        | "analyze"
        | "generate"
        | "message"
        | "translate"
        | "transcribe"
        | "deleteAssistant"
        | "classify";
    options?: | {
        failIfExists?: boolean;
        temperature?: number;
        topP?: number;
    }
    | {
        baseURL?: string;
        maxRetries?: number;
        preserveOriginalTools?: boolean;
        timeout?: number;
    }
    | {
        codeInterpreter?: boolean;
        description?: string;
        file_ids?: unknown[];
        instructions?: string;
        knowledgeRetrieval?: boolean;
        modelId?: { mode: "id"
        | "list"; value: string };
        name?: string;
        removeCustomTools?: boolean;
        temperature?: number;
        topP?: number;
    }
    | {
        binaryPropertyOutput?: string;
        response_format?: "mp3"
        | "opus"
        | "aac"
        | "flac";
        speed?: number;
    }
    | { language?: string; temperature?: number }
    | { temperature?: number }
    | { purpose?: "assistants" | "fine-tune" }
    | { purpose?: "any" | "assistants" | "fine-tune" }
    | {
        binaryPropertyOutput?: string;
        dalleQuality?: "standard" | "hd";
        n?: number;
        quality?: "low" | "high" | "medium";
        returnImageUrls?: boolean;
        size?:
            | "256x256"
            | "512x512"
            | "1024x1024"
            | "1792x1024"
            | "1024x1792"
            | "1024x1536"
            | "1536x1024";
        style?: "natural"
        | "vivid";
    }
    | {
        detail?: "auto"
        | "low"
        | "high";
        maxTokens?: number;
    }
    | { useStableModel?: boolean }
    | {
        frequency_penalty?: number;
        maxTokens?: number;
        maxToolsIterations?: number;
        n?: number;
        presence_penalty?: number;
        reasoning_effort?: "low" | "high" | "medium";
        temperature?: number;
        topP?: number;
    };
    prompt?: string;
    resource?: | "file"
    | "image"
    | "text"
    | "assistant"
    | "audio";
    simplify?: boolean;
    text?: string;
    threadId?: string;
    voice?: | "alloy"
    | "echo"
    | "fable"
    | "nova"
    | "onyx"
    | "shimmer";
}

Properties§

Source§

readonly assistantId?: { mode: "id" | "list"; value: string }

Assistant to respond to the message. You can add, modify or remove assistants in the playground. Default: {"mode":"list","value":""}

Source§

readonly binaryPropertyName?: string

Name of the binary property which contains the audio file in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm Default: "data"

Source§

readonly codeInterpreter?: boolean

Whether to enable the code interpreter that allows the assistants to write and run Python code in a sandboxed execution environment, find more here

Source§

readonly description?: string

The description of the assistant. The maximum length is 512 characters.

Source§

readonly file_ids?: unknown[]

The files to be used by the assistant, there can be a maximum of 20 files attached to the assistant. You can use expression to pass file IDs as an array or comma-separated string. Default: [] Type options: {"loadOptionsMethod":"getFiles"}

Source§

readonly fileId?: { mode: "id" | "list"; value: string }

Default: {"mode":"list","value":""}

Source§

readonly imageUrls?: string

URL(s) of the image(s) to analyze, multiple URLs can be added separated by comma

Source§

readonly input?: string

The text to generate audio for. The maximum length is 4096 characters. Type options: {"rows":2}

Source§

readonly inputType?: "url" | "base64"

Default: "url"

Source§

readonly instructions?: string

The system instructions that the assistant uses. The maximum length is 32768 characters. Type options: {"rows":2}

Source§

readonly jsonOutput?: boolean

Whether to attempt to return the response in JSON format. Compatible with GPT-4 Turbo and all GPT-3.5 Turbo models newer than gpt-3.5-turbo-1106.

Source§

readonly knowledgeRetrieval?: boolean

Whether to augments the assistant with knowledge from outside its model, such as proprietary product information or documents, find more here

Source§

readonly memory?: "connector" | "threadId"

Default: "connector"

Source§

readonly messages?: {
    values: {
        content?: string;
        role?: "system" | "user" | "assistant";
    }[];
}

Default: {"values":[{"content":""}]} Type options: {"sortable":true,"multipleValues":true}

Source§

readonly model?:
    | "tts-1"
    | "tts-1-hd"
    | "dall-e-2"
    | "dall-e-3"
    | "gpt-image-1"

Default: "tts-1"

Source§

readonly modelId?: { mode: "id" | "list"; value: string }

Default: {"mode":"list","value":""}

Source§

readonly name?: string

The name of the assistant. The maximum length is 256 characters.

Source§

readonly operation?:
    | "create"
    | "update"
    | "list"
    | "deleteFile"
    | "upload"
    | "analyze"
    | "generate"
    | "message"
    | "translate"
    | "transcribe"
    | "deleteAssistant"
    | "classify"

Default: "message"

Source§

readonly options?:
    | {
        failIfExists?: boolean;
        temperature?: number;
        topP?: number;
    }
    | {
        baseURL?: string;
        maxRetries?: number;
        preserveOriginalTools?: boolean;
        timeout?: number;
    }
    | {
        codeInterpreter?: boolean;
        description?: string;
        file_ids?: unknown[];
        instructions?: string;
        knowledgeRetrieval?: boolean;
        modelId?: { mode: "id"
        | "list"; value: string };
        name?: string;
        removeCustomTools?: boolean;
        temperature?: number;
        topP?: number;
    }
    | {
        binaryPropertyOutput?: string;
        response_format?: "mp3"
        | "opus"
        | "aac"
        | "flac";
        speed?: number;
    }
    | { language?: string; temperature?: number }
    | { temperature?: number }
    | { purpose?: "assistants" | "fine-tune" }
    | { purpose?: "any" | "assistants" | "fine-tune" }
    | {
        binaryPropertyOutput?: string;
        dalleQuality?: "standard" | "hd";
        n?: number;
        quality?: "low" | "high" | "medium";
        returnImageUrls?: boolean;
        size?:
            | "256x256"
            | "512x512"
            | "1024x1024"
            | "1792x1024"
            | "1024x1792"
            | "1024x1536"
            | "1536x1024";
        style?: "natural"
        | "vivid";
    }
    | {
        detail?: "auto"
        | "low"
        | "high";
        maxTokens?: number;
    }
    | { useStableModel?: boolean }
    | {
        frequency_penalty?: number;
        maxTokens?: number;
        maxToolsIterations?: number;
        n?: number;
        presence_penalty?: number;
        reasoning_effort?: "low" | "high" | "medium";
        temperature?: number;
        topP?: number;
    }

Default: {}

Source§

readonly prompt?: string

Default: "auto"

Source§

readonly resource?: "file" | "image" | "text" | "assistant" | "audio"

Default: "text"

Source§

readonly simplify?: boolean

Whether to return a simplified version of the response instead of the raw data Default: true

Source§

readonly text?: string

Type options: {"rows":2}

Source§

readonly threadId?: string

The ID of the thread to continue, a new thread will be created if not specified

Source§

readonly voice?: "alloy" | "echo" | "fable" | "nova" | "onyx" | "shimmer"

The voice to use when generating the audio Default: "alloy"