Contact Us 1-800-596-4880
  1. Homepage
  2. OpenAI Connector (1.1)

  3. OpenAI Connector Reference

All Connectors

OpenAI Connector 1.1 Reference

Configurations

Config

Default configuration.

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

Api Key

The connection types to provide to this configuration.

x

Name

String

The identifier of this element used to reference it in other components.

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Connection Types

Api Key
Parameters
Name Type Description Default Value Required

baseUri

String

The base URI for the OpenAI API.

x

token

String

The API key token for authentication.

x

TLS Configuration

Tls

The TLS configuration for secure connections.

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Supported Operations

Operations

Create Chat Completion

<openai:create-chat-completion>

Creates a chat completion.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • OPENAI:CLIENT_ERROR

  • OPENAI:CONNECTIVITY

  • OPENAI:FORBIDDEN

  • OPENAI:SECURITY

  • OPENAI:SERVER_ERROR

  • OPENAI:TIMEOUT

  • OPENAI:UNAUTHORIZED

Create Conversation

<openai:create-conversation>

Creates a conversation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • OPENAI:CLIENT_ERROR

  • OPENAI:CONNECTIVITY

  • OPENAI:FORBIDDEN

  • OPENAI:SECURITY

  • OPENAI:SERVER_ERROR

  • OPENAI:TIMEOUT

  • OPENAI:UNAUTHORIZED

Create Conversation Items

<openai:create-conversation-items>

Creates items in a conversation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

conversation_id

String

The ID of the conversation.

x

includes

Array of String

Additional fields to include in the response.

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • OPENAI:CLIENT_ERROR

  • OPENAI:CONNECTIVITY

  • OPENAI:FORBIDDEN

  • OPENAI:SECURITY

  • OPENAI:SERVER_ERROR

  • OPENAI:TIMEOUT

  • OPENAI:UNAUTHORIZED

Create Embedding

<openai:create-embedding>

Creates an embedding.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • OPENAI:CLIENT_ERROR

  • OPENAI:CONNECTIVITY

  • OPENAI:FORBIDDEN

  • OPENAI:SECURITY

  • OPENAI:SERVER_ERROR

  • OPENAI:TIMEOUT

  • OPENAI:UNAUTHORIZED

Create Moderation

<openai:create-moderation>

Creates a moderation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • OPENAI:CLIENT_ERROR

  • OPENAI:CONNECTIVITY

  • OPENAI:FORBIDDEN

  • OPENAI:SECURITY

  • OPENAI:SERVER_ERROR

  • OPENAI:TIMEOUT

  • OPENAI:UNAUTHORIZED

Create Response

<openai:create-response>

Creates a response.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • OPENAI:CLIENT_ERROR

  • OPENAI:CONNECTIVITY

  • OPENAI:FORBIDDEN

  • OPENAI:SECURITY

  • OPENAI:SERVER_ERROR

  • OPENAI:TIMEOUT

  • OPENAI:UNAUTHORIZED

Delete Conversation

<openai:delete-conversation>

Deletes a conversation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

conversation_id

String

The ID of the conversation.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • OPENAI:CLIENT_ERROR

  • OPENAI:CONNECTIVITY

  • OPENAI:FORBIDDEN

  • OPENAI:SECURITY

  • OPENAI:SERVER_ERROR

  • OPENAI:TIMEOUT

  • OPENAI:UNAUTHORIZED

Delete Conversation Item

<openai:delete-conversation-item>

Deletes an item from a conversation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

conversation_id

String

The ID of the conversation.

x

item_id

String

The ID of the item.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • OPENAI:CLIENT_ERROR

  • OPENAI:CONNECTIVITY

  • OPENAI:FORBIDDEN

  • OPENAI:SECURITY

  • OPENAI:SERVER_ERROR

  • OPENAI:TIMEOUT

  • OPENAI:UNAUTHORIZED

Delete Response

<openai:delete-response>

Deletes a response.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

response_id

String

The ID of the response.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • OPENAI:CLIENT_ERROR

  • OPENAI:CONNECTIVITY

  • OPENAI:FORBIDDEN

  • OPENAI:SECURITY

  • OPENAI:SERVER_ERROR

  • OPENAI:TIMEOUT

  • OPENAI:UNAUTHORIZED

List Conversation Items

<openai:list-conversation-items>

Lists items in a conversation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

conversation_id

String

The ID of the conversation.

x

limit

Number

The maximum number of results to return.

order

Enumeration, one of:

  • asc

  • desc

The sort order for the results.

after

String

A cursor for pagination to fetch results after this ID.

includes

Array of String

Additional fields to include in the response.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • OPENAI:CLIENT_ERROR

  • OPENAI:CONNECTIVITY

  • OPENAI:FORBIDDEN

  • OPENAI:SECURITY

  • OPENAI:SERVER_ERROR

  • OPENAI:TIMEOUT

  • OPENAI:UNAUTHORIZED

List Models

<openai:list-models>

Lists models.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • OPENAI:CLIENT_ERROR

  • OPENAI:CONNECTIVITY

  • OPENAI:FORBIDDEN

  • OPENAI:SECURITY

  • OPENAI:SERVER_ERROR

  • OPENAI:TIMEOUT

  • OPENAI:UNAUTHORIZED

List Response Input Items

<openai:list-response-input-items>

Lists input items for a response.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

response_id

String

The ID of the response.

x

limit

Number

The maximum number of results to return.

order

Enumeration, one of:

  • asc

  • desc

The sort order for the results.

after

String

A cursor for pagination to fetch results after this ID.

includes

Array of String

Additional fields to include in the response.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • OPENAI:CLIENT_ERROR

  • OPENAI:CONNECTIVITY

  • OPENAI:FORBIDDEN

  • OPENAI:SECURITY

  • OPENAI:SERVER_ERROR

  • OPENAI:TIMEOUT

  • OPENAI:UNAUTHORIZED

Retrieve Conversation

<openai:retrieve-conversation>

Retrieves a conversation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

conversation_id

String

The ID of the conversation.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • OPENAI:CLIENT_ERROR

  • OPENAI:CONNECTIVITY

  • OPENAI:FORBIDDEN

  • OPENAI:SECURITY

  • OPENAI:SERVER_ERROR

  • OPENAI:TIMEOUT

  • OPENAI:UNAUTHORIZED

Retrieve Conversation Item

<openai:retrieve-conversation-item>

Retrieves an item from a conversation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

conversation_id

String

The ID of the conversation.

x

item_id

String

The ID of the item.

x

includes

Array of String

Additional fields to include in the response.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • OPENAI:CLIENT_ERROR

  • OPENAI:CONNECTIVITY

  • OPENAI:FORBIDDEN

  • OPENAI:SECURITY

  • OPENAI:SERVER_ERROR

  • OPENAI:TIMEOUT

  • OPENAI:UNAUTHORIZED

Retrieve Response

<openai:retrieve-response>

Retrieves a response.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

response_id

String

The ID of the response.

x

includes

Array of String

Additional fields to include in the response.

stream

Boolean

Whether to stream the response.

false

starting_after

Number

The sequence number after which to start streaming.

include_obfuscation

Boolean

Whether to include obfuscation in streamed events.

false

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • OPENAI:CLIENT_ERROR

  • OPENAI:CONNECTIVITY

  • OPENAI:FORBIDDEN

  • OPENAI:SECURITY

  • OPENAI:SERVER_ERROR

  • OPENAI:TIMEOUT

  • OPENAI:UNAUTHORIZED

Update Conversation

<openai:update-conversation>

Updates a conversation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

conversation_id

String

The ID of the conversation.

x

body

Any

The request body content.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

Throws

  • OPENAI:CLIENT_ERROR

  • OPENAI:CONNECTIVITY

  • OPENAI:FORBIDDEN

  • OPENAI:SECURITY

  • OPENAI:SERVER_ERROR

  • OPENAI:TIMEOUT

  • OPENAI:UNAUTHORIZED

Types

Tls

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Trust Store

Configures the TLS truststore.

Key Store

Key Store

Configures the TLS keystore.

Revocation Check

Configures a revocation checking mechanism.

Trust Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

Custom Ocsp Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

Crl File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

Error Mapping

Field Type Description Default Value Required

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Source of the error.

Target

String

Target of the error.

x
Back to top