- モデル名は大文字と小文字を判別するように変更されます
これまでパラメータで指定されたモデル名は内部で小文字に変換されていました。これはOpenAIには適した動作ですが、一部の互換APIサーバは大文字を含むモデル名を必要としています。 Get-OpenAIFile
に-All
,-Limit
,-Order
パラメータを追加します
Request-ChatCompletion
に-Prediction
パラメータを追加します
参照: Use Predicted Outputs
-
Request-ChatCompletion
が音声入出力に対応しましたRequest-ChatCompletion -Model gpt-4o-audio-preview ` -Modalities text, audio ` -Voice 'shimmer' ` -InputAudio 'C:\hello.mp3' ` -AudioOutFile 'C:\response.mp3'
-
gpt4-32kモデルの廃止予定日が正しくない問題を修正
- Realtime APIの実験的なサポートを追加します
これを使用するとAIアシスタントとリアルタイムの会話が可能になります
詳しくはガイドを参照してください
Guide: How to use Realtime API - Azure OpenAI ServiceのデフォルトAPIバージョンを
2024-10-01-preview
に更新します - Run および RunStep にエラーが含まれている場合、それを警告メッセージとして出力します
- APIリクエストURIのいくつかに二重にスラッシュが含まれていた問題を修正します
Request-ChatCompletion
に-Store
と-MetaData
パラメータを追加します
これを使用するとチャット応答を保存し、モデル蒸留や評価といった
OpenAI DevDay 2024で発表された機能に利用できます
Request-Moderation
に-Images
パラメータを追加します
omni-moderation-latest
モデルをタブ補完に追加します
- 非ASCIIファイル名のファイルアップロード処理を改善
- タブ補完に
o1-preview
とo1-mini
モデルを追加します Request-ChatCompletion
に-MaxCompletionTokens
パラメータを追加します
-MaxTokens
パラメータは非推奨となりましたが、引き続き使用可能ですgpt-3.5-turbo-0613
とgpt-3.5-turbo-16k-0613
は2024年9月13日に廃止されました
これらのモデルは引き続き呼び出すことができますが、モデル名の補完からは削除されます
Get-ThreadRunStep
に-Include
パラメータを追加しますNew-Assistant
に-RankerForFileSearch
および-ScoreThresholdForFileSearch
パラメータを追加しますWait-*
関数に-PollIntervalSec
パラメータを追加します- Azure OpenAI ServiceのデフォルトAPIバージョンを
2024-07-01-preview
に更新します - Azure OpenAI Serviceに関連するいくつかのバグを修正します
- 新しい
chatgpt-4o-latest
モデルをサポート
- Windows PowerShell 5.1 で
-Format
にjson_schema
を指定した場合に発生するエラーを修正
- Structured Outputs (構造化出力) の使用に対応しました
使い方の詳細はガイドを参照してください
Guide: How to use Structured Outputs
これは破壊的変更を含むメジャーリリースです。
- Azure専用関数をすべて削除しました
-ApiType
パラメータを使用することで引き続きAzure OpenAI Serviceを使用できます - モデル名のタブ補完に
gpt-4o-mini
を追加します
Request-ChatCompletion
に-ServiceTier
パラメータを追加
- Azure OpenAI Service と Get/Add/Remove-OpenAIFile を組み合わせた場合の問題を修正
New-VectorStore
に-FileId
パラメータを指定した場合の問題を修正
-ParallelToolCalls
パラメータを追加-ChunkingStrategy
パラメータを追加-MaxNumberOfFileSearchResults
パラメータを追加
- Windows PowerShell 5.1でAzure OpenAI Serviceを使用する際のバグを修正
Add-ThreadMessage
に-WaitForRunComplete
パラメータを追加します
- 共通パラメータをコンテキストとして設定するための新しい関数を追加します
cl100k_base
トークナイザーのパフォーマンスを向上
gpt-4o
で使用されているo200k_base
トークナイザーに対応します- embeddings と text completions に
-AsBatch
オプションを追加します - Run の状態に
imcomplete
を追加します
- モデル名のタブ補完に
gpt-4o
を追加します
Add-ThreadMessage
に-Images
パラメータを追加
Assistantsを使用して画像入力を利用可能になります- 相対ファイルパスに関する不具合の修正
Register-OpenAIFile
をAdd-OpenAIFile
に名称変更
エイリアスとしてRegister-OpenAIFile
も引き続き使用できますが、将来のリリースで削除されます
Start-ThreadRun
が特定の条件で認証エラーを発生させる問題を修正 (#11) (Thanks @potatoqualitee!)- Windows PowerShell 5.1 で
Start-ThreadRun
に-Stream
を指定した場合に実行が失敗する問題を修正 - ドキュメントの修正
- 新しい関数 Remove-ThreadMessage を追加
-ToolChoice
パラメータの選択肢に "required" を追加- ドキュメントの修正
- Assistants 関連のコマンドはすべて新しい Assistants v2 API を使用するように変更されました
- Vector Store を使用するための新しい関数を追加
- 不具合の修正
Guide: How to use File search with Assistants and Vector Store
-
Batch APIを使用するための新しい関数を追加. Batchの使い方はガイドを参照してください Guide: How to use Batch
Start-Batch
Get-Batch
Wait-Batch
Stop-Batch
Get-BatchOutput
-
Register-OpenAIFile
を使用してファイルではなくバイト列をアップロードできるようになりました$ByteArray = [System.Text.Encoding]::UTF8.GetBytes('some text data') Register-OpenAIFile -Content $ByteArray -Name 'filename.txt' -Purpose assistants
-
Azure OpenAI Service 用の関数は全て非推奨になりました
代わりに通常のOpenAI用関数の-ApiType
パラメータにAzure
を設定することでAzure OpenAI Serviceを使用できます$env:OPENAI_API_KEY = '<Put your api key here>' $env:OPENAI_API_BASE = 'https://<your-resource-name>.openai.azure.com/' Request-ChatCompletion ` -Message 'こんにちは!' ` -Deployment 'gpt-4' ` -ApiType Azure
New-Assistant
の-Model
パラメータを明示的に指定しない場合に発生する問題を修正Stop-ThreadRun
が機能していない問題を修正- スプラッティングを使用してコードの可読性を向上します (#6) (Thanks @potatoqualitee!)
Start-ThreadRun
に新しいパラメータを追加-MaxPromptTokens
-MaxCompletionTokens
-TruncationStrategyType
-TruncationStrategyLastMessages
-ToolChoice
-ToolChoiceFunctionName
- タブ補完のモデル名リストを更新
Start-ThreadRun
に-AdditionalMessages
パラメータを追加Get-ThreadMessage
に-RunId
パラメータを追加
Start-ThreadRun
に-Temperature
パラメータを追加
- 前回のリリース内に意図しないファイルが混入していた問題を修正
-UseCodeInterpreter
と-UseRetrieval
のパラメータタイプを[bool]
から[switch]
に変更Start-ThreadRun
に-Stream
パラメータを追加Start-ThreadRun
に-Format
パラメータを追加
-
事前にThreadオブジェクトを用意せずアドホックに
Start-ThreadRun
を実行できるようになりました使用例 :
$Assistant = New-Assistant -Model "gpt-3.5-turbo" $Run = Start-ThreadRun -Assistant $Assistant -Message "Hello, what can you do for me?" $Result = $Run | Receive-ThreadRun -Wait
-TopLogProbs
パラメータの最大値を20
に変更しました- Azure OpenAI ServiceのデフォルトAPIバージョンを
2024-03-01-preview
に変更しました - ほとんどの関数に新しい共通パラメータを追加しました
-AdditionalQuery
-AdditionalHeaders
-AdditionalBody
- 軽微な不具合修正
これは破壊的変更を含むメジャーリリースです。
- すべての関数からパラメータエイリアス
Engine
を削除しました。 ConvertTo-Token
とConvertFrom-Token
から古いエンコーディングサポートを削除しました。これらのコマンドは現在cl100k_base
エンコーディングのみをサポートします。これは、OpenAIが現在サポートしているすべてのモデルがこのエンコーディングを使用しているためです。Request-AzureExtensionsChatCompletion
を削除しました。これは文書化されていませんでした。-OutFile
パラメータでファイル名のみが指定された場合に、ファイルが予期しない場所に保存されるバグを修正しました。- Azure OpenAIサービスのAssistants APIを使用するための新しい関数を追加しました。
Request-AudioSpeech
のレスポンスフォーマットにwav
とpcm
を追加しました。
ConvertTo-Token
に新しい埋め込みモデル名のサポートを追加Request-ChatCompletion
の-InstanceId
パラメータを削除 (OpenAI側で取り下げられたため)
Request-ChatCompletion
に-InstanceId
パラメータを追加
Request-AudioTranscription
に-TimestampGranularities
パラメータを追加- 新しい関数Request-AzureAudioSpeechを追加
- Azure OpenAI Service のデフォルトAPIバージョンを
2024-02-15-preview
に更新
- APIリクエストのリトライ待機時間が
retry-after-ms
およびretry-after
応答ヘッダの値に従うようになりました - モデル名のタブ補完に
gpt-4-turbo-preview
などの新しい候補を追加しました Request-Embeddings
に新しいパラメータ-Dimensions
を追加しました- APIエラーが出力する例外はエラーの種類ごとに固有の型情報を持つようになりました
また、エラーオブジェクトに完全な応答ヘッダとコンテンツが含まれるようになりました
現在PSOpenAIは以下の例外型を実装していますAPIRequestException
BadRequestException
ContentFilteredException
UnauthorizedException
NotFoundException
RateLimitExceededException
QuotaLimitExceededException
- 短時間に多数のリクエストを実行する際のパフォーマンスを改善
-Stream
を指定した際に誤って二重にリクエストが実行される問題を修正
Request-TextEdit
関数は削除されました。これはOpenAIのAPIエンドポイントが廃止されたためです。- APIリクエストのリトライ判定は
x-should-retry
応答ヘッダの値に従うようになりました。 - 廃止予定のモデルリストを更新しました。
- 内部ライブラリは.NET 8でリビルドされています。
Start-ThreadRun
に新しいパラメータ-AdditionalInstructions
を追加しました
Request-ChatCompletion
に新しいパラメータ-LogProbs
と-TopLogProbs
を追加しましたRequest-AzureChatCompletion
に新しいパラメータ-Images
と-ImageDetail
を追加しました
現時点ではこのパラメータはgpt-4-vision-preview
モデルでのみ使用可能です
Request-AzureImageGeneration
が DALL-E 3 モデルを使用した画像生成に対応しました。- Azure OpenAI Service 使用時のAPIバージョンを
2023-12-01-preview
に更新します。 - 軽微な不具合を修正しました。
-
新しい関数 Request-AudioSpeech を追加しました。入力したテキストから読み上げ音声を生成します。
PS C:\> Request-AudioSpeech -text 'Do something fun to play.' -OutFile 'C:\Output\text2speech.mp3' -Voice Alloy
-
Assistants APIを使用するための新しい関数を多数追加しました。
Assistantsの使用方法はこちらのガイドを参照してください。 Guide: How to use Assistants
Warning
Assistants API はまだベータ版です. 動作、パラメータ、使い方は予告なく変更されることがあります
- Assistants:
Get-Assistant
,New-Assistant
,Remove-Assistant
,Set-Assistant
- Threads:
Get-Thread
,New-Thread
,Remove-Thread
,Set-Thread
- Messages:
Get-ThreadMessage
,Add-ThreadMessage
- Runs:
Get-ThreadRun
,Start-ThreadRun
,Stop-ThreadRun
,Wait-ThreadRun
,Receive-ThreadRun
- Steps:
Get-ThreadRunStep
- Files:
Get-OpenAIFile
,Register-OpenAIFile
,Remove-OpenAIFile
,Get-OpenAIFileContent
- "Examples" ディレクトリの名前を "Guides" に変更します。
- 組織IDが環境変数から取得できなかった場合に出力される煩わしい詳細メッセージを削除しました。
- いくつかの軽微な不具合を修正しました。
OpenAI Dev Day 2023で発表された新しい機能への対応を進めています。
ThreadsやAssistantsなどの機能へはまだ対応していませんが、今後のリリースで対応予定です。
Request-ChatComplention
のいくつかのパラメータを追加/変更/廃止しました- 新しいモデルを
Request-ChatComplention
のモデル名タブ補完に追加します Request-ImageGeneration
に-Model
パラメータを追加しました。dall-e-2
とdall-e-3
を選択できますRequest-ImageGeneration
に-Quality
と-Style
パラメータを追加しました。これらはdall-e-3
専用です
これは、破壊的な変更を含むメジャーリリースです。
-ApiBase
パラメータを追加して、APIエンドポイントのURLを指定できるようにしました
FastChatやLM StudioなどのOpenAI互換APIを使用することができます。PS C:\> Request-ChatCompletion -Message 'Hello' -ApiBase 'https://localhost:8000/v1'
Get/New/Remove-AzureOpenAIDeployments
関数を削除しました。- すべての関数から
-Token
パラメータを削除しました。代わりに-ApiKey
を使用してください。 OPENAI_TOKEN
環境変数は参照されなくなりました。代わりにOPENAI_API_KEY
を使用してください。Request-TextCompletion
のデフォルトモデルをtext-davinci-003
からgpt-3.5-turbo-instruct
に変更しました。Request-Embeddings
関数に-Format
パラメータを追加しました。このパラメータを使用して、返される埋め込みの形式を指定できます。
- 関数呼び出しに関する複数の不具合を修正しました。
- Azure OpenAI Serviceの音声認識モデル(Whisper)に対応する関数を追加しました。
-MaxTokens
パラメータの上限値制限を削除しました。 (実際の上限値は使用するモデルによって変わります)- Azure OpenAI ServiceのチャットAPIを使用した関数呼び出し機能に対応しました。
- Azure OpenAI ServiceのデフォルトAPIバージョンを
2023-09-01-preview
に変更しました。
- 新しい
gpt-3.5-turbo-instruct
モデルをRequest-TextCompletion
のモデル名タブ補完に追加します
Request-TextCompletion
のモデル名タブ補完を更新しました- 破壊的変更を避けるためデフォルトで使用するモデルは古い
text-davinci-003
のままですが、将来的には変更される予定です。
- 破壊的変更を避けるためデフォルトで使用するモデルは古い
- 廃止予定がアナウンスされているモデルに関する警告メッセージを更新しました。
- 以下のモデルの廃止予定は延期されたため、警告メッセージの表示をとりやめました。
gpt-3.5-turbo-0301
gpt-4-0314
gpt-4-32k-0314
- OpenAI チャットAPIの関数呼び出し機能に対応しました. 使い方はガイドを参照してください
- パラメータ名を
-RolePrompt
から-SystemMessage
に変更します (-RolePrompt
もエイリアスとして引き続き使用可能です) - ChatGPTの新しいモデルに対応します
gpt-3.5-turbo-16k
gpt-3.5-turbo-0613
gpt-3.5-turbo-16k-0613
gpt-4-0613
gpt-4-32k-0613
- 2023-09-13に廃止予定の古いモデルはタブ補完に表示されなくなります(廃止日までは引き続き使用可能です)
gpt-3.5-turbo-0301
gpt-4-0314
gpt-4-32k-0314
- Azure DALL-Eを使用するための Request-AzureImageGeneration コマンドを追加します
- Azure API のバージョンを最新の安定板である
2023-05-15
に更新 - ドキュメント更新
-Stream
のAPIリクエストにUser-Agent文字列が設定されていない問題を修正- 軽微な修正/改善
- プラットフォームがサポートしている場合、APIリクエストに HTTP/2 を使用します
- APIリクエストのリトライ間隔秒数を調整しました
- エラー処理の改善
code-davinci-edit-001
モデルを復活
以前使用できなくなっていたのはOpenAIの一時的な問題で、永続的な提供終了ではなかったようです
ConvertTo-Token
とConvertFrom-Token
が大幅に高速化しました (最大100倍程度)
- エラー処理の改善
- メッセージをパイプラインから直接入力できるようになりました (
Request-ChatGPT
)PS C:\> "人気のジャズ音楽を教えて" | Request-ChatGPT | Select-Object -ExpandProperty Answer 人気のジャズ音楽には、以下のようなものがあります...
Request-Moderation
がコンテンツポリシー抵触を検出した際に警告メッセージを出力するようになりました。警告メッセージを非表示にしたい場合は-WarningAction Ignore
を指定してくださいPS C:\> Request-Moderation -Text "これは有害なメッセージです" -WarningAction Ignore
- コマンドヘルプメッセージのリンクURLの間違いを修正
- Azure OpenAI Service のための新しいコマンドの追加
-Stream
を使用した際にAPIキーがマスクされずにDebugストリームに出力されていた問題を修正-Stream
を使用した際にOpenAI組織IDがAPIリクエストに付与されない問題を修正- その他の軽微な修正
- APIリクエストに組織IDを指定する
-Organization
パラメータを追加 - デバッグメッセージと詳細メッセージの出力を強化
- モデル名のタブ補完を可能にしました
- 様々な改善
- 新しいコマンド Get-CosineSimilarity を追加。2つのベクトルのコサイン類似度を計算します
注意: パフォーマンスや精度を重視していない簡易的な実装です。運用環境ではMath.NET Numericsなど別の外部ライブラリを使用することをおすすめします
ConvertTo-Token
およびConvertFrom-Token
に複数のオブジェクトをパイプライン経由で入力した場合に予期しない動作をする問題を改善
- 以下の関数で Azure OpenAI Service を試験的にサポートします
Request-ChatGPT
に-Name
オプションを追加
ChatGPTにユーザの名前を指示することができます
使用例.)PS C:\> (Request-ChatGPT -Message 'Do you know my name?' -Name 'Samuel' -Model 'gpt-4-0314' -Temperature 0).Answer Yes, your name is Samuel.
Request-ChatGPT
の-Message
パラメータを必須ではなくオプションにしました。またパイプラインから入力可能にしましたRequest-ChatGPT
の-RolePrompt
に複数の文字列を指定可能にしましたConvertFrom-Token
に-AsArray
を追加- いくつかの細かい変更
- 新しいコマンド ConvertTo-Token と ConvertFrom-Token を追加。テキストとトークンIDを相互に変換できます。
(microsoft/Tokenizer ライブラリを使用しています) -LogitBias
オプションをRequest-ChatGPT
とRequest-TextCompletion
に追加しました
- 新しい関数 Request-Embeddings を追加
- [重大な変更]
API認証用キーの環境変数名をOPENAI_TOKEN
からOPENAI_API_KEY
に変更します。関数のパラメータ名も-Token
から-ApiKey
に変更します。
"Token"という単語が機械学習の分野で使われる用語と混同されやすいことと、OpenAIの公式リファレンスがこの名前を使用していることが理由です。
後方互換性を維持するためOPENAI_TOKEN
および-Token
も引き続き機能しますが、将来的に完全に廃止する可能性があるため使用しないでください。
-MaxRetryCount
オプションを追加
APIリクエストが429 (レート制限超過)
もしくは5xx (サーバ側エラー)
で失敗した場合に、指定された最大回数までリトライします。リトライ間隔は最大128秒まで指数的に増加します(ジッター付き指数バックオフアルゴリズム)- すでに廃止された以下の関数が完全に削除されます
Request-CodeCompletion
Request-CodeEdit
- いくつかの軽微な修正
- 新しいコマンド Enter-ChatGPT を追加。コンソール上でChatGPTとインタラクティブに対話ができます
Request-ChatGPT
とRequest-TextCompletion
に-Stream
オプションを追加code-davinci-edit-001
モデルが廃止されました(OpenAIによって)- AIモデルの廃止日が誤って表示される問題を修正
- OpenAIがCodex APIを2023-03-23に廃止することを発表したため、以下の関数は今後動作しなくなる可能性があります。将来的にこれらの関数はモジュールから完全に削除される予定です
Request-CodeCompletion
Request-CodeEdit
- OpenAIにより廃止、もしくは廃止予定のAIモデルを指定したリクエストを実行しようとした際に警告メッセージを出力するようにしました(リクエスト自体は引き続き実行されます)
現時点で警告メッセージが出力されるAIモデル:code-davinci-001
code-davinci-002
code-cushman-001
code-cushman-002
Request-ChatGPT
,Request-TextCompletion
,Request-CodeCompletion
に新しいパラメータStopSequence
を追加
特定のワードが出てきた場合にそこで出力を打ち切ることができます
使用例.)# This code generates only top 4 list. Request-TextCompletion -Prompt 'List of top 10 most populous countries' -StopSequence '5.'
- macOS, Linux環境において
Request-AudioTranscription
関数のLanguage
プロパティが意図しない値に設定される場合がある問題を修正 - Windows PowerShell 5.1環境での細かい不具合を修正
- テストコードの改善
- エラー処理の改善
Request-TextCompletion
関数におけるMaxTokens
パラメータのデフォルト値を2048
に変更します。以前のデフォルト値16
はほとんどの場合において実用的ではありませんでした。Request-CodeCompletion
関数を追加します。これはRequest-TextCompletion
と同じ処理を実行しますが、デフォルトで使用するAIモデルがcode-davinci-002
であるため、プログラムコードの生成により適しています。- 全ての公開された関数についてPesterテストコードを追加します。
- Initial public release.