Agent - Application Configuration

1 Configuration Structure
- 1.1 1. Features
  - 1.1.1 Available Features settings:
  - 1.1.2 Example Features configuration:
- 1.2 2. Actions
  - 1.2.1 Available Actions settings:
  - 1.2.2 Example Actions configuration:
- 1.3 3. General Settings
  - 1.3.1 Available General settings:
  - 1.3.2 Example General configuration:
2 Editing the Configuration File

Configuration Structure

The configuration file is structured into three main sections: features, commands, and general. Each section contains various settings that can be enabled or disabled, along with additional parameters that can be adjusted to modify the application's behavior.

1. Features

The features section allows you to enable or disable specific functionalities within the application.

Available Features settings:

sharing: Enables or disables the sharing functionality.
workflows: Controls the availability of workflow features.
chatbots: Manages chatbot settings, including the maximum number of conversations and messages per conversation.
promptAssistance: Enables assistance for prompts.
suggestions: Configures suggestion settings, including maximum search phrase length and the number of suggestions returned.
speechToSpeech: Enables speech-to-speech functionality.
dataRetention: Manages data retention policies, including expiration times for data and files.
textExtraction: Configures text extraction capabilities using different extractors.

Example Features configuration:

"features": {
    "sharing": {
        "enabled": true
    },
    "workflows": {
        "enabled": false
    },
    "chatbots": {
        "enabled": false,
        "maxConversations": 1000,
        "maxMessagesPerConversation": 100
    },
    "promptAssistance": {
        "enabled": true
    },
    "suggestions": {
        "enabled": false,
        "maxSearchPhraseLength": 50,
        "noOfReturnedSuggestions": 3,
        "noOfStoredSuggestions": 100
    },
    "speechToSpeech": {
        "enabled": true
    },
    "dataRetention": {
        "enabled": false,
        "executeImmediately": false,
        "expirationTimeDays": 30,
        "fileInactiveTimeDays": 20
    },
    "textExtraction": {
        "ayfieTextExtractor": {
            "enabled": true
        },
        "azureDocumentIntelligenceTextExtractor": {
            "enabled": true,
            "url": "https://azure-resource.cognitiveservices.azure.com/",
            "key": "*****"
        }
    }
}

2. Actions

The actions section allows you to enable or disable specific commands that the application can execute.

Available Actions settings:

analyze: Controls the availability of data analysis action.
generateImage: Controls the availability of the image generation action.
translate: Configures translation settings
- ratioForTranslationContent -determines the proportion of the model's output context size used for a single translation step
- requiredNoOfTokensForNotification - configures when to notify the user that the translated file is large, indicating that the translation process may take some time.
reason: Enables reasoning capabilities within the application.

Example Actions configuration:

 "actions": {
          "search": {
                  "enabled": true
          },
          "websearch": {
                  "enabled": true,
                  "provider": "google",
                  "maxResults": 5,
                  "maxConcurrentFetches": 5,
                  "fetchTimeout": 10,
                  "googleApiKey": "your_google_api_key",
                  "googleCseId": "your_google_cse_id",
                  "tavilyApiKey": "your_tavily_api_key"
          }
          "analyze": {
                  "enabled": true
          },
          "generateImage": {
                  "enabled": true
          },
          "translate": {
                  "enabled": true,
                  "ratioForTranslationContent": 0.5,
                  "requiredNoOfTokensForNotification": 2000
          },
          "reason": {
                  "enabled": true
          }
  },

3. General Settings

The general section contains settings that affect the overall behavior of the application.

Available General settings:

fileChunkSettings: Configures parameters related to file chunking, including:
- relevancyThreshold: Specifies the minimum rank required for a file chunk to be included in the conversation context. This threshold is applied only to file-specific queries when prompt assistance is enabled.
- embeddingChunkSize: Defines the minimum size of a single file chunk, measured in tokens.
chatHistory: Manages the storage limits for chat history, including:
- maxConversations: Sets the maximum number of conversations that can be stored.
- maxMessagesPerConversation: Determines the maximum number of messages that can be stored within each conversation.
temporaryData: Controls the expiration settings for temporary data:
- expirationTimeInSeconds: Specifies the duration for which temporary data remains valid. A value of -1 indicates that the data does not expire. This setting applies to data uploaded from Ayfie Locator to Ayfie Personal Assistant.

Example General configuration:

"general": {
    "fileChunkSettings": {
        "relevancyThreshold": 0.75,
        "embeddingChunkSize": 200
    },
    "chatHistory": {
        "maxConversations": 10,
        "maxMessagesPerConversation": 100
    },
    "temporaryData": {
        "expirationTimeInSeconds": -1
    }
}

Editing the Configuration File

To customize your instance, follow these steps:

Locate the JSON configuration file in your application directory.
Open the file using a text editor.
Modify the settings according to your requirements. Ensure that the updated file remains compliant with the JSON syntax requirements after the changes.
Save the changes and restart the application for the new settings to take effect.