Management API Reference for chroma-embedding-store

Chroma 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/weaviate-embedding-store=* /subsystem=ai/in-memory-embedding-store=*

Attributes (8)

api-version - The supported API version of Chroma to use.

Type	STRING
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Allowed Values	V1 V2
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The supported API version of Chroma to use.", "expressions-allowed" : true, "required" : true, "nillable" : false, "allowed" : [ "V1", "V2" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

base-url - The base URL to the Chroma server.

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 base URL to the Chroma server.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"socket-config" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

collection-name - The name of the collection in the Chroma database.

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 collection in the Chroma database.", "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 }`

connect-timeout - The connection timeout for connecting to the Chroma server.

Type	LONG
Default Value	0
Unit	MILLISECONDS
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" : "LONG" }, "description" : "The connection timeout for connecting to the Chroma server.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 0, "unit" : "MILLISECONDS", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

database-name - The name of the database in the Chroma database.

Type	STRING
Default Value	default
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 database in the Chroma database.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "default", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

log-requests - Whether to log API requests to the Chroma server.

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?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether to log API requests to the Chroma server.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

log-responses - Whether to log API responses from the Chroma server.

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?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether to log API responses from the Chroma server.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

tenant-name - The name of the tenant in the Chroma database.

Type	STRING
Default Value	default
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 tenant in the Chroma database.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "default", "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 Chroma embedding store.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
api-version	STRING	true	true		The supported API version of Chroma to use.
base-url	STRING	true	true		The base URL to the Chroma server.
collection-name	STRING	false	true		The name of the collection in the Chroma database.
connect-timeout	LONG	false	true	0	The connection timeout for connecting to the Chroma server.
database-name	STRING	false	true	default	The name of the database in the Chroma database.
log-requests	BOOLEAN	false	true		Whether to log API requests to the Chroma server.
log-responses	BOOLEAN	false	true		Whether to log API responses from the Chroma server.
tenant-name	STRING	false	true	default	The name of the tenant in the Chroma database.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "This operation adds a Chroma embedding store.",
    "request-properties" : {
        "api-version" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The supported API version of Chroma to use.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "allowed" : [
                "V1",
                "V2"
            ],
            "stability" : "default"
        },
        "base-url" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The base URL to the Chroma server.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "collection-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the collection in the Chroma database.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "connect-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The connection timeout for connecting to the Chroma server.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 0,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "database-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the database in the Chroma database.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "default",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "log-requests" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether to log API requests to the Chroma server.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "log-responses" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether to log API responses from the Chroma server.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "tenant-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the tenant in the Chroma database.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "default",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - This operation removes a Chroma embedding store.

Raw DMR model


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

        
<feature spec="subsystem.ai.chroma-embedding-store">
  <param name="chroma-embedding-store" value="{resource name}"/>
  <param name="api-version" value="{value}"/>
  <param name="base-url" value="{value}"/>
  <param name="collection-name" value="{value}"/>
  <param name="connect-timeout" value="{value}"/>
  <param name="database-name" value="{value}"/>
  <param name="log-requests" value="{value}"/>
  <param name="log-responses" value="{value}"/>
  <param name="tenant-name" value="{value}"/>
<feature/>