Reference Index

Model Description
.halguru.yaml: The full configuration of an agent.
Agent.Author.Company The company associated with the author.
Agent.Author.Copyright The copyright information associated with the author or their works.
Agent.Author.Email The email address of the author.
Agent.Author.Name The name of the author.
Agent.Author.Url The URL associated with the author.
Agent.Author The author information of the agent.
Agent.Description The description of the agent.
Agent.Domains[] The list of domains associated with the agent.
Agent.Features.CheckAllUrls Determines whether all URLs exist and are valid in the generated answer.
Agent.Features.CheckIsAnswerCorrect Determines whether the answer provided is evaluated as correct.
Agent.Features.CheckIsLastUrlCorrectAnswer Determines whether the last URL in the provided collection is the correct answer.
Agent.Features.CommentCurrentUrl Determines whether the robot should comment the current URL.
Agent.Features.DisplayImagesForUrls Determines whether the robot should display images for URLs.
Agent.Features.DisplayWebsiteForUrl Determines whether the agent should display the website for the URL.
Agent.Features.MaxRetryAttempts Determines whether the robot should retry the check fails.
Agent.Features.PerChannelThreading Determines whether a separate thread is created for each channel.
Agent.Features The features and capabilities of the agent.
Agent.Id The unique identifier for the agent
Agent.IsAuthorizationRequired A value indicating whether authorization is required for the agent
Agent.Name The name of the agent.
Agent.Start.LlmConnectorName Name of the LLM connector to be used from the LlmConnectors list.
Agent.Start.PromptName Name of the prompt to be used during the agent's initialization process.
Agent.Start.Url URL associated with the start configuration of the agent.
Agent.Start The starting configuration for the agent.
Agent.Themes.Dark.Messages.Agent.BackgroundColor The background color for the user interface.
Agent.Themes.Dark.Messages.Agent.IconColor The color for the icon displayed in the user interface.
Agent.Themes.Dark.Messages.Agent.IconCssClass The CSS class for the icon displayed in the user interface.
Agent.Themes.Dark.Messages.Agent.IconUrl The URL for the icon displayed in the user interface.
Agent.Themes.Dark.Messages.Agent.TextColor The text color displayed in the user interface.
Agent.Themes.Dark.Messages.Agent Agent message theme specific to the dark theme
Agent.Themes.Dark.Messages.Busy.BackgroundColor The background color for the user interface.
Agent.Themes.Dark.Messages.Busy.IconColor The color for the icon displayed in the user interface.
Agent.Themes.Dark.Messages.Busy.IconCssClass The CSS class for the icon displayed in the user interface.
Agent.Themes.Dark.Messages.Busy.IconUrl The URL for the icon displayed in the user interface.
Agent.Themes.Dark.Messages.Busy.TextColor The text color displayed in the user interface.
Agent.Themes.Dark.Messages.Busy Busy message theme specific to the dark theme
Agent.Themes.Dark.Messages.Error.BackgroundColor The background color for the user interface.
Agent.Themes.Dark.Messages.Error.IconColor The color for the icon displayed in the user interface.
Agent.Themes.Dark.Messages.Error.IconCssClass The CSS class for the icon displayed in the user interface.
Agent.Themes.Dark.Messages.Error.IconUrl The URL for the icon displayed in the user interface.
Agent.Themes.Dark.Messages.Error.TextColor The text color displayed in the user interface.
Agent.Themes.Dark.Messages.Error Error message theme specific to the dark theme
Agent.Themes.Dark.Messages.Owner.BackgroundColor The background color for the user interface.
Agent.Themes.Dark.Messages.Owner.IconColor The color for the icon displayed in the user interface.
Agent.Themes.Dark.Messages.Owner.IconCssClass The CSS class for the icon displayed in the user interface.
Agent.Themes.Dark.Messages.Owner.IconUrl The URL for the icon displayed in the user interface.
Agent.Themes.Dark.Messages.Owner.TextColor The text color displayed in the user interface.
Agent.Themes.Dark.Messages.Owner Owner message theme specific to the dark theme
Agent.Themes.Dark.Messages.System.BackgroundColor The background color for the user interface.
Agent.Themes.Dark.Messages.System.IconColor The color for the icon displayed in the user interface.
Agent.Themes.Dark.Messages.System.IconCssClass The CSS class for the icon displayed in the user interface.
Agent.Themes.Dark.Messages.System.IconUrl The URL for the icon displayed in the user interface.
Agent.Themes.Dark.Messages.System.TextColor The text color displayed in the user interface.
Agent.Themes.Dark.Messages.System System message theme specific to the dark theme
Agent.Themes.Dark.Messages.User.BackgroundColor The background color for the user interface.
Agent.Themes.Dark.Messages.User.IconColor The color for the icon displayed in the user interface.
Agent.Themes.Dark.Messages.User.IconCssClass The CSS class for the icon displayed in the user interface.
Agent.Themes.Dark.Messages.User.IconUrl The URL for the icon displayed in the user interface.
Agent.Themes.Dark.Messages.User.TextColor The text color displayed in the user interface.
Agent.Themes.Dark.Messages.User User message theme specific to the dark theme
Agent.Themes.Dark.Messages Chat message themes associated with the theme design.
Agent.Themes.Dark Dark theme design settings for the agent
Agent.Themes.Light.Messages.Agent.BackgroundColor The background color for the user interface.
Agent.Themes.Light.Messages.Agent.IconColor The color for the icon displayed in the user interface.
Agent.Themes.Light.Messages.Agent.IconCssClass The CSS class for the icon displayed in the user interface.
Agent.Themes.Light.Messages.Agent.IconUrl The URL for the icon displayed in the user interface.
Agent.Themes.Light.Messages.Agent.TextColor The text color displayed in the user interface.
Agent.Themes.Light.Messages.Agent Agent message theme specific to the light theme
Agent.Themes.Light.Messages.Busy.BackgroundColor The background color for the user interface.
Agent.Themes.Light.Messages.Busy.IconColor The color for the icon displayed in the user interface.
Agent.Themes.Light.Messages.Busy.IconCssClass The CSS class for the icon displayed in the user interface.
Agent.Themes.Light.Messages.Busy.IconUrl The URL for the icon displayed in the user interface.
Agent.Themes.Light.Messages.Busy.TextColor The text color displayed in the user interface.
Agent.Themes.Light.Messages.Busy Busy message theme specific to the light theme
Agent.Themes.Light.Messages.Error.BackgroundColor The background color for the user interface.
Agent.Themes.Light.Messages.Error.IconColor The color for the icon displayed in the user interface.
Agent.Themes.Light.Messages.Error.IconCssClass The CSS class for the icon displayed in the user interface.
Agent.Themes.Light.Messages.Error.IconUrl The URL for the icon displayed in the user interface.
Agent.Themes.Light.Messages.Error.TextColor The text color displayed in the user interface.
Agent.Themes.Light.Messages.Error Error message theme specific to the light theme
Agent.Themes.Light.Messages.Owner.BackgroundColor The background color for the user interface.
Agent.Themes.Light.Messages.Owner.IconColor The color for the icon displayed in the user interface.
Agent.Themes.Light.Messages.Owner.IconCssClass The CSS class for the icon displayed in the user interface.
Agent.Themes.Light.Messages.Owner.IconUrl The URL for the icon displayed in the user interface.
Agent.Themes.Light.Messages.Owner.TextColor The text color displayed in the user interface.
Agent.Themes.Light.Messages.Owner Owner message theme specific to the light theme
Agent.Themes.Light.Messages.System.BackgroundColor The background color for the user interface.
Agent.Themes.Light.Messages.System.IconColor The color for the icon displayed in the user interface.
Agent.Themes.Light.Messages.System.IconCssClass The CSS class for the icon displayed in the user interface.
Agent.Themes.Light.Messages.System.IconUrl The URL for the icon displayed in the user interface.
Agent.Themes.Light.Messages.System.TextColor The text color displayed in the user interface.
Agent.Themes.Light.Messages.System System message theme specific to the light theme
Agent.Themes.Light.Messages.User.BackgroundColor The background color for the user interface.
Agent.Themes.Light.Messages.User.IconColor The color for the icon displayed in the user interface.
Agent.Themes.Light.Messages.User.IconCssClass The CSS class for the icon displayed in the user interface.
Agent.Themes.Light.Messages.User.IconUrl The URL for the icon displayed in the user interface.
Agent.Themes.Light.Messages.User.TextColor The text color displayed in the user interface.
Agent.Themes.Light.Messages.User User message theme specific to the light theme
Agent.Themes.Light.Messages Chat message themes associated with the theme design.
Agent.Themes.Light Light theme design settings for the agent
Agent.Themes The collection of themes and their associated designs for the agent.
Agent.Type The type of the agent, such as Basic (default), Advanced, or Custom.
Agent.UI.DisableCloseButton Indicates whether the close button should be disabled.
Agent.UI.DisableSignOutButton Indicates whether the sign out button should be disabled.
Agent.UI The user interface design configuration for the agent.
Agent.Version The version of the agent.
Agent The agent configuration
Channels[].Active Whether the channel is active or not.
Channels[].Description A description of the channel.
Channels[].Name The name of the channel.
Channels[].ReferenceId The unique identifier for the channel for external use.
Channels[].Source The source of the infoormation for the channel.
Channels[].UserType Determines the level of access granted to the user for the agent channel.
Channels[] The communication channels that are available to the agent.
ExampleMessages[].Answer The response message generated by the service.
ExampleMessages[].Question The message provided as input by the user.
ExampleMessages[] Example messages that demonstrate input-output interactions for an agent.
HalGuru.AutogeneratedAgentUrl The autogenerated URL for this agent.
HalGuru.FilePurpose The purpose of the file.
HalGuru.PlatformUrl The URL of the hal.guru platform.
HalGuru.PlatformVersion The version of the hal.guru platform in use.
HalGuru Header information for the hal.guru platform. Don't change this.
LlmConnectors[].ApiKey The API key used to authenticate with the LLM provider.
LlmConnectors[].ApiUrl The base URL of the API used to connect to the Large Language Model (LLM) provider.
LlmConnectors[].AssistantId The specific assistant model or instance used within the LLM connection.
LlmConnectors[].InstructionsPrompt The custom instructions or contextual guidance provided to the LLM for tailoring its responses.
LlmConnectors[].LlmProvider The large language model (LLM) provider to be used by the LLM Connector.
LlmConnectors[].MaxTokens The maximum number of tokens the model will generate in its response.
LlmConnectors[].Model The model identifier to use within the LLM Connector instance.
LlmConnectors[].Name The name of the llm connector.
LlmConnectors[].Temperature The randomness of responses generated by the language model.
LlmConnectors[].Tools[] The collection of tools or additional functionalities associated with the LLM connection.
LlmConnectors[].VectorStoreId The identifier for the associated vector store.
LlmConnectors[] LLM connector configurations.
Messages[].Message Content of the static message for the agent.
Messages[].Name The name of the static message for the agent.
Messages[] Static messages used for quick access within the system.
Operator.Features The features and capabilities of the agent.
Operator.UI The user interface design configuration for the agent.
Operator The operator configuration
Prompts[].Name The name of the prompt.
Prompts[].Prompt The text content of the prompt.
Prompts[] Prompts available within the agent's configuration.
Secrets[].Key The name of the secret key.
Secrets[].Secret The value of the secret key.
Secrets[] Key-value pairs used to store sensitive information.
TestCases[].AnswerMessageContains[] A list of substrings that the output message is expected to contain.
TestCases[].AnswerMessageRegex A regular expression pattern that the agent's response should conform to.
TestCases[].Name The name of the test case.
TestCases[].QuestionMessage The question or input message directed to the agent.
TestCases[] Test cases for validating the behavior of an agent.
UserLimits.Anonymous.MaxDailyMessagesCount The maximum number of messages that can be sent by the user per day.
UserLimits.Anonymous.MaxDailyTokensCount The maximum number of tokens allowed per day for a user
UserLimits.Anonymous.MaxDailyWordsCount The maximum number of words allowed per day for a user
UserLimits.Anonymous.MaxMessageTokensCount The maximum number of tokens that can be used in a single message
UserLimits.Anonymous.MaxMessageWordsCount The maximum number of words allowed per message for a user
UserLimits.Anonymous.MaxMonthlyMessagesCount The maximum number of messages that can be sent by the user per month.
UserLimits.Anonymous.MaxMonthlyTokensCount The maximum number of tokens allowed per month for a user
UserLimits.Anonymous.MaxMonthlyWordsCount The maximum number of words allowed per month for a user
UserLimits.Anonymous.MaxTotalMessagesCount The maximum number of messages that can be sent by the user.
UserLimits.Anonymous.MaxTotalTokensCount The maximum number of tokens allowed for a user
UserLimits.Anonymous.MaxTotalWordsCount The maximum number of words allowed for a user
UserLimits.Anonymous Access restrictions and limitations for anonymous users
UserLimits.Paid.MaxDailyMessagesCount The maximum number of messages that can be sent by the user per day.
UserLimits.Paid.MaxDailyTokensCount The maximum number of tokens allowed per day for a user
UserLimits.Paid.MaxDailyWordsCount The maximum number of words allowed per day for a user
UserLimits.Paid.MaxMessageTokensCount The maximum number of tokens allowed in a single message
UserLimits.Paid.MaxMessageWordsCount The maximum number of words allowed per message for a user
UserLimits.Paid.MaxMonthlyMessagesCount The maximum number of messages that can be sent by the user per month.
UserLimits.Paid.MaxMonthlyTokensCount The maximum number of tokens allowed per month for a user
UserLimits.Paid.MaxMonthlyWordsCount The maximum number of words allowed per month for a user
UserLimits.Paid.MaxTotalMessagesCount The maximum number of messages that can be sent by the user.
UserLimits.Paid.MaxTotalTokensCount The maximum number of tokens allowed for a user
UserLimits.Paid.MaxTotalWordsCount The maximum number of words allowed for a user
UserLimits.Paid Access restrictions and limitations for paid users
UserLimits.Registered.MaxDailyMessagesCount The maximum number of messages that can be sent by the user per day.
UserLimits.Registered.MaxDailyTokensCount The maximum number of tokens allowed per day for a user
UserLimits.Registered.MaxDailyWordsCount The maximum number of words allowed per day for a user
UserLimits.Registered.MaxMessageTokensCount The maximum number of tokens allowed in a single message for a user
UserLimits.Registered.MaxMessageWordsCount The maximum number of words allowed per message for a user
UserLimits.Registered.MaxMonthlyMessagesCount The maximum number of messages that can be sent by the user per month.
UserLimits.Registered.MaxMonthlyTokensCount The maximum number of tokens allowed per month for a user
UserLimits.Registered.MaxMonthlyWordsCount The maximum number of words allowed per month for a user
UserLimits.Registered.MaxTotalMessagesCount The maximum number of messages that can be sent by the user.
UserLimits.Registered.MaxTotalTokensCount The maximum number of tokens allowed for a user
UserLimits.Registered.MaxTotalWordsCount The maximum number of words allowed for a user
UserLimits.Registered Access restrictions and limitations for registered users
UserLimits Defines the access limitations and restrictions for users based on their account type

Last updated: 2025-10-13
Autogenerated: Yes
AI powered: Yes
Core version: 1.66.0