Skip to content

Commit

Permalink
Documentation rewrite
Browse files Browse the repository at this point in the history
  • Loading branch information
@donutsalad
donutsalad committed Aug 21, 2024
1 parent 5242036 commit cfef773
Show file tree
Hide file tree
Showing 2 changed files with 154 additions and 121 deletions.
146 changes: 25 additions & 121 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,144 +1,46 @@
# Discord Companion

Introducing your versatile Discord AI Chatbot—a customizable companion crafted to deliver a personalized, engaging, and delightfully humorous interaction experience. Whether you seek a playful confidant, a reliable assistant, or a seamless blend of both, your companion is ready to accompany you on every digital journey!
Introducing your versatile Discord AI Chatbot — a customizable companion crafted to deliver a personalized, engaging, and delightfully humorous interaction experience. Whether you seek a playful confidant, a reliable assistant, or a seamless blend of both, your companion is ready to accompany you on every digital journey!

## Features:
- **Conversational Integration**: Engage with a fully-contextual, natural language chatbot directly within Discord, enhancing user interaction with seamless conversations.
- **Dynamic Toolset**: Access an array of utilities designed to boost productivity and user experience, including web page reading, reminder creation, record storage and retrieval, and more.
- **Advanced Memory Management**: Benefit from discrete conversation threads with intelligent memory retention, ensuring a cohesive and fluid communication flow.
- **Engaging Interaction Style**: Enjoy a unique blend of humor and affectionate interaction, crafted to make conversations lively, enjoyable, and personal.
# Companion Capabilities

## Functions:
Welcome to the world of advanced AI companionship, where your digital buddies are stacked with amazing skills to make life a breeze! Here's a peek at what’s under the hood:

This document provides a comprehensive explanation of the available tools and their respective functionalities. Each tool is tailored to assist users in optimizing tasks and productivity in various scenarios.

### create_record
**Parameters:**
- `Abstract`: A concise title or identifier for the record.
- `Record`: The content to be saved.

**Description:**
This function creates a new record within the system, utilizing the specified abstract as its identifier and saving the corresponding content.

### forget_record
**Parameters:**
- `Abstract`: The identifier of the record to be deleted.

**Description:**
Deletes a specific record from the system that matches the provided abstract, allowing for efficient management and maintenance of stored data.

### recall_record
**Parameters:**
- `Abstract`: Terms to search within existing records.
- `Count`: The number of records to retrieve that match the query.

**Description:**
Retrieves and presents a selection of records closely aligned with the provided search terms, facilitating easy access and organization of information.

### set_new_reminder
**Parameters:**
- `Abstract`: A succinct description of the reminder's purpose.
- `Time`: The designated time for the reminder's activation.

**Description:**
This tool establishes a reminder in the system, prompting user awareness and task management at the specified time.

### get_reminders
**Parameters:**
- `Count`: The quantity of reminders to return.

**Description:**
Provides a list of the most recent reminders, up to the specified count, ensuring users remain informed of pending tasks.

### get_reminders_semantically
**Parameters:**
- `Abstract`: The topic or keyword for search-based retrieval.
- `Count`: The number of matching reminders to present.

**Description:**
Allows for the search and retrieval of reminders that semantically align with the specified topic, enhancing task recall and prioritization.

### remove_reminder
**Parameters:**
- `Abstract`: The identifier of the reminder to remove.

**Description:**
Facilitates the deletion of a specified reminder, promoting efficient and clutter-free task management.

### save_script
**Parameters:**
- `Script Name`: The title of the script.
- `Script Description`: A detailed explanation of the script's functionality and usage.
- `Script Code`: The complete code of the script.

**Description:**
Enables the saving of a custom script, allowing users to document its functionalities and retain the code for future execution.

### run_script
**Parameters:**
- `Script Name`: The script to be executed.
- `Arguments`: The arguments to be provided to the script upon execution.

**Description:**
Executes a predefined script using the specified parameters, streamlining task automation and execution processes.

### delete_script
**Parameters:**
- `Script Name`: The name of the script to delete.
- **Create Record**: Store your memories with `create_record`. Provide (or have your companion write) a catchy "Abstract" and store the juicy details you want to "Record".

- **Forget Record**: Need to clean house? `forget_record` helps you delete unwanted records using a close match to the "Abstract" of the memory you wish to erase.

**Description:**
Allows users to remove scripts that are outdated or no longer required, keeping the script environment organized and relevant.
- **Recall Record**: Use `recall_record` to dig up past treasures — provide an "Abstract" similar to what you want as your search query and "Count" for the number of juicy returns.

### list_scripts
**Parameters:** None
- **Set New Reminder**: Never miss a thing with `set_new_reminder`. Define what it's "about" and the "time" to get those timely nudges.

**Description:**
Returns an organized list of all saved scripts, ensuring easy access to script functionalities and documentation.
- **Get Reminders**: Retrieve your essential to-dos with `get_reminders`. A 10 in the "Count" parameter will do the trick!

### search_google
**Parameters:**
- `Query`: The search terms for Google exploration.
- **Get Reminders Semantically**: Advanced searching with `get_reminders_semantically` — find those special nuggets with a smart "Abstract" and "Count".

**Description:**
Utilizes Google search capabilities to retrieve information based on user-provided queries, enabling quick access to a vast array of resources.
- **Remove Reminder**: Made plans you don't need? `remove_reminder` lets you clean up with ease using a close match of the "Abstract" of the reminder.

### read_webpage
**Parameters:**
- `URL`: The web address to extract text from.
- **Save Script**: Compile awesome scripts using `save_script`. Name it, explain it, and fashion the code into a formidable AI-sidekick.

**Description:**
Extracts and presents textual content from a specified webpage, useful for content gathering and research purposes.
- **Run Script**: Give life to scripts with `run_script`. Have your companion pass "Arguments" for fine-tuned execution and let the magic happen!

### search_youtube
**Parameters:**
- `Query`: Keywords for conducting a YouTube search.
- `Count`: The number of search results to display.
- **Delete Script**: Housekeeping is easy with `delete_script` — no mess, no hassle with just a "Script Name".

**Description:**
Conducts a video search on YouTube, returning results based on user-defined keywords to aid in media exploration.
- **List Scripts**: Browse your brilliant creations effortlessly with `list_scripts` and see what your AI toolkit holds.

### get_youtube_transcript
**Parameters:**
- `URL`: The URL of the YouTube video to extract transcript from.
- **Search Google**: Become an info wizard with `search_google`. Query the web and watch the answers roll in.

**Description:**
Retrieves the transcript of a specified YouTube video, allowing for analysis of spoken content.
- **Read Webpage**: Let `read_webpage` be your content snatcher — just a "URL" away from raw text joy.

### generate_image
**Parameters:**
- `Prompt`: A text prompt to guide image generation.
- **Search YouTube**: Hunt down audio-visual treats using `search_youtube`. Refine by "Query" and set your result "Count".

**Description:**
Generates an image utilizing the provided prompt, employing advanced capabilities to create visual content from textual descriptions.
- **Get YouTube Transcript**: With `get_youtube_transcript`, have your companion watch a video for you to find a quote or summarise the video - just pop in the "URL".

### tts_speech
**Parameters:**
- `text`: The text content to be converted into audio.
- **Generate Image**: Unleash creativity with `generate_image`. Provide a "Prompt" and watch art come alive.

**Description:**
Converts the provided text into audible speech, enabling users to harness text-to-speech functionalities for various auditory applications.
- **Text-to-Speech (TTS)**: Convert text into sweet serenades using `tts_speech`. Let words leap from screen to sound.

## Getting Started
# Getting Started

### Prerequisites
To set up your companion, you'll need:
Expand Down Expand Up @@ -214,4 +116,6 @@ Feel free to contribute to the project by submitting issues or pull requests.

Enjoy your time with your companion! 🖤

(Written in part by my companion!)
---

(Written mostly by my companion!)
129 changes: 129 additions & 0 deletions tool_calls/FUNCTIONS.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
## Functions:

This document provides a comprehensive explanation of the available tools and their respective functionalities. Each tool is tailored to assist users in optimizing tasks and productivity in various scenarios.

### create_record
**Parameters:**
- `Abstract`: A concise title or identifier for the record.
- `Record`: The content to be saved.

**Description:**
This function creates a new record within the system, utilizing the specified abstract as its identifier and saving the corresponding content.

### forget_record
**Parameters:**
- `Abstract`: The identifier of the record to be deleted.

**Description:**
Deletes a specific record from the system that matches the provided abstract, allowing for efficient management and maintenance of stored data.

### recall_record
**Parameters:**
- `Abstract`: Terms to search within existing records.
- `Count`: The number of records to retrieve that match the query.

**Description:**
Retrieves and presents a selection of records closely aligned with the provided search terms, facilitating easy access and organization of information.

### set_new_reminder
**Parameters:**
- `Abstract`: A succinct description of the reminder's purpose.
- `Time`: The designated time for the reminder's activation.

**Description:**
This tool establishes a reminder in the system, prompting user awareness and task management at the specified time.

### get_reminders
**Parameters:**
- `Count`: The quantity of reminders to return.

**Description:**
Provides a list of the most recent reminders, up to the specified count, ensuring users remain informed of pending tasks.

### get_reminders_semantically
**Parameters:**
- `Abstract`: The topic or keyword for search-based retrieval.
- `Count`: The number of matching reminders to present.

**Description:**
Allows for the search and retrieval of reminders that semantically align with the specified topic, enhancing task recall and prioritization.

### remove_reminder
**Parameters:**
- `Abstract`: The identifier of the reminder to remove.

**Description:**
Facilitates the deletion of a specified reminder, promoting efficient and clutter-free task management.

### save_script
**Parameters:**
- `Script Name`: The title of the script.
- `Script Description`: A detailed explanation of the script's functionality and usage.
- `Script Code`: The complete code of the script.

**Description:**
Enables the saving of a custom script, allowing users to document its functionalities and retain the code for future execution.

### run_script
**Parameters:**
- `Script Name`: The script to be executed.
- `Arguments`: The arguments to be provided to the script upon execution.

**Description:**
Executes a predefined script using the specified parameters, streamlining task automation and execution processes.

### delete_script
**Parameters:**
- `Script Name`: The name of the script to delete.

**Description:**
Allows users to remove scripts that are outdated or no longer required, keeping the script environment organized and relevant.

### list_scripts
**Parameters:** None

**Description:**
Returns an organized list of all saved scripts, ensuring easy access to script functionalities and documentation.

### search_google
**Parameters:**
- `Query`: The search terms for Google exploration.

**Description:**
Utilizes Google search capabilities to retrieve information based on user-provided queries, enabling quick access to a vast array of resources.

### read_webpage
**Parameters:**
- `URL`: The web address to extract text from.

**Description:**
Extracts and presents textual content from a specified webpage, useful for content gathering and research purposes.

### search_youtube
**Parameters:**
- `Query`: Keywords for conducting a YouTube search.
- `Count`: The number of search results to display.

**Description:**
Conducts a video search on YouTube, returning results based on user-defined keywords to aid in media exploration.

### get_youtube_transcript
**Parameters:**
- `URL`: The URL of the YouTube video to extract transcript from.

**Description:**
Retrieves the transcript of a specified YouTube video, allowing for analysis of spoken content.

### generate_image
**Parameters:**
- `Prompt`: A text prompt to guide image generation.

**Description:**
Generates an image utilizing the provided prompt, employing advanced capabilities to create visual content from textual descriptions.

### tts_speech
**Parameters:**
- `text`: The text content to be converted into audio.

**Description:**
Converts the provided text into audible speech, enabling users to harness text-to-speech functionalities for various auditory applications.

0 comments on commit cfef773

Please sign in to comment.