# P4U 客户端 AI 节点 API 库 [任务自动化主页](https://app.apihub4ai.com) [文档: API](https://app.apihub4ai.com/zh/doc)
一个与 AI 模型中心通信的客户端工具。通过您在管理面板中定义的任务,您可以为任何应用程序编写自己的后端,而无需编程知识。您可以通过一个 API 访问来自不同供应商的多个 AI 模型。该工具使您能够轻松快速地实现由我们通过描述要执行的任务来编程的人工智能模型管理的功能。API 接口允许自动化和链接任务。使用这个工具,您可以轻松创建一个 AI 代理,它可以接听电话、回复电子邮件、聊天、撰写文章或社交媒体帖子。该库提供了一种方便的方式通过 TypeScript 或 JavaScript 访问 REST API。
## 安装
### 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 类旨在与 [任务自动化系统](https://app.apihub4ai.com/zh/doc) 的 API 进行交互。它管理用户认证、任务操作。
# AIClient 用户文档
## 概述
`AIClient` 类提供了一个与 `https://api.programmers4u.com` 上的 API 进行交互的接口。该客户端支持用户认证、任务操作(如创建、查看、运行和删除任务)。它还提供了一些辅助方法来与 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 `method` 和可选的 `data` 向指定的 `endpoint` 发出 HTTP 请求。
### `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/zh/doc/api-node) [#人工智能](https://app.apihub4ai.com/zh/doc/api-node) [#API](https://app.apihub4ai.com/zh/doc/api-node) [#任务](https://app.apihub4ai.com/zh/doc/api-node) [#库](https://app.apihub4ai.com/zh/doc/api-node)
分享:
常见问题解答
AIClient 是一个旨在与任务自动化系统 API 交互的类。它管理用户身份验证和任务操作,如创建、显示、运行和删除任务。
AIClient 支持各种 AI 模型,包括来自 Anthropic (Claude) 和 Stable Diffusion 的音频模型(如 whisper-1、tts-1)和 GPT 模型(如 gpt-3.5-turbo、gpt-4)。
要安装 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 还可能允许我们收集人口统计和统计数据,并将此信息提供给我们的服务提供商,以帮助他们提供服务。
更多