Rename agent->assistant

Author: bsquizz

README.md

@@ -1,9 +1,9 @@
 
 # 🍊 tangerine (backend) <!-- omit from toc -->
 
-tangerine is a slim and light-weight RAG (Retieval Augmented Generated) system used to create and manage chat bot agents.
+tangerine is a slim and light-weight RAG (Retieval Augmented Generated) system used to create and manage chat bot assistants.
 
-Each agent is intended to answer questions related to a set of documents known as a knowledge base (KB).
+Each assistant is intended to answer questions related to a set of documents known as a knowledge base (KB).
 
 ![Demo video](docs/demo.gif)
 
@@ -61,10 +61,10 @@ It was born out of a hack-a-thon and is still a work in progress. You will find
 
 #### Retrieval Augmented Generation (RAG)
 
-- **1:** A user presents a question to an agent in the chat interface
+- **1:** A user presents a question to an assistant in the chat interface
 - **2:** Embeddings are created for the query using the embedding model
 - **3:** A similarity search and a max marginal relevance search are performed against the vector DB to find the top N most relevant document chunks
-  - The document set searched is scoped only to that specific agent
+  - The document set searched is scoped only to that specific assistant
 - **4:** The LLM is prompted to answer the question using only the context found within the relevant document chunks
 - **5:** The LLM response is streamed by the backend service to the user. Metadata containing the document chunks are also returned to be used as citations.
 
@@ -110,7 +110,7 @@ Our documentation set has initially focused on pages that have been compiled usi
 
 The **tangerine-backend** service manages:
 
-- Create/update/delete of chat bot "agents" via REST API.
+- Create/update/delete of chat bot "assistants" via REST API.
 - Document ingestion
   - Upload via the API, or sync via an s3 bucket
   - Text cleanup/conversion
@@ -176,7 +176,7 @@ The docker compose file offers an easy way to spin up all components. [ollama](h
 6. Access the API on port `8000`
 
    ```sh
-   curl -XGET 127.0.0.1:8000/api/agents
+   curl -XGET 127.0.0.1:8000/api/assistants
    {
        "data": []
    }
@@ -293,7 +293,7 @@ to use this to test different embedding models that are not supported by ollama,
 1. Access the API on port `8000`
 
     ```sh
-    curl -XGET 127.0.0.1:8000/api/agents
+    curl -XGET 127.0.0.1:8000/api/assistants
     {
        "data": []
     }
@@ -376,7 +376,7 @@ Comment out `ollama` from the compose file, or stop the ollama container. Invoke
 
 ## Synchronizing Documents from S3
 
-You can configure a set of agents and continually sync their knowledge base via documents stored in an S3 bucket.
+You can configure a set of assistants and continually sync their knowledge base via documents stored in an S3 bucket.
 
 To do so you'll need to do the following:
 
@@ -400,7 +400,7 @@ To do so you'll need to do the following:
    echo 'BUCKET=mybucket' >> .env
    ```
 
-1. Create an `s3.yaml` file that describes your agents and the documents they should ingest. See [s3-example.yaml](s3-example.yaml) for an example.
+1. Create an `s3.yaml` file that describes your assistants and the documents they should ingest. See [s3-example.yaml](s3-example.yaml) for an example.
 
    If using docker compose, copy this config into your container:
 
@@ -422,7 +422,7 @@ To do so you'll need to do the following:
     flask s3sync
     ```
 
-The sync creates agents and ingests the configured documents for each agent. After initial creation, when the task is run it checks the S3 bucket for updates and will only re-ingest files into the vector DB when it detects file changes.
+The sync creates assistants and ingests the configured documents for each assistant. After initial creation, when the task is run it checks the S3 bucket for updates and will only re-ingest files into the vector DB when it detects file changes.
 
 The OpenShift templates contain a CronJob configuration that is used to run this document sync repeatedly.
 
@@ -445,19 +445,19 @@ This repository provides [OpenShift templates](openshift/) for all infrastructur
 
 ## Run Tangerine Frontend Locally
 
-The API can be used to create/manage/update agents, upload documents, and to chat with each agent. However, the frontend provides a simpler interface to manage the service with. To run the UI in a development environment, see [tangerine-frontend](https://github.com/RedHatInsights/tangerine-frontend)
+The API can be used to create/manage/update assistants, upload documents, and to chat with each assistant. However, the frontend provides a simpler interface to manage the service with. To run the UI in a development environment, see [tangerine-frontend](https://github.com/RedHatInsights/tangerine-frontend)
 
 ## Available API Paths
 
 | Path                               | Method   | Description                |
 | ---------------------------------- | -------- | -------------------------- |
-| `/api/agents`                      | `GET`    | Get a list of all agents   |
-| `/api/agents`                      | `POST`   | Create a new agent         |
-| `/api/agents/<id>`                 | `GET`    | Get an agent               |
-| `/api/agents/<id>`                 | `PUT`    | Update an agent            |
-| `/api/agents/<id>`                 | `DELETE` | Delete an agent            |
-| `/api/agents/<id>/chat`            | `POST`   | Chat with an agent         |
-| `/api/agents/<id>/documents`       | `POST`   | Agent document uploads     |
-| `/api/agents/<id>/documents`       | `DELETE` | Delete agent documents     |
-| `/api/agentDefaults`               | `GET`    | Get agent default settings |
+| `/api/assistants`                      | `GET`    | Get a list of all assistants   |
+| `/api/assistants`                      | `POST`   | Create a new assistant         |
+| `/api/assistants/<id>`                 | `GET`    | Get an assistant               |
+| `/api/assistants/<id>`                 | `PUT`    | Update an assistant            |
+| `/api/assistants/<id>`                 | `DELETE` | Delete an assistant            |
+| `/api/assistants/<id>/chat`            | `POST`   | Chat with an assistant         |
+| `/api/assistants/<id>/documents`       | `POST`   | Assistant document uploads     |
+| `/api/assistants/<id>/documents`       | `DELETE` | Delete assistant documents     |
+| `/api/assistantDefaults`               | `GET`    | Get assistant default settings |
 | `/ping`                            | `GET`    | Health check endpoint      |

openshift/s3sync-cronjob.template.yaml

@@ -60,15 +60,15 @@ objects:
           - md
         citation_url_template: 'https://files.test/{{ full_path }}'
 
-      agents:
-        - name: agent1
-          description: Agent One
+      assistants:
+        - name: assistant1
+          description: Assistant One
           bucket: mybucket
           paths:
             - prefix: path/in/bucket
 
-        - name: agent2
-          description: Agent Two
+        - name: assistant2
+          description: Assistant Two
           bucket: mybucket
           paths:
             - prefix: other/path/in/bucket

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "tangerine"
 version = "0.0.1"
-description = "A slim and light-weight RAG (Retieval Augmented Generated) system used to create and manage chat bot agents."
+description = "A slim and light-weight RAG (Retieval Augmented Generated) system used to create and manage chat bot assistants."
 readme = "README.md"
 requires-python = ">=3.12"
 classifiers = [

s3-example.yaml

@@ -4,15 +4,15 @@ defaults:
     - md
   citation_url_template: 'https://files.test/{{ full_path }}'
 
-agents:
-  - name: agent1
-    description: Agent One
+assistants:
+  - name: assistant1
+    description: Assistant One
     bucket: mybucket
     paths:
       - prefix: path/in/bucket
 
-  - name: agent2
-    description: Agent Two
+  - name: assistant2
+    description: Assistant Two
     bucket: mybucket
     paths:
       - prefix: other/path/in/bucket

src/tangerine/__init__.py

@@ -54,7 +54,7 @@ def create_app():
 
 
 @click.command("s3sync")
-@click.option("--force-resync", is_flag=True, help="Delete all files from agents and re-import")
+@click.option("--force-resync", is_flag=True, help="Delete all files from assistants and re-import")
 @click.option(
     "--force-resync-until",
     help=(

src/tangerine/llm.py

@@ -11,12 +11,14 @@
 
 import tangerine.config as cfg
 from tangerine.metrics import get_counter, get_gauge
-from tangerine.models.agent import Agent
+from tangerine.models.assistant import Assistant
 
 log = logging.getLogger("tangerine.llm")
 
-agent_response_counter = get_counter(
-    "agent_response_counter", "Total number of responses for an agent", ["agent_id", "agent_name"]
+assistant_response_counter = get_counter(
+    "assistant_response_counter",
+    "Total number of responses for an assistant",
+    ["assistant_id", "assistant_name"],
 )
 llm_completion_tokens_metric = get_counter("llm_completion_tokens", "LLM completion tokens usage")
 llm_prompt_tokens_metric = get_counter("llm_prompt_tokens", "LLM prompt tokens usage")
@@ -26,7 +28,9 @@
 llm_processing_rate = get_gauge(
     "llm_processing_rate", "Observed tokens per sec for most recent LLM processing after prompted"
 )
-llm_no_answer = get_counter("llm_no_answer", "No search results found", ["agent_id", "agent_name"])
+llm_no_answer = get_counter(
+    "llm_no_answer", "No search results found", ["assistant_id", "assistant_name"]
+)
 
 
 def _record_metrics(
@@ -147,7 +151,7 @@ def rerank(query, search_results):
 
 
 def ask(
-    agent: Agent,
+    assistant: Assistant,
     previous_messages,
     question,
     search_results: list[Document],
@@ -161,17 +165,19 @@ def ask(
     if len(search_results) == 0:
         log.debug("given 0 search results")
         search_context = "No matching search results found"
-        llm_no_answer.labels(agent_id=agent.id, agent_name=agent.name).inc()
+        llm_no_answer.labels(assistant_id=assistant.id, assistant_name=assistant.name).inc()
     else:
         search_context, search_metadata = _build_context(search_results)
-        agent_response_counter.labels(agent_id=agent.id, agent_name=agent.name).inc()
+        assistant_response_counter.labels(
+            assistant_id=assistant.id, assistant_name=assistant.name
+        ).inc()
 
     if not search_metadata:
         search_metadata = [{}]
     for m in search_metadata:
         m["interactionId"] = interaction_id
 
-    msg_list = [("system", agent.system_prompt or cfg.DEFAULT_SYSTEM_PROMPT)]
+    msg_list = [("system", assistant.system_prompt or cfg.DEFAULT_SYSTEM_PROMPT)]
     if previous_messages:
         for msg in previous_messages:
             if msg["sender"] == "human":

src/tangerine/models/__init__.py

@@ -1,5 +1,5 @@
 # import all models
-from .agent import Agent
+from .assistant import Assistant
 from .interactions import Interaction, QuestionEmbedding, RelevanceScore, UserFeedback
 
-__all__ = ["Agent", "RelevanceScore", "QuestionEmbedding", "UserFeedback", "Interaction"]
+__all__ = ["Assistant", "RelevanceScore", "QuestionEmbedding", "UserFeedback", "Interaction"]

src/tangerine/models/agent.py

@@ -4,10 +4,10 @@
 import tangerine.config as cfg
 from tangerine.db import db
 
-log = logging.getLogger("tangerine.models.agent")
+log = logging.getLogger("tangerine.models.assistant")
 
 
-class Agent(db.Model):
+class Assistant(db.Model):
     id = db.Column(db.Integer, primary_key=True, autoincrement=True)
     name = db.Column(db.String(50), nullable=False)
     description = db.Column(db.Text, nullable=False)
@@ -18,38 +18,38 @@ def to_dict(self):
         return {c.name: getattr(self, c.name) for c in self.__table__.columns}
 
     def __repr__(self):
-        return f"<Agent {self.id}>"
+        return f"<Assistant {self.id}>"
 
     @classmethod
     def create(cls, name: str, description: str, system_prompt: str = None, **kwargs) -> Self:
-        new_agent = cls(
+        new_assistant = cls(
             name=name,
             description=description,
             system_prompt=system_prompt or cfg.DEFAULT_SYSTEM_PROMPT,
         )
-        db.session.add(new_agent)
+        db.session.add(new_assistant)
         db.session.commit()
-        db.session.refresh(new_agent)
+        db.session.refresh(new_assistant)
 
-        log.debug("agent %d created", new_agent.id)
+        log.debug("assistant %d created", new_assistant.id)
 
-        return new_agent
+        return new_assistant
 
     @classmethod
     def list(cls) -> List[Self]:
         return db.session.scalars(db.select(cls)).all()
 
     @classmethod
     def get(cls, id: int) -> Optional[Self]:
-        agent_id = int(id)
-        agent = db.session.get(cls, agent_id)
-        return agent
+        assistant_id = int(id)
+        assistant = db.session.get(cls, assistant_id)
+        return assistant
 
     @classmethod
     def get_by_name(cls, name: str) -> Optional[Self]:
-        agent = db.session.scalar(db.select(cls).filter_by(name=name))
-        log.debug("get agent by name '%s' result: %s", name, agent)
-        return agent
+        assistant = db.session.scalar(db.select(cls).filter_by(name=name))
+        log.debug("get assistant by name '%s' result: %s", name, assistant)
+        return assistant
 
     def update(self, **kwargs) -> Self:
         updated_keys = []
@@ -62,7 +62,7 @@ def update(self, **kwargs) -> Self:
         db.session.add(self)
         db.session.commit()
         db.session.refresh(self)
-        log.debug("updated attributes %s of agent %d", updated_keys, self.id)
+        log.debug("updated attributes %s of assistant %d", updated_keys, self.id)
         return self
 
     def add_files(self, file_display_names: Iterable[str]) -> Self:
@@ -72,7 +72,7 @@ def add_files(self, file_display_names: Iterable[str]) -> Self:
             if name not in filenames:
                 filenames.append(name)
         log.debug(
-            "adding %d files to agent %d, total files now %d",
+            "adding %d files to assistant %d, total files now %d",
             len(file_display_names),
             self.id,
             len(filenames),
@@ -85,7 +85,7 @@ def remove_files(self, file_display_names: Iterable[str]) -> Self:
         new_count = len(new_names)
         diff = old_count - new_count
         log.debug(
-            "removing %d files from agent %d, old count %d, new count %d",
+            "removing %d files from assistant %d, old count %d, new count %d",
             diff,
             self.id,
             old_count,
@@ -98,4 +98,4 @@ def remove_files(self, file_display_names: Iterable[str]) -> Self:
     def delete(self) -> None:
         db.session.delete(self)
         db.session.commit()
-        log.debug("agent with id %d deleted", self.id)
+        log.debug("assistant with id %d deleted", self.id)