solver-sdk 1.7.4 → 1.7.5

package/docs/API_REFERENCE.md

@@ -0,0 +1,168 @@
+# API Reference
+
+В этом документе описаны основные классы и методы SDK.
+
+## Содержание
+
+- [CodeSolverSDK](#codesolversdk)
+- [ChatApi](#chatapi)
+- [ReasoningApi](#reasoningapi)
+- [ProjectsApi](#projectsapi)
+- [SearchApi](#searchapi)
+
+## CodeSolverSDK
+
+Основной класс SDK, предоставляющий доступ ко всем API.
+
+### Конструктор
+
+```javascript
+const sdk = new CodeSolverSDK(options);
+```
+
+### Параметры
+
+| Параметр | Тип | Описание | Обязательно |
+|----------|-----|----------|-------------|
+| `baseURL` | string | Базовый URL API | Да |
+| `apiKey` | string | API ключ для авторизации | Нет |
+| `timeout` | number | Таймаут для HTTP запросов (мс) | Нет |
+| `websocket` | object | Настройки WebSocket | Нет |
+
+### Методы
+
+#### `getWebSocketClient()`
+
+Возвращает экземпляр WebSocket клиента для работы с соединениями.
+
+```javascript
+const wsClient = sdk.getWebSocketClient();
+```
+
+#### `checkHealth()`
+
+Проверяет доступность API сервера.
+
+```javascript
+const isHealthy = await sdk.checkHealth();
+```
+
+## ChatApi
+
+API для работы с чатом и потоковой передачей мышления.
+
+### Методы
+
+#### `streamChatWithThinking(messages, options, callback)`
+
+Отправляет запрос чата с потоковой передачей мышления через WebSocket.
+
+```javascript
+const response = await sdk.chat.streamChatWithThinking(
+  messages,
+  options,
+  callback
+);
+```
+
+##### Параметры
+
+| Параметр | Тип | Описание | Обязательно |
+|----------|-----|----------|-------------|
+| `messages` | Array | Массив сообщений для отправки модели | Да |
+| `options` | Object | Параметры запроса (модель, thinking: true) | Да |
+| `callback` | Function | Обработчик событий | Да |
+
+#### `chat(messages, options)`
+
+Отправляет запрос чата и возвращает полный ответ.
+
+```javascript
+const response = await sdk.chat.chat(
+  messages,
+  options
+);
+```
+
+#### `getModels()`
+
+Получает список доступных моделей.
+
+```javascript
+const models = await sdk.chat.getModels();
+```
+
+## ReasoningApi
+
+API для работы с рассуждениями.
+
+### Методы
+
+#### `createReasoning(options)`
+
+Создаёт новое рассуждение.
+
+```javascript
+const reasoning = await sdk.reasoning.createReasoning({
+  projectId: 'project-id',
+  query: 'Объясни этот проект'
+});
+```
+
+#### `getReasoning(reasoningId)`
+
+Получает информацию о рассуждении.
+
+```javascript
+const reasoning = await sdk.reasoning.getReasoning('reasoning-id');
+```
+
+## ProjectsApi
+
+API для работы с проектами.
+
+### Методы
+
+#### `createProject(name, path)`
+
+Создаёт новый проект.
+
+```javascript
+const project = await sdk.projects.createProject('Мой проект', '/path/to/project');
+```
+
+#### `indexProject(projectId)`
+
+Запускает индексацию проекта.
+
+```javascript
+await sdk.projects.indexProject('project-id');
+```
+
+## SearchApi
+
+API для поиска кода.
+
+### Методы
+
+#### `searchCode(projectId, options)`
+
+Выполняет поиск кода в проекте.
+
+```javascript
+const results = await sdk.search.searchCode('project-id', {
+  query: 'function example',
+  limit: 10
+});
+```
+
+#### `semanticSearch(projectId, options)`
+
+Выполняет семантический поиск в проекте.
+
+```javascript
+const results = await sdk.search.semanticSearch('project-id', {
+  query: 'функция для обработки HTTP запросов',
+  limit: 10
+});
+```

package/docs/README.md

@@ -1,77 +1,53 @@
-# Документация Solver SDK
+# Документация SDK
 
-Эта директория содержит подробную документацию по Solver SDK версии 1.7.2.
+Добро пожаловать в документацию SDK для интеграции с Code Solver Backend API.
 
 ## Содержание
 
-### Основная документация
+### Введение
+- [Быстрый старт](../README.md) - основная информация по установке и использованию SDK
 
-- [Потоковая передача мышления (Thinking Architecture)](./THINKING_ARCHITECTURE.md) - Архитектура системы потоковой передачи мышления
-- [Руководство по потоковой передаче мышления](./streaming-thinking-guide.md) - Практическое руководство по использованию потоковой передачи мышления
-- [Работа с региональными эндпоинтами](./REGIONS.md) - Информация о работе с региональными эндпоинтами Anthropic API
-- [Расширенные возможности SDK](./ADVANCED.md) - Продвинутые функции и конфигурация SDK
-- [WebSocket API](./WEBSOCKET.md) - Подробное руководство по работе с WebSocket
-- [Справочник WebSocket событий](./WEBSOCKET_EVENTS.md) - Полный список всех WebSocket событий SDK
-- [Механизм Ping/Pong](./PING_PONG.md) - Документация по мониторингу состояния WebSocket соединений
-- [Индексация проектов](./INDEXING.md) - Руководство по индексации и обновлению индекса проектов
+### Основные функции
+- [Потоковая передача мышления](./features/THINKING.md) - получение процесса мышления модели
+- [Работа с WebSocket](./WEBSOCKET.md) - соединения и потоковая передача данных
+- [Работа с проектами](./PROJECTS.md) - создание и управление проектами
 
-### Дополнительные материалы
+### API Reference
+- [Аутентификация](./AUTHENTICATION.md) - способы аутентификации в API
+- [Обработка ошибок](./ERROR_HANDLING.md) - типы ошибок и их обработка
+- [API Reference](./API_REFERENCE.md) - полное описание всех методов SDK
 
-- [Режим мышления](./thinking/thinking-mode.md) - Основная информация о режиме мышления
+### Расширенные возможности
+- [Механизм ping/pong](./advanced/PING_PONG.md) - мониторинг состояния соединений
 
-## Основные возможности SDK 1.7.2
+## Начало работы
 
-### Потоковая передача мышления (Streaming Thinking)
+Установите SDK с помощью npm:
 
-В версии 1.7.2 добавлена полная поддержка потоковой передачи мышления с помощью метода `streamChatWithThinking()`. Это позволяет получать события мышления модели в реальном времени через WebSocket.
-
-```javascript
-const response = await sdk.chat.streamChatWithThinking(
-  messages,
-  { model: 'claude-3-7-sonnet-20240229', thinking: true },
-  handleEvent
-);
+```bash
+npm install solver-sdk
 ```
 
-### Региональные эндпоинты
-
-SDK поддерживает работу с различными региональными эндпоинтами Anthropic API:
+Простой пример использования:
 
 ```javascript
+const { CodeSolverSDK } = require('solver-sdk');
+
+// Создание экземпляра SDK
 const sdk = new CodeSolverSDK({
-  providers: {
-    anthropic: {
-      region: 'eu-west-1'  // Использовать европейский регион
-    }
-  }
+  baseURL: 'https://api.example.com',
+  apiKey: 'your-api-key'
 });
 
-// Автоматическое переключение между регионами при ошибках
-const response = await sdk.chat.chatWithRegionFailover([...], options);
-```
-
-### WebSocket улучшения
+// Получение списка моделей
+async function getModels() {
+  const models = await sdk.chat.getModels();
+  console.log('Доступные модели:', models);
+}
 
-Улучшена надежность и диагностика WebSocket соединений:
-
-```javascript
-// Диагностика соединения
-const diagnostics = sdk.getWebSocketClient().diagnoseConnection(namespace);
-console.log(diagnostics);
-
-// Мониторинг здоровья
-sdk.getWebSocketClient().setupConnectionHealthCheck(interval);
+getModels().catch(console.error);
 ```
 
-## Примеры кода
-
-Примеры использования SDK доступны в директории `examples` корневого каталога проекта:
-
-- `example:check-api` - Проверка соединения с API
-- `example:indexing` - Индексация проектов
-- `example:dependencies` - Работа с зависимостями
-- `example:regions` - Проверка доступности регионов
-
-## Обратная связь
+## Примеры использования
 
-Если вы обнаружили ошибки в документации или у вас есть предложения по улучшению, пожалуйста, создайте issue в репозитории проекта. 
+Полный набор примеров доступен в директории [examples](../examples).