Contact Us 1-800-596-4880
  1. Homepage
  2. MuleSoft Vectors Connector (1.0)

  3. MuleSoft Vectors Connector Reference

All Connectors

MuleSoft Vectors Connector 1.0 Reference

MuleSoft Vectors Connector provides operations to work with vector stores and embedding models.

Configurations

Embedding Config

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

Connection types for this configuration.

x

Name

String

ID used to reference this configuration.

x

Expiration Policy

Expiration Policy

Configures an expiration policy for the configuration.

Connection Types

Azure AI Vision
Parameters
Name Type Description Default Value Required

Proxy Config

HttpProxyConfig

Configures a proxy for outbound connections.

TLS Configuration

TLS

If HTTPS is configured as a protocol, then you must configure at least the keystore configuration.

Timeout

Number

Timeout for the operation in milliseconds.

60000

Endpoint

String

Endpoint.

x

Api Key

String

API key.

x

Api Version

String

API version.

x

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.
Azure OpenAI
Parameters
Name Type Description Default Value Required

Proxy Config

HttpProxyConfig

Configures a proxy for outbound connections.

TLS Configuration

TLS

If HTTPS is configured as a protocol, then you must configure at least the keystore configuration.

Timeout

Number

Timeout for the operation in milliseconds.

60000

Endpoint

String

Endpoint.

x

Api Key

String

API key.

x

Api Version

String

API version.

x

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.
Einstein
Parameters
Name Type Description Default Value Required

Proxy Config

HttpProxyConfig

Configures a proxy for outbound connections.

TLS Configuration

TLS

If HTTPS is configured as a protocol, then you must configure at least the keystore configuration.

Timeout

Number

Timeout for the operation in milliseconds.

60000

Salesforce Org

String

Salesforce org.

x

Client Id

String

Client ID.

x

Client Secret

String

Client secret.

x

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.
Hugging Face
Parameters
Name Type Description Default Value Required

Proxy Config

HttpProxyConfig

Configures a proxy for outbound connections.

TLS Configuration

TLS

If HTTPS is configured as a protocol, then you must configure at least the keystore configuration.

Timeout

Number

Timeout for the operation in milliseconds.

60000

Api Key

String

API key.

x

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.
Mistral AI
Parameters
Name Type Description Default Value Required

Proxy Config

HttpProxyConfig

Configures a proxy for outbound connections.

TLS Configuration

TLS

If HTTPS is configured as a protocol, then you must configure at least the keystore configuration.

Timeout

Number

Timeout for the operation in milliseconds.

60000

Api Key

String

API key.

x

Total Timeout (ms)

Number

Total timeout in milliseconds for API requests.

60000

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.
Nomic
Parameters
Name Type Description Default Value Required

Proxy Config

HttpProxyConfig

Configures a proxy for outbound connections.

TLS Configuration

TLS

If HTTPS is configured as a protocol, then you must configure at least the keystore configuration.

Timeout

Number

Timeout for the operation in milliseconds.

60000

Api Key

String

API key.

x

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.
Ollama
Parameters
Name Type Description Default Value Required

Proxy Config

HttpProxyConfig

Configures a proxy for outbound connections.

TLS Configuration

TLS

If HTTPS is configured as a protocol, then you must configure at least the keystore configuration.

Timeout

Number

Timeout for the operation in milliseconds.

60000

Base URL

String

Ollama base URL.

x

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.
OpenAI
Parameters
Name Type Description Default Value Required

Proxy Config

HttpProxyConfig

Configures a proxy for outbound connections.

TLS Configuration

TLS

If HTTPS is configured as a protocol, then you must configure at least the keystore configuration.

Timeout

Number

Timeout for the operation in milliseconds.

60000

Api Key

String

API key.

x

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

Store Config

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

Connection types for this configuration.

x

Name

String

ID used to reference this configuration.

x

Expiration Policy

Expiration Policy

Configures an expiration policy for the configuration.

Connection Types

AI Search
Parameters
Name Type Description Default Value Required

Proxy Configuration

HttpProxyConfig

Configures a proxy for outbound connections.

TLS Configuration

TLS

If HTTPS is configured as a protocol, then you must configure at least the keystore configuration.

Url

String

URL.

x

Api Key

String

API key.

x

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.
Chroma
Parameters
Name Type Description Default Value Required

Proxy Configuration

HttpProxyConfig

Configures a proxy for outbound connections.

TLS Configuration

TLS

If HTTPS is configured as a protocol, then you must configure at least the keystore configuration.

Url

String

URL.

x

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.
Ephemeral File
Parameters
Name Type Description Default Value Required

Working Directory

String

Directory for creating store files.

x

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.
Milvus
Parameters
Name Type Description Default Value Required

Uri

String

URI.

Host

String

Host.

Port

Number

Port.

Token

String

Token.

Username

String

Username.

Password

String

Password.

Database Name

String

Database name.

Index Type

String

Index type.

FLAT

Metric Type

String

Metric type.

COSINE

Consistency Level

String

Consistency level.

EVENTUALLY

Auto Flush On Insert

Boolean

Determines whether to auto-flush on insert.

true

Id Field Name

String

ID field name.

ID

Text Field Name

String

Text field name.

text

Metadata Field Name

String

Metadata field name.

metadata

Vector Field Name

String

Vector field name.

vector

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.
MongoDB Atlas
Parameters
Name Type Description Default Value Required

Host

String

Host.

x

Port

Number

Port.

Username

String

Username.

Password

String

Password.

x

Database Name

String

Database name.

Options

String

Options.

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.
OpenSearch
Parameters
Name Type Description Default Value Required

Url

String

URL.

x

User

String

Username.

Password

String

Password.

x

Api Key

String

API key.

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.
PGVector
Parameters
Name Type Description Default Value Required

Host

String

Host.

x

Port

Number

Port.

x

Database

String

Database.

x

User

String

Username.

x

Password

String

Password.

x

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.
Pinecone
Parameters
Name Type Description Default Value Required

Cloud

String

Cloud.

x

Region

String

Region.

x

Api Key

String

API key.

x

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.
Qdrant
Parameters
Name Type Description Default Value Required

Host

String

Host.

x

GPRC Port

Number

gRPC port.

x

Use TLS

Boolean

Determines whether to use TLS.

false

Text Segment Key

String

Text segment key.

x

Api Key

String

API key.

x

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

Transform Config

Parameters

Name Type Description Default Value Required

Name

String

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

x

Name

String

ID used to reference this configuration.

x

Supported Operations

Operations

[Embedding] Generate from text

<ms-vectors:embedding-generate-from-text>

Generates embeddings from a given text string. The text can optionally be segmented before embedding.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Input Texts

Array of String

Input list of texts to generate embeddings from.

#[payload]

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Model (Deployment) Name

String

Embedding model (deployment) name.

x

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Embedding Response Attributes

For Configurations

Throws

  • MS-VECTORS:AI_SERVICES_FAILURE

  • MS-VECTORS:AI_SERVICES_RATE_LIMITING_ERROR

  • MS-VECTORS:CONNECTIVITY

  • MS-VECTORS:EMBEDDING_OPERATIONS_FAILURE

  • MS-VECTORS:INVALID_CONNECTION

  • MS-VECTORS:INVALID_PARAMETER

  • MS-VECTORS:RETRY_EXHAUSTED

[Store] Query

<ms-vectors:query>

Queries an embedding store based on the provided embedding and text segment, and applies a metadata filter.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Store Name

String

Name of the store or collection to query.

x

Text Segment and Embedding

Any

Text segment and embedding generated from the question and used to query the store.

x

Max Results

Number

Maximum number of results (text segments) retrieved.

x

Min Score

Number

Minimum score used to filter retrieved results (text segments) (0-1).

x

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Metadata Condition

String

Metadata condition.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Store Response Attributes

For Configurations

Throws

  • MS-VECTORS:CONNECTIVITY

  • MS-VECTORS:INVALID_CONNECTION

  • MS-VECTORS:INVALID_PARAMETER

  • MS-VECTORS:RETRY_EXHAUSTED

  • MS-VECTORS:STORE_OPERATIONS_FAILURE

  • MS-VECTORS:STORE_SERVICES_FAILURE

  • MS-VECTORS:STORE_UNSUPPORTED_OPERATION

[Store] Query all

<ms-vectors:query-all>

Lists all sources in the specified embedding store.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Store Name

String

Name of the store.

x

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Retrieve Embeddings

Boolean

Flag to indicate whether embeddings should be retrieved.

false

Page size

Number

Page size used when querying the vector store.

5000

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Message of [Binary] payload and Store Response Attributes attributes

For Configurations

Throws

  • MS-VECTORS:CONNECTIVITY

  • MS-VECTORS:INVALID_CONNECTION

  • MS-VECTORS:INVALID_PARAMETER

  • MS-VECTORS:RETRY_EXHAUSTED

  • MS-VECTORS:STORE_OPERATIONS_FAILURE

  • MS-VECTORS:STORE_SERVICES_FAILURE

  • MS-VECTORS:STORE_UNSUPPORTED_OPERATION

[Store] Add

<ms-vectors:store-add>

Adds embeddings and text segments to the store.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Store Name

String

Name of the store or collection to use for data ingestion.

x

Text Segments and Embeddings

Any

Text segments and embeddings to add to the store.

#[payload]

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Metadata entries

Object

Custom metadata key-value pairs to add to the vector store.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Store Response Attributes

For Configurations

Throws

  • MS-VECTORS:CONNECTIVITY

  • MS-VECTORS:INVALID_CONNECTION

  • MS-VECTORS:INVALID_PARAMETER

  • MS-VECTORS:RETRY_EXHAUSTED

  • MS-VECTORS:STORE_OPERATIONS_FAILURE

  • MS-VECTORS:STORE_SERVICES_FAILURE

  • MS-VECTORS:STORE_UNSUPPORTED_OPERATION

[Store] Remove

<ms-vectors:store-remove>

Removes embeddings from the store based on the provided filter.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Store Name

String

Name of the store.

x

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Ids

Array of String

List of IDs to remove.

Metadata Condition

String

Metadata condition.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Store Response Attributes

For Configurations

Throws

  • MS-VECTORS:CONNECTIVITY

  • MS-VECTORS:INVALID_CONNECTION

  • MS-VECTORS:INVALID_PARAMETER

  • MS-VECTORS:RETRY_EXHAUSTED

  • MS-VECTORS:STORE_OPERATIONS_FAILURE

  • MS-VECTORS:STORE_SERVICES_FAILURE

  • MS-VECTORS:STORE_UNSUPPORTED_OPERATION

[Transform] Parse document

<ms-vectors:transform-parse-document>

Parses a document from a raw binary or Base64-encoded content.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Document binary

Any

Raw binary or Base64-encoded content of the document to parse.

#[payload]

Document parser

One of:

Document parser to use.

x

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Binary

Attributes Type

Parser Response Attributes

For Configurations

Throws

  • MS-VECTORS:INVALID_PARAMETER

  • MS-VECTORS:TRANSFORM_DOCUMENT_PARSING_FAILURE

  • MS-VECTORS:TRANSFORM_OPERATIONS_FAILURE

[Transform] Chunk text

<ms-vectors:transform-chunk-text>

Chunks the provided text into multiple segments based on the segmentation parameters. This operation splits the input text into smaller segments according to the maximum segment size and overlap size specified in the segmentation parameters. The result is returned as a JSON document containing the chunked text segments and associated metadata.

Parameters

Name Type Description Default Value Required

Text

Any

Input text to chunk.

#[payload]

Output Mime Type

String

MIME type of the payload that this operation outputs.

Output Encoding

String

Encoding of the payload that this operation outputs.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Max Segment Size (Characters)

Number

Maximum size of a segment in characters.

Max Overlap Size (Characters)

Number

Maximum overlap between segments in characters.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Array of String

Attributes Type

Chunk Response Attributes

Throws

  • MS-VECTORS:INVALID_PARAMETER

  • MS-VECTORS:TRANSFORM_DOCUMENT_PARSING_FAILURE

  • MS-VECTORS:TRANSFORM_OPERATIONS_FAILURE

Types

TLS

Configures TLS to provide secure communications for the Mule app.

Field Type Description Default Value Required

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Truststore

Configures the TLS truststore.

Key Store

Keystore

Configures the TLS keystore.

Revocation Check

Configures a revocation checking mechanism.

Truststore

Configures the truststore for TLS.

Field Type Description Default Value Required

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

Password

String

Password used to protect the truststore.

Type

String

Type of truststore.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

Keystore

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.

Field Type Description Default Value Required

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system.

Type

String

Type of keystore.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

Standard Revocation Check

Configures standard revocation checks for TLS certificates.

Field Type Description Default Value Required

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

    Verify only the last element in the certificate chain.

  • false

    Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

    Check the Certification Revocation List (CRL) for certificate validity.

  • false

    Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

    Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

  • false

    Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

    Avoid verification failure.

  • false

    Allow the verification to fail.

Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

Field Type Description Default Value Required

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

CRL File

Specifies the location of the certification revocation list (CRL) file.

Field Type Description Default Value Required

Path

String

Path to the CRL file.

Reconnection

Configures a reconnection strategy for an operation.

Field Type Description Default Value Required

Fails Deployment

Boolean

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Reconnection Strategy

Reconnection strategy to use.

Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

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

Count

Number

How many reconnection attempts the Mule app can make.

Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

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

Expiration Policy

Configures an expiration policy strategy.

Field Type Description Default Value Required

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

Embedding Response Attributes

Configures the response attributes for the embedding operation.

Field Type Description Default Value Required

Embedding Model Dimension

Number

Embedding model dimension.

Embedding Model Name

String

Embedding model name.

Other Attributes

Object

Other attributes.

Token Usage

Token Usage

Token usage.

Token Usage

Configures token usage metadata returned as attributes.

Field Type Description Default Value Required

Input Count

Number

Number of tokens used to process the input.

Output Count

Number

Number of tokens used to generate the output.

Total Count

Number

Total number of tokens used for input and output.

Repeatable In Memory Stream

Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.

Field Type Description Default Value Required

Initial Buffer Size

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max Buffer Size.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a STREAM_MAXIMUM_SIZE_EXCEEDED error. A value of less than or equal to 0 means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Initial Buffer Size, Buffer Size Increment, and Max Buffer Size fields.

Repeatable File Store Stream

Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.

Field Type Description Default Value Required

In Memory Size

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

  • Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.

  • Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

Error Mapping

Configures 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

Store Response Attributes

Configures the response attributes for the store operation.

Field Type Description Default Value Required

Ids

Array of String

IDs.

Metadata Condition

String

Metadata condition.

Other Attributes

Object

Other attributes.

Store Name

String

Name of the store.

Repeatable In Memory Iterable

Configures the repeatable in memory iterable type.

Field Type Description Default Value Required

Initial Buffer Size

Number

Amount of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the Buffer Size Increment attribute, with an upper limit of Max Buffer Size. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower means that the buffer must not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

Maximum amount of memory to use. If more than that is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to 0 means no limit.

Repeatable File Store Iterable

Configures the repeatable file store iterable type.

Field Type Description Default Value Required

In Memory Objects

Number

Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Objects field.

Parser Response Attributes

Configures the response attributes for the parser.

Field Type Description Default Value Required

Document Parser Name

String

Document parser name.

Chunk Response Attributes

Configures the response attributes for the chunk.

Field Type Description Default Value Required

Max Overlap Size In Chars

Number

Maximum overlap size in characters.

Max Segment Size In Chars

Number

Maximum segment size in characters.

Multiformat Document Parser Parameters

Configures the parameters for the multiformat document parser.

Field Type Description Default Value Required

Include Metadata

Boolean

Determines whether to include metadata.

false

Text Document Parser Parameters

Configures the parameters for the text document parser.

Field Type Description Default Value Required

Document Parser

DocumentParser

Document parser.

Name

String

Document parser name.

See Also

Back to top
View on GitHub