langchain4j-embeddingstore/component.json

455 lines
17 KiB
JSON
Raw Normal View History

{
"component": {
"kind": "component",
"name": "langchain4j-embeddingstore",
"title": "LangChain4j Embedding Store",
"description": "Perform operations on the Langchain4jEmbeddingStores.",
"deprecated": false,
"firstVersion": "3.29.0",
"label": "database,ai",
"javaType": "org.apache.camel.component.langchain4j.embeddingstore.LangChain4jEmbeddingStoreComponent",
"supportLevel": "Stable",
"nativeSupported": true,
"metadata": {
"quarkusVersion": "3.36.0",
"camelArtifact": "org.apache.camel:camel-langchain4j-embeddingstore",
"camelVersion": "4.20.0"
},
"groupId": "org.apache.camel.quarkus",
"artifactId": "camel-quarkus-langchain4j-embeddingstore",
"version": "4.20.0 (CEQ 3.36.0)",
"scheme": "langchain4j-embeddingstore",
"extendsScheme": "",
"syntax": "langchain4j-embeddingstore:embeddingStoreId",
"async": false,
"api": false,
"consumerOnly": false,
"producerOnly": true,
"lenientProperties": false,
"browsable": false,
"remote": true
},
"componentProperties": {
"action": {
"index": 0,
"kind": "property",
"displayName": "Action",
"group": "producer",
"label": "",
"required": false,
"type": "enum",
"javaType": "org.apache.camel.component.langchain4j.embeddingstore.LangChain4jEmbeddingStoreAction",
"enum": [
"ADD",
"REMOVE",
"SEARCH"
],
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.langchain4j.embeddingstore.LangChain4jEmbeddingStoreConfiguration",
"configurationField": "configuration",
"description": "The operation to perform: ADD, REMOVE, or SEARCH"
},
"configuration": {
"index": 1,
"kind": "property",
"displayName": "Configuration",
"group": "producer",
"label": "",
"required": false,
"type": "object",
"javaType": "org.apache.camel.component.langchain4j.embeddingstore.LangChain4jEmbeddingStoreConfiguration",
"deprecated": false,
"autowired": false,
"secret": false,
"description": "The configuration;"
},
"embeddingStore": {
"index": 2,
"kind": "property",
"displayName": "Embedding Store",
"group": "producer",
"label": "",
"required": false,
"type": "object",
"javaType": "dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment>",
"deprecated": false,
"deprecationNote": "",
"autowired": true,
"secret": false,
"configurationClass": "org.apache.camel.component.langchain4j.embeddingstore.LangChain4jEmbeddingStoreConfiguration",
"configurationField": "configuration",
"description": "Direct embedding store instance for vector operations"
},
"embeddingStoreFactory": {
"index": 3,
"kind": "property",
"displayName": "Embedding Store Factory",
"group": "producer",
"label": "",
"required": false,
"type": "object",
"javaType": "org.apache.camel.component.langchain4j.embeddingstore.EmbeddingStoreFactory",
"deprecated": false,
"deprecationNote": "",
"autowired": true,
"secret": false,
"configurationClass": "org.apache.camel.component.langchain4j.embeddingstore.LangChain4jEmbeddingStoreConfiguration",
"configurationField": "configuration",
"description": "The embedding store factory to use for creating embedding stores if no embeddingstore is provided"
},
"lazyStartProducer": {
"index": 4,
"kind": "property",
"displayName": "Lazy Start Producer",
"group": "producer",
"label": "producer",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing."
},
"maxResults": {
"index": 5,
"kind": "property",
"displayName": "Max Results",
"group": "producer",
"label": "",
"required": false,
"type": "integer",
"javaType": "java.lang.Integer",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 5,
"configurationClass": "org.apache.camel.component.langchain4j.embeddingstore.LangChain4jEmbeddingStoreConfiguration",
"configurationField": "configuration",
"description": "Maximum number of results to return for SEARCH operation"
},
"minScore": {
"index": 6,
"kind": "property",
"displayName": "Min Score",
"group": "producer",
"label": "",
"required": false,
"type": "number",
"javaType": "java.lang.Double",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.langchain4j.embeddingstore.LangChain4jEmbeddingStoreConfiguration",
"configurationField": "configuration",
"description": "Minimum similarity score threshold for SEARCH operation (0.0 to 1.0)"
},
"returnTextContent": {
"index": 7,
"kind": "property",
"displayName": "Return Text Content",
"group": "producer",
"label": "",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.langchain4j.embeddingstore.LangChain4jEmbeddingStoreConfiguration",
"configurationField": "configuration",
"description": "When true, SEARCH returns List with text content instead of List"
},
"autowiredEnabled": {
"index": 8,
"kind": "property",
"displayName": "Autowired Enabled",
"group": "advanced",
"label": "advanced",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc."
}
},
"headers": {
"CamelLangchain4jEmbeddingStoreAction": {
"index": 0,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "String",
"enum": [
"ADD",
"REMOVE",
"SEARCH"
],
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The action to be performed.",
"constantName": "org.apache.camel.component.langchain4j.embeddingstore.LangChain4jEmbeddingStoreHeaders#ACTION"
},
"CamelLangchain4jEmbeddingStoreMaxResults": {
"index": 1,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "Integer",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"defaultValue": "5",
"description": "Maximum number of search results to return",
"constantName": "org.apache.camel.component.langchain4j.embeddingstore.LangChain4jEmbeddingStoreHeaders#MAX_RESULTS"
},
"CamelLangchain4jEmbeddingStoreMinScore": {
"index": 2,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "Double",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Minimum similarity score for search results",
"constantName": "org.apache.camel.component.langchain4j.embeddingstore.LangChain4jEmbeddingStoreHeaders#MIN_SCORE"
},
"CamelLangchain4jEmbeddingStoreFilter": {
"index": 3,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "dev.langchain4j.store.embedding.filter.Filter",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Search filter for metadata-based constraints",
"constantName": "org.apache.camel.component.langchain4j.embeddingstore.LangChain4jEmbeddingStoreHeaders#FILTER"
}
},
"properties": {
"embeddingStoreId": {
"index": 0,
"kind": "path",
"displayName": "Embedding Store Id",
"group": "producer",
"label": "",
"required": true,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The id of the embedding store"
},
"action": {
"index": 1,
"kind": "parameter",
"displayName": "Action",
"group": "producer",
"label": "",
"required": false,
"type": "enum",
"javaType": "org.apache.camel.component.langchain4j.embeddingstore.LangChain4jEmbeddingStoreAction",
"enum": [
"ADD",
"REMOVE",
"SEARCH"
],
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.langchain4j.embeddingstore.LangChain4jEmbeddingStoreConfiguration",
"configurationField": "configuration",
"description": "The operation to perform: ADD, REMOVE, or SEARCH"
},
"embeddingStore": {
"index": 2,
"kind": "parameter",
"displayName": "Embedding Store",
"group": "producer",
"label": "",
"required": false,
"type": "object",
"javaType": "dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment>",
"deprecated": false,
"deprecationNote": "",
"autowired": true,
"secret": false,
"configurationClass": "org.apache.camel.component.langchain4j.embeddingstore.LangChain4jEmbeddingStoreConfiguration",
"configurationField": "configuration",
"description": "Direct embedding store instance for vector operations"
},
"embeddingStoreFactory": {
"index": 3,
"kind": "parameter",
"displayName": "Embedding Store Factory",
"group": "producer",
"label": "",
"required": false,
"type": "object",
"javaType": "org.apache.camel.component.langchain4j.embeddingstore.EmbeddingStoreFactory",
"deprecated": false,
"deprecationNote": "",
"autowired": true,
"secret": false,
"configurationClass": "org.apache.camel.component.langchain4j.embeddingstore.LangChain4jEmbeddingStoreConfiguration",
"configurationField": "configuration",
"description": "The embedding store factory to use for creating embedding stores if no embeddingstore is provided"
},
"maxResults": {
"index": 4,
"kind": "parameter",
"displayName": "Max Results",
"group": "producer",
"label": "",
"required": false,
"type": "integer",
"javaType": "java.lang.Integer",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 5,
"configurationClass": "org.apache.camel.component.langchain4j.embeddingstore.LangChain4jEmbeddingStoreConfiguration",
"configurationField": "configuration",
"description": "Maximum number of results to return for SEARCH operation"
},
"minScore": {
"index": 5,
"kind": "parameter",
"displayName": "Min Score",
"group": "producer",
"label": "",
"required": false,
"type": "number",
"javaType": "java.lang.Double",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.langchain4j.embeddingstore.LangChain4jEmbeddingStoreConfiguration",
"configurationField": "configuration",
"description": "Minimum similarity score threshold for SEARCH operation (0.0 to 1.0)"
},
"returnTextContent": {
"index": 6,
"kind": "parameter",
"displayName": "Return Text Content",
"group": "producer",
"label": "",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"configurationClass": "org.apache.camel.component.langchain4j.embeddingstore.LangChain4jEmbeddingStoreConfiguration",
"configurationField": "configuration",
"description": "When true, SEARCH returns List with text content instead of List"
},
"lazyStartProducer": {
"index": 7,
"kind": "parameter",
"displayName": "Lazy Start Producer",
"group": "producer (advanced)",
"label": "producer,advanced",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": false,
"description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing."
}
},
"propertiesSchema": {
"properties": {
"embeddingStoreId": {
"title": "Embedding Store Id",
"description": "The id of the embedding store",
"type": "string",
"$comment": "group:producer"
},
"action": {
"title": "Action",
"description": "The operation to perform: ADD, REMOVE, or SEARCH",
"type": "string",
"enum": [
"ADD",
"REMOVE",
"SEARCH"
],
"$comment": "group:producer"
},
"embeddingStore": {
"title": "Embedding Store",
"description": "Direct embedding store instance for vector operations",
"type": "string",
"$comment": "group:producer",
"format": "bean:dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment>"
},
"embeddingStoreFactory": {
"title": "Embedding Store Factory",
"description": "The embedding store factory to use for creating embedding stores if no embeddingstore is provided",
"type": "string",
"$comment": "group:producer",
"format": "bean:org.apache.camel.component.langchain4j.embeddingstore.EmbeddingStoreFactory"
},
"maxResults": {
"title": "Max Results",
"description": "Maximum number of results to return for SEARCH operation",
"type": "integer",
"$comment": "group:producer",
"default": 5
},
"minScore": {
"title": "Min Score",
"description": "Minimum similarity score threshold for SEARCH operation (0.0 to 1.0)",
"type": "number",
"$comment": "group:producer"
},
"returnTextContent": {
"title": "Return Text Content",
"description": "When true, SEARCH returns List with text content instead of List",
"type": "boolean",
"$comment": "group:producer",
"default": false
},
"lazyStartProducer": {
"title": "Lazy Start Producer",
"description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.",
"type": "boolean",
"$comment": "group:producer (advanced)",
"default": false
}
},
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"required": [
"embeddingStoreId"
]
}
}