diff --git a/mulesoft-vectors/1.1/antora.yml b/mulesoft-vectors/1.1/antora.yml new file mode 100644 index 0000000000..b9be3cb671 --- /dev/null +++ b/mulesoft-vectors/1.1/antora.yml @@ -0,0 +1,18 @@ +name: mulesoft-vectors-connector +version: '1.1' +display_version: 1.1 (Mule 4) +title: MuleSoft Vectors Connector +nav: +- modules/ROOT/nav.adoc +asciidoc: + attributes: + page-component-desc: Enables you to integrate AI into your data for smarter search and RAG + page-connector-type: Connector + page-connector-level: Select + page-exchange-group-id: com.mulesoft.connectors + page-exchange-asset-id: mule4-vectors-connector + page-runtime-version: 4.9.0 + page-release-notes-page: release-notes::connector/mulesoft-vectors-connector-release-notes-mule-4.adoc + page-vendor-name: MuleSoft + page-vendor-title: MuleSoft + page-notice-banner-message: Standard support for Java 8 and 11 ends in August 2026 for 4.6 LTS. Plan your upgrade path for apps that are running on Java 8 or 11 accordingly. diff --git a/mulesoft-vectors/1.1/modules/ROOT/nav.adoc b/mulesoft-vectors/1.1/modules/ROOT/nav.adoc new file mode 100644 index 0000000000..980db95b4f --- /dev/null +++ b/mulesoft-vectors/1.1/modules/ROOT/nav.adoc @@ -0,0 +1,11 @@ +.xref:index.adoc[MuleSoft Vectors Connector] +* xref:index.adoc[MuleSoft Vectors Connector Overview] +* xref:mulesoft-vectors-connector-studio.adoc[Using Anypoint Studio to Configure MuleSoft Vectors Connector] +* xref:mulesoft-vectors-connector-config-acb.adoc[Using Anypoint Code Builder to Configure MuleSoft Vectors Connector] +* xref:mulesoft-vectors-additional-config.adoc[MuleSoft Vectors Connector Additional Configuration Information] + ** xref:configuring-embedding-operations.adoc[] + ** xref:configuring-store-operations.adoc[] + ** xref:configuring-transform-operations.adoc[] +* xref:mulesoft-vectors-connector-xml-maven.adoc[MuleSoft Vectors Connector XML and Maven Support] +* xref:mulesoft-vectors-connector-examples.adoc[MuleSoft Vectors Connector Examples] +* xref:mulesoft-vectors-connector-reference.adoc[MuleSoft Vectors Connector Reference] \ No newline at end of file diff --git a/mulesoft-vectors/1.1/modules/ROOT/pages/configuring-embedding-operations.adoc b/mulesoft-vectors/1.1/modules/ROOT/pages/configuring-embedding-operations.adoc new file mode 100644 index 0000000000..d063f0a8df --- /dev/null +++ b/mulesoft-vectors/1.1/modules/ROOT/pages/configuring-embedding-operations.adoc @@ -0,0 +1,113 @@ += Configuring Embedding Operations + +Configure the *[Embedding] Generate from text* operation. + +== Configure the Embedding Generate from Text Operation + +The *[Embedding] Generate from text* operation splits the text into chunks of the provided size and creates numeric vectors for each text chunk. + +The *[Embedding] Generate from text* operation can be followed by either the *[Store] Add* operation or the *[Store] Query* operation. Both operations can use the output payload of the *[Embedding] Generate from text* operation without any transformation. When the *[Embedding] Generate from text* operation is used before the: + +* *[Store] Add* operation: The text along with the generated embeddings can be ingested into a vector store. +* *[Store] Query* operation: The text is first used to generate an embedding that is then used to perform a query against the vector store. ++ +NOTE: When generating an embedding from text for query purposes, don't provide any segmentation fields. Leave the *Max Segment Size (Characters)* and *Max Overlap Size (Characters)* fields blank. + +To configure the *[Embedding] Generate from text* operation: + +include::connectors::partial$t-configure-operations.adoc[] +* *Input Texts* ++ +Enter the input list of texts to generate embeddings from. +* *Max Segment Size (Characters)* ++ +Enter the segment size of the document to be split in. This can be left blank as it is an optional input. +* *Max Overlap Size (Characters)* ++ +Enter the overlap size of the segments to fine-tune the similarity search. This can be left blank as it is an optional input. +* *Model (Deployment) Name* ++ +Enter the embedding model (deployment) name. + +This is the XML for this operation: +[source,xml,linenums, subs=attributes+] +---- + + + +---- + +=== Output Configuration + +This operation responds with a JSON payload. This is an example response: + +[source,json] +---- +{ + "embeddings": [ + [-0.00683132, -0.0033572172, 0.02698761, -0.01291587, ...], + [-0.0047172513, -0.03481483, 0.02046227, -0.037395656, ...], + ... + ] + "text-segments": [ + { + "metadata": { + "index": "0" + }, + "text": "In the modern world, technological advancements have become .", + }, + { + "metadata": { + "index": "1" + }, + "text": "E-commerce giants like Amazon and Alibaba have redefined ..", + }, + ... + ], + "dimension": 1536 +} +---- + +* `embeddings`: List of generated embeddings. +** `list-item` (embedding) +* `text-segments`: List of segments. +** `list-item` (text-segment) +*** `text`: Text segment. +*** `metadata`: Metadata key-value pairs. +***** `index`: Segment or chunk number for the uploaded data source. +* `dimension`: Dimension of the embeddings. + +The operation also returns attributes that aren't within the main JSON payload, that include information about token usage, for example: + +[source,json] +---- +{ + "embeddingModelDimension": 1536, + "embeddingModelName": "sfdc_ai__DefaultOpenAITextEmbeddingAda_002", + "tokenUsage": { + "outputCount": 9, + "totalCount": 18, + "inputCount": 9 + }, + "additionalAttributes": {} +} +---- + +* `embeddingModelDimension`: Dimension for the embedding model used. +* `embeddingModelName`: Embedding model name used. +* `tokenUsage`: Token usage metadata returned as attributes +** `outputCount`: Number of tokens used to generate the output +** `totalCount`: Total number of tokens used for input and output. +** `inputCount`: Number of tokens used to process the input. + +== See Also + +* xref:index.adoc[MuleSoft Vectors Connector Overview] +* xref:mulesoft-vectors-connector-reference.adoc[MuleSoft Vectors Connector Reference] +* https://help.salesforce.com[Salesforce Help] \ No newline at end of file diff --git a/mulesoft-vectors/1.1/modules/ROOT/pages/configuring-store-operations.adoc b/mulesoft-vectors/1.1/modules/ROOT/pages/configuring-store-operations.adoc new file mode 100644 index 0000000000..82961cb69d --- /dev/null +++ b/mulesoft-vectors/1.1/modules/ROOT/pages/configuring-store-operations.adoc @@ -0,0 +1,317 @@ += Configuring Store Operations + +Configure the *[Store] Add*, *[Store] Query*, *[Store] Query All*, and *[Store] Remove* operations. + +== Configure the Store Add Operation + +The *[Store] Add* operation adds a document or text into an embedding store. + +The *[Store] Add* operation must be preceded by the *[Embedding] Generate from text* operation to ingest the text into a vector store. + +To configure the *[Store] Add* operation: + +include::connectors::partial$t-configure-operations.adoc[] +* *Store Name* ++ +Enter the name of the collection in the external vector database. +* *Text Segments and Embeddings* ++ +Enter the text segments and embeddings to ingest into the vector database. It is typically the output of the *[Embedding] Generate from text* operation. +* *Metadata entries* ++ +Enter a list-item (metadata entry), such as key (custom metadata key) and value (custom metadata value). + +This is the XML for this operation: +[source,xml,linenums, subs=attributes+] +---- + +---- + +=== Output Configuration + +This operation responds with a JSON payload. This is an example response: + +[source,json] +---- +{ + "sourceId": "af44c7ef-4562-4712-af09-4498fc7f29a2", + "embeddingIds": [ + "81f257c6-6406-4936-8c22-0ae523cce5fd", + "2127ef9b-08f4-4bfc-b769-1f488cdbf835", + "639e9994-f406-4481-a08a-0058ed3d781e" + ], + "status": "updated" +} +---- + +* `sourceId`: Unique identifier for the source document. +* `embeddingIds`: List of unique identifiers for the embeddings added to the store. +* `status`: Status of the operation. + +The operation also returns other attributes: + +* `storeName`: Name of the vector store collection. + +== Configure the Store Query Operation + +The *[Store] Query* operation retrieves information from the embedding store based on an embedding (previously generated from a text prompt) and optionally a filter on metadata. It can be used for: + +* *Knowledge Management Systems* ++ +Retrieving documents from an organizational knowledge base. +* *Customer Support* ++ +Storing customer interaction documents for quick retrieval and analysis. +* *Content Management* ++ +Ingesting various types of documents (text, PDF, URL) into a centralized repository for easy access and searchability. + +The *[Store] Query* operation can be preceded by the *[Embedding] Generate from text* operation. The plain text to use when querying the store is first processed by the *[Embedding] Generate from text* operation that generates an embedding that can be used to perform the actual query and represents the input for the *[Store] Query* operation. + +NOTE: When generating an embedding from text for query purposes, don't provide any segmentation fields. Leave the *Max Segment Size (Characters)* and *Max Overlap Size (Characters)* fields blank. + +To configure the *[Store] Query* operation: + +include::connectors::partial$t-configure-operations.adoc[] +* *Store Name* ++ +Enter the name of the collection in the external vector database. +* *Text Segments and Embeddings* ++ +Enter the text segments and embeddings to query into the vector database. It is typically the output of the *[Embedding] Generate from text* operation. Text segments and embeddings must have only one element. +* *Max Results* ++ +Enter the maximum number of results to query back. +* *Min Score* ++ +Enter the minimum score for the similarity search (0-1). +* *Metadata Condition* ++ +Enter the condition used for filtering results based on metadata. ++ +It supports SQL-like syntax. ++ +** Comparison operators are `=`, `!=`, `<`, `<=`, `>`, and `>=`. +** Special operators: +*** `CONTAINS(field_name, 'value')` - Check if the field contains the value. +** Logical operators are `AND` and `OR`. ++ +Here is an example: `index=1 AND (CONTAINS(file_name,'example.pdf') OR file_type='any')` ++ +NOTE: Both `CONTAINS(field_name, 'value')` and `field_name LIKE '%value%'` work most of the time, but the behavior might differ for each store provider. For example, for Azure AI Search, it maps to `search.ismatch('value', field_name)`. + +This is the XML for this operation: +[source,xml,linenums, subs=attributes+] +---- + +---- + +=== Output Configuration + +This operation responds with a JSON payload. This is an example response: + +[source,json] +---- +{ + "question": "Tell me more about Cloudhub High Availability Feature", + "sources": [ + { + "embeddingId": "", + "text": "= CloudHub High Availability Features\nifndef::env-site,env-github[]\ninclude::_attributes.adoc[]\nendif::[]\n:page-aliases: runtime-manager::cloudhub-fabric.adoc,\....\n\n== Worker Scale-out", + "score": 0.9282029356714594, + "metadata": { + "source_Id": "c426a871-1a6e-4a47-a8ab-027eec9303e1", + "index": "0" + "absolute_directory_path": "/Users//Documents/Downloads/patch 8", + "file_name": "docs-runtime-manager__cloudhub_modules_ROOT_pages_cloudhub-fabric.adoc", + "full_path": "/Users//Documents/Downloads/patch 8docs-runtime-manager__cloudhub_modules_ROOT_pages_cloudhub-fabric.adoc", + "file_type": "any", + "ingestion_datetime": "2024-11-20T20:34:41.691Z", + "ingestion_timestamp": "1732134881691" + } + }, + { + ... + }, + { + ... + } + ] + "response": "= CloudHub High Availability Features\.. (...) \..distributes HTTP requests among your assigned workers.\n. Persistent message queues (see below)", + "maxResults": 3, + "storeName": "gettingstarted", + "minimumScore": 0.7 +} +---- + +* `question`: The question of the request. +* `sources`: The sources identified by the similarity search. +** `embeddingId`: The embedding UUID. +** `text`: The relevant text segment. +** `score`: The score of the similarity search based on the question. +** `metadata`: The metadata key-value pairs. +** `source_id`: The UUID for the uploaded data source. +** `index`: The segment or chunk number for the uploaded data source. +** `absolute_directory_path`: The full path to the file that contains relevant text segment. +** `file_name`: The name of the file, in which the text segment is found. +** `full_path`: The full path to the file. +** `file_Type`: The file type. +** `ingestion_datetime`: The ingestion date and time in ISO 8601 format (UTC). +** `ingestion_timestamp`: The ingestion time in milliseconds. +* `response`: The collected response of all relevant text segment. This is the response will is sent to the LLM. +* `maxResults`: The maximum number of text segments considered. +* `storeName`: The name of the vector store. +* `minimumScore`: The minimum score for the result. + +The operation also returns other attributes: + +* `storeName`: Name of the vector store collection. +* `metadataCondition` (Optional): Filter condition used to query embeddings. + +== Configure the Store Query All Operation + +The *[Store] Query All* operation lists all sources into the embedding store. + +To configure the *[Store] Query All* operation: + +include::connectors::partial$t-configure-operations.adoc[] +* *Store Name* ++ +Enter the name of the collection in the external vector database. +* *Retrieve Embeddings* ++ +If true, retrieve embeddings from the store. ++ +NOTE: When querying the store along with embeddings using Azure AI Search, the connector might return the `Invalid expression: 'content_vector' is not a retrievable field. Only fields marked as retrievable in the index can be used in $select.\r\nParameter name: $select` error. To resolve the issue, set `content_vector as a retrievable field. +* *Page Size* ++ +Enter the page size to use when querying the store. + + +This is the XML for this operation: +[source,xml,linenums, subs=attributes+] +---- + +---- + +=== Output Configuration + +This operation responds with a JSON payload. This is an example response: + +[source,json] +---- +[ + { + "embeddingId": "81f257c6-6406-4936-8c22-0ae523cce5fd", + "text": "E-commerce giants like Amazon and Alibaba have redefined ..", + "metadata": { + "index": "0", + "source": "s3://ms-vectors/invoicesample.pdf", + "file_type": "any", + "file_name": "invoicesample.pdf" + ... + }, + "embeddings": [-0.00683132, -0.0033572172, 0.02698761, -0.01291587, ...] + } +] +---- + +* `embeddingId`: The embedding UUID. +* `text`: The relevant text segment. +* `metadata`: The metadata key-value pairs. +** `index`: The segment or chunk number for the uploaded data source. +** `source`: The source of the text segment. +** `file_type`: The file type. +** `file_name`: The name of the file, in which the text segment is found. +* `embeddings`: The embeddings for the text segment. + +The operation also returns other attributes: + +* `storeName`: Name of the vector store collection. + +== Configure the Store Remove Operation + +The *[Store] Remove* operation removes all embeddings from the store based on a metadata filter. + +To configure the *[Store] Remove* operation: + +include::connectors::partial$t-configure-operations.adoc[] +* *Store Name* ++ +Enter the name of the collection in the external vector database. +* *Ids* ++ +Enter the list of IDs to delete. +* *Metadata Condition* ++ +Enter the condition used for filtering results based on metadata. ++ +It supports SQL-like syntax. ++ +** Comparison operators are `=`, `!=`, `<`, `<=`, `>`, and `>=`. +** Special operators: +*** `CONTAINS(field_name, 'value')` - Check if the field contains the value. +** Logical operators are `AND` and `OR`. ++ +Here is an example: `index=1 AND (CONTAINS(file_name,'example.pdf') OR file_type='any')` ++ +NOTE: Both `CONTAINS(field_name, 'value')` and `field_name LIKE '%value%'` work most of the time, but the behavior might differ for each store provider. For example, for Azure AI Search, it maps to `search.ismatch('value', field_name)`. + + +This is the XML for this operation: +[source,xml,linenums, subs=attributes+] +---- + +---- + +=== Output Configuration + +This operation responds with a JSON payload. This is an example response: + +[source,json] +---- +{ + "status": "deleted" +} +---- + +* `status`: Status of the operation. + +The operation also returns other attributes: + +* `storeName`: Name of the vector store collection. +* `ids` (Optional): IDs of the embeddings to remove. +* `metadataCondition` (Optional): Filter condition used to remove embeddings. + +== See Also + +* xref:index.adoc[MuleSoft Vectors Connector Overview] +* xref:mulesoft-vectors-connector-reference.adoc[MuleSoft Vectors Connector Reference] +* https://help.salesforce.com[Salesforce Help] diff --git a/mulesoft-vectors/1.1/modules/ROOT/pages/configuring-transform-operations.adoc b/mulesoft-vectors/1.1/modules/ROOT/pages/configuring-transform-operations.adoc new file mode 100644 index 0000000000..6cb82ab8ed --- /dev/null +++ b/mulesoft-vectors/1.1/modules/ROOT/pages/configuring-transform-operations.adoc @@ -0,0 +1,85 @@ += Configuring Transform Operations + +Configure the *[Transform] Parse document* and *[Transform] Chunk text* operations. + +== Configure the Transform Parse Document Operation + +The *[Transform] Parse document* operation parses a document from a raw binary or Base64-encoded content. + +To configure the *[Transform] Parse document* operation: + +include::connectors::partial$t-configure-operations.adoc[] +* *Document binary* ++ +Enter the raw binary or Base64-encoded content of the document to parse. +* *Document parser* ++ +Enter the document parser to use. + +This is the XML for this operation: +[source,xml,linenums, subs=attributes+] +---- + + +---- + +=== Output Configuration + +This operation responds with a JSON payload. This is an example response: + +[source,json] +---- +{ +In the modern world, technological advancements have become essential for businesses to remain competitive. E-commerce giants have redefined the retail landscape through innovative use of technology and data analytics. +} +---- + +== Configure the Transform Chunk Text Operation + +The *[Transform] Chunk text* operation 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. + +To configure the *[Transform] Chunk text* operation: + +include::connectors::partial$t-configure-operations.adoc[] +* *Text* ++ +Enter the text content to chunk. +* *Max Segment Size (Characters)* ++ +Enter the maximum size of a segment in characters. +* *Max Overlap Size (Characters)* ++ +Enter the maximum overlap between segments in characters. + +This is the XML for this operation: +[source,xml,linenums, subs=attributes+] +---- + + +---- + +=== Output Configuration + +This operation responds with a JSON payload. This is an example response: + +[source,json] +---- +["In the modern world, technological advancements have become essential for businesses to", "remain competitive. E-commerce giants have redefined the retail landscape through innovative use of technology and data analytics"] +---- + +== See Also + +* xref:index.adoc[MuleSoft Vectors Connector Overview] +* xref:mulesoft-vectors-connector-reference.adoc[MuleSoft Vectors Connector Reference] +* https://help.salesforce.com[Salesforce Help] diff --git a/mulesoft-vectors/1.1/modules/ROOT/pages/index.adoc b/mulesoft-vectors/1.1/modules/ROOT/pages/index.adoc new file mode 100644 index 0000000000..ef477dc0fb --- /dev/null +++ b/mulesoft-vectors/1.1/modules/ROOT/pages/index.adoc @@ -0,0 +1,152 @@ += MuleSoft Vectors Connector 1.1 +:lc-connector-name: mulesoft-vectors + +Anypoint Connector for MuleSoft Vectors (MuleSoft Vectors Connector) provides access to a broad number of external vector stores and databases. MuleSoft Vectors Connector can be used with other connectors (for example, MuleSoft Inference Connector or Einstein AI Connector) and provides seamless access to vector stores for implementing smarter search or Retrieval Augmented Generation (RAG) use cases. + +For information about compatibility and fixed issues, see the MuleSoft Vectors Connector release notes. + +== Before You Begin + +To use this connector, you must be familiar with: + +* Anypoint Connectors +* Mule runtime engine (Mule) +* Elements and global elements in a Mule flow +* How to create a Mule app using Anypoint Code Builder or Anypoint Studio + +Before creating an app, you must have: + +* Java 17 (required for compilation and runtime) +* Apache Maven +* Credentials to access the MuleSoft Vectors Connector target resources +* Anypoint Platform +* The latest versions of Anypoint Code Builder or Anypoint Studio + +== Key Features + +MuleSoft Vectors Connector provides: + +* Accelerated AI-powered application development +* Simplified vector database integration +* Easy-to-build semantic search and RAG experiences without managing complex vector infrastructure + +NOTE: Data is processed in in-memory, so if you do parallel processing (such as running multiple flows in one go), you might encounter an out-of-memory issue. For example, if you process 1 MB files in three flows, around 3 MB files will be loaded in-memory. This is due to the nature of Apache Tika and LangChain4j libraries. + +== Supported Vector Stores + +MuleSoft Vectors Connector supports these vector stores: + +* Azure AI Search (beta) +* Chroma (beta) +* Milvus (beta) +* OpenSearch (beta) +* PGVector (beta) ++ +NOTE: PGVector is not FIPS-compliant. +* Pinecone (beta) +* Qdrant (beta) +* MongoDB Atlas (beta) +* Ephemeral File (beta) + +=== Supported Operations by Vector Stores + +This table provides a detailed view of operation support across all vector stores: + +[%header,cols="1,1,1,1,1"] +|=== +|Vector Store |Storing Metadata |Filtering by Metadata |Removing Embeddings |List All Embeddings + +|*Azure AI Search* +|Yes |Yes |Yes |Yes + +|*Chroma* +|Yes |Yes |Yes |Yes + +|*Milvus* +|Yes |Yes |Yes |Yes + +|*OpenSearch* +|Yes |Yes |Yes |No + +|*PGVector* +|Yes |Yes |Yes |Yes + +|*Pinecone* +|Yes |Yes |No |No + +|*Qdrant* +|Yes |Yes |Yes |Yes + +|*MongoDB Atlas* +|Yes |Yes |Yes |Yes + +|*Ephemeral File* +|Yes |Yes |Yes |Yes +|=== + +== Supported Model Providers + +MuleSoft Vectors Connector supports these model providers to generate embeddings: + +* Azure OpenAI +* Azure Vision AI (beta) +* Einstein +* Hugging Face (beta) +* Mistral AI (beta) +* Nomic (beta) +* Ollama (beta) +* OpenAI + +=== Supported Embedding Types by Model Providers + +This table provides a detailed view of embedding type support across all model providers: + +[%header,cols="1,1,1,1"] +|=== +|Model Provider |Text Embedding |Image Embedding |Video Embedding + +|*Azure OpenAI* +|Yes |No |No + +|*Azure Vision AI* +|Yes |No |No + +|*Einstein* +|Yes |No |No + +|*Hugging Face* +|Yes |No |No + +|*Mistral AI* +|Yes |No |No + +|*Nomic* +|Yes |No |No + +|*Ollama* +|Yes |No |No + +|*OpenAI* +|Yes |No |No +|=== + +NOTE: To keep pace with the rapidly evolving AI landscape, certain vector stores and LLMs are marked as beta. These are early-stage integrations that may change based on stability, demand, or provider updates. You can explore them but should do so with awareness that support might be limited and subject to change. + +== Supported Storage Options + +* *Local*: Load data from application local storage +* xref:azure-data-lake-storage-connector::index.adoc[*Azure Blob Storage*]: Load data from Azure Blob Storage containers +* xref:amazon-s3-connector::index.adoc[*Amazon S3*]: Load data from Amazon S3 buckets + +== Next Step + +After you complete the prerequisites, you are ready to create an app and configure the connector using xref:{lc-connector-name}-connector-studio.adoc[Anypoint Studio] or xref:{lc-connector-name}-connector-config-acb.adoc[Anypoint Code Builder]. + +== See Also + +* xref:connectors::introduction/introduction-to-anypoint-connectors.adoc[Introduction to Anypoint Connectors] +* xref:connectors::introduction/intro-config-use-acb.adoc[] +* xref:connectors::introduction/intro-config-use-studio.adoc[Using Studio to Configure a Connector] +* xref:mulesoft-vectors-additional-config.adoc[MuleSoft Vectors - Additional Configuration Information] +* xref:mulesoft-vectors-connector-reference.adoc[MuleSoft Vectors Connector Reference] +* https://help.salesforce.com[Salesforce Help] diff --git a/mulesoft-vectors/1.1/modules/ROOT/pages/mulesoft-vectors-additional-config.adoc b/mulesoft-vectors/1.1/modules/ROOT/pages/mulesoft-vectors-additional-config.adoc new file mode 100644 index 0000000000..9ad9acae4d --- /dev/null +++ b/mulesoft-vectors/1.1/modules/ROOT/pages/mulesoft-vectors-additional-config.adoc @@ -0,0 +1,7 @@ += MuleSoft Vectors Connector - Additional Configuration Information + +MuleSoft Vectors Connector provides detailed configuration information for each operation type. Select the operation you want to configure. + +* xref:configuring-embedding-operations.adoc[Configure Embedding Operations] +* xref:configuring-store-operations.adoc[Configure Store Operations] +* xref:configuring-transform-operations.adoc[Configure Transform Operations] diff --git a/mulesoft-vectors/1.1/modules/ROOT/pages/mulesoft-vectors-connector-config-acb.adoc b/mulesoft-vectors/1.1/modules/ROOT/pages/mulesoft-vectors-connector-config-acb.adoc new file mode 100644 index 0000000000..658023ef67 --- /dev/null +++ b/mulesoft-vectors/1.1/modules/ROOT/pages/mulesoft-vectors-connector-config-acb.adoc @@ -0,0 +1,45 @@ += Using Anypoint Code Builder to Configure {connector-name} Connector {version} +:exchange-search-name: mulesoft vectors +:connector-name: MuleSoft Vectors +:version: 1.1 +:lc-connector-name: mulesoft-vectors +:studio-connector-name: MuleSoft Vectors + + +include::connectors::partial$configure-acb-connectors-partial.adoc[tag="acb-connector-config-intro"] + +== Create a New Integration Project + +include::connectors::partial$configure-acb-connectors-partial.adoc[tag="acb-create-integration-project"] + +== Add the Connector to Your Integration Project + +include::connectors::partial$configure-acb-connectors-partial.adoc[tag="acb-add-connector-to-project"] + +== Configure the Source For the Flow + +include::connectors::partial$configure-acb-connectors-partial.adoc[tag="acb-configure-source"] + +== Add Components to Your Project + +include::connectors::partial$configure-acb-connectors-partial.adoc[tag="acb-add-components-to-project"] + +== Configure the Component Attributes + +include::connectors::partial$configure-acb-connectors-partial.adoc[tag="acb-configure-attributes"] + +== Create a New Configuration XML File + +include::connectors::partial$configure-acb-connectors-partial.adoc[tag="acb-create-config-file-acb"] + +[[debug]] +== Debug the App + +Debug your Mule application using the embedded debugger in Anypoint Code Builder. + +See xref:anypoint-code-builder::int-debug-mule-apps.adoc[]. + +== See Also + +include::connectors::partial$configure-acb-connectors-partial.adoc[tag="acb-template-see-also"] +* xref:runtime-manager::deployment-strategies.adoc[] diff --git a/mulesoft-vectors/1.1/modules/ROOT/pages/mulesoft-vectors-connector-examples.adoc b/mulesoft-vectors/1.1/modules/ROOT/pages/mulesoft-vectors-connector-examples.adoc new file mode 100644 index 0000000000..a8c6018661 --- /dev/null +++ b/mulesoft-vectors/1.1/modules/ROOT/pages/mulesoft-vectors-connector-examples.adoc @@ -0,0 +1,76 @@ += MuleSoft Vectors Connector Examples +:lc-connector-name: mulesoft-vectors + +These examples show you how to use MuleSoft Vectors Connector. + +== Example: File + +This flow listens for HTTP requests on `/store01`, retrieves a file from an Amazon S3 bucket using a provided or default key, and parses its content into text using a text parser. The text is then split into smaller overlapping chunks, converted into embeddings using an embedding model, and stored in a vector store named `loadf02`. + +[source,xml,linenums] +---- + + + + + + + + + + + + + + + + + + + + + +---- + +== Example: PDF + +This flow listens for HTTP requests on `/store02`, retrieves a PDF from an Amazon S3 bucket using a provided or default key, and parses its content into text using a MultiFormat Document parser. The text is then split into smaller overlapping chunks, converted into embeddings using an embedding model, and stored in a vector store named `loadf02`. + +[source,xml,linenums] +---- + + + + + + + + + + + + + + + + + + + + + +---- + +== See Also + +* xref:mulesoft-vectors-additional-config.adoc[MuleSoft Vectors - Additional Configuration Information] +* xref:mulesoft-vectors-connector-studio.adoc[Using Anypoint Studio to Configure MuleSoft Vectors Connector] +* xref:mulesoft-vectors-connector-reference.adoc[MuleSoft Vectors Connector Reference] diff --git a/mulesoft-vectors/1.1/modules/ROOT/pages/mulesoft-vectors-connector-reference.adoc b/mulesoft-vectors/1.1/modules/ROOT/pages/mulesoft-vectors-connector-reference.adoc new file mode 100644 index 0000000000..993251b5b6 --- /dev/null +++ b/mulesoft-vectors/1.1/modules/ROOT/pages/mulesoft-vectors-connector-reference.adoc @@ -0,0 +1,1087 @@ + += MuleSoft Vectors Connector 1.1 Reference + + +MuleSoft Vectors Connector provides operations to work with vector stores and embedding models. + + +== Configurations +--- +[[EmbeddingConfig]] +=== Embedding Config + + +==== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +|Name | String | Name for this configuration. Connectors reference the configuration with this name. | | x +| Connection a| * <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> + | Connection types for this configuration. | | x +| Name a| String | ID used to reference this configuration. | | x +| Expiration Policy a| <> | Configures an expiration policy for the configuration. | | +|=== + +==== Connection Types +[[EmbeddingConfig_AzureAiVision]] +===== Azure AI Vision + + +====== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Proxy Config a| HttpProxyConfig | Configures a proxy for outbound connections. | | +| TLS Configuration a| <> | If HTTPS is configured as a protocol, then you must configure at least the keystore configuration. | | +| Timeout a| Number | Timeout for the operation in milliseconds. | 60000 | +| Endpoint a| String | Endpoint. | | x +| Api Key a| String | API key. | | x +| Api Version a| String | API version. | | x +| Reconnection a| <> | 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. | | +|=== +[[EmbeddingConfig_AzureOpenAi]] +===== Azure OpenAI + + +====== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Proxy Config a| HttpProxyConfig | Configures a proxy for outbound connections. | | +| TLS Configuration a| <> | If HTTPS is configured as a protocol, then you must configure at least the keystore configuration. | | +| Timeout a| Number | Timeout for the operation in milliseconds. | 60000 | +| Endpoint a| String | Endpoint. | | x +| Api Key a| String | API key. | | x +| Api Version a| String | API version. | | x +| Reconnection a| <> | 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. | | +|=== +[[EmbeddingConfig_Einstein]] +===== Einstein + + +====== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Proxy Config a| HttpProxyConfig | Configures a proxy for outbound connections. | | +| TLS Configuration a| <> | If HTTPS is configured as a protocol, then you must configure at least the keystore configuration. | | +| Timeout a| Number | Timeout for the operation in milliseconds. | 60000 | +| Salesforce Org a| String | Salesforce org. | | x +| Client Id a| String | Client ID. | | x +| Client Secret a| String | Client secret. | | x +| Reconnection a| <> | 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. | | +|=== +[[EmbeddingConfig_HuggingFace]] +===== Hugging Face + + +====== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Proxy Config a| HttpProxyConfig | Configures a proxy for outbound connections. | | +| TLS Configuration a| <> | If HTTPS is configured as a protocol, then you must configure at least the keystore configuration. | | +| Timeout a| Number | Timeout for the operation in milliseconds. | 60000 | +| Api Key a| String | API key. | | x +| Reconnection a| <> | 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. | | +|=== +[[EmbeddingConfig_MistralAi]] +===== Mistral AI + + +====== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Proxy Config a| HttpProxyConfig | Configures a proxy for outbound connections. | | +| TLS Configuration a| <> | If HTTPS is configured as a protocol, then you must configure at least the keystore configuration. | | +| Timeout a| Number | Timeout for the operation in milliseconds. | 60000 | +| Api Key a| String | API key. | | x +| Total Timeout (ms) a| Number | Total timeout in milliseconds for API requests. | 60000 | +| Reconnection a| <> | 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. | | +|=== +[[EmbeddingConfig_Nomic]] +===== Nomic + + +====== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Proxy Config a| HttpProxyConfig | Configures a proxy for outbound connections. | | +| TLS Configuration a| <> | If HTTPS is configured as a protocol, then you must configure at least the keystore configuration. | | +| Timeout a| Number | Timeout for the operation in milliseconds. | 60000 | +| Api Key a| String | API key. | | x +| Reconnection a| <> | 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. | | +|=== +[[EmbeddingConfig_Ollama]] +===== Ollama + + +====== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Proxy Config a| HttpProxyConfig | Configures a proxy for outbound connections. | | +| TLS Configuration a| <> | If HTTPS is configured as a protocol, then you must configure at least the keystore configuration. | | +| Timeout a| Number | Timeout for the operation in milliseconds. | 60000 | +| Base URL a| String | Ollama base URL. | | x +| Reconnection a| <> | 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. | | +|=== +[[EmbeddingConfig_OpenAi]] +===== OpenAI + + +====== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Proxy Config a| HttpProxyConfig | Configures a proxy for outbound connections. | | +| TLS Configuration a| <> | If HTTPS is configured as a protocol, then you must configure at least the keystore configuration. | | +| Timeout a| Number | Timeout for the operation in milliseconds. | 60000 | +| Api Key a| String | API key. | | x +| Reconnection a| <> | 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 +* <> + + +--- +[[StoreConfig]] +=== Store Config + + +==== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +|Name | String | Name for this configuration. Connectors reference the configuration with this name. | | x +| Connection a| * <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> + | Connection types for this configuration. | | x +| Name a| String | ID used to reference this configuration. | | x +| Expiration Policy a| <> | Configures an expiration policy for the configuration. | | +|=== + +==== Connection Types +[[StoreConfig_AiSearch]] +===== AI Search + + +====== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Proxy Configuration a| HttpProxyConfig | Configures a proxy for outbound connections. | | +| TLS Configuration a| <> | If HTTPS is configured as a protocol, then you must configure at least the keystore configuration. | | +| Url a| String | URL. | | x +| Api Key a| String | API key. | | x +| Reconnection a| <> | 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. | | +|=== +[[StoreConfig_Chroma]] +===== Chroma + + +====== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Proxy Configuration a| HttpProxyConfig | Configures a proxy for outbound connections. | | +| TLS Configuration a| <> | If HTTPS is configured as a protocol, then you must configure at least the keystore configuration. | | +| Url a| String | URL. | | x +| Reconnection a| <> | 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. | | +|=== + +[[StoreConfig_EphemeralFile]] +===== Ephemeral File + + +====== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Working Directory a| String | Directory for creating store files. | | x +| Reconnection a| <> | 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. | | +|=== +[[StoreConfig_Milvus]] +===== Milvus + + +====== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Uri a| String | URI. | | +| Host a| String | Host. | | +| Port a| Number | Port. | | +| Token a| String | Token. | | +| Username a| String | Username. | | +| Password a| String | Password. | | +| Database Name a| String | Database name. | | +| Index Type a| String | Index type. | FLAT | +| Metric Type a| String | Metric type. | COSINE | +| Consistency Level a| String | Consistency level. | EVENTUALLY | +| Auto Flush On Insert a| Boolean | Determines whether to auto-flush on insert. | true | +| Id Field Name a| String | ID field name. | ID | +| Text Field Name a| String | Text field name. | text | +| Metadata Field Name a| String | Metadata field name. | metadata | +| Vector Field Name a| String | Vector field name. | vector | +| Reconnection a| <> | 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. | | +|=== +[[StoreConfig_MongoDbAtlas]] +===== MongoDB Atlas + + +====== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Host a| String | Host. | | x +| Port a| Number | Port. | | +| Username a| String | Username. | | +| Password a| String | Password. | | x +| Database Name a| String | Database name. | | +| Options a| String | Options. | | +| Reconnection a| <> | 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. | | +|=== +[[StoreConfig_OpenSearch]] +===== OpenSearch + + +====== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Url a| String | URL. | | x +| User a| String | Username. | | +| Password a| String | Password. | | x +| Api Key a| String | API key. | | +| Reconnection a| <> | 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. | | +|=== +[[StoreConfig_PgVector]] +===== PGVector + + +====== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Host a| String | Host. | | x +| Port a| Number | Port. | | x +| Database a| String | Database. | | x +| User a| String | Username. | | x +| Password a| String | Password. | | x +| Reconnection a| <> | 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. | | +|=== +[[StoreConfig_Pinecone]] +===== Pinecone + + +====== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Cloud a| String | Cloud. | | x +| Region a| String | Region. | | x +| Api Key a| String | API key. | | x +| Reconnection a| <> | 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. | | +|=== +[[StoreConfig_Qdrant]] +===== Qdrant + + +====== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Host a| String | Host. | | x +| GPRC Port a| Number | gRPC port. | | x +| Use TLS a| Boolean | Determines whether to use TLS. | false | +| Text Segment Key a| String | Text segment key. | | x +| Api Key a| String | API key. | | x +| Reconnection a| <> | 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 +* <> +* <> +* <> +* <> + + +--- +[[TransformConfig]] +=== Transform Config + + +==== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +|Name | String | Name for this configuration. Connectors reference the configuration with this name. | | x +| Name a| String | ID used to reference this configuration. | | x +|=== + + +== Supported Operations +* <> + + + +== Operations + +[[EmbeddingGenerateFromText]] +== [Embedding] Generate from text +`` + + +Generates embeddings from a given text string. The text can optionally be segmented before embedding. + + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Input Texts a| Array of String | Input list of texts to generate embeddings from. | #[payload] | +| Output Mime Type a| String | MIME type of the payload that this operation outputs. | | +| Output Encoding a| String | Encoding of the payload that this operation outputs. | | +| Config Ref a| ConfigurationProvider | Name of the configuration to use to execute this component. | | x +| Streaming Strategy a| * <> +* <> +* non-repeatable-stream | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Model (Deployment) Name a| String | Embedding model (deployment) name. | | x +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | #[payload] | +| Error Mappings a| Array of <> | Set of error mappings. | | +| Reconnection Strategy a| * <> +* <> | Retry strategy in case of connectivity errors. | | +|=== + +=== Output + +[%autowidth.spread] +|=== +|Type |Any +| Attributes Type a| <> +|=== + +=== 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 + + +[[Query]] +== [Store] Query +`` + + +Queries an embedding store based on the provided embedding and text segment, and applies a metadata filter. + + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Store Name a| String | Name of the store or collection to query. | | x +| Text Segment and Embedding a| Any | Text segment and embedding generated from the question and used to query the store. | | x +| Max Results a| Number | Maximum number of results (text segments) retrieved. | | x +| Min Score a| Number | Minimum score used to filter retrieved results (text segments) (0-1). | | x +| Output Mime Type a| String | MIME type of the payload that this operation outputs. | | +| Output Encoding a| String | Encoding of the payload that this operation outputs. | | +| Config Ref a| ConfigurationProvider | Name of the configuration to use to execute this component. | | +| Streaming Strategy a| * <> +* <> +* non-repeatable-stream | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Metadata Condition a| String | Metadata condition. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | #[payload] | +| Error Mappings a| Array of <> | Set of error mappings. | | +| Reconnection Strategy a| * <> +* <> | Retry strategy in case of connectivity errors. | | +|=== + +=== Output + +[%autowidth.spread] +|=== +|Type |Any +| Attributes Type a| <> +|=== + +=== 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 + + +[[QueryAll]] +== [Store] Query all +`` + + +Lists all sources in the specified embedding store. + + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Store Name a| String | Name of the store. | | x +| Output Mime Type a| String | MIME type of the payload that this operation outputs. | | +| Output Encoding a| String | Encoding of the payload that this operation outputs. | | +| Config Ref a| ConfigurationProvider | Name of the configuration to use to execute this component. | | +| Streaming Strategy a| * <> +* <> +* non-repeatable-iterable | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Retrieve Embeddings a| Boolean | Flag to indicate whether embeddings should be retrieved. | false | +| Page size a| Number | Page size used when querying the vector store. | 5000 | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | #[payload] | +| Error Mappings a| Array of <> | Set of error mappings. | | +| Reconnection Strategy a| * <> +* <> | Retry strategy in case of connectivity errors. | | +|=== + +=== Output + +[%autowidth.spread] +|=== +|Type |Array of Message of [Binary] payload and <> 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 + + +[[StoreAdd]] +== [Store] Add +`` + + +Adds embeddings and text segments to the store. + + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Store Name a| String | Name of the store or collection to use for data ingestion. | | x +| Text Segments and Embeddings a| Any | Text segments and embeddings to add to the store. | #[payload] | +| Output Mime Type a| String | MIME type of the payload that this operation outputs. | | +| Output Encoding a| String | Encoding of the payload that this operation outputs. | | +| Config Ref a| ConfigurationProvider | Name of the configuration to use to execute this component. | | +| Streaming Strategy a| * <> +* <> +* non-repeatable-stream | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Metadata entries a| Object | Custom metadata key-value pairs to add to the vector store. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | #[payload] | +| Error Mappings a| Array of <> | Set of error mappings. | | +| Reconnection Strategy a| * <> +* <> | Retry strategy in case of connectivity errors. | | +|=== + +=== Output + +[%autowidth.spread] +|=== +|Type |Any +| Attributes Type a| <> +|=== + +=== 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 + + +[[StoreRemove]] +== [Store] Remove +`` + + +Removes embeddings from the store based on the provided filter. + + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Store Name a| String | Name of the store. | | x +| Output Mime Type a| String | MIME type of the payload that this operation outputs. | | +| Output Encoding a| String | Encoding of the payload that this operation outputs. | | +| Config Ref a| ConfigurationProvider | Name of the configuration to use to execute this component. | | +| Streaming Strategy a| * <> +* <> +* non-repeatable-stream | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Ids a| Array of String | List of IDs to remove. | | +| Metadata Condition a| String | Metadata condition. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | #[payload] | +| Error Mappings a| Array of <> | Set of error mappings. | | +| Reconnection Strategy a| * <> +* <> | Retry strategy in case of connectivity errors. | | +|=== + +=== Output + +[%autowidth.spread] +|=== +|Type |Any +| Attributes Type a| <> +|=== + +=== 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 + + +[[TransformParseDocument]] +== [Transform] Parse document +`` + + +Parses a document from a raw binary or Base64-encoded content. + + +=== Parameters + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Configuration | String | Name of the configuration to use. | | x +| Document binary a| Any | Raw binary or Base64-encoded content of the document to parse. | #[payload] | +| Document parser a| One of: + +* <> +* <> | Document parser to use. | | x +| Output Mime Type a| String | MIME type of the payload that this operation outputs. | | +| Output Encoding a| String | Encoding of the payload that this operation outputs. | | +| Config Ref a| ConfigurationProvider | Name of the configuration to use to execute this component. | | +| Streaming Strategy a| * <> +* <> +* non-repeatable-stream | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | #[payload] | +| Error Mappings a| Array of <> | Set of error mappings. | | +|=== + +=== Output + +[%autowidth.spread] +|=== +|Type |Binary +| Attributes Type a| <> +|=== + +=== For Configurations + +* <> + +=== Throws + +* MS-VECTORS:INVALID_PARAMETER +* MS-VECTORS:TRANSFORM_DOCUMENT_PARSING_FAILURE +* MS-VECTORS:TRANSFORM_OPERATIONS_FAILURE + + +[[TransformChunkText]] +== [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 + +[%header%autowidth.spread] +|=== +| Name | Type | Description | Default Value | Required +| Text a| Any | Input text to chunk. | #[payload] | +| Output Mime Type a| String | MIME type of the payload that this operation outputs. | | +| Output Encoding a| String | Encoding of the payload that this operation outputs. | | +| Streaming Strategy a| * <> +* <> +* non-repeatable-stream | Configures how Mule processes streams. Repeatable streams are the default behavior. | | +| Max Segment Size (Characters) a| Number | Maximum size of a segment in characters. | | +| Max Overlap Size (Characters) a| Number | Maximum overlap between segments in characters. | | +| Target Variable a| String | Name of the variable that stores the operation's output. | | +| Target Value a| String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the *Target Variable* field. | #[payload] | +| Error Mappings a| Array of <> | Set of error mappings. | | +|=== + +=== Output + +[%autowidth.spread] +|=== +|Type |Array of String +| Attributes Type a| <> +|=== + + +=== Throws + +* MS-VECTORS:INVALID_PARAMETER +* MS-VECTORS:TRANSFORM_DOCUMENT_PARSING_FAILURE +* MS-VECTORS:TRANSFORM_OPERATIONS_FAILURE + + + +== Types + +[[Tls]] +=== TLS + +Configures TLS to provide secure communications for the Mule app. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Enabled Protocols a| String | Comma-separated list of protocols enabled for this context. | | +| Enabled Cipher Suites a| String | Comma-separated list of cipher suites enabled for this context. | | +| Trust Store a| <> | Configures the TLS truststore. | | +| Key Store a| <> | Configures the TLS keystore. | | +| Revocation Check a| * <> +* <> +* <> | Configures a revocation checking mechanism. | | +|=== + +[[TrustStore]] +=== Truststore + +Configures the truststore for TLS. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Path a| String | Path to the truststore. Mule resolves the path relative to the current classpath and file system. | | +| Password a| String | Password used to protect the truststore. | | +| Type a| String | Type of truststore. | | +| Algorithm a| String | Encryption algorithm that the truststore uses. | | +| Insecure a| Boolean | If `true`, Mule stops performing certificate validations. Setting this to `true` can make connections vulnerable to attacks. | | +|=== + +[[KeyStore]] +=== Keystore + +Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Path a| String | Path to the keystore. Mule resolves the path relative to the current classpath and file system. | | +| Type a| String | Type of keystore. | | +| Alias a| 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 a| String | Password used to protect the private key. | | +| Password a| String | Password used to protect the keystore. | | +| Algorithm a| String | Encryption algorithm that the keystore uses. | | +|=== + +[[StandardRevocationCheck]] +=== Standard Revocation Check + +Configures standard revocation checks for TLS certificates. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Only End Entities a| Boolean a| 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 a| Boolean a| 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 a| Boolean a| 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 a| Boolean a| What to do if the revocation server can't be reached or is busy: + +* `true` ++ +Avoid verification failure. + +* `false` ++ +Allow the verification to fail. | | +|=== + +[[CustomOcspResponder]] +=== Custom OCSP Responder + +Configures a custom OCSP responder for certification revocation checks. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Url a| String | URL of the OCSP responder. | | +| Cert Alias a| String | Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore. | | +|=== + +[[CrlFile]] +=== CRL File + +Specifies the location of the certification revocation list (CRL) file. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Path a| String | Path to the CRL file. | | +|=== + +[[Reconnection]] +=== Reconnection + +Configures a reconnection strategy for an operation. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Fails Deployment a| Boolean | Configures a reconnection strategy to use when a connector operation fails to connect to an external server. | | +| Reconnection Strategy a| * <> +* <> | Reconnection strategy to use. | | +|=== + +[[Reconnect]] +=== Reconnect + +Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Frequency a| Number | How often to attempt to reconnect, in milliseconds. | | +| Blocking a| Boolean | If `false`, the reconnection strategy runs in a separate, non-blocking thread. | | +| Count a| Number | How many reconnection attempts the Mule app can make. | | +|=== + +[[ReconnectForever]] +=== 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. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Frequency a| Number | How often to attempt to reconnect, in milliseconds. | | +| Blocking a| Boolean | If `false`, the reconnection strategy runs in a separate, non-blocking thread. | | +|=== + +[[ExpirationPolicy]] +=== Expiration Policy + +Configures an expiration policy strategy. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Max Idle Time a| Number | Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. | | +| Time Unit a| Enumeration, one of: + +** NANOSECONDS +** MICROSECONDS +** MILLISECONDS +** SECONDS +** MINUTES +** HOURS +** DAYS | Time unit for the *Max Idle Time* field. | | +|=== + +[[EmbeddingResponseAttributes]] +=== Embedding Response Attributes + +Configures the response attributes for the embedding operation. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Embedding Model Dimension a| Number | Embedding model dimension. | | +| Embedding Model Name a| String | Embedding model name. | | +| Other Attributes a| Object | Other attributes. | | +| Token Usage a| <> | Token usage. | | +|=== + +[[TokenUsage]] +=== Token Usage + +Configures token usage metadata returned as attributes. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Input Count a| Number | Number of tokens used to process the input. | | +| Output Count a| Number | Number of tokens used to generate the output. | | +| Total Count a| Number | Total number of tokens used for input and output. | | +|=== + +[[RepeatableInMemoryStream]] +=== 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. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Initial Buffer Size a| 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 a| 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 a| 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 a| Enumeration, one of: + +** BYTE +** KB +** MB +** GB | Unit for the *Initial Buffer Size*, *Buffer Size Increment*, and *Max Buffer Size* fields. | | +|=== + +[[RepeatableFileStoreStream]] +=== 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. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| In Memory Size a| Number a| 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 a| Enumeration, one of: + +** BYTE +** KB +** MB +** GB | Unit for the *In Memory Size* field. | | +|=== + +[[ErrorMapping]] +=== Error Mapping + +Configures error mapping. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Source a| Enumeration, one of: + +** ANY +** REDELIVERY_EXHAUSTED +** TRANSFORMATION +** EXPRESSION +** SECURITY +** CLIENT_SECURITY +** SERVER_SECURITY +** ROUTING +** CONNECTIVITY +** RETRY_EXHAUSTED +** TIMEOUT | Source of the error. | | +| Target a| String | Target of the error. | | x +|=== + +[[StoreResponseAttributes]] +=== Store Response Attributes + +Configures the response attributes for the store operation. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Ids a| Array of String | IDs. | | +| Metadata Condition a| String | Metadata condition. | | +| Other Attributes a| Object | Other attributes. | | +| Store Name a| String | Name of the store. | | +|=== + +[[RepeatableInMemoryIterable]] +=== Repeatable In Memory Iterable + +Configures the repeatable in memory iterable type. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Initial Buffer Size a| 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 a| 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 a| 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. | | +|=== + +[[RepeatableFileStoreIterable]] +=== Repeatable File Store Iterable + +Configures the repeatable file store iterable type. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| In Memory Objects a| Number | Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered. | | +| Buffer Unit a| Enumeration, one of: + +** BYTE +** KB +** MB +** GB | Unit for the *In Memory Objects* field. | | +|=== + +[[ParserResponseAttributes]] +=== Parser Response Attributes + +Configures the response attributes for the parser. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Document Parser Name a| String | Document parser name. | | +|=== + +[[ChunkResponseAttributes]] +=== Chunk Response Attributes + +Configures the response attributes for the chunk. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Max Overlap Size In Chars a| Number | Maximum overlap size in characters. | | +| Max Segment Size In Chars a| Number | Maximum segment size in characters. | | +|=== + +[[MultiformatDocumentParserParameters]] +=== Multiformat Document Parser Parameters + +Configures the parameters for the multiformat document parser. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Include Metadata a| Boolean | Determines whether to include metadata. | false | +|=== + +[[TextDocumentParserParameters]] +=== Text Document Parser Parameters + +Configures the parameters for the text document parser. + +[%header,cols="20s,25a,30a,15a,10a"] +|=== +| Field | Type | Description | Default Value | Required +| Document Parser a| DocumentParser | Document parser. | | +| Name a| String | Document parser name. | | +|=== + +== See Also + +* xref:index.adoc[MuleSoft Vectors Connector Overview] +* xref:connectors::introduction/introduction-to-anypoint-connectors.adoc[Introduction to Anypoint Connectors] +* https://help.salesforce.com[Salesforce Help] diff --git a/mulesoft-vectors/1.1/modules/ROOT/pages/mulesoft-vectors-connector-studio.adoc b/mulesoft-vectors/1.1/modules/ROOT/pages/mulesoft-vectors-connector-studio.adoc new file mode 100644 index 0000000000..65fdc84af8 --- /dev/null +++ b/mulesoft-vectors/1.1/modules/ROOT/pages/mulesoft-vectors-connector-studio.adoc @@ -0,0 +1,435 @@ += Using Anypoint Studio to Configure MuleSoft Vectors Connector 1.1 +:exchange-search-name: mulesoft vectors +:connector-name: MuleSoft Vectors +:lc-connector-name: mulesoft-vectors +:studio-connector-name: MuleSoft Vectors Connector + +Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. + +To add and configure a connector in Studio: + +. <>. +. <>. +. <>. +. <>. +. <>. +. <>. +. <>. + +When you run the connector, you can view the app log to check for problems in real time, as described in <>. + +If you are new to configuring connectors in Studio, see xref:connectors::introduction/intro-config-use-studio.adoc[Using Anypoint Studio to Configure a Connector]. If, after reading this topic, you need additional information about the connector fields, see the xref:{lc-connector-name}-connector-reference.adoc[{connector-name} Connector Reference]. + +[[create-mule-project]] +== Create a Mule Project + +include::connectors::partial$t-studio-partial.adoc[tags=create-project-intro] + +[[add-connector-to-project]] +== Add the Connector to Your Mule Project + +Add MuleSoft Vectors Connector to your Mule project to automatically populate the XML code with the connector's namespace and schema location and add the required dependencies to the project's `pom.xml` file: + +. In *Mule Palette*, click *(X) Search in Exchange*. +. In *Add Dependencies to Project*, type `mulesoft vectors` in the search field. +. Click *MuleSoft Vectors Connector* in *Available modules*. +. Click *Add*. +. Click *Finish*. + +Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. + +[[configure-shared-libraries]] +== Configure Shared Libraries + +To reduce the overall size of the connector and avoid adding dependencies that are not required, all the optional libraries are removed from the connector and only the required ones can be added depending on the specific use case. You can use the Mule Maven plugin to add the required dependencies to the project's `pom.xml` file. For more information about how to configure shared libraries, see xref:mule-runtime::mmp-concept.adoc#configure-shared-libraries[Configure Shared Libraries]. + +=== Embedding Models + +==== Configuration + +[source,xml,linenums] +---- +... + + + dev.langchain4j + langchain4j-core + + ... + +... + + + dev.langchain4j + langchain4j-core + 1.0.1 + + ... + +... +---- + +=== Vector Stores + +==== Connections + +[tabs] +==== +Azure AI Search:: ++ +[source,xml,linenums] +---- +... + + + dev.langchain4j + langchain4j-azure-ai-search + + ... + +... + + + dev.langchain4j + langchain4j-azure-ai-search + 1.0.1-beta6 + + ... + +... +---- + +AlloyDB:: ++ +[source,xml,linenums] +---- +... + + + dev.langchain4j + langchain4j-community-alloydb-pg + + ... + +... + + + dev.langchain4j + langchain4j-community-alloydb-pg + 1.0.1-beta6 + + ... + +... +---- + +Chroma:: ++ +[source,xml,linenums] +---- +... + + + dev.langchain4j + langchain4j-chroma + + ... + +... + + + dev.langchain4j + langchain4j-chroma + 1.0.1-beta6 + + ... + +... +---- + +Elasticsearch:: ++ +[source,xml,linenums] +---- +... + + + dev.langchain4j + langchain4j-elasticsearch + + ... + +... + + + dev.langchain4j + langchain4j-elasticsearch + 1.0.1-beta6 + + ... + +... +---- + +Milvus:: ++ +[source,xml,linenums] +---- +... + + + dev.langchain4j + langchain4j-milvus + + ... + +... + + + dev.langchain4j + langchain4j-milvus + 1.0.1-beta6 + + ... + +... +---- + +Amazon OpenSearch:: ++ +[source,xml,linenums] +---- +... + + + dev.langchain4j + langchain4j-opensearch + + ... + +... + + + dev.langchain4j + langchain4j-opensearch + 1.0.1-beta6 + + ... + +... +---- + +PGVector:: ++ +[source,xml,linenums] +---- +... + + + dev.langchain4j + langchain4j-pgvector + + ... + +... + + + dev.langchain4j + langchain4j-pgvector + 1.0.1-beta6 + + ... + +... +---- + +Pinecone:: ++ +NOTE: You can't use Pinecone with Milvus or Qdrant. ++ +[source,xml,linenums] +---- +... + + + dev.langchain4j + langchain4j-pinecone + + ... + +... + + + dev.langchain4j + langchain4j-pinecone + 1.0.1-beta6 + + ... + +... +---- + +Qdrant:: ++ +[source,xml,linenums] +---- +... + + + dev.langchain4j + langchain4j-qdrant + + + io.grpc + grpc-netty-shaded + + ... + +... + + + dev.langchain4j + langchain4j-qdrant + 1.0.1-beta6 + + + io.grpc + grpc-netty-shaded + 1.65.1 + + ... + +... +---- + +Weaviate:: ++ +[source,xml,linenums] +---- +... + + + dev.langchain4j + langchain4j-weaviate + + ... + +... + + + dev.langchain4j + langchain4j-weaviate + 1.0.1-beta6 + + ... + +... + +---- + +MongoDB Atlas:: ++ +[source,xml,linenums] +---- +... + + + dev.langchain4j + langchain4j-mongodb-atlas + + ... + +... + + + dev.langchain4j + langchain4j-mongodb-atlas + 1.0.1-beta6 + + ... + +... +---- + +Ephemeral File:: ++ +[source,xml,linenums] +---- +... + + + dev.langchain4j + langchain4j + + ... + +... + + + dev.langchain4j + langchain4j + 1.0.1 + + ... + +... +---- +==== + +[[configure-source]] +== Configure a Source + +include::connectors::partial$t-studio-partial.adoc[tags=configure-source-intro] +You can configure one of these sources to use with MuleSoft Vectors Connector: + +include::connectors::partial$t-studio-partial.adoc[tags=listener-scheduler-descriptions] + +include::connectors::partial$t-studio-partial.adoc[tags=listener-steps] + +[[add-connector-operation]] +== Add a Connector Operation to the Flow + +When you add a connector operation to your flow, you are specifying an action for that connector to perform. + +To add an operation for MuleSoft Vectors Connector, follow these steps: + +. In *Mule Palette*, select *MuleSoft Vectors Connector* and then select the operation to add. +. Drag the operation onto the Studio canvas, next to the source. + +[[configure-global-element]] +== Configure a Global Element for the Connector + +When you configure a connector, configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target vector stores and embedding providers. + +include::connectors::partial$t-studio-partial.adoc[tags=property-placeholders] + +To configure the global element for MuleSoft Vectors Connector, follow these steps. + +. Select the operation in the Studio canvas. +. On the properties screen for the operation, click the Add (*+*) icon to access the global element configuration fields. +. Choose from these configs. ++ +* Embedding Config +* Store Config +* Transform Config +. Fill out the fields depending on the operation type. +. Click *OK*. + +[[configure-other-fields]] +== Configure Additional Connector Fields + +After you configure a global element for the connector, configure the other required fields. The required fields vary depending on which connector operation you use. + +For detailed configuration information for each operation type, see xref:mulesoft-vectors-additional-config.adoc[MuleSoft Vectors - Additional Configuration Information]. + +[[view-app-log]] +== View the App Log + +include::connectors::partial$t-studio-partial.adoc[tags=view-app-log] + +== See Also + +* xref:connectors::introduction/introduction-to-anypoint-connectors.adoc[Introduction to Anypoint Connectors] +* xref:connectors::introduction/intro-config-use-studio.adoc[Using Studio to Configure a Connector] +* xref:mulesoft-vectors-connector-reference.adoc[MuleSoft Vectors Connector Reference] +* https://help.salesforce.com[Salesforce Help] \ No newline at end of file diff --git a/mulesoft-vectors/1.1/modules/ROOT/pages/mulesoft-vectors-connector-xml-maven.adoc b/mulesoft-vectors/1.1/modules/ROOT/pages/mulesoft-vectors-connector-xml-maven.adoc new file mode 100644 index 0000000000..0004174218 --- /dev/null +++ b/mulesoft-vectors/1.1/modules/ROOT/pages/mulesoft-vectors-connector-xml-maven.adoc @@ -0,0 +1,23 @@ += {connector-name} Connector {version} XML and Maven Support +:connector-name: MuleSoft Vectors +:version: 1.1.0 +:lc-connector-name: ms-vectors +:connector-xsd: ms-vectors +:group-id-exchange: com.mulesoft.connectors +:artifact-id-exchange: mule4-vectors-connector +:exchange-search-name: vectors + + +include::connectors::partial$t-xml-maven-partial.adoc[tags=topic-intro] + +== Add a Namespace for the Connector + +include::connectors::partial$t-xml-maven-partial.adoc[tags=add-namespace] + +== Add a POM File Dependency + +include::connectors::partial$t-xml-maven-partial.adoc[tags=pom-file] + +== See Also + +include::connectors::partial$t-xml-maven-partial.adoc[tags=see-also]