examples/README.md

Примеры использования FreeQwenApi

В этой директории собраны примеры использования API-прокси для Qwen AI.

Установка и запуск

Установка зависимостей производится в корневой директории проекта:

# В корневой директории проекта
npm install

Перед запуском примеров убедитесь, что сервер FreeQwenApi запущен и доступен по адресу http://localhost:3264.

# Запуск сервера
npm start

# В отдельном терминале запустите примеры
npm run example:simple
npm run example:stream
# и т.д.

Примеры с использованием OpenAI SDK

1. Простой запрос (не потоковый)

npm run example:simple

Демонстрирует отправку простого запроса к Qwen AI с использованием OpenAI SDK.

2. Потоковый запрос

npm run example:stream

Показывает, как получать ответ в потоковом режиме, где токены приходят по мере их генерации.

3. Запрос с системным сообщением

npm run example:system

Пример использования системного сообщения для задания роли и инструкций модели.

4. Анализ изображения

npm run example:image

Демонстрация отправки изображения для анализа моделью (требуется заменить URL изображения в примере).

5. Диалог с несколькими сообщениями

npm run example:conversation

Пример поддержания диалога из нескольких сообщений с сохранением контекста.

6. Совместимость с OpenAI API

npm run example:compatibility

Демонстрация полной совместимости с форматом API OpenAI.

Примеры прямого использования API

1. Запрос с использованием fetch

npm run example:direct

Пример отправки прямого запроса к API без использования SDK, с использованием нативного fetch.

2. Запрос с использованием axios

npm run example:axios

Пример использования библиотеки axios для отправки запросов к API.

3. Управление диалогами

npm run example:chat-management

Демонстрация API для управления диалогами: создание, получение списка, получение истории, переименование и удаление.

Модификация примеров

Вы можете модифицировать примеры для своих нужд:

1. Изменяйте запросы и параметры в файлах примеров
2. Попробуйте различные модели (список доступен через /api/models)
3. Экспериментируйте с разными форматами запросов

Работа с изображениями

Для примеров с изображениями необходимо:

1. Загрузить изображение в официальном веб-интерфейсе Qwen
2. Получить URL изображения из сетевых запросов (см. инструкцию в README.md основного проекта)
3. Заменить IMAGE_URL в примере на полученный URL

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

Подробная документация API доступна в README.md основного проекта.