PuterAi python_SDK

Puterai-python_sdk

Puterai Python SDK обеспечивает простой способ взаимодействия с API Putter AI для взаимодействия чат-ботов и генерации текста в речь (TTS). Этот SDK позволяет интегрировать функции Chatbot и TTS в ваши собственные приложения.

Функции

• Взаимодействие чат -бота : общаться с чатботом, питаемым от Putter AI.
• Текст в речь (TTS) : преобразовать любой текст в аудио с помощью службы AWS Polly TTS.

Структура проекта

Проект состоит из нескольких компонентов:

• login.py : скрипт для обработки входа пользователя и получения токена API для дальнейших запросов.
• cli.py : интерфейс командной строки, который позволяет пользователям взаимодействовать с чат-ботом Putter или генерировать выход TTS.
• server.py : API-сервер, основанный на колбе, который открывает конечные точки для функциональных возможностей Chatbot и TTS.
• example.html : простой фронт-конечный HTML для взаимодействия с чатботом и генерировать TTS через браузер.

Требования

Чтобы запустить этот проект, вам необходимо установить следующие зависимости:

• requests : обработать HTTP -запросы.
• flask : для сервера API.
• flask_cors : для обработки совместного использования ресурсов по перекрестному происхождению (CORS).
• dotenv : загрузить переменные среды из файла .env.

Вы можете установить необходимые зависимости с помощью:

pip install -r requirements.txt

Инструкции по настройке

1. Клонировать репозиторий

git clone https://github.com/mowhn/PuterAi-python_SDK.git
cd puterAi-python_SDK

2. Файл Setup .ENV в папках CLI и API

Создайте файл .env как в каталогах cli , так и в API и включите свой API_TOKEN:

 API_TOKEN = your_api_token_here

3. Получите жетон API

Чтобы быстро получить свой API_TOKEN , вы должны сначала запустить login.py , чтобы войти в систему и получить токен:

• Запустить login.py :

   cd cli
  python login.py

  Это подскажет вам имя пользователя и пароль, и если вход в систему будет успешным, он выведет API_TOKEN . Вы можете скопировать этот токен и вставить его в файл .env в папках cli и API .

  Примечание . Если у вас нет учетной записи PUTER AI, вы можете зарегистрироваться в

4. Запуск проекта

• Запустите сервер API:

   cd API
  python server.py

  Это запустит сервер API Flask на http://localhost:5000 .

• Используйте интерфейс командной строки (CLI):

  Чтобы взаимодействовать с чатботом или генерировать TTS из командной строки, запустите:

   cd cli
  python cli.py

5. Передний пример

Откройте файл example.html в браузере, чтобы взаимодействовать с чат -ботом Putter и генерировать TTS:

• Общайтесь с ботом : введите сообщение и получите ответ от бота.
• Создайте TTS : введите текст, чтобы преобразовать в речь и воспроизводить сгенерированную аудио.

Конечные точки

API API раскрывает следующие конечные точки:

• Post /chat : принимает объект JSON с поле message и возвращает ответ бота.

  Пример запроса:

  {
    "message" : " Hello, bot! "
  }

• Post /tts : принимает объект JSON с text полем и возвращает соответствующий звук TTS.

  Пример запроса:

  {
    "text" : " Hello, this is a test. "
  }

Лицензия

Этот проект лицензирован по лицензии MIT - для получения подробной информации см. Файл лицензии.

---

Наслаждайтесь строительством с Puter!