Management API Reference for weaviate-embedding-store

Weaviate embedding store for AI.

Provided Capabilities (1)

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

Attributes (6)

avoid-dups - If true the object id is a hashed ID based on provided text segment else a random ID will be generated.

Type	BOOLEAN
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If true the object id is a hashed ID based on provided text segment else a random ID will be generated.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

consistency-level - How the consistency is tuned when writing into weaviate embedding store.

Type	STRING
Default Value	ALL
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Allowed Values	ALL QUORUM ONE
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "How the consistency is tuned when writing into weaviate embedding store.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "ALL", "min-length" : 1, "max-length" : 2147483647, "allowed" : [ "ONE", "QUORUM", "ALL" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

metadata - The list of metadata keys to store with an embedding content.

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

object-class - The object class under which the embeddings are stored.

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

socket-binding - The outbound socket binding to connect to the Weaviate store.

Type	STRING
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The outbound socket binding to connect to the Weaviate store.", "expressions-allowed" : true, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.network.outbound-socket-binding", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"socket-binding-ref" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

ssl-enabled - True if the connection to the Weaviate store is https or not.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "True if the connection to the Weaviate store is https or not.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

Operations (2)

add - This operation adds a weaviate embedding store.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
avoid-dups	BOOLEAN	false	true		If true the object id is a hashed ID based on provided text segment else a random ID will be generated.
consistency-level	STRING	false	true	ALL	How the consistency is tuned when writing into weaviate embedding store.
metadata	LIST	false	true		The list of metadata keys to store with an embedding content.
object-class	STRING	true	true		The object class under which the embeddings are stored.
socket-binding	STRING	true	true		The outbound socket binding to connect to the Weaviate store.
ssl-enabled	BOOLEAN	false	true	false	True if the connection to the Weaviate store is https or not.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "This operation adds a weaviate embedding store.",
    "request-properties" : {
        "avoid-dups" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "If true the object id is a hashed ID based on provided text segment else a random ID will be generated.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "consistency-level" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "How the consistency is tuned when writing into weaviate embedding store.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "ALL",
            "min-length" : 1,
            "max-length" : 2147483647,
            "allowed" : [
                "ONE",
                "QUORUM",
                "ALL"
            ],
            "stability" : "default"
        },
        "metadata" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The list of metadata keys to store with an embedding content.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "object-class" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The object class under which the embeddings are stored.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "socket-binding" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The outbound socket binding to connect to the Weaviate store.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "capability-reference" : "org.wildfly.network.outbound-socket-binding",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "ssl-enabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "True if the connection to the Weaviate store is https or not.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - This operation removes a weaviate embedding store.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "This operation removes a weaviate 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.weaviate-embedding-store

        
<feature spec="subsystem.ai.weaviate-embedding-store">
  <param name="weaviate-embedding-store" value="{resource name}"/>
  <param name="avoid-dups" value="{value}"/>
  <param name="consistency-level" value="{value}"/>
  <param name="metadata" value="{value}"/>
  <param name="object-class" value="{value}"/>
  <param name="socket-binding" value="{value}"/>
  <param name="ssl-enabled" value="{value}"/>
<feature/>