Management API Reference for ollama-embedding-model

Embedding model for AI for Ollama.

Provided Capabilities (1)

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

Attributes (5)

base-url - Endpoint to connect to an Ollama embedding model.

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" : "Endpoint to connect to an Ollama embedding model.", "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 }`

connect-timeout - Timeout for the Ollama embedding model.

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" : "Timeout for the Ollama embedding model.", "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 }`

log-requests - Enabling the tracing of requests going to Ollama.

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" : "Enabling the tracing of requests going to Ollama.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

log-responses - Enabling the tracing of responses from Ollama.

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" : "Enabling the tracing of responses from Ollama.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

model-name - Name of the embedding model served by Ollama.

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" : "Name of the embedding model served by Ollama.", "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 embedding model

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
base-url	STRING	true	true		Endpoint to connect to an Ollama embedding model.
connect-timeout	LONG	false	true	0	Timeout for the Ollama embedding model.
log-requests	BOOLEAN	false	true		Enabling the tracing of requests going to Ollama.
log-responses	BOOLEAN	false	true		Enabling the tracing of responses from Ollama.
model-name	STRING	true	true		Name of the embedding model served by Ollama.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "This operation adds a embedding model",
    "request-properties" : {
        "base-url" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Endpoint to connect to an Ollama embedding model.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "connect-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "Timeout for the Ollama embedding model.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 0,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "log-requests" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enabling the tracing of requests going to Ollama.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "log-responses" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enabling the tracing of responses from Ollama.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "model-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of the embedding model served by Ollama.",
            "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 embedding model

Raw DMR model


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

        
<feature spec="subsystem.ai.ollama-embedding-model">
  <param name="ollama-embedding-model" value="{resource name}"/>
  <param name="base-url" value="{value}"/>
  <param name="connect-timeout" value="{value}"/>
  <param name="log-requests" value="{value}"/>
  <param name="log-responses" value="{value}"/>
  <param name="model-name" value="{value}"/>
<feature/>