Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/mkht/psopenai

PowerShell module for OpenAI API.
https://github.com/mkht/psopenai
azureopenai chatgpt openai powershell
Last synced: about 1 month ago
JSON representation
PowerShell module for OpenAI API.
Host: GitHub
URL: https://github.com/mkht/psopenai
Owner: mkht
License: mit
Created: 2023-03-08T12:26:27.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-10-29T12:02:25.000Z (about 2 months ago)
Last Synced: 2024-10-29T13:36:55.948Z (about 2 months ago)
Topics: azureopenai, chatgpt, openai, powershell
Language: PowerShell
Homepage:
Size: 21.3 MB
Stars: 40
Watchers: 3
Forks: 12
Open Issues: 3
Metadata Files:
- Readme: README.ja.md
- Changelog: CHANGELOG.ja.md
- License: LICENSE
Awesome Lists containing this project

README

        # PSOpenAI

OpenAI および Azure OpenAI Service を PowerShell から使用するためのラッパーモジュールです。  

ChatGPT, 音声の文字起こし, テキストからの画像生成などの OpenAI の提供する機能を使用できます。

**これはコミュニティベースの非公式モジュールであり OpenAI による提供ではありません**

+ OpenAI API について  

https://platform.openai.com/docs

+ Azure OpenAI Service について  

https://learn.microsoft.com/en-us/azure/ai-services/openai/overview

----

## 動作環境

+ Windows PowerShell 5.1

+ PowerShell 7 or higher

+ Windows, macOS or Linux

使用するには OpenAI のアカウントを作成し、以下URLから API キーを取得する必要があります。  

https://platform.openai.com/account/api-keys

----

## インストール

[PowerShell Gallery](https://www.powershellgallery.com/packages/PSOpenAI/) からインストールしてください。

```Powershell

Install-Module -Name PSOpenAI

```

----

## 使用できる関数

### 共通

+ [ConvertFrom-Token](/Docs/ConvertFrom-Token.md)

+ [ConvertTo-Token](/Docs/ConvertTo-Token.md)

+ [Get-CosineSimilarity](/Docs/Get-CosineSimilarity.md)

+ [Get-OpenAIContext](/Docs/Get-OpenAIContext.md)

+ [Set-OpenAIContext](/Docs/Set-OpenAIContext.md)

+ [Clear-OpenAIContext](/Docs/Clear-OpenAIContext.md)

### OpenAI

#### Chat

[ガイド: Chat の使用方法](/Guides/How_to_use_Chat.md)

+ [Enter-ChatGPT](/Docs/Enter-ChatGPT.md)

+ [Request-ChatCompletion](/Docs/Request-ChatCompletion.md)

+ [New-ChatCompletionFunction](/Docs/New-ChatCompletionFunction.md)

#### Assistants

[ガイド: Assistants の使用方法](/Guides/How_to_use_Assistants.md)  

[ガイド: Assistants と Vector Store を使用したファイル検索](/Guides/How_to_use_FileSearch_with_VectorStore.md)

+ [Get-Assistant](/Docs/Get-Assistant.md)

+ [New-Assistant](/Docs/New-Assistant.md)

+ [Set-Assistant](/Docs/Set-Assistant.md)

+ [Remove-Assistant](/Docs/Remove-Assistant.md)

+ [Get-Thread](/Docs/Get-Thread.md)

+ [New-Thread](/Docs/New-Thread.md)

+ [Set-Thread](/Docs/Set-Thread.md)

+ [Remove-Thread](/Docs/Remove-Thread.md)

+ [Get-ThreadMessage](/Docs/Get-ThreadMessage.md)

+ [Add-ThreadMessage](/Docs/Add-ThreadMessage.md)

+ [Remove-ThreadMessage](/Docs/Remove-ThreadMessage.md)

+ [Get-ThreadRun](/Docs/Get-ThreadRun.md)

+ [Start-ThreadRun](/Docs/Start-ThreadRun.md)

+ [Stop-ThreadRun](/Docs/Stop-ThreadRun.md)

+ [Wait-ThreadRun](/Docs/Wait-ThreadRun.md)

+ [Receive-ThreadRun](/Docs/Receive-ThreadRun.md)

+ [Get-ThreadRunStep](/Docs/Get-ThreadRunStep.md)

+ [Get-VectorStore](/Docs/Get-VectorStore.md)

+ [New-VectorStore](/Docs/New-VectorStore.md)

+ [Set-VectorStore](/Docs/Set-VectorStore.md)

+ [Remove-VectorStore](/Docs/Remove-VectorStore.md)

+ [Add-VectorStoreFile](/Docs/Add-VectorStoreFile.md)

+ [Get-VectorStoreFile](/Docs/Get-VectorStoreFile.md)

+ [Remove-VectorStoreFile](/Docs/Remove-VectorStoreFile.md)

+ [Start-VectorStoreFileBatch](/Docs/Start-VectorStoreFileBatch.md)

+ [Get-VectorStoreFileBatch](/Docs/Get-VectorStoreFileBatch.md)

+ [Stop-VectorStoreFileBatch](/Docs/Stop-VectorStoreFileBatch.md)

+ [Wait-VectorStoreFileBatch](/Docs/Wait-VectorStoreFileBatch.md)

+ [Get-VectorStoreFileInBatch](/Docs/Get-VectorStoreFileInBatch.md)

#### Realtime

[Guide: Realtime API の使用方法](/Guides/How_to_use_Realtime_API.md)  

+ [Connect-RealtimeSession](/Docs/Connect-RealtimeSession.md)

+ [Disconnect-RealtimeSession](/Docs/Disconnect-RealtimeSession.md)

+ [Set-RealtimeSessionCofiguration](/Docs/Set-RealtimeSessionCofiguration.md)

+ [Send-RealtimeSessionEvent](/Docs/Send-RealtimeSessionEvent.md)

+ [Add-RealtimeSessionItem](/Docs/Add-RealtimeSessionItem.md)

+ [Remove-RealtimeSessionItem](/Docs/Remove-RealtimeSessionItem.md)

+ [Request-RealtimeSessionResponse](/Docs/Request-RealtimeSessionResponse.md)

+ [Stop-RealtimeSessionResponse](/Docs/Stop-RealtimeSessionResponse.md)

+ [Start-RealtimeSessionAudioInput](/Docs/Start-RealtimeSessionAudioInput.md) *

+ [Stop-RealtimeSessionAudioInput](/Docs/Stop-RealtimeSessionAudioInput.md) *

+ [Start-RealtimeSessionAudioOutput](/Docs/Start-RealtimeSessionAudioInput.md) *

+ [Stop-RealtimeSessionAudioOutput](/Docs/Stop-RealtimeSessionAudioInput.md) *

> [*] Windows と PowerShell 7.4 以上の組み合わせでのみ動作します

#### Images

+ [Request-ImageEdit](/Docs/Request-ImageEdit.md)

+ [Request-ImageGeneration](/Docs/Request-ImageGeneration.md)

+ [Request-ImageVariation](/Docs/Request-ImageVariation.md)

#### Audio

+ [Request-AudioSpeech](/Docs/Request-AudioSpeech.md)

+ [Request-AudioTranscription](/Docs/Request-AudioTranscription.md)

+ [Request-AudioTranslation](/Docs/Request-AudioTranslation.md)

#### Files

+ [Get-OpenAIFile](/Docs/Get-OpenAIFile.md)

+ [Add-OpenAIFile](/Docs/Add-OpenAIFile.md)

+ [Remove-OpenAIFile](/Docs/Remove-OpenAIFile.md)

+ [Get-OpenAIFileContent](/Docs/Get-OpenAIFileContent.md)

#### Others

+ [Get-OpenAIModels](/Docs/Get-OpenAIModels.md)

+ [Request-Embeddings](/Docs/Request-Embeddings.md)

+ [Request-Moderation](/Docs/Request-Moderation.md)

+ [Request-TextCompletion](/Docs/Request-TextCompletion.md)

#### Batch

[ガイド: Batch の使用方法](/Guides/How_to_use_Batch.md)

+ [Start-Batch](/Docs/Start-Batch.md)

+ [Get-Batch](/Docs/Get-Batch.md)

+ [Wait-Batch](/Docs/Wait-Batch.md)

+ [Stop-Batch](/Docs/Stop-Batch.md)

+ [Get-BatchOutput](/Docs/Get-BatchOutput.md)

### Azure OpenAI Service

+ [ガイド: Azure OpenAI Service の使用方法](Guides/How_to_use_with_Azure_OpenAI_Service.md)

----

## 使い方

より詳細で複雑なシナリオの説明は [Docs](/Docs) および [Guides](/Guides) も参照してください。

### ChatGPT (インタラクティブ)

コンソール上でインタラクティブにChatGPTと対話します。

```PowerShell

$global:OPENAI_API_KEY = ''

Enter-ChatGPT

```

![Interactive Chat](/Docs/images/InteractiveChat.gif)

### ChatGPT (スクリプティング)

ChatGPTに質問をして回答を得ます。

```PowerShell

$global:OPENAI_API_KEY = ''

$Result = Request-ChatCompletion -Message "自己紹介をしてください"

Write-Output $Result.Answer

```

このような出力が得られます。

```

はじめまして、私はAIアシスタントのGPT-3です。人工知能のプログラムであり、自然言語処理を使って... (以下省略)

```

> [!TIP]  

> デフォルトで使用するモデルはGPT-3.5-Turboです。  

> GPT-4oなど他のモデルを使用したい場合はモデル名を明示的に指定してください。  

> ```PowerShell

> Request-ChatCompletion -Message "Who are you?" -Model "gpt-4o"

> ```

> 

### 音声文字起こし

音声ファイルからテキストに文字起こしをさせます。

```PowerShell

$global:OPENAI_API_KEY = ''

Request-AudioTranscription -File 'C:\SampleData\audio.mp3' -Format text

```

文字起こしの結果が出力されます。

```

Perhaps he made up to the party afterwards and took her and ...

```

### 画像生成

テキストで指示を与えると、AIがそれっぽい画像を生成します。

```PowerShell

$global:OPENAI_API_KEY = ''

Request-ImageGeneration -Prompt 'かわいいライオンの子供' -Size 256x256 -OutFile 'C:\output\babylion.png'

```

このような画像が出力されます。

![Generated image](/Docs/images/babylion.png)

### 文脈を保ったままChatGPTと対話する

パイプライン経由で `Request-ChatCompletion` に対話の履歴を与えることで、文脈を維持したまま複数の質問を行うことができます。

```PowerShell

PS C:\> $FirstQA = Request-ChatCompletion -Message "アメリカの人口は？"

PS C:\> Write-Output $FirstQA.Answer

2021年現在、アメリカ合衆国の人口は約3億3300万人です。

PS C:\> $SecondQA = $FirstQA | Request-ChatCompletion -Message "では日本は？"

PS C:\> Write-Output $SecondQA.Answer

2021年現在、日本の人口は約1億2600万人です。

PS C:\> $ThirdQA = $SecondQA | Request-ChatCompletion -Message 'アメリカと日本を比較すると？'

PS C:\> Write-Output $ThirdQA.Answer

アメリカと日本の人口は、約3倍以上の開きがあります。

```

### ストリーム出力

デフォルトではサーバからのレスポンスがすべて完了してから結果がまとめて出力されるため、特に長い出力がある場合は、処理結果が得られるまでに時間がかかります。

`-Stream`オプションを使用するとChatGPTのWebUIのように結果はストリームとして逐次的に出力されるため、UXが改善する場合があります。現在`-Stream`オプションは`Request-ChatCompletion`と`Request-TextCompletion`で使用可能です。

```PowerShell

Request-ChatCompletion 'Describe ChatGPT in 100 charactors.' -Stream | Write-Host -NoNewline

```

![Stream](/Docs/images/StreamOutput.gif)

### 一部が欠けた画像を復元する

一部がマスクされた画像を与え、推定された全体画像を出力させる例です。  

与える画像はマスク部分が完全透過された正方形のPNG画像で、4MB未満でなければなりません。

```PowerShell

Request-ImageEdit -Image 'C:\sunflower_masked.png' -Prompt 'sunflower' -OutFile 'C:\sunflower_restored.png' -Size 256x256

```

左が与えた画像、右が生成された画像です。

| Source                                       | Generated                                        |

| -------------------------------------------- | ------------------------------------------------ |

| ![masked](/Docs/images/sunflower_masked.png) | ![restored](/Docs/images/sunflower_restored.png) |

### モデレーション

テキストが OpenAI のコンテンツポリシ－に抵触しているかテストします。

> 注意：モデレーションAPI は OpenAI への入力もしくは OpenAI からの出力結果をテストする目的に限り使用できます

```PowerShell

PS C:\> $Result = Request-Moderation -Text "気に入らない人間を皆殺しにしてやる"

PS C:\> $Result.results.categories

# True となっているカテゴリに抵触していることを示します

sexual           : False

hate             : True

violence         : True

self-harm        : False

sexual/minors    : False

hate/threatening : False

violence/graphic : False

```

----

## API キーについて

+ [ガイド: APIキーとコンテキストについて](Guides/How_to_handle_API-keys_and_Context.md)

ほぼ全ての関数で認証のための API キーが必要です.  

OpenAI のアカウントを作成し、以下URLから API キーを取得する必要があります。  

https://platform.openai.com/account/api-keys

関数に API キーを指定するには3種類の方法があります。

### 方法 1: 環境変数 `OPENAI_API_KEY`. (推奨)

API キーを環境変数 `OPENAI_API_KEY`に設定します。関数呼び出し時に暗黙的に使用されます。  

```PowerShell

PS C:> $env:OPENAI_API_KEY = ''

PS C:> Request-ChatCompletion -Message "Who are you?"

```

### 方法 2: Global 変数 `OPENAI_API_KEY`

API キーを`$global:OPENAI_API_KEY`変数に設定します。関数呼び出し時に暗黙的に使用されます。

```PowerShell

PS C:> $global:OPENAI_API_KEY = ''

PS C:> Request-ChatCompletion -Message "Who are you?"

```

### 方法 3: 名前付きパラメータ

各関数の `ApiKey` パラメータに API キーを指定します。すべての関数呼び出しに都度指定する必要があります。  

```PowerShell

PS C:> Request-ChatCompletion -Message "Who are you?" -ApiKey ''

```

## Azure OpenAI Service

OpenAI ではなく Azure OpenAI Service を使用する場合は、AzureテナントにOpenAIリソースを作成し、APIキーとエンドポイントURLを取得する必要があります。詳細な手順はGuidesを参照してください。

+ [How to use with Azure OpenAI Service](Guides/How_to_use_with_Azure_OpenAI_Service.md)

### Azure のサンプルコード

```powershell

$global:OPENAI_API_KEY = ''

$global:OPENAI_API_BASE  = 'https://.openai.azure.com/'

Request-ChatCompletion `

  -Message 'Hello Azure OpenAI Service.' `

  -Model 'gpt-4o' `

  -ApiType Azure

```

----

## 変更履歴

[CHANGELOG.ja.md](/CHANGELOG.ja.md)

----

## ライセンス

[MIT ライセンス](/LICENSE)