Management API Reference for neo4j-embedding-store

Neo4J embedding store for AI.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.ai.embedding.store	true	/subsystem=ai/weaviate-embedding-store=* /subsystem=ai/in-memory-embedding-store=* /subsystem=ai/chroma-embedding-store=*

Attributes (12)

bolt-url - The Bolt URL to connect to the Neo4J server.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The Bolt URL to connect to the Neo4J server.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

credential-reference - Credential (from Credential Store) to authenticate to Neo4J.

Type	OBJECT
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Credential (from Credential Store) to authenticate to Neo4J.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-constraints" : {"sensitive" : {"credential" : {"type" : "core"}}}, "value-type" : { "store" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the credential store holding the alias to credential", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.credential-store", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "alias" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The alias which denotes stored secret or credential in the store", "expressions-allowed" : true, "required" : false, "nillable" : true, "requires" : ["store"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of credential this reference is denoting", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "clear-text" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Secret specified using clear text (check credential store way of supplying credential/secrets to services)", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

database-name - The Neo4J database name.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The Neo4J database name.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

dimension - The dimension of the embedding.

Type	INT
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Min	1
Max	2147483647
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The dimension of the embedding.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

embedding-property - The name of the property to store the embedding.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the property to store the embedding.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

id-property - The optional id property name.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The optional id property name.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

index-name - The optional index name.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The optional index name.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

label - The optional label name.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The optional label name.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

metadata-prefix - The optional metadata prefix.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The optional metadata prefix.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

retrieval-query - The optional retrieval query.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The optional retrieval query.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

text-property - The optional textProperty property name

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The optional textProperty property name", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

username - The username to connect to Neo4J.

Type	STRING
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The username to connect to Neo4J.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

Operations (2)

add - This operation adds a Neo4J embedding store.

Request Parameter	Type	Required	Expressions Allowed	Description
bolt-url	STRING	false	true	The Bolt URL to connect to the Neo4J server.
credential-reference	OBJECT	false	false	Credential (from Credential Store) to authenticate to Neo4J.
database-name	STRING	false	true	The Neo4J database name.
dimension	INT	true	true	The dimension of the embedding.
embedding-property	STRING	false	true	The name of the property to store the embedding.
id-property	STRING	false	true	The optional id property name.
index-name	STRING	false	true	The optional index name.
label	STRING	false	true	The optional label name.
metadata-prefix	STRING	false	true	The optional metadata prefix.
retrieval-query	STRING	false	true	The optional retrieval query.
text-property	STRING	false	true	The optional textProperty property name
username	STRING	true	true	The username to connect to Neo4J.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "This operation adds a Neo4J embedding store.",
    "request-properties" : {
        "bolt-url" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The Bolt URL to connect to the Neo4J server.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "credential-reference" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Credential (from Credential Store) to authenticate to Neo4J.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "store" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The name of the credential store holding the alias to credential",
                    "expressions-allowed" : false,
                    "required" : false,
                    "nillable" : true,
                    "capability-reference" : "org.wildfly.security.credential-store",
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "alias" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The alias which denotes stored secret or credential in the store",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "requires" : ["store"],
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "type" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The type of credential this reference is denoting",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "clear-text" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Secret specified using clear text (check credential store way of supplying credential/secrets to services)",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                }
            }
        },
        "database-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The Neo4J database name.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "dimension" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The dimension of the embedding.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        },
        "embedding-property" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the property to store the embedding.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "id-property" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The optional id property name.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "index-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The optional index name.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "label" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The optional label name.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "metadata-prefix" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The optional metadata prefix.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "retrieval-query" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The optional retrieval query.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "text-property" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The optional textProperty property name",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "username" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The username to connect to Neo4J.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - This operation removes a Neo4J embedding store.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "This operation removes a Neo4J embedding store.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.ai.neo4j-embedding-store

        
<feature spec="subsystem.ai.neo4j-embedding-store">
  <param name="neo4j-embedding-store" value="{resource name}"/>
  <param name="bolt-url" value="{value}"/>
  <param name="credential-reference" value="{value}"/>
  <param name="database-name" value="{value}"/>
  <param name="dimension" value="{value}"/>
  <param name="embedding-property" value="{value}"/>
  <param name="id-property" value="{value}"/>
  <param name="index-name" value="{value}"/>
  <param name="label" value="{value}"/>
  <param name="metadata-prefix" value="{value}"/>
  <param name="retrieval-query" value="{value}"/>
  <param name="text-property" value="{value}"/>
  <param name="username" value="{value}"/>
<feature/>