pinecone/component.json

900 lines
29 KiB
JSON
Raw Normal View History

2026-10-12 02:42:40 +00:00
{
"component": {
"kind": "component",
"name": "pinecone",
"title": "Pinecone",
"description": "Perform operations on the Pinecone Vector Database.",
"deprecated": false,
"firstVersion": "3.12.0",
"label": "database,ai",
"javaType": "org.apache.camel.component.pinecone.PineconeVectorDbComponent",
"supportLevel": "Stable",
"nativeSupported": true,
"metadata": {
"quarkusVersion": "3.36.0",
"camelArtifact": "org.apache.camel:camel-pinecone",
"camelVersion": "4.20.0"
},
"groupId": "org.apache.camel.quarkus",
"artifactId": "camel-quarkus-pinecone",
"version": "4.20.0 (CEQ 3.36.0)",
"scheme": "pinecone",
"extendsScheme": "",
"syntax": "pinecone:collection",
"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": "producer",
"required": false,
"type": "enum",
"javaType": "org.apache.camel.component.pinecone.PineconeVectorDbAction",
"enum": [
"CREATE_COLLECTION",
"CREATE_SERVERLESS_INDEX",
"CREATE_POD_INDEX",
"FETCH",
"UPSERT",
"DELETE_INDEX",
"DELETE_COLLECTION",
"QUERY",
"QUERY_BY_ID",
"UPDATE",
"DELETE_BY_ID"
],
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Action to perform."
},
"cloud": {
"index": 1,
"kind": "property",
"displayName": "Cloud",
"group": "producer",
"label": "producer",
"required": false,
"type": "enum",
"javaType": "java.lang.String",
"enum": [
"aws",
"azure",
"gcp"
],
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Sets the cloud type to use (aws/gcp/azure)"
},
"cloudRegion": {
"index": 2,
"kind": "property",
"displayName": "Cloud Region",
"group": "producer",
"label": "producer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Sets the cloud region"
},
"collectionDimension": {
"index": 3,
"kind": "property",
"displayName": "Collection Dimension",
"group": "producer",
"label": "producer",
"required": false,
"type": "integer",
"javaType": "java.lang.Integer",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 1536,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Sets the Collection Dimension to use (1-1536)"
},
"collectionSimilarityMetric": {
"index": 4,
"kind": "property",
"displayName": "Collection Similarity Metric",
"group": "producer",
"label": "producer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Sets the Collection Similarity Metric to use (cosine/euclidean/dotproduct)"
},
"configuration": {
"index": 5,
"kind": "property",
"displayName": "Configuration",
"group": "producer",
"label": "",
"required": false,
"type": "object",
"javaType": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"deprecated": false,
"autowired": false,
"secret": false,
"description": "The configuration;"
},
"host": {
"index": 6,
"kind": "property",
"displayName": "Host",
"group": "producer",
"label": "producer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Sets a custom host URL to connect to"
},
"indexName": {
"index": 7,
"kind": "property",
"displayName": "Index Name",
"group": "producer",
"label": "producer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Sets the index name to use"
},
"lazyStartProducer": {
"index": 8,
"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."
},
"proxyHost": {
"index": 9,
"kind": "property",
"displayName": "Proxy Host",
"group": "producer",
"label": "producer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Set the proxy host"
},
"proxyPort": {
"index": 10,
"kind": "property",
"displayName": "Proxy Port",
"group": "producer",
"label": "producer",
"required": false,
"type": "integer",
"javaType": "java.lang.Integer",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Set the proxy port"
},
"autowiredEnabled": {
"index": 11,
"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."
},
"tls": {
"index": 12,
"kind": "property",
"displayName": "Tls",
"group": "security",
"label": "security",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Whether the client uses Transport Layer Security (TLS) to secure communications"
},
"token": {
"index": 13,
"kind": "property",
"displayName": "Token",
"group": "security",
"label": "security",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": true,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Sets the API key to use for authentication"
}
},
"headers": {
"CamelPineconeAction": {
"index": 0,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "String",
"enum": [
"CREATE_COLLECTION",
"CREATE_SERVERLESS_INDEX",
"CREATE_POD_INDEX",
"FETCH",
"UPSERT",
"DELETE_INDEX",
"DELETE_COLLECTION",
"QUERY",
"QUERY_BY_ID",
"UPDATE",
"DELETE_BY_ID"
],
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The action to be performed.",
"constantName": "org.apache.camel.component.pinecone.PineconeVectorDbHeaders#ACTION"
},
"CamelPineconeTextFieldName": {
"index": 1,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Text Field Name for Insert/Upsert operation",
"constantName": "org.apache.camel.component.pinecone.PineconeVectorDbHeaders#TEXT_FIELD_NAME"
},
"CamelPineconeVectorFieldName": {
"index": 2,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Vector Field Name for Insert/Upsert operation",
"constantName": "org.apache.camel.component.pinecone.PineconeVectorDbHeaders#VECTOR_FIELD_NAME"
},
"CamelPineconeIndexName": {
"index": 3,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Index Name",
"constantName": "org.apache.camel.component.pinecone.PineconeVectorDbHeaders#INDEX_NAME"
},
"CamelPineconeIndexPodType": {
"index": 4,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Index Pod Type",
"constantName": "org.apache.camel.component.pinecone.PineconeVectorDbHeaders#INDEX_POD_TYPE"
},
"CamelPineconeIndexPodEnvironment": {
"index": 5,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Index Pod Environment",
"constantName": "org.apache.camel.component.pinecone.PineconeVectorDbHeaders#INDEX_POD_ENVIRONMENT"
},
"CamelPineconeCollectionName": {
"index": 6,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Collection Name for Insert/Upsert operation",
"constantName": "org.apache.camel.component.pinecone.PineconeVectorDbHeaders#COLLECTION_NAME"
},
"CamelPineconeCollectionSimilarityMetric": {
"index": 7,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "String",
"enum": [
"cosine",
"euclidean",
"dotproduct"
],
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Collection Similarity Metric",
"constantName": "org.apache.camel.component.pinecone.PineconeVectorDbHeaders#COLLECTION_SIMILARITY_METRIC"
},
"CamelPineconeCollectionDimension": {
"index": 8,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "int",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Collection Dimension",
"constantName": "org.apache.camel.component.pinecone.PineconeVectorDbHeaders#COLLECTION_DIMENSION"
},
"CamelPineconeCollectionCloud": {
"index": 9,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "String",
"enum": [
"aws",
"gcp",
"azure"
],
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Collection Cloud Vendor",
"constantName": "org.apache.camel.component.pinecone.PineconeVectorDbHeaders#COLLECTION_CLOUD"
},
"CamelPineconeCollectionCloudRegion": {
"index": 10,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "String",
"enum": [
"aws",
"gcp",
"azure"
],
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Collection Cloud Vendor Region",
"constantName": "org.apache.camel.component.pinecone.PineconeVectorDbHeaders#COLLECTION_CLOUD_REGION"
},
"CamelPineconeIndexId": {
"index": 11,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Index Upsert Id",
"constantName": "org.apache.camel.component.pinecone.PineconeVectorDbHeaders#INDEX_ID"
},
"CamelPineconeQueryTopK": {
"index": 12,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "Integer",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Query Top K",
"constantName": "org.apache.camel.component.pinecone.PineconeVectorDbHeaders#QUERY_TOP_K"
},
"CamelPineconeNamespace": {
"index": 13,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Namespace for actions (query/upsert/etc)",
"constantName": "org.apache.camel.component.pinecone.PineconeVectorDbHeaders#NAMESPACE"
},
"CamelPineconeQueryFilter": {
"index": 14,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Query Filter",
"constantName": "org.apache.camel.component.pinecone.PineconeVectorDbHeaders#QUERY_FILTER"
},
"CamelPineconeQueryIncludeValues": {
"index": 15,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "boolean",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Query Include Values",
"constantName": "org.apache.camel.component.pinecone.PineconeVectorDbHeaders#QUERY_INCLUDE_VALUES"
},
"CamelPineconeQueryIncludeMetadata": {
"index": 16,
"kind": "header",
"displayName": "",
"group": "producer",
"label": "",
"required": false,
"javaType": "com.google.protobuf.Struct",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "Query Include Metadata",
"constantName": "org.apache.camel.component.pinecone.PineconeVectorDbHeaders#QUERY_INCLUDE_METADATA"
}
},
"properties": {
"collection": {
"index": 0,
"kind": "path",
"displayName": "Collection",
"group": "producer",
"label": "",
"required": true,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"description": "The collection Name. (Only used by some actions)"
},
"action": {
"index": 1,
"kind": "parameter",
"displayName": "Action",
"group": "producer",
"label": "producer",
"required": false,
"type": "enum",
"javaType": "org.apache.camel.component.pinecone.PineconeVectorDbAction",
"enum": [
"CREATE_COLLECTION",
"CREATE_SERVERLESS_INDEX",
"CREATE_POD_INDEX",
"FETCH",
"UPSERT",
"DELETE_INDEX",
"DELETE_COLLECTION",
"QUERY",
"QUERY_BY_ID",
"UPDATE",
"DELETE_BY_ID"
],
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Action to perform."
},
"cloud": {
"index": 2,
"kind": "parameter",
"displayName": "Cloud",
"group": "producer",
"label": "producer",
"required": false,
"type": "enum",
"javaType": "java.lang.String",
"enum": [
"aws",
"azure",
"gcp"
],
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Sets the cloud type to use (aws/gcp/azure)"
},
"cloudRegion": {
"index": 3,
"kind": "parameter",
"displayName": "Cloud Region",
"group": "producer",
"label": "producer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Sets the cloud region"
},
"collectionDimension": {
"index": 4,
"kind": "parameter",
"displayName": "Collection Dimension",
"group": "producer",
"label": "producer",
"required": false,
"type": "integer",
"javaType": "java.lang.Integer",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": 1536,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Sets the Collection Dimension to use (1-1536)"
},
"collectionSimilarityMetric": {
"index": 5,
"kind": "parameter",
"displayName": "Collection Similarity Metric",
"group": "producer",
"label": "producer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Sets the Collection Similarity Metric to use (cosine/euclidean/dotproduct)"
},
"host": {
"index": 6,
"kind": "parameter",
"displayName": "Host",
"group": "producer",
"label": "producer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Sets a custom host URL to connect to"
},
"indexName": {
"index": 7,
"kind": "parameter",
"displayName": "Index Name",
"group": "producer",
"label": "producer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Sets the index name to use"
},
"proxyHost": {
"index": 8,
"kind": "parameter",
"displayName": "Proxy Host",
"group": "producer",
"label": "producer",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Set the proxy host"
},
"proxyPort": {
"index": 9,
"kind": "parameter",
"displayName": "Proxy Port",
"group": "producer",
"label": "producer",
"required": false,
"type": "integer",
"javaType": "java.lang.Integer",
"deprecated": false,
"autowired": false,
"secret": false,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Set the proxy port"
},
"lazyStartProducer": {
"index": 10,
"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."
},
"tls": {
"index": 11,
"kind": "parameter",
"displayName": "Tls",
"group": "security",
"label": "security",
"required": false,
"type": "boolean",
"javaType": "boolean",
"deprecated": false,
"autowired": false,
"secret": false,
"defaultValue": true,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Whether the client uses Transport Layer Security (TLS) to secure communications"
},
"token": {
"index": 12,
"kind": "parameter",
"displayName": "Token",
"group": "security",
"label": "security",
"required": false,
"type": "string",
"javaType": "java.lang.String",
"deprecated": false,
"deprecationNote": "",
"autowired": false,
"secret": true,
"configurationClass": "org.apache.camel.component.pinecone.PineconeVectorDbConfiguration",
"configurationField": "configuration",
"description": "Sets the API key to use for authentication"
}
},
"propertiesSchema": {
"properties": {
"collection": {
"title": "Collection",
"description": "The collection Name. (Only used by some actions)",
"type": "string",
"$comment": "group:producer"
},
"action": {
"title": "Action",
"description": "Action to perform.",
"type": "string",
"enum": [
"CREATE_COLLECTION",
"CREATE_SERVERLESS_INDEX",
"CREATE_POD_INDEX",
"FETCH",
"UPSERT",
"DELETE_INDEX",
"DELETE_COLLECTION",
"QUERY",
"QUERY_BY_ID",
"UPDATE",
"DELETE_BY_ID"
],
"$comment": "group:producer"
},
"cloud": {
"title": "Cloud",
"description": "Sets the cloud type to use (aws/gcp/azure)",
"type": "string",
"enum": [
"aws",
"azure",
"gcp"
],
"$comment": "group:producer"
},
"cloudRegion": {
"title": "Cloud Region",
"description": "Sets the cloud region",
"type": "string",
"$comment": "group:producer"
},
"collectionDimension": {
"title": "Collection Dimension",
"description": "Sets the Collection Dimension to use (1-1536)",
"type": "integer",
"$comment": "group:producer",
"default": 1536
},
"collectionSimilarityMetric": {
"title": "Collection Similarity Metric",
"description": "Sets the Collection Similarity Metric to use (cosine/euclidean/dotproduct)",
"type": "string",
"$comment": "group:producer"
},
"host": {
"title": "Host",
"description": "Sets a custom host URL to connect to",
"type": "string",
"$comment": "group:producer"
},
"indexName": {
"title": "Index Name",
"description": "Sets the index name to use",
"type": "string",
"$comment": "group:producer"
},
"proxyHost": {
"title": "Proxy Host",
"description": "Set the proxy host",
"type": "string",
"$comment": "group:producer"
},
"proxyPort": {
"title": "Proxy Port",
"description": "Set the proxy port",
"type": "integer",
"$comment": "group:producer"
},
"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
},
"tls": {
"title": "Tls",
"description": "Whether the client uses Transport Layer Security (TLS) to secure communications",
"type": "boolean",
"$comment": "group:security",
"default": true
},
"token": {
"title": "Token",
"description": "Sets the API key to use for authentication",
"type": "string",
"$comment": "group:security",
"format": "password"
}
},
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"required": [
"collection"
]
}
}