AiSwiftAssist

AISwiftAssist

iOS 13 以降用の Swift Package Manager (SPM) ライブラリ。iOS アプリケーションでの OpenAI の Assistant API との統合を簡素化するように設計されています。このライブラリを使用すると、AI を利用したアシスタントを効率的かつ対話的に構築できます。

特徴

• OpenAI のアシスタント API とのシームレスな統合。
• さまざまなモデルやツールを使用して AI アシスタントを簡単に作成および管理します。
• スレッドとメッセージを通じて会話を処理します。
• コードインタープリタ、取得、関数呼び出しツールを利用します。
• Swift を使用して iOS 13 以降に最適化されています。

インストール

Xcodeの使用

AISwiftAssist Xcode プロジェクトに追加するには、次の手順に従います。

1. Xcode でプロジェクトを開きます。
2. メニューバーの「ファイル」をクリックし、「Swift パッケージ」を選択し、「パッケージの依存関係を追加...」を選択します。
3. 表示されるダイアログで、パッケージ リポジトリの URL: https://github.com/DeveloperZelentsov/AiSwiftAssist.gitを入力します。
4. 統合する最後のバージョンを選択し、「次へ」をクリックします。
5. パッケージ製品と対象を確認し、「完了」をクリックします。

使用法

ステップ 1: ライブラリをインポートする

AISwiftAssist使用したい Swift ファイルにインポートします。

import AISwiftAssist

ステップ 2: クライアントを初期化する

API キーと組織 ID を使用して、AISwiftAssistClient のインスタンスを作成します。

 let config = AISwiftAssistConfig ( apiKey : " your-api-key " , organizationId : " your-org-id " )
let aiSwiftAssistClient = AISwiftAssistClient ( config : config )

ステップ 3: アシスタントを作成する

AI アシスタントを作成するには、モデル、名前、説明、指示などのパラメータを定義します。必要に応じて、ツールとファイル ID を指定することもできます。

 let assistantParams = AssistantCreationParams (
    modelName : " gpt-4-1106-preview " ,
    name : " Math Tutor " ,
    description : " Your personal math tutor. " ,
    instructions : " Solve math problems and explain solutions. "
)

let creationAssistantParams = try await aiSwiftAssistClient . createAssistantAndThread ( with : assistantParams )
let assistantId = creationParams . assistant . id
let threadId = creationParams . thread . id

ステップ 4: 会話を管理する

メッセージの送信

作成したスレッドを通じてアシスタントにメッセージを送信します。

 let messageRequest : ASACreateMessageRequest = . init ( role : " user " , content : content )
try await aiSwiftAssistClient . messagesApi . create ( by : threadId , createMessage : messageRequest )

実行の開始

メッセージを処理して応答を受け取るには、実行を開始します。

 let runRequest = ASACreateRunRequest ( assistantId : assistantId )
try await aiSwiftAssistClient . runsApi . create ( by : threadId , createRun : runRequest )

応答の取得

アシスタントの応答を取得します。

 let messages = try await aiSwiftAssistClient . messagesApi . list ( threadId : threadId )
// Process and display these messages, including the assistant's response.

ステップ 5: 継続的なインタラクション

追加のメッセージを送信し、実行を開始し、応答を取得することで会話を続けます。これにより、アシスタントとの動的でインタラクティブなコミュニケーション フローが作成されます。

基本を超えて

これは、アシスタント API の最も基本的な使用例です。より複雑で興味深いアシスタントの可能性があり、これらの高度な機能を活用できるように、この Swift API を進化させ続けます。

フィードバックと貢献

AISwiftAssist強化するためのフィードバックや貢献を歓迎します。問題を報告したり、GitHub リポジトリでプル リクエストを送信したりしてください。

ライセンス

このライブラリは MIT ライセンスに基づいて配布されています。