Model Specs Object Structure

Overview

The modelSpecs object helps you provide a simpler UI experience for AI models within your application.

There are 3 main fields under modelSpecs:

• enforce (optional; default: false)
• prioritize (optional; default: true)
• list (required)

Notes:

• If enforce is set to true, model specifications can potentially conflict with other interface settings such as endpointsMenu, modelSelect, presets, and parameters.
• The list array contains detailed configurations for each model, including presets that dictate specific behaviors, appearances, and capabilities.
• If interface fields are not specified, having a list of model specs will disable the following interface elements:
  • endpointsMenu
  • modelSelect
  • parameters
  • presets
• If you would like to enable these interface elements along with model specs, you can set them to true in the interface object.

Example

modelSpecs:
  enforce: true
  prioritize: true
  list:
    - name: "commander_01"
      label: "Commander in Chief"
      description: "An AI roleplaying as the 50th President."
      iconURL: "https://example.com/icon.jpg"
      preset: {Refer to the detailed preset configuration example below}

enforce

Key:

Default: false

Example:

modelSpecs:
  enforce: true

prioritize

Key:

Default: true

Example:

modelSpecs:
  prioritize: false

list

Key:

Each spec object in the list can have the following settings:

Overview

• name
  • Unique identifier for the model.
• label
  • A user-friendly name or label for the model, shown in the header dropdown.
• description
  • A brief description of the model and its intended use or role, shown in the header dropdown menu.
• iconURL
  • URL or a predefined endpoint name for the model’s icon.
• default
  • Specifies if this model spec is the default selection, to be auto-selected on every new chat.
• showIconInMenu
  • Controls whether the model’s icon appears in the header dropdown menu.
• showIconInHeader
  • Controls whether the model’s icon appears in the header dropdown button, left of its name.
• preset
  • Detailed preset configurations that define the behavior and capabilities of the model (see preset object structure section below for more details).

Preset Object Structure

The preset field for a modelSpec list item is made up of a comprehensive configuration blueprint for AI models within the system. It is designed to specify the operational settings of AI models, tailoring their behavior, outputs, and interactions with other system components and endpoints.

modelLabel

Key:

Default: None

Example:

preset:
  modelLabel: "Customer Support Bot"

endpoint

Key:

Default: None

Example:

preset:
  endpoint: "openAI"

greeting

Key:

Default: None

Example:

preset:
  greeting: "Hello! How can I assist you today?"

promptPrefix

Key:

Default: None

Example:

preset:
  promptPrefix: "As a financial advisor, ..."

model_options

These settings control the stochastic nature and behavior of model responses, affecting creativity, relevance, and variability.

Key:

Example:

preset:
  temperature: 0.7
  top_p: 0.9

resendFiles

Key:

Default: false

Example:

preset:
  resendFiles: true

imageDetail

Key:

Example:

preset:
  imageDetail: "high"

agentOptions

Key:

Example:

preset:
  agentOptions:
    agent: "functions"
    skipCompletion: false
    model: "gpt-4-turbo"
    temperature: 0.5

tools

Key:

Example:

preset:
  tools: ["dalle", "tavily_search_results_json", "azure-ai-search", "traversaal_search"]

Notes:

• At the moment, only tools that have credentials provided for them via .env file can be used with modelSpecs, unless the user already had the tool installed.
• You can find the names of the tools to filter in api/app/clients/tools/manifest.json
  • Use the pluginKey value
• Also, any listed under the “.well-known” directory api/app/clients/tools/.well-known
  • Use the name_for_model value

assistant_options

Key:

Example:

preset:
  assistant_id: "asst_98765"
  instructions: "Please handle customer queries regarding order status."