Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Examples merged into main repo #286

Draft
wants to merge 18 commits into
base: dev
Choose a base branch
from
Draft

Examples merged into main repo #286

wants to merge 18 commits into from

Conversation

pseusys
Copy link
Collaborator

@pseusys pseusys commented Nov 21, 2023

Description

Examples from demo repository merged into examples directory.

Checklist

  • I have performed a self-review of the changes

Maybe examples should be added to docs?
To tests?
Testing them would require OpenAI and Telegram tokens.

To Consider

  • Add tests (if functionality is changed)
  • Update API reference / tutorials / guides
  • Update CONTRIBUTING.md (if devel workflow is changed)
  • Update .ignore files, scripts (such as lint), distribution manifest (if files are added/deleted)
  • Search for references to changed entities in the codebase

@pseusys pseusys added the enhancement New feature or request label Nov 21, 2023
@pseusys pseusys requested review from kudep and RLKRo November 21, 2023 09:14
Copy link
Member

@ruthenian8 ruthenian8 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated examples/customer_service_bot

examples/README.md Outdated Show resolved Hide resolved
examples/README.md Outdated Show resolved Hide resolved
examples/README.md Outdated Show resolved Hide resolved
examples/README.md Outdated Show resolved Hide resolved
examples/customer_service_bot/README.md Outdated Show resolved Hide resolved
examples/customer_service_bot/bot/requirements.txt Outdated Show resolved Hide resolved
examples/customer_service_bot/bot/test.py Outdated Show resolved Hide resolved
examples/customer_service_bot/bot/api/chatgpt.py Outdated Show resolved Hide resolved
examples/customer_service_bot/bot/api/chatgpt.py Outdated Show resolved Hide resolved
examples/customer_service_bot/README.md Outdated Show resolved Hide resolved
@RLKRo
Copy link
Member

RLKRo commented Nov 23, 2023

@ruthenian8
You can commit these changes instead of suggesting them if they're unlikely to cause any discussion.

@ruthenian8 ruthenian8 changed the base branch from master to dev November 23, 2023 10:47
@RLKRo
Copy link
Member

RLKRo commented Nov 24, 2023

I think we should change FAQ demo from answering questions about arch linux to answering questions about dff / deeppavlov. That way we could simultaneously teach users something about us or even use this bot in a production environment (e.g. as a helper in df designer).

Also, something to consider: we could make the FAQ bot multilingual (it would detect the language of the question and answer in the same language). That could be an interesting feature to showcase our users.

@RLKRo
Copy link
Member

RLKRo commented Nov 30, 2023

ToDo:

  • Add multiple languages (e.g. de, zh, ru, fr, es, en) and use placeholder instead of answers (or translate but check translation)
  • Merge two interfaces into one (use something similar to CallbackTelegramInterface; split endpoints across two files; merge them into a single FastAPI app in the main file; remove buttons from script)

This bot is designed to answer any type of user questions in a limited business domain (book shop).
Uses a Telegram interface.

You can read more about deploying the project in its README file.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link to readme file?


* The rest of the project-related Python code is factored out into other packages.

* We also create 'run.py' and 'test.py' at the project root. These files import the ready pipeline
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link to the files?

FAQ bot for Deeppavlov users built using `DFF`.
Can be run with Telegram or with a web interface.

You can read more about deploying the project in its README file.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link to the readme file?

The API responds with a nested array containing `label - score` pairs.

```json
[["no",0.3393537402153015]]
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[["no",0.3393537402153015]]
[["no", 0.3393537402153015]]

@Ramimashkouk Ramimashkouk mentioned this pull request Feb 12, 2024
4 tasks

Run the intent catcher:
```commandline
docker compose up --build --abort-on-container-exit --exit-code-from intent_client
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose this command should be:
docker compose up --build --abort-on-container-exit --exit-code-from intent_catcher for it to run.

Anyways, the command still runs with errors


Building the bot and launching it in the background can be done with a single command given that the environment variables have been configured correctly. Then you can immediately interact with your bot in Telegram.
```commandline
docker-compose up -d
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uniform the commands: with - or without

@RLKRo RLKRo added this to the Release v1.0 milestone Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants