Management API Reference for openai-chat-model

Chat model for OpenAI

Provided Capabilities (1)

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

Attributes (15)

api-key - API key to authenticate to an OpenAI 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 an OpenAI 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 an OpenAI 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 OpenAI 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 OpenAI 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 OpenAI 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 - Frequency penalty of the OpenAI 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 OpenAI 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 - Enabling the tracing of requests going to OpenAI.

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 OpenAI.", "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 OpenAI.

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 OpenAI.", "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 OpenAI 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 OpenAI 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 OpenAI.

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

organization-id - Name of the organization id served by OpenAI.

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" : "Name of the organization id served by OpenAI.", "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 }`

presence-penalty - Presence penalty of the OpenAI 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 OpenAI 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 OpenAI.

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 OpenAI.", "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 OpenAI 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 OpenAI chat model.", "expressions-allowed" : true, "required" : false, "nillable" : true, "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 OpenAI 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 OpenAI 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 OpenAI 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 OpenAI 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 an OpenAI chat model.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
api-key	STRING	true	true		API key to authenticate to an OpenAI chat model.
base-url	STRING	true	true		Endpoint to connect to an OpenAI chat model.
connect-timeout	LONG	false	true	0	Timeout for the OpenAI chat model.
frequency-penalty	DOUBLE	false	true		Frequency penalty of the OpenAI chat model.
log-requests	BOOLEAN	false	true		Enabling the tracing of requests going to OpenAI.
log-responses	BOOLEAN	false	true		Enabling the tracing of responses from OpenAI.
max-token	INT	false	true	1000	The number of token returned by the OpenAI chat model.
model-name	STRING	true	true		Name of the model served by OpenAI.
organization-id	STRING	false	true		Name of the organization id served by OpenAI.
presence-penalty	DOUBLE	false	true		Presence penalty of the OpenAI chat model.
response-format	STRING	false	true		The format of the response from OpenAI.
seed	LONG	false	true		Seed of the OpenAI chat model.
streaming	BOOLEAN	false	true	false	Whether to create a token streaming chat language model or not.
temperature	DOUBLE	false	true		Temperature of the OpenAI chat model.
top-p	DOUBLE	false	true		Top P of the OpenAI chat model.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "This operation adds an OpenAI chat model.",
    "request-properties" : {
        "api-key" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "API key to authenticate to an OpenAI 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 an OpenAI 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 OpenAI chat model.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 0,
            "unit" : "MILLISECONDS",
            "stability" : "default"
        },
        "frequency-penalty" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "DOUBLE"
            },
            "description" : "Frequency penalty of the OpenAI chat model.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "log-requests" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enabling the tracing of requests going to OpenAI.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "log-responses" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enabling the tracing of responses from OpenAI.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "max-token" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The number of token returned by the OpenAI 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 OpenAI.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "organization-id" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of the organization id served by OpenAI.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "presence-penalty" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "DOUBLE"
            },
            "description" : "Presence penalty of the OpenAI 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 OpenAI.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "allowed" : [
                "JSON",
                "TEXT"
            ],
            "stability" : "default"
        },
        "seed" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "Seed of the OpenAI chat model.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "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 OpenAI chat model.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "top-p" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "DOUBLE"
            },
            "description" : "Top P of the OpenAI 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 an OpenAI chat model.

Raw DMR model


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

        
<feature spec="subsystem.ai.openai-chat-model">
  <param name="openai-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-token" value="{value}"/>
  <param name="model-name" value="{value}"/>
  <param name="organization-id" value="{value}"/>
  <param name="presence-penalty" value="{value}"/>
  <param name="response-format" value="{value}"/>
  <param name="seed" value="{value}"/>
  <param name="streaming" value="{value}"/>
  <param name="temperature" value="{value}"/>
  <param name="top-p" value="{value}"/>
<feature/>