Management API Reference for ollama-chat-model

Chat model for AI for Ollama.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.ai.chatmodel	true	/subsystem=ai/openai-chat-model=* /subsystem=ai/gemini-chat-model=* /subsystem=ai/github-chat-model=* /subsystem=ai/mistral-ai-chat-model=*

Attributes (15)

base-url - Endpoint to connect to an Ollama chat 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 chat 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 chat 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 chat 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 }`

max-retries - =The maximum number of retries for API requests.

Type	INT
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" : "INT" }, "description" : "=The maximum number of retries for API requests.", "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 chat 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 chat 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 }`

num-predict - The maximum number of tokens to predict (Ollama-specific parameter).

Type	INT
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" : "INT" }, "description" : "The maximum number of tokens to predict (Ollama-specific parameter).", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

repeat-penalty - Penalty for token repetition to reduce repetitive text generation.

Type	DOUBLE
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" : "DOUBLE" }, "description" : "Penalty for token repetition to reduce repetitive text generation.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

response-format - The format of the response from Ollama.

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
Allowed Values	JSON TEXT
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The format of the response from Ollama.", "expressions-allowed" : true, "required" : false, "nillable" : true, "allowed" : [ "JSON", "TEXT" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

seed - Random seed for reproducible outputs from the Ollama model.

Type	INT
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" : "INT" }, "description" : "Random seed for reproducible outputs from the Ollama model.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

stop-sequences - List of stop sequences to tell the model to stop generating 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" : "List of stop sequences to tell the model to stop generating 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 }`

streaming - Whether to create a token streaming chat language model 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?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether to create a token streaming chat language model or not.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

temperature - Temperature of the Ollama chat model.

Type	DOUBLE
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" : "DOUBLE" }, "description" : "Temperature of the Ollama chat model.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

top-k - The number of highest probability tokens to consider during generation.

Type	INT
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" : "INT" }, "description" : "The number of highest probability tokens to consider during generation.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

top-p - Controls token diversity using nucleus sampling.

Type	DOUBLE
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" : "DOUBLE" }, "description" : "Controls token diversity using nucleus sampling.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

Operations (3)

add - This operation adds a chat model

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
base-url	STRING	true	true		Endpoint to connect to an Ollama chat model.
connect-timeout	LONG	false	true	0	Timeout for the Ollama chat 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.
max-retries	INT	false	true		=The maximum number of retries for API requests.
model-name	STRING	true	true		Name of the chat model served by Ollama.
num-predict	INT	false	true		The maximum number of tokens to predict (Ollama-specific parameter).
repeat-penalty	DOUBLE	false	true		Penalty for token repetition to reduce repetitive text generation.
response-format	STRING	false	true		The format of the response from Ollama.
seed	INT	false	true		Random seed for reproducible outputs from the Ollama model.
stop-sequences	LIST	false	true		List of stop sequences to tell the model to stop generating content.
streaming	BOOLEAN	false	true	false	Whether to create a token streaming chat language model or not.
temperature	DOUBLE	false	true		Temperature of the Ollama chat model.
top-k	INT	false	true		The number of highest probability tokens to consider during generation.
top-p	DOUBLE	false	true		Controls token diversity using nucleus sampling.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "This operation adds a chat model",
    "request-properties" : {
        "base-url" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Endpoint to connect to an Ollama chat 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 chat 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"
        },
        "max-retries" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "=The maximum number of retries for API requests.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "model-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of the chat model served by Ollama.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "num-predict" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The maximum number of tokens to predict (Ollama-specific parameter).",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "repeat-penalty" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "DOUBLE"
            },
            "description" : "Penalty for token repetition to reduce repetitive text generation.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "response-format" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The format of the response from Ollama.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "allowed" : [
                "JSON",
                "TEXT"
            ],
            "stability" : "default"
        },
        "seed" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Random seed for reproducible outputs from the Ollama model.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "stop-sequences" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "List of stop sequences to tell the model to stop generating content.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "streaming" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether to create a token streaming chat language model or not.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "temperature" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "DOUBLE"
            },
            "description" : "Temperature of the Ollama chat model.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "top-k" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The number of highest probability tokens to consider during generation.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "top-p" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "DOUBLE"
            },
            "description" : "Controls token diversity using nucleus sampling.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

chat - Simple operation to send a user message to the LLM.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
user-message	STRING	true	true		The user message sent to the LLM to test it.

Reply properties

Type: STRING

Raw DMR model


{
    "operation-name" : "chat",
    "description" : "Simple operation to send a user message to the LLM.",
    "request-properties" : {"user-message" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The user message sent to the LLM to test it.",
        "expressions-allowed" : true,
        "required" : true,
        "nillable" : false,
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "STRING"
    }},
    "access-constraints" : {"sensitive" : {"read-whole-config" : {"type" : "core"}}},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

remove - This operation removes a chat model

Raw DMR model


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

        
<feature spec="subsystem.ai.ollama-chat-model">
  <param name="ollama-chat-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="max-retries" value="{value}"/>
  <param name="model-name" value="{value}"/>
  <param name="num-predict" value="{value}"/>
  <param name="repeat-penalty" value="{value}"/>
  <param name="response-format" value="{value}"/>
  <param name="seed" value="{value}"/>
  <param name="stop-sequences" value="{value}"/>
  <param name="streaming" value="{value}"/>
  <param name="temperature" value="{value}"/>
  <param name="top-k" value="{value}"/>
  <param name="top-p" value="{value}"/>
<feature/>