ActorConfig.cs

Go to the documentation of this file.

using System;
using Microsoft.Extensions.Configuration;
using UnityEngine;
 
namespace EchoTrio {
    /// Actor's configuration as a ScriptableObject.
    /// Some configurations can be overridden via the ActorOverrides.ini file.
    [CreateAssetMenu(fileName = "ActorConfig", menuName = "EchoTrio/ActorConfig")]
    public class ActorConfig : ScriptableObject {
        private const string OverrideFileName = "ActorOverrides.ini";
 
        [System.Serializable] public class InstructionSnippet {
            public bool enabled = true;
            [TextArea(minLines: 4, maxLines: 8)] public string instruction = string.Empty;
        }
 
        /// Flags to enable or disable actor features.
        [System.Flags] public enum Feature {
            /// Allow the actor's OpenAI model to access the internet and search for information.
            WebSearch = 1 << 0,
            /// Allow the actor's OpenAI model to access files uploaded into the vector store. https://platform.openai.com/storage
            FileSearch = 1 << 1,
            /// Allow the actor's OpenAI model to provide its reasoning when generating a response.
            Reasoning = 1 << 2,
            /// Allow the actor's ElevenLabs model to use audio tags to generate more expressive dialouge. https://elevenlabs.io/blog/v3-audiotags
            AudioTags = 1 << 3,
        }
 
        [Header("Settings")]
        [SerializeField] private Persona persona = PersonaExtensions.DefaultValue;
        [SerializeField] private Feature enabledFeatures = Feature.WebSearch | Feature.FileSearch | Feature.Reasoning | Feature.AudioTags;
        [SerializeField] private string elevenLabsVoiceId = string.Empty;
        [SerializeField] private string openAIVectorStoreId = string.Empty;
 
        [Header("Instructions")]
        [SerializeField, TextArea(minLines: 16, maxLines: 32)] private string generalInstructions = string.Empty;
        [SerializeField] private InstructionSnippet[] contextInfos = new InstructionSnippet[0];
        [SerializeField] private InstructionSnippet[] backgroundInfos = new InstructionSnippet[0];
        [SerializeField] private InstructionSnippet[] personalityInfos = new InstructionSnippet[0];
        [SerializeField] private InstructionSnippet[] exampleResponses = new InstructionSnippet[0];
 
        // Public Interface
        public Persona GetPersona() { return persona; }
 
        public bool AreAllFeaturesEnabled(Feature features) { return (enabledFeatures & features) == features; }
 
        public bool IsAnyFeatureEnabled(Feature features) { return (enabledFeatures & features) != 0; }
 
        public string GetElevenLabsVoiceID() { return elevenLabsVoiceId; }
 
        public string GetOpenAIVectorStoreID() { return openAIVectorStoreId; }
 
        public string GetInstructions() {
            string instructions = $"You will be playing a character named {this.persona}.\n\n";
            instructions += generalInstructions + "\n\n";
            instructions += GetSnippetsInstructions("Here are some context information about your character:", contextInfos);
            instructions += GetSnippetsInstructions("Here are some background information about your character:", backgroundInfos);
            instructions += GetSnippetsInstructions("Here are some personality information about your character:", personalityInfos);
            instructions += GetSnippetsInstructions("Here are some example responses that you should style your own responses after:", exampleResponses);
            return instructions;
        }
 
        /// <summary>
        /// Overrides any actor config if value is set in ActorOverrides.ini.
        /// </summary>
        /// <returns>Returns a copy of this ActorConfig with values overridden.</returns>
        public ActorConfig Override() {
            ActorConfig overriddenConfig = Instantiate(this);
 
            string filePath = $"{Application.streamingAssetsPath}/Configs/{OverrideFileName}";
            IConfiguration config = new ConfigurationBuilder().AddIniFile(filePath).Build();
            IConfigurationSection section = config.GetSection(persona.ToString());
 
            // We cannot proceed if the section does not exist.
            if (section == null) {
                Debug.LogWarning($"Section {persona.ToString()} not found in {filePath}!");
                return overriddenConfig;
            }
 
            // Define a helper function.
            Func<string, string> GetValue = (string key) => { return section[key] == null ? string.Empty : section[key].Trim(); };
            string value = string.Empty;
 
            // Override OpenAI Vector Store ID
            value = GetValue("openai_vector_store_id");
            if (!string.IsNullOrEmpty(value)) {
                Debug.Log($"Overrode {persona.ToString()}'s OpenAI Vector Store ID.");
                overriddenConfig.openAIVectorStoreId = value;
            }
 
            // Override ElevenLabs Voice ID
            value = GetValue("elevenlabs_voice_id");
            if (!string.IsNullOrEmpty(value)) {
                Debug.Log($"Overrode {persona.ToString()}'s ElevenLabs Voice ID.");
                overriddenConfig.elevenLabsVoiceId = value.Trim();
            }
 
            // Override Features
            value = GetValue("feature_web_search");
            if (!string.IsNullOrEmpty(value)) {
                if (value.ToUpper() == "TRUE") {
                    Debug.Log($"Overrode {persona.ToString()}'s Web Search Feature Setting To TRUE.");
                    overriddenConfig.enabledFeatures |= Feature.WebSearch;
                } else if (value.ToUpper() == "FALSE") {
                    Debug.Log($"Overrode {persona.ToString()}'s Web Search Feature Setting To TRUE.");
                    overriddenConfig.enabledFeatures &= ~Feature.WebSearch;
                }
            }
 
            value = GetValue("feature_file_search");
            if (!string.IsNullOrEmpty(value)) {
                if (value.ToUpper() == "TRUE") {
                    Debug.Log($"Overrode {persona.ToString()}'s File Search Feature Setting To TRUE.");
                    overriddenConfig.enabledFeatures |= Feature.FileSearch;
                } else if (value.ToUpper() == "FALSE") {
                    Debug.Log($"Overrode {persona.ToString()}'s File Search Feature Setting To FALSE.");
                    overriddenConfig.enabledFeatures &= ~Feature.FileSearch;
                }
            }
 
            value = GetValue("feature_reasoning");
            if (!string.IsNullOrEmpty(value)) {
                if (value.ToUpper() == "TRUE") {
                    Debug.Log($"Overrode {persona.ToString()}'s Reasoning Feature Setting To TRUE.");
                    overriddenConfig.enabledFeatures |= Feature.Reasoning;
                } else if (value.ToUpper() == "FALSE") {
                    Debug.Log($"Overrode {persona.ToString()}'s Reasoning Feature Setting To FALSE.");
                    overriddenConfig.enabledFeatures &= ~Feature.Reasoning;
                }
            }
 
            value = GetValue("feature_audio_tags");
            if (!string.IsNullOrEmpty(value)) {
                if (value.ToUpper() == "TRUE") {
                    Debug.Log($"Overrode {persona.ToString()}'s Audio Tags Feature Setting To TRUE.");
                    overriddenConfig.enabledFeatures |= Feature.AudioTags;
                } else if (value.ToUpper() == "FALSE") {
                    Debug.Log($"Overrode {persona.ToString()}'s Audio Tags Feature Setting To FALSE.");
                    overriddenConfig.enabledFeatures &= ~Feature.AudioTags;
                }
            }
 
            return overriddenConfig;
        }
 
        // Internal Variables
        private string GetSnippetsInstructions(string prefix, InstructionSnippet[] snippets) {
            // Check if there are any valid snippets.
            bool hasValidSnippets = false;
            foreach (InstructionSnippet snippet in snippets) {
                if (snippet == null) { continue; }
                hasValidSnippets = hasValidSnippets || snippet.enabled;
            }
            if (!hasValidSnippets) { return string.Empty; }
 
            // Combine all the snippets into a single string.
            string instructions = $"{prefix}\n";
            foreach (InstructionSnippet snippet in snippets) {
                if (snippet == null) { continue; }
                if (!snippet.enabled) { continue; }
                instructions += $"{snippet.instruction}\n";
            }
            return instructions + "\n";
        }
    }
}