---
schema_version: "1"
id: a85b36b20b207d51c6c92575aa2e8c87b3ef4449a79788d11da24c31f8ac83c9
title: MuleSoft Vectors Connector 1.0 Reference
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/mulesoft-vectors-connector/1.0/mulesoft-vectors-connector-reference.md
canonical_url: https://docs.mulesoft.com/mulesoft-vectors-connector/1.0/mulesoft-vectors-connector-reference
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 8f2fe52581ccdf4c381f466017d39be5da67d2252568e1e396bfe4bbd4d39dc7
description: MuleSoft Documentation Site
release: "1.0"
latest: false
---
---
product: MuleSoft Vectors Connector
version: 1.0
---

# MuleSoft Vectors Connector 1.0 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

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

## Configurations

---

### Embedding Config

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>Name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><ul><li><p><a href="#EmbeddingConfig_AzureAiVision">Azure AI Vision</a></p></li><li><p><a href="#EmbeddingConfig_AzureOpenAi">Azure OpenAI</a></p></li><li><p><a href="#EmbeddingConfig_Einstein">Einstein</a></p></li><li><p><a href="#EmbeddingConfig_HuggingFace">Hugging Face</a></p></li><li><p><a href="#EmbeddingConfig_MistralAi">Mistral AI</a></p></li><li><p><a href="#EmbeddingConfig_Nomic">Nomic</a></p></li><li><p><a href="#EmbeddingConfig_Ollama">Ollama</a></p></li><li><p><a href="#EmbeddingConfig_OpenAi">OpenAI</a></p></li></ul></div></div></td><td><p>Connection types for this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>ID used to reference this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>Configures an expiration policy for the configuration.</p></td><td></td><td></td></tr></tbody></table>

#### Connection Types

##### Azure AI Vision

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Proxy Config</p></td><td><div><div><p>HttpProxyConfig</p></div></div></td><td><p>Configures a proxy for outbound connections.</p></td><td></td><td></td></tr><tr><td><p>TLS Configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>If HTTPS is configured as a protocol, then you must configure at least the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Timeout for the operation in milliseconds.</p></td><td><p>60000</p></td><td></td></tr><tr><td><p>Endpoint</p></td><td><div><div><p>String</p></div></div></td><td><p>Endpoint.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Api Key</p></td><td><div><div><p>String</p></div></div></td><td><p>API key.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Api Version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

##### Azure OpenAI

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Proxy Config</p></td><td><div><div><p>HttpProxyConfig</p></div></div></td><td><p>Configures a proxy for outbound connections.</p></td><td></td><td></td></tr><tr><td><p>TLS Configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>If HTTPS is configured as a protocol, then you must configure at least the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Timeout for the operation in milliseconds.</p></td><td><p>60000</p></td><td></td></tr><tr><td><p>Endpoint</p></td><td><div><div><p>String</p></div></div></td><td><p>Endpoint.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Api Key</p></td><td><div><div><p>String</p></div></div></td><td><p>API key.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Api Version</p></td><td><div><div><p>String</p></div></div></td><td><p>API version.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

##### Einstein

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Proxy Config</p></td><td><div><div><p>HttpProxyConfig</p></div></div></td><td><p>Configures a proxy for outbound connections.</p></td><td></td><td></td></tr><tr><td><p>TLS Configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>If HTTPS is configured as a protocol, then you must configure at least the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Timeout for the operation in milliseconds.</p></td><td><p>60000</p></td><td></td></tr><tr><td><p>Salesforce Org</p></td><td><div><div><p>String</p></div></div></td><td><p>Salesforce org.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Client Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Client ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Client Secret</p></td><td><div><div><p>String</p></div></div></td><td><p>Client secret.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

##### Hugging Face

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Proxy Config</p></td><td><div><div><p>HttpProxyConfig</p></div></div></td><td><p>Configures a proxy for outbound connections.</p></td><td></td><td></td></tr><tr><td><p>TLS Configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>If HTTPS is configured as a protocol, then you must configure at least the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Timeout for the operation in milliseconds.</p></td><td><p>60000</p></td><td></td></tr><tr><td><p>Api Key</p></td><td><div><div><p>String</p></div></div></td><td><p>API key.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

##### Mistral AI

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Proxy Config</p></td><td><div><div><p>HttpProxyConfig</p></div></div></td><td><p>Configures a proxy for outbound connections.</p></td><td></td><td></td></tr><tr><td><p>TLS Configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>If HTTPS is configured as a protocol, then you must configure at least the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Timeout for the operation in milliseconds.</p></td><td><p>60000</p></td><td></td></tr><tr><td><p>Api Key</p></td><td><div><div><p>String</p></div></div></td><td><p>API key.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Total Timeout (ms)</p></td><td><div><div><p>Number</p></div></div></td><td><p>Total timeout in milliseconds for API requests.</p></td><td><p>60000</p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

##### Nomic

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Proxy Config</p></td><td><div><div><p>HttpProxyConfig</p></div></div></td><td><p>Configures a proxy for outbound connections.</p></td><td></td><td></td></tr><tr><td><p>TLS Configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>If HTTPS is configured as a protocol, then you must configure at least the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Timeout for the operation in milliseconds.</p></td><td><p>60000</p></td><td></td></tr><tr><td><p>Api Key</p></td><td><div><div><p>String</p></div></div></td><td><p>API key.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

##### Ollama

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Proxy Config</p></td><td><div><div><p>HttpProxyConfig</p></div></div></td><td><p>Configures a proxy for outbound connections.</p></td><td></td><td></td></tr><tr><td><p>TLS Configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>If HTTPS is configured as a protocol, then you must configure at least the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Timeout for the operation in milliseconds.</p></td><td><p>60000</p></td><td></td></tr><tr><td><p>Base URL</p></td><td><div><div><p>String</p></div></div></td><td><p>Ollama base URL.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

##### OpenAI

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Proxy Config</p></td><td><div><div><p>HttpProxyConfig</p></div></div></td><td><p>Configures a proxy for outbound connections.</p></td><td></td><td></td></tr><tr><td><p>TLS Configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>If HTTPS is configured as a protocol, then you must configure at least the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Timeout for the operation in milliseconds.</p></td><td><p>60000</p></td><td></td></tr><tr><td><p>Api Key</p></td><td><div><div><p>String</p></div></div></td><td><p>API key.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

## Supported Operations

- [\[Embedding\] Generate from text](#EmbeddingGenerateFromText)

---

### Store Config

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>Name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><ul><li><p><a href="#StoreConfig_AiSearch">AI Search</a></p></li><li><p><a href="#StoreConfig_Chroma">Chroma</a></p></li><li><p><a href="#StoreConfig_EphemeralFile">Ephemeral File</a></p></li><li><p><a href="#StoreConfig_Milvus">Milvus</a></p></li><li><p><a href="#StoreConfig_MongoDbAtlas">MongoDB Atlas</a></p></li><li><p><a href="#StoreConfig_OpenSearch">OpenSearch</a></p></li><li><p><a href="#StoreConfig_PgVector">PGVector</a></p></li><li><p><a href="#StoreConfig_Pinecone">Pinecone</a></p></li><li><p><a href="#StoreConfig_Qdrant">Qdrant</a></p></li></ul></div></div></td><td><p>Connection types for this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>ID used to reference this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>Configures an expiration policy for the configuration.</p></td><td></td><td></td></tr></tbody></table>

#### Connection Types

##### AI Search

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Proxy Configuration</p></td><td><div><div><p>HttpProxyConfig</p></div></div></td><td><p>Configures a proxy for outbound connections.</p></td><td></td><td></td></tr><tr><td><p>TLS Configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>If HTTPS is configured as a protocol, then you must configure at least the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Url</p></td><td><div><div><p>String</p></div></div></td><td><p>URL.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Api Key</p></td><td><div><div><p>String</p></div></div></td><td><p>API key.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

##### Chroma

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Proxy Configuration</p></td><td><div><div><p>HttpProxyConfig</p></div></div></td><td><p>Configures a proxy for outbound connections.</p></td><td></td><td></td></tr><tr><td><p>TLS Configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>If HTTPS is configured as a protocol, then you must configure at least the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Url</p></td><td><div><div><p>String</p></div></div></td><td><p>URL.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

##### Ephemeral File

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Working Directory</p></td><td><div><div><p>String</p></div></div></td><td><p>Directory for creating store files.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

##### Milvus

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Uri</p></td><td><div><div><p>String</p></div></div></td><td><p>URI.</p></td><td></td><td></td></tr><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host.</p></td><td></td><td></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port.</p></td><td></td><td></td></tr><tr><td><p>Token</p></td><td><div><div><p>String</p></div></div></td><td><p>Token.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password.</p></td><td></td><td></td></tr><tr><td><p>Database Name</p></td><td><div><div><p>String</p></div></div></td><td><p>Database name.</p></td><td></td><td></td></tr><tr><td><p>Index Type</p></td><td><div><div><p>String</p></div></div></td><td><p>Index type.</p></td><td><p>FLAT</p></td><td></td></tr><tr><td><p>Metric Type</p></td><td><div><div><p>String</p></div></div></td><td><p>Metric type.</p></td><td><p>COSINE</p></td><td></td></tr><tr><td><p>Consistency Level</p></td><td><div><div><p>String</p></div></div></td><td><p>Consistency level.</p></td><td><p>EVENTUALLY</p></td><td></td></tr><tr><td><p>Auto Flush On Insert</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Determines whether to auto-flush on insert.</p></td><td><p>true</p></td><td></td></tr><tr><td><p>Id Field Name</p></td><td><div><div><p>String</p></div></div></td><td><p>ID field name.</p></td><td><p>ID</p></td><td></td></tr><tr><td><p>Text Field Name</p></td><td><div><div><p>String</p></div></div></td><td><p>Text field name.</p></td><td><p>text</p></td><td></td></tr><tr><td><p>Metadata Field Name</p></td><td><div><div><p>String</p></div></div></td><td><p>Metadata field name.</p></td><td><p>metadata</p></td><td></td></tr><tr><td><p>Vector Field Name</p></td><td><div><div><p>String</p></div></div></td><td><p>Vector field name.</p></td><td><p>vector</p></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

##### MongoDB Atlas

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port.</p></td><td></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Database Name</p></td><td><div><div><p>String</p></div></div></td><td><p>Database name.</p></td><td></td><td></td></tr><tr><td><p>Options</p></td><td><div><div><p>String</p></div></div></td><td><p>Options.</p></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

##### OpenSearch

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Url</p></td><td><div><div><p>String</p></div></div></td><td><p>URL.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User</p></td><td><div><div><p>String</p></div></div></td><td><p>Username.</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Api Key</p></td><td><div><div><p>String</p></div></div></td><td><p>API key.</p></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

##### PGVector

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>Port.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Database</p></td><td><div><div><p>String</p></div></div></td><td><p>Database.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>User</p></td><td><div><div><p>String</p></div></div></td><td><p>Username.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

##### Pinecone

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Cloud</p></td><td><div><div><p>String</p></div></div></td><td><p>Cloud.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Region</p></td><td><div><div><p>String</p></div></div></td><td><p>Region.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Api Key</p></td><td><div><div><p>String</p></div></div></td><td><p>API key.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

##### Qdrant

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Host</p></td><td><div><div><p>String</p></div></div></td><td><p>Host.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>GPRC Port</p></td><td><div><div><p>Number</p></div></div></td><td><p>gRPC port.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Use TLS</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Determines whether to use TLS.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Text Segment Key</p></td><td><div><div><p>String</p></div></div></td><td><p>Text segment key.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Api Key</p></td><td><div><div><p>String</p></div></div></td><td><p>API key.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

## Supported Operations

- [\[Store\] Query](#Query)

- [\[Store\] Query all](#QueryAll)

- [\[Store\] Add](#StoreAdd)

- [\[Store\] Remove](#StoreRemove)

---

### Transform Config

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>Name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>ID used to reference this configuration.</p></td><td></td><td><p>x</p></td></tr></tbody></table>

## Supported Operations

- [\[Transform\] Parse document](#TransformParseDocument)

## 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Input Texts</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>Input list of texts to generate embeddings from.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Output Encoding</p></td><td><div><div><p>String</p></div></div></td><td><p>Encoding of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Model (Deployment) Name</p></td><td><div><div><p>String</p></div></div></td><td><p>Embedding model (deployment) name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#EmbeddingResponseAttributes">Embedding Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Embedding Config](#EmbeddingConfig)

### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Store Name</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the store or collection to query.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Text Segment and Embedding</p></td><td><div><div><p>Any</p></div></div></td><td><p>Text segment and embedding generated from the question and used to query the store.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Max Results</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of results (text segments) retrieved.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Min Score</p></td><td><div><div><p>Number</p></div></div></td><td><p>Minimum score used to filter retrieved results (text segments) (0-1).</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Output Encoding</p></td><td><div><div><p>String</p></div></div></td><td><p>Encoding of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Metadata Condition</p></td><td><div><div><p>String</p></div></div></td><td><p>Metadata condition.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#StoreResponseAttributes">Store Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Store Config](#StoreConfig)

### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Store Name</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the store.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Output Encoding</p></td><td><div><div><p>String</p></div></div></td><td><p>Encoding of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Retrieve Embeddings</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Flag to indicate whether embeddings should be retrieved.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Page size used when querying the vector store.</p></td><td><p>5000</p></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Message of [Binary] payload and <a href="#StoreResponseAttributes">Store Response Attributes</a> attributes</p></td></tr></tbody></table>

### For Configurations

- [Store Config](#StoreConfig)

### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Store Name</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the store or collection to use for data ingestion.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Text Segments and Embeddings</p></td><td><div><div><p>Any</p></div></div></td><td><p>Text segments and embeddings to add to the store.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Output Encoding</p></td><td><div><div><p>String</p></div></div></td><td><p>Encoding of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Metadata entries</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom metadata key-value pairs to add to the vector store.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#StoreResponseAttributes">Store Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Store Config](#StoreConfig)

### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Store Name</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the store.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Output Encoding</p></td><td><div><div><p>String</p></div></div></td><td><p>Encoding of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Ids</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>List of IDs to remove.</p></td><td></td><td></td></tr><tr><td><p>Metadata Condition</p></td><td><div><div><p>String</p></div></div></td><td><p>Metadata condition.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>Retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#StoreResponseAttributes">Store Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Store Config](#StoreConfig)

### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Document binary</p></td><td><div><div><p>Any</p></div></div></td><td><p>Raw binary or Base64-encoded content of the document to parse.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Document parser</p></td><td><div><div><p>One of:</p></div><div><ul><li><p><a href="#MultiformatDocumentParserParameters">Multiformat Document Parser Parameters</a></p></li><li><p><a href="#TextDocumentParserParameters">Text Document Parser Parameters</a></p></li></ul></div></div></td><td><p>Document parser to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Output Encoding</p></td><td><div><div><p>String</p></div></div></td><td><p>Encoding of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Binary</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#ParserResponseAttributes">Parser Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Transform Config](#TransformConfig)

### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Text</p></td><td><div><div><p>Any</p></div></div></td><td><p>Input text to chunk.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Output Mime Type</p></td><td><div><div><p>String</p></div></div></td><td><p>MIME type of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Output Encoding</p></td><td><div><div><p>String</p></div></div></td><td><p>Encoding of the payload that this operation outputs.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Max Segment Size (Characters)</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum size of a segment in characters.</p></td><td></td><td></td></tr><tr><td><p>Max Overlap Size (Characters)</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum overlap between segments in characters.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The outcome of the expression is stored in the <strong>Target Variable</strong> field.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of String</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#ChunkResponseAttributes">Chunk Response Attributes</a></p></div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Enabled Protocols</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of protocols enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enabled Cipher Suites</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of cipher suites enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trust Store</strong></p></td><td><div><div><p><a href="#TrustStore">Truststore</a></p></div></div></td><td><div><div><p>Configures the TLS truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p><a href="#KeyStore">Keystore</a></p></div></div></td><td><div><div><p>Configures the TLS keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Revocation Check</strong></p></td><td><div><div><ul><li><p><a href="#StandardRevocationCheck">Standard Revocation Check</a></p></li><li><p><a href="#CustomOcspResponder">Custom OCSP Responder</a></p></li><li><p><a href="#CrlFile">CRL File</a></p></li></ul></div></div></td><td><div><div><p>Configures a revocation checking mechanism.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Truststore

Configures the truststore for TLS.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the truststore. Mule resolves the path relative to the current classpath and file system.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the truststore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Insecure</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, Mule stops performing certificate validations. Setting this to <code>true</code> can make connections vulnerable to attacks.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Keystore

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the keystore. Mule resolves the path relative to the current classpath and file system.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the private key.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the keystore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Standard Revocation Check

Configures standard revocation checks for TLS certificates.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Only End Entities</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Which elements to verify in the certificate chain:</p></div><div><ul><li><p><code>true</code></p><div><p>Verify only the last element in the certificate chain.</p></div></li><li><p><code>false</code></p><div><p>Verify all elements in the certificate chain.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Prefer Crls</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>How to check certificate validity:</p></div><div><ul><li><p><code>true</code></p><div><p>Check the Certification Revocation List (CRL) for certificate validity.</p></div></li><li><p><code>false</code></p><div><p>Use the Online Certificate Status Protocol (OCSP) to check certificate validity.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>No Fallback</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use the secondary method to check certificate validity:</p></div><div><ul><li><p><code>true</code></p><div><p>Use the method that wasn’t specified in the <strong>Prefer Crls</strong> field (the secondary method) to check certificate validity.</p></div></li><li><p><code>false</code></p><div><p>Do not use the secondary method to check certificate validity.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Soft Fail</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>What to do if the revocation server can’t be reached or is busy:</p></div><div><ul><li><p><code>true</code></p><div><p>Avoid verification failure.</p></div></li><li><p><code>false</code></p><div><p>Allow the verification to fail.</p></div></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the OCSP responder.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Cert Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### CRL File

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the CRL file.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnection

Configures a reconnection strategy for an operation.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How many reconnection attempts the Mule app can make.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

Configures an expiration policy strategy.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Max Idle Time</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Embedding Response Attributes

Configures the response attributes for the embedding operation.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Embedding Model Dimension</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Embedding model dimension.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Embedding Model Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Embedding model name.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Other Attributes</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Other attributes.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Token Usage</strong></p></td><td><div><div><p><a href="#TokenUsage">Token Usage</a></p></div></div></td><td><div><div><p>Token usage.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Token Usage

Configures token usage metadata returned as attributes.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Input Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Number of tokens used to process the input.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Output Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Number of tokens used to generate the output.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Total Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Total number of tokens used for input and output.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by <strong>Buffer Size Increment</strong>, with an upper limit of <strong>Max Buffer Size</strong>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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 <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error is raised when the buffer gets full.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error. A value of less than or equal to <code>0</code> means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>Initial Buffer Size</strong>, <strong>Buffer Size Increment</strong>, and <strong>Max Buffer Size</strong> fields.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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:</p></div><div><ul><li><p>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.</p></li><li><p>Configure a smaller buffer size to decrease memory load at the expense of response time.</p></li></ul></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>In Memory Size</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Error Mapping

Configures error mapping.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Source</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ANY</p></li><li><p>REDELIVERY_EXHAUSTED</p></li><li><p>TRANSFORMATION</p></li><li><p>EXPRESSION</p></li><li><p>SECURITY</p></li><li><p>CLIENT_SECURITY</p></li><li><p>SERVER_SECURITY</p></li><li><p>ROUTING</p></li><li><p>CONNECTIVITY</p></li><li><p>RETRY_EXHAUSTED</p></li><li><p>TIMEOUT</p></li></ul></div></div></td><td><div><div><p>Source of the error.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Target of the error.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Store Response Attributes

Configures the response attributes for the store operation.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Ids</strong></p></td><td><div><div><p>Array of String</p></div></div></td><td><div><div><p>IDs.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Metadata Condition</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Metadata condition.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Other Attributes</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div><div><p>Other attributes.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Store Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Name of the store.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable In Memory Iterable

Configures the repeatable in memory iterable type.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>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 <strong>Buffer Size Increment</strong> attribute, with an upper limit of <strong>Max Buffer Size</strong>. Default value is 100 instances.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>This is by how much the buffer size expands if it exceeds its initial size. Setting a value of <code>0</code> or lower means that the buffer must not expand, meaning that a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error is raised when the buffer gets full. Default value is 100 instances.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum amount of memory to use. If more than that is used, a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error is raised. A value lower than or equal to <code>0</code> means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable File Store Iterable

Configures the repeatable file store iterable type.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Objects</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>Unit for the <strong>In Memory Objects</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Parser Response Attributes

Configures the response attributes for the parser.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Document Parser Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Document parser name.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Chunk Response Attributes

Configures the response attributes for the chunk.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Overlap Size In Chars</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum overlap size in characters.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Segment Size In Chars</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum segment size in characters.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Multiformat Document Parser Parameters

Configures the parameters for the multiformat document parser.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Include Metadata</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Determines whether to include metadata.</p></div></div></td><td><div><div><p>false</p></div></div></td><td><div></div></td></tr></tbody></table>

### Text Document Parser Parameters

Configures the parameters for the text document parser.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Document Parser</strong></p></td><td><div><div><p>DocumentParser</p></div></div></td><td><div><div><p>Document parser.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Document parser name.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## See Also

- [MuleSoft Vectors Connector Overview](https://docs.mulesoft.com/mulesoft-vectors-connector/1.0/)

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)
