@ apicity/ openai (英语)
OpenAI / GPT 服务器,用于聊天完成 .
WebRTC 上的实时语音 : openai.post.v1.realtime.calls({ sdp, session }) 将浏览器的 SDP 提供并解析给 SDP 答案 加上 callId (从 Location 头曰. 这个 @apicity/openai/realtime 子路径导出 connectOpenAiRealtime,它打开了服务器侧的WebSocket对那个呼叫(callId)或改为新的届会(第1款)model: send() 客户端事件,例如 session.update,然后通过 onEvent。 。 。 . openai.post.v1.realtime.calls.hangup(callId) 结束通话.
运行时间依赖性 :
ws@^8.21.0—— 用于实时服务器控制频道的 WebSocket 客户端@apicity/openai/realtimezod@^4.6.6- 请求在每一个 POST 端点上附加计划.schema
安装
npm install @apicity/openai
# or
pnpm add @apicity/openai
快速启动
import { createOpenAi } from "@apicity/openai";
const openai = createOpenAi({ apiKey: process.env.OPENAI_API_KEY! });
API 参考
共有19组64个终点. 每个方法都映射出上游的 URL 路径 .
音频
POST openai.v1.audio.speech
POST https://api.openai.com/v1/audio/speech
成本等级 : expensive
const res = await openai.post.v1.audio.speech({ /* ... */ });
POST openai.v1.audio.transcriptions
POST https://api.openai.com/v1/audio/transcriptions
成本等级 : expensive
const res = await openai.post.v1.audio.transcriptions({ /* ... */ });
POST openai.v1.audio.translations
POST https://api.openai.com/v1/audio/translations
成本等级 : expensive
const res = await openai.post.v1.audio.translations({ /* ... */ });
批号
GET openai.v1.batches
GET https://api.openai.com/v1/batches/{idOrOpts}
成本等级 : expensive
const res = await openai.get.v1.batches({ /* ... */ });
POST openai.v1.batches
POST https://api.openai.com/v1/batches
成本等级 : expensive
const res = await openai.post.v1.batches({ /* ... */ });
POST openai.v1.batches.cancel
POST https://api.openai.com/v1/batches/{id}/cancel
成本等级 : expensive
const res = await openai.post.v1.batches.cancel({ /* ... */ });
聊天
DELETE openai.v1.chat.completions
DELETE https://api.openai.com/v1/chat/completions/{id}
成本等级 : expensive
const res = await openai.delete.v1.chat.completions({ /* ... */ });
GET openai.v1.chat.completions
GET https://api.openai.com/v1/chat/completions/{idOrOpts}
成本等级 : expensive
const res = await openai.get.v1.chat.completions({ /* ... */ });
GET openai.v1.chat.completions.messages
GET https://api.openai.com/v1/chat/completions/{id}/messages
成本等级 : expensive
const res = await openai.get.v1.chat.completions.messages({ /* ... */ });
POST openai.v1.chat.completions
POST https://api.openai.com/v1/chat/completions/{id}
成本等级 : expensive
const res = await openai.post.v1.chat.completions({ /* ... */ });
代码
GET openai.codex.usage
GET https://chatgpt.com/backend-api/wham/usage
成本等级 : expensive
const res = await openai.get.codex.usage();
完成数
POST openai.v1.completions
POST https://api.openai.com/v1/completions
成本等级 : expensive
const res = await openai.post.v1.completions({ /* ... */ });
集装箱
POST openai.v1.containers
POST https://api.openai.com/v1/containers
成本等级 : expensive
const res = await openai.post.v1.containers({ /* ... */ });
对话
GET openai.v1.conversations.retrieve
GET https://api.openai.com/v1/conversations/{conversationId}
成本等级 : expensive
const res = await openai.get.v1.conversations.retrieve({ /* ... */ });
POST openai.v1.conversations
POST https://api.openai.com/v1/conversations
成本等级 : expensive
const res = await openai.post.v1.conversations({ /* ... */ });
嵌入
POST openai.v1.embeddings
POST https://api.openai.com/v1/embeddings
成本等级 : expensive
const res = await openai.post.v1.embeddings({ /* ... */ });
evals (中文)
POST openai.v1.evals
POST https://api.openai.com/v1/evals
成本等级 : expensive
const res = await openai.post.v1.evals({ /* ... */ });
文件
DELETE openai.v1.files
DELETE https://api.openai.com/v1/files/{id}
成本等级 : expensive
const res = await openai.delete.v1.files({ /* ... */ });
GET openai.v1.files
GET https://api.openai.com/v1/files/{idOrOpts}
成本等级 : expensive
const res = await openai.get.v1.files({ /* ... */ });
GET openai.v1.files.content
GET https://api.openai.com/v1/files/{id}/content
成本等级 : expensive
const res = await openai.get.v1.files.content({ /* ... */ });
POST openai.v1.files
POST https://api.openai.com/v1/files
成本等级 : expensive
const res = await openai.post.v1.files({ /* ... */ });
微调
DELETE openai.v1.fineTuning.checkpoints.permissions
DELETE https://api.openai.com/v1/fine_tuning/checkpoints/{checkpoint}/permissions/{permissionId}
成本等级 : expensive
const res = await openai.delete.v1.fineTuning.checkpoints.permissions({ /* ... */ });
GET openai.v1.fineTuning.checkpoints.permissions
GET https://api.openai.com/v1/fine_tuning/checkpoints/{checkpoint}/permissions
成本等级 : expensive
const res = await openai.get.v1.fineTuning.checkpoints.permissions({ /* ... */ });
GET openai.v1.fineTuning.jobs
GET https://api.openai.com/v1/fine_tuning/jobs/{idOrOpts}
成本等级 : expensive
const res = await openai.get.v1.fineTuning.jobs({ /* ... */ });
GET openai.v1.fineTuning.jobs.checkpoints
GET https://api.openai.com/v1/fine_tuning/jobs/{id}/checkpoints
成本等级 : expensive
const res = await openai.get.v1.fineTuning.jobs.checkpoints({ /* ... */ });
GET openai.v1.fineTuning.jobs.events
GET https://api.openai.com/v1/fine_tuning/jobs/{id}/events
成本等级 : expensive
const res = await openai.get.v1.fineTuning.jobs.events({ /* ... */ });
POST openai.v1.fineTuning.checkpoints.permissions
POST https://api.openai.com/v1/fine_tuning/checkpoints/{checkpoint}/permissions
成本等级 : expensive
const res = await openai.post.v1.fineTuning.checkpoints.permissions({ /* ... */ });
POST openai.v1.fineTuning.jobs
POST https://api.openai.com/v1/fine_tuning/jobs
成本等级 : expensive
const res = await openai.post.v1.fineTuning.jobs({ /* ... */ });
POST openai.v1.fineTuning.jobs.cancel
POST https://api.openai.com/v1/fine_tuning/jobs/{id}/cancel
成本等级 : expensive
const res = await openai.post.v1.fineTuning.jobs.cancel({ /* ... */ });
POST openai.v1.fineTuning.jobs.pause
POST https://api.openai.com/v1/fine_tuning/jobs/{id}/pause
成本等级 : expensive
const res = await openai.post.v1.fineTuning.jobs.pause({ /* ... */ });
POST openai.v1.fineTuning.jobs.resume
POST https://api.openai.com/v1/fine_tuning/jobs/{id}/resume
成本等级 : expensive
const res = await openai.post.v1.fineTuning.jobs.resume({ /* ... */ });
图像
POST openai.v1.images.edits
POST https://api.openai.com/v1/images/edits
成本等级 : expensive
const res = await openai.post.v1.images.edits({ /* ... */ });
POST openai.v1.images.generations
POST https://api.openai.com/v1/images/generations
成本等级 : expensive
const res = await openai.post.v1.images.generations({ /* ... */ });
POST openai.v1.images.variations
POST https://api.openai.com/v1/images/variations
成本等级 : expensive
const res = await openai.post.v1.images.variations({ /* ... */ });
模型
DELETE openai.v1.models
DELETE https://api.openai.com/v1/models/{id}
成本等级 : expensive
const res = await openai.delete.v1.models({ /* ... */ });
GET openai.v1.models
GET https://api.openai.com/v1/models/{id}
成本等级 : expensive
const res = await openai.get.v1.models({ /* ... */ });
温和
POST openai.v1.moderations
POST https://api.openai.com/v1/moderations
成本等级 : expensive
const res = await openai.post.v1.moderations({ /* ... */ });
组织
GET openai.v1.organization.costs
GET https://api.openai.com/v1/organization/costs
成本等级 : expensive
const res = await openai.get.v1.organization.costs({ /* ... */ });
GET openai.v1.organization.projects
GET https://api.openai.com/v1/organization/projects/{idOrOpts}
成本等级 : expensive
const res = await openai.get.v1.organization.projects({ /* ... */ });
GET openai.v1.organization.projects.rateLimits
GET https://api.openai.com/v1/organization/projects/{projectId}/rate_limits
成本等级 : expensive
const res = await openai.get.v1.organization.projects.rateLimits({ /* ... */ });
GET openai.v1.organization.usage.audioSpeeches
GET https://api.openai.com/v1/organization/usage/audio_speeches
成本等级 : expensive
const res = await openai.get.v1.organization.usage.audioSpeeches({ /* ... */ });
GET openai.v1.organization.usage.audioTranscriptions
GET https://api.openai.com/v1/organization/usage/audio_transcriptions
成本等级 : expensive
const res = await openai.get.v1.organization.usage.audioTranscriptions({ /* ... */ });
GET openai.v1.organization.usage.codeInterpreterSessions
GET https://api.openai.com/v1/organization/usage/code_interpreter_sessions
成本等级 : expensive
const res = await openai.get.v1.organization.usage.codeInterpreterSessions({ /* ... */ });
GET openai.v1.organization.usage.completions
GET https://api.openai.com/v1/organization/usage/completions
成本等级 : expensive
const res = await openai.get.v1.organization.usage.completions({ /* ... */ });
GET openai.v1.organization.usage.embeddings
GET https://api.openai.com/v1/organization/usage/embeddings
成本等级 : expensive
const res = await openai.get.v1.organization.usage.embeddings({ /* ... */ });
GET openai.v1.organization.usage.images
GET https://api.openai.com/v1/organization/usage/images
成本等级 : expensive
const res = await openai.get.v1.organization.usage.images({ /* ... */ });
GET openai.v1.organization.usage.moderations
GET https://api.openai.com/v1/organization/usage/moderations
成本等级 : expensive
const res = await openai.get.v1.organization.usage.moderations({ /* ... */ });
GET openai.v1.organization.usage.vectorStores
GET https://api.openai.com/v1/organization/usage/vector_stores
成本等级 : expensive
const res = await openai.get.v1.organization.usage.vectorStores({ /* ... */ });
实时
POST openai.v1.realtime.calls
POST https://api.openai.com/v1/realtime/calls
成本等级 : expensive
const res = await openai.post.v1.realtime.calls({ /* ... */ });
POST openai.v1.realtime.calls.hangup
POST https://api.openai.com/v1/realtime/calls/{call_id}/hangup
成本等级 : expensive
const res = await openai.post.v1.realtime.calls.hangup({ /* ... */ });
POST openai.v1.realtime.clientSecrets
POST https://api.openai.com/v1/realtime/client_secrets
成本等级 : expensive
const res = await openai.post.v1.realtime.clientSecrets({ /* ... */ });
答复
DELETE openai.v1.responses
DELETE https://api.openai.com/v1/responses/{id}
成本等级 : expensive
const res = await openai.delete.v1.responses({ /* ... */ });
GET openai.v1.responses
GET https://api.openai.com/v1/responses/{id}
成本等级 : expensive
const res = await openai.get.v1.responses({ /* ... */ });
GET openai.v1.responses.inputItems
GET https://api.openai.com/v1/responses/{id}/input_items
成本等级 : expensive
const res = await openai.get.v1.responses.inputItems({ /* ... */ });
POST openai.v1.responses
POST https://api.openai.com/v1/responses
成本等级 : expensive
const res = await openai.post.v1.responses({ /* ... */ });
POST openai.v1.responses.cancel
POST https://api.openai.com/v1/responses/{id}/cancel
成本等级 : expensive
const res = await openai.post.v1.responses.cancel({ /* ... */ });
POST openai.v1.responses.compact
POST https://api.openai.com/v1/responses/compact
成本等级 : expensive
const res = await openai.post.v1.responses.compact({ /* ... */ });
POST openai.v1.responses.inputTokens
POST https://api.openai.com/v1/responses/input_tokens
成本等级 : expensive
const res = await openai.post.v1.responses.inputTokens({ /* ... */ });
上传
POST openai.v1.uploads
POST https://api.openai.com/v1/uploads
成本等级 : expensive
const res = await openai.post.v1.uploads({ /* ... */ });
矢量种子
GET openai.v1.vectorStores
GET https://api.openai.com/v1/vector_stores/{idOrOpts}
成本等级 : expensive
const res = await openai.get.v1.vectorStores({ /* ... */ });
GET openai.v1.vectorStores.files
GET https://api.openai.com/v1/vector_stores/{vectorStoreId}/files
成本等级 : expensive
const res = await openai.get.v1.vectorStores.files({ /* ... */ });
POST openai.v1.vectorStores
POST https://api.openai.com/v1/vector_stores
成本等级 : expensive
const res = await openai.post.v1.vectorStores({ /* ... */ });
POST openai.v1.vectorStores.files
POST https://api.openai.com/v1/vector_stores/{vectorStoreId}/files
成本等级 : expensive
const res = await openai.post.v1.vectorStores.files({ /* ... */ });
POST openai.v1.vectorStores.search
POST https://api.openai.com/v1/vector_stores/{vectorStoreId}/search
成本等级 : expensive
const res = await openai.post.v1.vectorStores.search({ /* ... */ });
中间软件
import { createOpenAi, withRetry } from "@apicity/openai";
const openai = createOpenAi({ apiKey: process.env.OPENAI_API_KEY! });
const models = withRetry(openai.get.v1.models, { retries: 3 });
部分 辣点 单相机.
许可证
麻省理工学院——见 自由主义。 。 。 .