Embeddings Vector DB Outbound Connector

Embed and download documents with vector databases

outbound io.camunda:embeddings-vector-database:1

Required inputs

Key	Label	Type
`vectorDatabaseConnectorOperation.query.query`	Search query	FEEL expression
`vectorDatabaseConnectorOperation.query.maxResults`	Max results	string
`embeddingModelProvider.endpoint`	Endpoint	FEEL expression
`embeddingModelProvider.authentication.apiKey`	API key	secret
`embeddingModelProvider.authentication.clientId`	Client ID	FEEL expression
`embeddingModelProvider.authentication.clientSecret`	Client secret	secret
`embeddingModelProvider.authentication.tenantId`	Tenant ID	FEEL expression
`embeddingModelProvider.deploymentName`	Model deployment name	FEEL expression
`embeddingModelProvider.bedrockAccessKey`	Access key	secret
`embeddingModelProvider.bedrockSecretKey`	Secret key	secret
`embeddingModelProvider.bedrockRegion`	Region	FEEL expression
`embeddingModelProvider.modelName`	Model name	string
`embeddingModelProvider.bedrockCustomModelName`	Custom model name	FEEL expression
`embeddingModelProvider.bedrockDimensions`	Embedding dimensions	string
`embeddingModelProvider.bedrockNormalize`	Normalize	string
`embeddingModelProvider.projectId`	Project ID	FEEL expression
`embeddingModelProvider.region`	Region	FEEL expression
`embeddingModelProvider.vertexAiAuthentication.jsonKey`	JSON key of the service account	FEEL expression
`embeddingModelProvider.vertexAiModelName`	Model name	FEEL expression
`embeddingModelProvider.vertexAiDimensions`	Embedding dimensions	FEEL expression
`embeddingModelProvider.openAiApiKey`	OpenAI API key	secret
`embeddingModelProvider.openAiModelName`	Model name	FEEL expression
`vectorStore.amazonManagedOpensearch.accessKey`	Access key	secret
`vectorStore.amazonManagedOpensearch.secretKey`	Secret key	secret
`vectorStore.amazonManagedOpensearch.serverUrl`	Server URL	FEEL expression
`vectorStore.amazonManagedOpensearch.region`	Region	FEEL expression
`vectorStore.amazonManagedOpensearch.indexName`	Index name	FEEL expression
`vectorStore.azureAiSearch.endpoint`	Endpoint	FEEL expression
`vectorStore.azureAiSearchAuthentication.apiKey`	API key	secret
`vectorStore.azureAiSearchAuthentication.clientId`	Client ID	FEEL expression
`vectorStore.azureAiSearchAuthentication.clientSecret`	Client secret	secret
`vectorStore.azureAiSearchAuthentication.tenantId`	Tenant ID	FEEL expression
`vectorStore.azureAiSearch.indexName`	Index name	FEEL expression
`vectorStore.azureCosmosDbNoSql.endpoint`	Endpoint	FEEL expression
`vectorStore.azureCosmosDbAuthentication.apiKey`	API key	secret
`vectorStore.azureCosmosDbAuthentication.clientId`	Client ID	FEEL expression
`vectorStore.azureCosmosDbAuthentication.clientSecret`	Client secret	secret
`vectorStore.azureCosmosDbAuthentication.tenantId`	Tenant ID	FEEL expression
`vectorStore.azureCosmosDbNoSql.databaseName`	Database name	FEEL expression
`vectorStore.azureCosmosDbNoSql.containerName`	Container name	FEEL expression
`vectorStore.azureCosmosDbNoSql.consistencyLevel`	Consistency level	string
`vectorStore.azureCosmosDbNoSql.distanceFunction`	Distance function	string
`vectorStore.azureCosmosDbNoSql.vectorIndexType`	Vector index type	string
`vectorStore.embeddingsStore.elasticsearch.baseUrl`	Base URL	FEEL expression
`vectorStore.embeddingsStore.elasticsearch.username`	Username	FEEL expression
`vectorStore.embeddingsStore.elasticsearch.password`	Password	secret
`vectorStore.embeddingsStore.elasticsearch.indexName`	Index name	FEEL expression
`vectorStore.embeddingsStore.opensearch.baseUrl`	Base URL	FEEL expression
`vectorStore.embeddingsStore.opensearch.username`	Username	FEEL expression
`vectorStore.embeddingsStore.opensearch.password`	Password	secret
`vectorStore.embeddingsStore.opensearch.indexName`	Index name	FEEL expression
`vectorDatabaseConnectorOperation.documentSource`	Document source	string
`vectorDatabaseConnectorOperation.documentSourceFromProcessVariable`	Plain text to embed	FEEL expression
`vectorDatabaseConnectorOperation.newDocuments`	Documents	FEEL expression
`vectorDatabaseConnectorOperation.documentSplitter.document.splitter.recursive.maxSegmentSizeInChars`	Max chars	string
`vectorDatabaseConnectorOperation.documentSplitter.document.splitter.recursive.maxOverlapSizeInChars`	Max overlap window	string

Optional inputs

Key	Label	Type
`vectorDatabaseConnectorOperation.operationType`	Operation	string
`vectorDatabaseConnectorOperation.query.minScore`	Min score	string
`embeddingModelProvider.modelProvider`	Model provider	string
`embeddingModelProvider.authentication.type`	Authentication	string
`embeddingModelProvider.authentication.authorityHost`	Authority host	FEEL expression
`embeddingModelProvider.dimensions`	Embedding dimensions	FEEL expression
`embeddingModelProvider.maxRetries`	Max retries	string
`embeddingModelProvider.customHeaders`	Custom headers	FEEL expression
`embeddingModelProvider.bedrockMaxRetries`	Max retries	string
`embeddingModelProvider.vertexAiAuthentication.type`	Authentication	string
`embeddingModelProvider.publisher`	Publisher	FEEL expression
`embeddingModelProvider.vertexAiMaxRetries`	Max retries	string
`embeddingModelProvider.openAiOrganizationId`	Organization ID	FEEL expression
`embeddingModelProvider.openAiProjectId`	Project ID	FEEL expression
`embeddingModelProvider.openAiDimensions`	Embedding dimensions	FEEL expression
`embeddingModelProvider.openAiMaxRetries`	Max retries	string
`embeddingModelProvider.openAiCustomHeaders`	Custom headers	FEEL expression
`embeddingModelProvider.openAiBaseUrl`	Custom base URL	FEEL expression
`vectorStore.vectorStore`	Embeddings store	string
`vectorStore.azureAiSearchAuthentication.type`	Authentication	string
`vectorStore.azureAiSearchAuthentication.authorityHost`	Authority host	FEEL expression
`vectorStore.azureCosmosDbAuthentication.type`	Authentication	string
`vectorStore.azureCosmosDbAuthentication.authorityHost`	Authority host	FEEL expression
`vectorDatabaseConnectorOperation.documentSplitter.documentSplitter`	Document splitting strategy	string
`resultVariable`	Result variable	string
`resultExpression`	Result expression	FEEL expression
`errorExpression`	Error expression	FEEL expression
`retryCount`	Retries	FEEL expression
`retryBackoff`	Retry backoff	string

Apply this connector with @bpmnkit/connectors

import { applyConnectorTemplate } from "@bpmnkit/connectors" const result = applyConnectorTemplate("io.camunda.connectors.EmbeddingsVectorDB.v1", { "vectorDatabaseConnectorOperation.query.query": "= ...", "vectorDatabaseConnectorOperation.query.maxResults": 5, "embeddingModelProvider.endpoint": "= ...", "embeddingModelProvider.authentication.apiKey": "<your api key>", "embeddingModelProvider.authentication.clientId": "= ...", "embeddingModelProvider.authentication.clientSecret": "<your client secret>", "embeddingModelProvider.authentication.tenantId": "= ...", "embeddingModelProvider.deploymentName": "= ...", "embeddingModelProvider.bedrockAccessKey": "<your access key>", "embeddingModelProvider.bedrockSecretKey": "<your secret key>", "embeddingModelProvider.bedrockRegion": "= ...", "embeddingModelProvider.modelName": "Custom", "embeddingModelProvider.bedrockCustomModelName": "= ...", "embeddingModelProvider.bedrockDimensions": "D256", "embeddingModelProvider.bedrockNormalize": false, "embeddingModelProvider.projectId": "= ...", "embeddingModelProvider.region": "= ...", "embeddingModelProvider.vertexAiAuthentication.jsonKey": "= ...", "embeddingModelProvider.vertexAiModelName": "= ...", "embeddingModelProvider.vertexAiDimensions": "= ...", "embeddingModelProvider.openAiApiKey": "<your openai api key>", "embeddingModelProvider.openAiModelName": "= ...", "vectorStore.amazonManagedOpensearch.accessKey": "<your access key>", "vectorStore.amazonManagedOpensearch.secretKey": "<your secret key>", "vectorStore.amazonManagedOpensearch.serverUrl": "= ...", "vectorStore.amazonManagedOpensearch.region": "= ...", "vectorStore.amazonManagedOpensearch.indexName": "= ...", "vectorStore.azureAiSearch.endpoint": "= ...", "vectorStore.azureAiSearchAuthentication.apiKey": "<your api key>", "vectorStore.azureAiSearchAuthentication.clientId": "= ...", "vectorStore.azureAiSearchAuthentication.clientSecret": "<your client secret>", "vectorStore.azureAiSearchAuthentication.tenantId": "= ...", "vectorStore.azureAiSearch.indexName": "= ...", "vectorStore.azureCosmosDbNoSql.endpoint": "= ...", "vectorStore.azureCosmosDbAuthentication.apiKey": "<your api key>", "vectorStore.azureCosmosDbAuthentication.clientId": "= ...", "vectorStore.azureCosmosDbAuthentication.clientSecret": "<your client secret>", "vectorStore.azureCosmosDbAuthentication.tenantId": "= ...", "vectorStore.azureCosmosDbNoSql.databaseName": "= ...", "vectorStore.azureCosmosDbNoSql.containerName": "= ...", "vectorStore.azureCosmosDbNoSql.consistencyLevel": "STRONG", "vectorStore.azureCosmosDbNoSql.distanceFunction": "EUCLIDEAN", "vectorStore.azureCosmosDbNoSql.vectorIndexType": "FLAT", "vectorStore.embeddingsStore.elasticsearch.baseUrl": "= ...", "vectorStore.embeddingsStore.elasticsearch.username": "= ...", "vectorStore.embeddingsStore.elasticsearch.password": "<your password>", "vectorStore.embeddingsStore.elasticsearch.indexName": "= ...", "vectorStore.embeddingsStore.opensearch.baseUrl": "= ...", "vectorStore.embeddingsStore.opensearch.username": "= ...", "vectorStore.embeddingsStore.opensearch.password": "<your password>", "vectorStore.embeddingsStore.opensearch.indexName": "= ...", "vectorDatabaseConnectorOperation.documentSource": "CamundaDocument", "vectorDatabaseConnectorOperation.documentSourceFromProcessVariable": "= ...", "vectorDatabaseConnectorOperation.newDocuments": "= ...", "vectorDatabaseConnectorOperation.documentSplitter.document.splitter.recursive.maxSegmentSizeInChars": 500, "vectorDatabaseConnectorOperation.documentSplitter.document.splitter.recursive.maxOverlapSizeInChars": 80, "vectorDatabaseConnectorOperation.operationType": "OPERATION_EMBED_DOCUMENT", "vectorDatabaseConnectorOperation.query.minScore": "...", })