Management API Reference for github-chat-model

Chat model for GitHub Models

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/mistral-ai-chat-model=*

Attributes (17)

api-key - API key to authenticate to a GitHub Models 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 GitHub Models 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 }`

connect-timeout - Timeout for the GitHub Models 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 GitHub Models 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 }`

custom-headers - Headers added to the requests to GitHub Models.

Type	OBJECT
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" : "OBJECT" }, "description" : "Headers added to the requests to GitHub Models.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

endpoint - Endpoint to connect to an GitHub Models 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 GitHub Models chat model.", "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 }`

frequency-penalty - Frequency penalty of the GitHub Models 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" : "Frequency penalty of the GitHub Models chat model.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

log-requests-responses - Enabling the tracing of requests and responses to GitHub Models.

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 and responses to GitHub Models.", "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 number of token retries when sending a request to GitHub Models.

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 token retries when sending a request to GitHub Models.", "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 GitHub Models 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 GitHub Models 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 GitHub Models.

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 GitHub Models.", "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 of the GitHub Models 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" : "Presence penalty of the GitHub Models 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 GitHub Models.

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 GitHub Models.", "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 - Seed of the GitHub Models chat model.

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

service-version - Version of GitHub Models to use.

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	2024-05-01-preview
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Version of GitHub Models to use.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "allowed" : [ "2024-05-01-preview", "2024-05-01-preview" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-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 GitHub Models 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 GitHub Models 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 GitHub Models 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 GitHub Models chat model.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

user-agent-suffix - Suffix to the user-agent.

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" : "Suffix to the user-agent.", "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 }`

Operations (3)

add - This operation adds a GitHub Models chat model.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
api-key	STRING	true	true		API key to authenticate to a GitHub Models chat model.
connect-timeout	LONG	false	true	0	Timeout for the GitHub Models chat model.
custom-headers	OBJECT	false	true		Headers added to the requests to GitHub Models.
endpoint	STRING	true	true		Endpoint to connect to an GitHub Models chat model.
frequency-penalty	DOUBLE	false	true		Frequency penalty of the GitHub Models chat model.
log-requests-responses	BOOLEAN	false	true		Enabling the tracing of requests and responses to GitHub Models.
max-retries	INT	false	true		The number of token retries when sending a request to GitHub Models.
max-token	INT	false	true	1000	The number of token returned by the GitHub Models chat model.
model-name	STRING	true	true		Name of the model served by GitHub Models.
presence-penalty	DOUBLE	false	true		Presence penalty of the GitHub Models chat model.
response-format	STRING	false	true		The format of the response from GitHub Models.
seed	LONG	false	true		Seed of the GitHub Models chat model.
service-version	STRING	false	true		Version of GitHub Models to use.
streaming	BOOLEAN	false	true	false	Whether to create a token streaming chat language model or not.
temperature	DOUBLE	false	true		Temperature of the GitHub Models chat model.
top-p	DOUBLE	false	true		Top P of the GitHub Models chat model.
user-agent-suffix	STRING	false	true		Suffix to the user-agent.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "This operation adds a GitHub Models chat model.",
    "request-properties" : {
        "api-key" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "API key to authenticate to a GitHub Models 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 GitHub Models chat model.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 0,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "custom-headers" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Headers added to the requests to GitHub Models.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "endpoint" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Endpoint to connect to an GitHub Models chat model.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "frequency-penalty" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "DOUBLE"
            },
            "description" : "Frequency penalty of the GitHub Models chat model.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "log-requests-responses" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enabling the tracing of requests and responses to GitHub Models.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "max-retries" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The number of token retries when sending a request to GitHub Models.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "max-token" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The number of token returned by the GitHub Models 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 GitHub Models.",
            "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 of the GitHub Models 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 GitHub Models.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "allowed" : [
                "JSON",
                "TEXT"
            ],
            "stability" : "default"
        },
        "seed" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "Seed of the GitHub Models chat model.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "service-version" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Version of GitHub Models to use.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "allowed" : [
                "2024-05-01-preview",
                "2024-05-01-preview"
            ],
            "stability" : "default"
        },
        "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 GitHub Models chat model.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "top-p" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "DOUBLE"
            },
            "description" : "Top P of the GitHub Models chat model.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "user-agent-suffix" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Suffix to the user-agent.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "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 GitHub Models chat model.

Raw DMR model


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

        
<feature spec="subsystem.ai.github-chat-model">
  <param name="github-chat-model" value="{resource name}"/>
  <param name="api-key" value="{value}"/>
  <param name="connect-timeout" value="{value}"/>
  <param name="custom-headers" value="{value}"/>
  <param name="endpoint" value="{value}"/>
  <param name="frequency-penalty" value="{value}"/>
  <param name="log-requests-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="response-format" value="{value}"/>
  <param name="seed" value="{value}"/>
  <param name="service-version" value="{value}"/>
  <param name="streaming" value="{value}"/>
  <param name="temperature" value="{value}"/>
  <param name="top-p" value="{value}"/>
  <param name="user-agent-suffix" value="{value}"/>
<feature/>