python task v2

Python Task v2: API управления публикацией и комментариями с модерацией искусственного интеллекта

Оглавление

1. Описание проекта
2. Функции
3. Структура проекта
4. Установка
5. Запуск API
6. Запуск бота
7. AI API установка
8. Заводящие тесты
9. Внося

Описание проекта

Этот проект представляет собой простой API для управления сообщениями и комментариями с модерацией искусственного интеллекта. API построен с использованием FASTAPI и PYDANTIC, и включает в себя функции для регистрации пользователей, входа в систему, управления публикациями и комментариями, модерации контента с AI и аналитики. Кроме того, бот включен для создания сообщений и комментариев с использованием ИИ и взаимодействия с API.

Функции

• Регистрация и вход пользователей : безопасная аутентификация пользователей с помощью JWT.
• Управление публикацией и комментариями : создавать, читать, обновить и удалять сообщения и комментарии.
• МЕДЕРАЦИЯ ИИ : автоматическое обнаружение и блокировка нецензурной лексики и оскорблений в постах и ​​комментариях.
• Аналитика : Получите аналитику по количеству комментариев, добавленных к сообщениям в течение определенного периода.
• Бот : простой бот для генерации и публикации контента с помощью ИИ.

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

 .
├── alembic/
├── app/
│   ├── __pycache__/
│   ├── auth.py
│   ├── crud.py
│   ├── database.py
│   ├── deps.py
│   ├── main.py
│   ├── models.py
│   ├── moderation.py
│   ├── schemas.py
├── bot/
│   ├── __pycache__/
│   ├── bot.py
│   ├── config.py
│   ├── template_config.py
├── venv/
├── tests/
│   ├── test_main.py
│   ├── test_post.py
├── .gitignore
├── alembic.ini
├── init_db.py
├── readme
├── requirements.txt
└── test.db

Установка

1. Настройте виртуальную среду

Создайте и активируйте виртуальную среду Python:

В окнах:

python -m venv venv
venv S cripts a ctivate

На MacOS/Linux:

python3 -m venv venv
source venv/bin/activate

2. Установите зависимости

Установите необходимые пакеты Python:

pip install -r requirements.txt

3. Установите учетные данные Google Cloud

Убедитесь, что у вас есть файл ключа учетной записи Google Cloud Service (JSON) и установите переменную среды GOOGLE_APPLICATION_CREDENTIALS .

В окнах:

 set GOOGLE_APPLICATION_CREDENTIALS=C: p ath t o y our s ervice-account-file.json

На MacOS/Linux:

 export GOOGLE_APPLICATION_CREDENTIALS= " /path/to/your/service-account-file.json "

4. Применить миграции

Используйте Alembic для применения миграций базы данных:

alembic upgrade head

5. Инициализировать базу данных

Запустите следующий скрипт для инициализации базы данных:

python init_db.py

6. Переменные среды

Создайте файл .env в корне проекта и добавьте следующие переменные:

GOOGLE_APPLICATION_CREDENTIALS= " /path/to/your/service-account-file.json "

Добавьте любые другие специфичные для среды переменные, необходимые для ваших настроек FastAPI.

Запуск API

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

Чтобы запустить сервер FASTAPI, запустите:

uvicorn app.main:app --reload

API будет доступен по адресу http://127.0.0.1:8000 .

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

• Корневая конечная точка : GET /
  Возвращает приветственное сообщение.

• Регистрация пользователя : POST /register/
  Зарегистрируйте нового пользователя.

• Вход пользователя : POST /login/
  Получите токен доступа для аутентифицированного пользователя.

• Создать сообщение : POST /posts/
  Создайте новый пост.

• Создать комментарий : POST /posts/{post_id}/comments/
  Добавьте комментарий к сообщению.

• Получите аналитику : GET /api/comments-daily-breakdown?date_from=<YYYY-MM-DD>&date_to=<YYYY-MM-DD>
  Получите ежедневные агрегированные данные комментариев в диапазоне дат.

• Автоматический ответ на комментарии : /comments/auto-response/
  Конечная точка и логика для обеспечения автоматического ответа на комментарии после задержки.

Запуск бота

Настройте бот

Настройки бота могут быть скорректированы в файле bot/config.py , включая:

• Количество пользователей для создания и подражания
• Тип комментариев для генерации (положительный/отрицательный)
• Количество сообщений и комментариев для создания для каждого пользователя

Начать бот

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

python bot/bot.py

AI API установка

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

1. Создайте Google Cloud Project :

   • Перейдите в Cloud Console Google.
   • Нажмите на выпадающий проект и выберите «Новый проект».
   • Введите имя для своего проекта и нажмите «Создать».
   • Как только проект создан, убедитесь, что он выбран.

2. Включить генеративный API AI :

   • В консоли Cloud Google перейдите в «API & Services»> «Библиотека».
   • Поиск «Generative AI API» и нажмите на него.
   • Нажмите «Включить», чтобы активировать API для вашего проекта.

3. Получить учетные данные API :

   • Перейдите на «API & Services»> «Учетные данные».
   • Нажмите «Создать учетные данные» и выберите «Ключ API».
   • Скопируйте предоставленную ключ API. Вам понадобится это для вашего приложения.

4. Установите клиентскую библиотеку API :

   • Установите клиентскую библиотеку Google Cloud Generative AI Python с помощью PIP:

     pip install google-generativeai

5. Настройте приложение :

   • Храните свой ключ API в bot/config.py :

      # bot/config.py
     class Config :
        API_URL = "http://localhost:8000"  # URL of your FastAPI app
        AI_API_URL = "https://ai.google.dev/generate-text"  # Google's AI API endpoint
        AI_API_KEY = "your_ai_key"  # Replace with your Google AI API key

   • Убедитесь, что ваш бот настроен на использование этого ключа API при создании текстового содержимого.

Заводящие тесты

Запустите тестовый набор

Тесты представлены для функций пост -создания и аналитики. Чтобы запустить тесты, выполнить:

pytest

Это выполнит тесты для создания, аналитики и других аспектов приложения.

Внося

1. Вилка репозитория.
2. Создайте филиал функции ( git checkout -b feature-branch ).
3. Сделайте свои изменения ( git commit -m 'Add some feature' ).
4. Толкайте к ветке ( git push origin feature-branch ).
5. Откройте запрос на тягу.

Дополнительная информация

По любым дополнительным вопросам или устранению неполадок, пожалуйста, обратитесь к официальной документации для Fastapi, Sqlalchemy и Google Generative API API. ``