This community-maintained library, written in Swift, provides an easy way to use the OpenAI REST API.
dependencies: [
.package(url: "https://github.com/exyte/OpenAI")
]To install OpenAI, simply add the following line to your Podfile:
pod 'ExyteOpenAI'To integrate OpenAI into your Xcode project using Carthage, specify it in your Cartfile
github "exyte/OpenAI"
- iOS 16+, tvOS 16+, macOS 13+, watchOS 8+
- Xcode 15+
- Obtain your API key. Do not share this with others or expose it in any client-side code.
⚠️ OpenAI strongly recommends developers of client-side applications proxy requests through a separate backend service to keep their API key safe. API keys can access and manipulate customer billing, usage, and organizational data, so it's a significant risk to expose them.
- Create a client instance.
let client = OpenAI(apiKey: "YOUR_API_KEY_HERE")- Create an Assistant by defining its instructions and model.
let assistantPayload = CreateAssistantPayload(model: .gpt_4o, name: "My Assistant", instructions: "Be funny")
client.createAssistant(from: assistantPayload) <...>- Create a Thread to start the conversation.
let threadPayload = CreateThreadPayload(messages: [...], metadata: [...])
client.createThread(from: threadPayload) <...>- Add Messages to the Thread from the user.
let messagePayload = CreateMessagePayload(role: .user, content: "Hello!")
client.createMessage(in: threadId, payload: messagePayload) <...>- Run the Assistant on the Thread to generate a response.
client.createRun(in: threadId, payload: CreateRunPayload(assistantId: assistantId)) <...>- Check the Run status until it is completed or failed.
client.retrieveRun(id: runId, from: threadId)- Retrieve the Messages from the Assistant.
let listPayload = ListPayload(after: lastMessageId)
client.listMessages(from: threadId, payload: listPayload) <...>For more detailed information about OpenAI Assistants API usage, please refer to platform.openai.com and our Examples section.
List and describe the various models available in the API. A list of models and their differences can be found on platform.openai.com.
listModels()retrieveModel(with: modelId)deleteModel(with: modelId)Files are used to upload documents that can be used with features like Assistants.
uploadFile(payload: FilePayload(purpose: filePurpose, fileURL: fileURL))listFiles()retrieveFile(id: fileId)deleteFile(id: fileId)retrieveFileContent(id: fileId, destinationURL: destinationURL)Build assistants that can call models and use tools to perform tasks.
createAssistant(from: CreateAssistantPayload(model: model, name: name, ...))listAssistants(payload: ListPayload(limit: limit, ...))retrieveAssistant(id: assistantId)modifyAssistant(id: assistandId, payload: CreateAssistantPayload(model: updatedModel, name: updatedName, ...))deleteAssistant(id: assistantId)createThread(
from: CreateThreadPayload(
messages: [CreateMessagePayload(role: .user, content: "Hello"), ...],
metadata: ["key1": "value1", ...]
)
)retrieveThread(id: threadId)modifyThread(id: threadId, payload: ModifyPayload(metadata: ["key1": "value1", ...]))deleteThread(id: threadId)createMessage(in: threadId, payload: CreateMessagePayload(role: .user, content: "Hello"))listMessages(from: threadId, payload: ListPayload(limit: limit))retrieveMessage(id: messageId, from: threadId)modifyMessage(id: messageId, from: threadId, payload: ModifyPayload(metadata: ["key1": "value1", ...]))createRun(in: threadId, payload: CreateRunPayload(assistantId: assistantId, ...))createStreamRun(in: threadId, payload: CreateStreamRunPayload(assistantId: assistantId))createThreadAndRun(
from: CreateThreadAndRunPayload(
assistantId: assistantId,
thread: CreateThreadPayload(
messages: [CreateMessagePayload(role: .user, content: "Hello"), ...],
metadata: ["key1": "value1", ...]
)
)
)listRuns(from: threadId, payload: ListPayload(limit: limit, ...))retrieveRun(id: runId, from: threadId)modifyRun(id: runId, from: threadId, payload: ModifyPayload(metadata: ["key1": "value1", ...]))cancelRun(id: runId, from: threadId)listRunSteps(from: runId, in: threadId, payload: ListPayload(limit: limit, ...))retrieveRunStep(id: runStepId, from: runId, in: threadId)To try the OpenAIAssistants examples:
- Clone the repo
https://github.com/exyte/OpenAI - Open OpenAIAssistantsExample/OpenAIAssistantsExample.xcodeproj
- Try it!
- Models
- Files
- Assistants
- Run streaming
- Swift Concurrency support
- Chat
- Audio
- Images
- Moderations
- Fine-tuning
- Vector Store Files
PopupView - Toasts and popups library
Grid - The most powerful Grid container
ScalingHeaderScrollView - A scroll view with a sticky header which shrinks as you scroll
AnimatedTabBar - A tabbar with a number of preset animations
MediaPicker - Customizable media picker
Chat - Chat UI framework with fully customizable message cells, input view, and a built-in media picker
AnimatedGradient - Animated linear gradient
ConcentricOnboarding - Animated onboarding flow
FloatingButton - Floating button menu
ActivityIndicatorView - A number of animated loading indicators
ProgressIndicatorView - A number of animated progress indicators
FlagAndCountryCode - Phone codes and flags for every country
SVGView - SVG parser
LiquidSwipe - Liquid navigation animation