# P4U Клиентское ИИ Node API Библиотека
[Домашняя страница системы автоматизации задач](https://app.apihub4ai.com/ru)
[Документация: API](https://app.apihub4ai.com/ru/doc)
Клиентский инструмент для взаимодействия с хабом ИИ-моделей. Благодаря задачам, которые вы определяете в административной панели, вы можете написать собственный бэкэнд для любого приложения без знания программирования. Вы можете получить доступ к множеству ИИ-моделей от различных поставщиков через единый API. Инструмент позволяет легко и быстро внедрять функции, управляемые моделями искусственного интеллекта, которые мы программируем, описывая задачу для выполнения. API-интерфейс позволяет автоматизировать и объединять задачи. С помощью этого инструмента вы можете легко создать ИИ-агента, который будет отвечать на телефонные звонки, отвечать на электронные письма, вести чат, писать статьи или посты в социальных сетях. Эта библиотека обеспечивает удобный доступ к REST API из TypeScript или JavaScript.
## Установка
### Npm
[AH4AI Npm пакет](https://www.npmjs.com/package/p4u-client-ai)
```sh
npm install --save p4u-client-ai
# или
yarn add p4u-client-ai
```
# Документация AIClient
Класс AIClient разработан для взаимодействия с API в [системе автоматизации задач](https://app.apihub4ai.com/ru/doc). Он управляет аутентификацией пользователя, операциями задач.
# Пользовательская документация AIClient
## Обзор
Класс `AIClient` предоставляет интерфейс для взаимодействия с API на `https://api.programmers4u.com`. Этот клиент поддерживает аутентификацию пользователя, операции с задачами, такие как создание, просмотр, запуск и удаление задач. Он также предоставляет несколько вспомогательных методов для базового взаимодействия с API.
## Перечисления
### `AudioModelsEnum`
- **OAIWHISPER1**: `whisper-1`
- **OAITTS1**: `tts-1`
- **OAITTS1HD**: `tts-1-hd`
### `GPTModelsEnum`
- **OAIGPT35Turbo**: `gpt-3.5-turbo`
- **OAIGPT35Turbo1106**: `gpt-3.5-turbo-1106`
- **OAIGPT35Turbo16k**: `gpt-3.5-turbo-16k`
- **OAIGPT35TurboInstruct**: `gpt-3.5-turbo-instruct`
- **OAIGPT4**: `gpt-4`
- **OAIGPT4o**: `gpt-4o`
- **OAIGPT432k**: `gpt-4-32k`
- **OAIGPT4VisionPreview**: `gpt-4-vision-preview`
- **OAIGPT41106Preview**: `gpt-4-1106-preview`
- **Claude3Opus**: `claude-3-opus-20240229`
- **Claude3Sonet**: `claude-3-sonnet-20240229`
- **Claude3Haiku**: `claude-3-haiku-20240307`
## Интерфейсы
### `IDelete`
```typescript
interface IDelete {
idTask: string;
}
```
### `IInsert`
```typescript
interface IInsert {
name: string;
context: string;
model: string;
instruction: string;
}
```
### `IRequest`
```typescript
interface IRequest {
ask: string;
context: string;
idTask: string;
}
```
## Методы
### `login(userName: string, password: string): Promise`
Выполняет вход пользователя с предоставленным `username` и `password`.
### `makeRequest(method: string, endpoint: string, data?: any): Promise>`
Выполняет HTTP-запрос к указанному `endpoint`, используя предоставленный HTTP `method` и необязательные `data`.
### `pingPong(): Promise>`
Проверяет, активно ли соединение с API.
### `listTasks(): Promise>`
Отображает все задачи, доступные для пользователя.
### `runTask(request: IRequest): Promise>`
Запускает указанную задачу на основе предоставленного `request`.
### `deleteTask(request: IDelete): Promise>`
Удаляет задачу, указанную в `request`.
### `createTask(request: IInsert): Promise>`
Создает новую задачу с использованием предоставленного `request`.
## Пример использования
Запустить тест
```sh
npm run test или yarn test
```
```typescript
import { IRequest } from "../interfaces/request.interface";
import AIClient from "../index";
const userName = "XXX@XXX";
const password = "XXXXXXX";
const startTest = async () => {
const client = new AIClient();
await client.login(userName, password);
const listOfTasks = await client.listTasks();
console.log(listOfTasks);
const testText = "Описание вашей задачи здесь.";
const taskRequest: IRequest = {
idTask: "52468971-a06e-413d-9b3a-212b53aad693",
ask: testText,
context: " ",
};
const taskRun = await client.runTask(taskRequest);
console.log(taskRun);
};
startTest();
```
[#автоматизация](https://app.apihub4ai.com/ru/doc/api-node) [#искусственныйинтеллект](https://app.apihub4ai.com/ru/doc/api-node) [#API](https://app.apihub4ai.com/ru/doc/api-node) [#задачи](https://app.apihub4ai.com/ru/) [#библиотека](https://app.apihub4ai.com/ru/doc/api-node)
поделиться:
ЧаВО
AIClient - это класс, предназначенный для взаимодействия с API в системе автоматизации задач. Он управляет аутентификацией пользователей и операциями с задачами, такими как создание, отображение, запуск и удаление задач.
AIClient поддерживает различные модели AI, включая аудиомодели (например, whisper-1, tts-1) и модели GPT (например, gpt-3.5-turbo, gpt-4) от Anthropic (Claude) и Stable Diffusion.
Чтобы установить библиотеку p4u-client-ai, используйте команду npm install --save p4u-client-ai или yarn add p4u-client-ai.
Чтобы войти в AIClient, используйте метод login, предоставив имя пользователя и пароль. Пример: await client.login(userName, password);
С помощью AIClient вы можете выполнять операции, такие как создание задач, отображение списка задач, запуск задач и удаление задач.
Чтобы создать новую задачу с помощью AIClient, используйте метод createTask, предоставив соответствующие данные в формате IInsert. Пример: const request: IInsert = { name: 'Название задачи', context: 'Контекст', model: 'Модель AI', instruction: 'Инструкция' }; await client.createTask(request);
Чтобы запустить задачу с помощью AIClient, используйте метод runTask, предоставив соответствующие данные в формате IRequest. Пример: const request: IRequest = { idTask: 'ID задачи', ask: 'Вопрос', context: 'Контекст' }; await client.runTask(request);
Чтобы удалить задачу с помощью AIClient, используйте метод deleteTask, предоставив соответствующие данные в формате IDelete. Пример: const request: IDelete = { idTask: 'ID задачи' }; await client.deleteTask(request);
Чтобы проверить, активно ли подключение к API, используйте метод pingPong. Пример: await client.pingPong();
Чтобы отобразить список задач, доступных пользователю, используйте метод listTasks. Пример: const listOfTasks = await client.listTasks();
Настройки cookie
Мы используем файлы cookie для управления Услугами и сбора информации о вас и вашем использовании Услуг. Файлы cookie помогают нам узнавать вас, настраивать или персонализировать ваш опыт, предлагать вам дополнительные продукты или услуги и анализировать использование наших Услуг, чтобы сделать их более полезными для вас. Файлы cookie также могут позволить нам собирать демографические и статистические данные и предоставлять эту информацию нашим поставщикам услуг, чтобы помочь им оказывать свои услуги.
большеAPIHUB4AI
2024 Programmers4u ©️ Все права защищены