EchoTrio
 
Loading...
Searching...
No Matches
EchoTrio.ActorConfig Class Reference
Inheritance diagram for EchoTrio.ActorConfig:
Inheritance graph
Collaboration diagram for EchoTrio.ActorConfig:
Collaboration graph

Classes

class  InstructionSnippet
 

Public Types

enum  Feature { WebSearch = 1 << 0 , FileSearch = 1 << 1 , Reasoning = 1 << 2 , AudioTags = 1 << 3 }
 Flags to enable or disable actor features. More...
 

Public Member Functions

Persona GetPersona ()
 
bool AreAllFeaturesEnabled (Feature features)
 
bool IsAnyFeatureEnabled (Feature features)
 
string GetElevenLabsVoiceID ()
 
string GetOpenAIVectorStoreID ()
 
string GetInstructions ()
 
ActorConfig Override ()
 Overrides any actor config if value is set in ActorOverrides.ini.
 

Private Member Functions

string GetSnippetsInstructions (string prefix, InstructionSnippet[] snippets)
 

Private Attributes

Persona persona = PersonaExtensions.DefaultValue
 
Feature enabledFeatures = Feature.WebSearch | Feature.FileSearch | Feature.Reasoning | Feature.AudioTags
 
string elevenLabsVoiceId = string.Empty
 
string openAIVectorStoreId = string.Empty
 
string generalInstructions = string.Empty
 
InstructionSnippet[] contextInfos = new InstructionSnippet[0]
 
InstructionSnippet[] backgroundInfos = new InstructionSnippet[0]
 
InstructionSnippet[] personalityInfos = new InstructionSnippet[0]
 
InstructionSnippet[] exampleResponses = new InstructionSnippet[0]
 

Static Private Attributes

const string OverrideFileName = "ActorOverrides.ini"
 

Detailed Description

Actor's configuration as a ScriptableObject. Some configurations can be overridden via the ActorOverrides.ini file.

Definition at line 9 of file ActorConfig.cs.

Member Enumeration Documentation

◆ Feature

Flags to enable or disable actor features.

Enumerator
WebSearch 

Allow the actor's OpenAI model to access the internet and search for information.

FileSearch 

Allow the actor's OpenAI model to access files uploaded into the vector store. https://platform.openai.com/storage.

Reasoning 

Allow the actor's OpenAI model to provide its reasoning when generating a response.

AudioTags 

Allow the actor's ElevenLabs model to use audio tags to generate more expressive dialouge. https://elevenlabs.io/blog/v3-audiotags.

Definition at line 18 of file ActorConfig.cs.

Member Function Documentation

◆ AreAllFeaturesEnabled()

bool EchoTrio.ActorConfig.AreAllFeaturesEnabled ( Feature  features)
inline

Definition at line 45 of file ActorConfig.cs.

◆ GetElevenLabsVoiceID()

string EchoTrio.ActorConfig.GetElevenLabsVoiceID ( )
inline

Definition at line 49 of file ActorConfig.cs.

◆ GetInstructions()

string EchoTrio.ActorConfig.GetInstructions ( )
inline

Definition at line 53 of file ActorConfig.cs.

◆ GetOpenAIVectorStoreID()

string EchoTrio.ActorConfig.GetOpenAIVectorStoreID ( )
inline

Definition at line 51 of file ActorConfig.cs.

◆ GetPersona()

Persona EchoTrio.ActorConfig.GetPersona ( )
inline

Definition at line 43 of file ActorConfig.cs.

◆ GetSnippetsInstructions()

string EchoTrio.ActorConfig.GetSnippetsInstructions ( string  prefix,
InstructionSnippet[]  snippets 
)
inlineprivate

Definition at line 147 of file ActorConfig.cs.

◆ IsAnyFeatureEnabled()

bool EchoTrio.ActorConfig.IsAnyFeatureEnabled ( Feature  features)
inline

Definition at line 47 of file ActorConfig.cs.

◆ Override()

ActorConfig EchoTrio.ActorConfig.Override ( )
inline

Overrides any actor config if value is set in ActorOverrides.ini.

Returns
Returns a copy of this ActorConfig with values overridden.

Definition at line 67 of file ActorConfig.cs.

Member Data Documentation

◆ backgroundInfos

InstructionSnippet [] EchoTrio.ActorConfig.backgroundInfos = new InstructionSnippet[0]
private

Definition at line 38 of file ActorConfig.cs.

◆ contextInfos

InstructionSnippet [] EchoTrio.ActorConfig.contextInfos = new InstructionSnippet[0]
private

Definition at line 37 of file ActorConfig.cs.

◆ elevenLabsVoiceId

string EchoTrio.ActorConfig.elevenLabsVoiceId = string.Empty
private

Definition at line 32 of file ActorConfig.cs.

◆ enabledFeatures

Feature EchoTrio.ActorConfig.enabledFeatures = Feature.WebSearch | Feature.FileSearch | Feature.Reasoning | Feature.AudioTags
private

Definition at line 31 of file ActorConfig.cs.

◆ exampleResponses

InstructionSnippet [] EchoTrio.ActorConfig.exampleResponses = new InstructionSnippet[0]
private

Definition at line 40 of file ActorConfig.cs.

◆ generalInstructions

string EchoTrio.ActorConfig.generalInstructions = string.Empty
private

Definition at line 36 of file ActorConfig.cs.

◆ openAIVectorStoreId

string EchoTrio.ActorConfig.openAIVectorStoreId = string.Empty
private

Definition at line 33 of file ActorConfig.cs.

◆ OverrideFileName

const string EchoTrio.ActorConfig.OverrideFileName = "ActorOverrides.ini"
staticprivate

Definition at line 10 of file ActorConfig.cs.

◆ persona

Persona EchoTrio.ActorConfig.persona = PersonaExtensions.DefaultValue
private

Definition at line 30 of file ActorConfig.cs.

◆ personalityInfos

InstructionSnippet [] EchoTrio.ActorConfig.personalityInfos = new InstructionSnippet[0]
private

Definition at line 39 of file ActorConfig.cs.


The documentation for this class was generated from the following file: