Management API Reference for mistral-ai-chat-model

Chat model for Mitral AI

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/ollama-chat-model=* /subsystem=ai/github-chat-model=*

Attributes (17)

api-key - API key to authenticate to a Mitral AI 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" : "API key to authenticate to a Mitral AI chat model.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"credential" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

base-url - Endpoint to connect to a Mitral AI 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 a Mitral AI 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 Mitral AI 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 Mitral AI 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 }`

frequency-penalty - Positive values penalize tokens that repeatedly appear in the generated text, decreasing the probability of repeating content.

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" : "Positive values penalize tokens that repeatedly appear in the generated text, decreasing the probability of repeating content.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

log-requests - Enabling the tracing of requests going to Mitral AI.

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 Mitral AI.", "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 Mitral AI.

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 Mitral AI.", "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 to Mitral AI.

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 to Mitral AI.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

max-token - The number of token returned by the Mitral AI chat model.

Type	INT
Default Value	1000
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 token returned by the Mitral AI chat model.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 1000, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

model-name - Name of the model served by Mitral AI.

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 model served by Mitral AI.", "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 }`

presence-penalty - Presence penalty applied to the next token's logprobs if the token has already been seen in the response. This penalty is binary on/off and not dependant on the number of times the token is used (after the first). Use frequency-penalty for a penalty that increases with each use.

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" : "Presence penalty applied to the next token's logprobs if the token has already been seen in the response. This penalty is binary on/off and not dependant on the number of times the token is used (after the first). Use frequency-penalty for a penalty that increases with each use.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

random-seed - Seed of the Mitral AI chat 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" : "Seed of the Mitral AI chat model.", "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 Mitral AI.

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 Mitral AI.", "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 }`

safe-prompt - Whether to inject a safety prompt before all conversations.

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 inject a safety prompt before all conversations.", "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 Mitral AI 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 Mitral AI 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-p - Top P of the Mitral AI 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" : "Top P of the Mitral AI chat model.", "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 Mitral AI chat model.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
api-key	STRING	true	true		API key to authenticate to a Mitral AI chat model.
base-url	STRING	true	true		Endpoint to connect to a Mitral AI chat model.
connect-timeout	LONG	false	true	0	Timeout for the Mitral AI chat model.
frequency-penalty	DOUBLE	false	true		Positive values penalize tokens that repeatedly appear in the generated text, decreasing the probability of repeating content.
log-requests	BOOLEAN	false	true		Enabling the tracing of requests going to Mitral AI.
log-responses	BOOLEAN	false	true		Enabling the tracing of responses from Mitral AI.
max-retries	INT	false	true		The maximum number of retries for API requests to Mitral AI.
max-token	INT	false	true	1000	The number of token returned by the Mitral AI chat model.
model-name	STRING	true	true		Name of the model served by Mitral AI.
presence-penalty	DOUBLE	false	true		Presence penalty applied to the next token's logprobs if the token has already been seen in the response. This penalty is binary on/off and not dependant on the number of times the token is used (after the first). Use frequency-penalty for a penalty that increases with each use.
random-seed	INT	false	true		Seed of the Mitral AI chat model.
response-format	STRING	false	true		The format of the response from Mitral AI.
safe-prompt	BOOLEAN	false	true		Whether to inject a safety prompt before all conversations.
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 Mitral AI chat model.
top-p	DOUBLE	false	true		Top P of the Mitral AI chat model.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "This operation adds a Mitral AI chat model.",
    "request-properties" : {
        "api-key" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "API key to authenticate to a Mitral AI chat model.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "base-url" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Endpoint to connect to a Mitral AI 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 Mitral AI chat model.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 0,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "frequency-penalty" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "DOUBLE"
            },
            "description" : "Positive values penalize tokens that repeatedly appear in the generated text, decreasing the probability of repeating content.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "log-requests" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enabling the tracing of requests going to Mitral AI.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "log-responses" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enabling the tracing of responses from Mitral AI.",
            "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 to Mitral AI.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "max-token" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The number of token returned by the Mitral AI chat model.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 1000,
            "stability" : "default"
        },
        "model-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of the model served by Mitral AI.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "presence-penalty" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "DOUBLE"
            },
            "description" : "Presence penalty applied to the next token's logprobs if the token has already been seen in the response. This penalty is binary on/off and not dependant on the number of times the token is used (after the first). Use frequency-penalty for a penalty that increases with each use.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "random-seed" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Seed of the Mitral AI chat model.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "response-format" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The format of the response from Mitral AI.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "allowed" : [
                "JSON",
                "TEXT"
            ],
            "stability" : "default"
        },
        "safe-prompt" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether to inject a safety prompt before all conversations.",
            "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 Mitral AI chat model.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "top-p" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "DOUBLE"
            },
            "description" : "Top P of the Mitral AI chat model.",
            "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 Mitral AI chat model.

Raw DMR model


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

        
<feature spec="subsystem.ai.mistral-ai-chat-model">
  <param name="mistral-ai-chat-model" value="{resource name}"/>
  <param name="api-key" value="{value}"/>
  <param name="base-url" value="{value}"/>
  <param name="connect-timeout" value="{value}"/>
  <param name="frequency-penalty" value="{value}"/>
  <param name="log-requests" value="{value}"/>
  <param name="log-responses" value="{value}"/>
  <param name="max-retries" value="{value}"/>
  <param name="max-token" value="{value}"/>
  <param name="model-name" value="{value}"/>
  <param name="presence-penalty" value="{value}"/>
  <param name="random-seed" value="{value}"/>
  <param name="response-format" value="{value}"/>
  <param name="safe-prompt" value="{value}"/>
  <param name="stop-sequences" value="{value}"/>
  <param name="streaming" value="{value}"/>
  <param name="temperature" value="{value}"/>
  <param name="top-p" value="{value}"/>
<feature/>