PSDify： Dify のワークスペースの管理をコマンドで！ アプリ・ナレッジ・モデル・メンバ管理用 PowerShell モジュール

# 既存の環境にログインする
PS> Connect-Dify -AuthMethod "Code" -Email "info@example.com"  # クラウド版 
PS> Connect-Dify -Server "https://dify.example.com" -Email "info@example.com"  # コミュニティ版

# 新しい環境に管理者アカウントを作成する（コミュニティ版のみ）
PS> Initialize-Dify -Server "https://dify.example.com" -Email "info@example.com" -Name "Dify"

# ワークスペースにモデルを追加する
PS> New-DifyModel -Provider "openai" -From "predefined" `
  -Credential @{
    "openai_api_key" = "sk-proj-****************"
  }

# ワークスペースのシステムモデルを変更する
PS> Set-DifySystemModel -Type "llm" -Provider "openai" -Name "gpt-4o-mini"
PS> Set-DifySystemModel -Type "text-embedding" -Provider "openai" -Name "text-embedding-3-small"

# 新しいナレッジを作成する
PS> $Knowledge = New-DifyKnowledge -Name "My New Knowledge"

# ナレッジにファイルを追加して、インデキシングの完了を待つ
PS> Get-Item -Path "Docs/*.md" | Add-DifyDocument -Knowledge $Knowledge -Wait

# 既存の DSL ファイル内のナレッジ ID を新しい ID に置き換えて別ファイルとして保存する
PS> $RawContent = Get-DifyDSLContent -Path "oldapp.yml"
PS> $RawContent = $RawContent -replace "dc642635-9416-4794-a99d-0d02bc4ead5e", $Knowledge.Id
PS> Set-DifyDSLContent -Path $UpdatedDSLFile -Content "newapp.yml"

# 新しくできた DSL ファイルをインポートする
PS> $App = Import-DifyApp -Path $UpdatedDSLFile

# インポートしたアプリで API キーを発行する
PS> $APIKey = New-DifyAppAPIKey -App $App

# インポートしたアプリにチャットメッセージを送信する
PS> $env:PSDIFY_APP_TOKEN = $Key.Token
PS> $env:PSDIFY_APP_URL = "https://dify.example.com"
PS> Send-DifyChatMessage -Message "おはよ！" -NewSession

# 全アプリを DSL ファイルとしてエクスポートする
PS> Get-DifyApp | Export-DifyApp

# ワークスペースに新しいメンバを招待する
PS> New-DifyMember -Email "dify-editor1@example.com" -Role "editor"
PS> New-DifyMember -Email "dify-normal1@example.com" -Role "normal"

Install-Module -Name PSDify

# メールによる認証（実行後、メールで届いたコードを手動で入力する）
PS> Connect-Dify -AuthMethod "Code" -Email "dify@example.com"
Enter the code sent to dify@example.com: 123456

Server                Version Name     Email
------                ------- ----     -----
https://cloud.dify.ai 0.12.1  kurokobo dify@example.com

PS> Connect-Dify -Server "https://dify.example.com" -Email "dify@example.com"
Enter password for dify@example.com: ****************

Server                   Version Name     Email
------                   ------- ----     -----
https://dify.example.com 0.12.1  kurokobo dify@example.com

PS> Set-PSDifyConfiguration -IgnoreSSLVerification $true

# すべてのアプリを取得
PS> Get-DifyApp

# ID や名前、タイプ、タグでフィルタ
PS> Get-DifyApp -Id "2a5f3b01-a14c-4f57-b5fd-9b7aa69c250e"
PS> Get-DifyApp -Name "My App"
PS> Get-DifyApp -Mode "chat"  # "chat", "workflow", "agent-chat", "channel", "all"
PS> Get-DifyApp -Tags "Tag A", "Tag B"

# アプリのエクスポート（"DSLs" フォルダに保存）
PS> Get-DifyApp | Export-DifyApp

# 保存先のディレクトリを変更
PS> Get-DifyApp | Export-DifyApp -Path "./path/to/your/directory"

# シークレットを含める場合
PS> Get-DifyApp | Export-DifyApp -IncludeSecret

# アプリのインポート
PS> Import-DifyApp -Path "DSLs/*.yml"

# アプリの削除
PS> Get-DifyApp -Name "Unused App" | Remove-DifyApp

# API キーの発行
PS> Get-DifyApp -Name "My Chat App" | New-DifyAppAPIKey

# API キーの確認
PS> Get-DifyApp -Name "My Chat App" | Get-DifyAppAPIKey

# すべてのナレッジを取得
PS> Get-DifyKnowledge

# ID や名前、タグでフィルタ
PS> Get-DifyKnowledge -Id "a48750ec-c36d-4b0f-aa22-2771c466ba3a"
PS> Get-DifyKnowledge -Name "My Knowledge"
PS> Get-DifyKnowledge -Tags "Tag A", "Tag B"

# 空のナレッジを作成
PS> New-DifyKnowledge -Name "My New Knowledge"

# ナレッジの作成（説明文を追加）
PS> New-DifyKnowledge -Name "My New Knowledge" -Description "This is a new knowledge."

# ナレッジの削除
Get-DifyKnowledge -Name "Unused Knowledge" | Remove-DifyKnowledge

# ナレッジのすべてのドキュメントの取得
PS> Get-DifyKnowledge -Name "My Knowledge" | Get-DifyDocument

# ID や名前でフィルタ
Get-DifyKnowledge -Name "My Knowledge" | Get-DifyDocument -Id "..."
Get-DifyKnowledge -Name "My Knowledge" | Get-DifyDocument -Name "..."

# 前提： アップロードするナレッジを取得
$Knowledge = Get-DifyKnowledge -Name "My New Knowledge"

# ドキュメントのアップロード
Get-Item -Path "Docs/*.md" | Add-DifyDocument -Knowledge $Knowledge

# システムモデル以外を使う
$EmbeddingModel = Get-DifyModel -Provider "openai" -Name "text-embedding-3-small"
Add-DifyDocument -Knowledge $Knowledge -Path "Docs/*.md" -IndexMode "high_quality" -Model $EmbeddingModel

# エコノミーモードにする
Add-DifyDocument -Knowledge $Knowledge -Path "Docs/*.md" -IndexMode "economy"

# すべてのメンバの取得
PS> Get-DifyMember

# ID や名前、メールアドレスでフィルタ
PS> Get-DifyMember -Id "6cee2985-f7f3-4b96-aa34-15a0b80a1a2c"
PS> Get-DifyMember -Name "kurokobo"
PS> Get-DifyMember -Email "dify@example.com"

# メンバの招待
PS> New-DifyMember -Email "dify-editor1@example.com" -Role "normal"  # "admin", "editor", "normal"

# メンバのロールの変更
PS> Get-DifyMember -Email "dify-editor1@example.com" | Set-DifyMemberRole -Role "editor"

# メンバの削除
PS> Get-DifyMember -Email "dify-editor1@example.com" | Remove-DifyMember

# すべてのモデルの取得
PS> Get-DifyModel

# プロバイダや種類、名前、タイプでフィルタ
PS> Get-DifyModel -Provider "openai"
PS> Get-DifyModel -From "predefined"  # "predefined", "customizable"
PS> Get-DifyModel -Name "gpt-4o-mini"
PS> Get-DifyModel -Type "llm"  # "llm", "text-embedding", "speech2text", "moderation", "tts", "rerank"

# モデルの追加（事前定義モデルの追加、OpenAI の例）
PS> New-DifyModel -Provider "openai" -From "predefined" `
  -Credential @{
    "openai_api_key" = "sk-proj-****************"
  }

# モデルの追加（カスタムモデルの追加、OpenAI の例）
PS> New-DifyModel -Provider "openai" -From "customizable" `
  -Type "llm" -Name "gpt-4o-mini" `
  -Credential @{
    "openai_api_key" = "sk-proj-****************"
  }

# すべてのシステムモデルの取得
PS> Get-DifySystemModel

# タイプでフィルタ
PS> Get-DifySystemModel -Type "llm"  # "llm", "text-embedding", "rerank", "speech2text", "tts"

# システムモデルの変更
PS> Set-DifySystemModel -Type "llm" -Provider "openai" -Name "gpt-4o-mini"

# 接続先の Dify のバージョンの取得
PS> Get-DifyVersion

# 認証したアカウントの情報の取得
PS> Get-DifyProfile

# 管理者アカウントの作成
PS> Initialize-Dify -Server "https://dify.example.com" -Email "dify@example.com"

# 環境変数の設定
PS> $env:PSDIFY_APP_URL = "https://dify.example.com"
PS> $env:PSDIFY_APP_TOKEN = "app-****************"

# チャットメッセージの送信
PS> Send-DifyChatMessage -Message "Hello, Dify!"

# チャットメッセージの送信（新しいセッションを開始）
PS> Send-DifyChatMessage -Message "Hello, Dify!" -NewSession