Soracom

Users

ドキュメント
Home ドキュメント SORACOM Flux アクションリファレンス

AI アクション

AI アクションは、AI モデルとプロンプトを指定し、AI モデルに指示や質問をして、AI モデルからのレスポンスを、次のチャネルに送信します。

AI アクションの設定

CONDITION

[アクションの実行条件] では、イベントやメッセージの値 (チャネルに送信された MESSAGE や CONTEXT) を使ってアクションを実行する条件を指定できます。入力できる式について詳しくは、アクション、コンディションの記法 を参照してください。

CONFIG

AI モデルの種類や AI モデルへの入力データなどを設定します。

項目説明
[AI モデル]

AI モデルを選択します。2024 年 7 月時点で利用できる AI モデルは以下のとおりです。

  • Azure OpenAI (GPT-4o)
  • OpenAI (GPT-4o mini) (*1)
  • OpenAI (GPT-4o) (*1)
  • Amazon Bedrock - Anthropic Claude 3 Haiku
  • Amazon Bedrock - Anthropic Claude 3.5 Sonnet
  • Amazon Bedrock - Anthropic Claude 3 Opus
  • Google Gemini 1.5 Flash
  • Google Gemini 1.5 Pro
  • (*1) この AI モデルは、クレジットを消費しません。ただし、お客様の OpenAI API キーが必要です。クレジットについては、SORACOM Flux の料金プラン を参照してください。
AI モデルによって決められたクレジットを消費します
  • AI モデルによって決められた数のクレジットを消費します。たとえば、Amazon Bedrock - Anthropic Claude 3 Haiku では 1 リクエストごとに 1 クレジットを消費します。Azure OpenAI (GPT-4o) では 1 リクエストごとに 10 クレジットを消費します。
  • クレジットが 0 になると、クレジットを消費する AI モデルは利用できません。その場合は、お客様の OpenAI API キーを使用する AI モデル (クレジットを消費しない AI モデル) を利用してください。
  • クレジットの詳細は SORACOM Flux の料金 を参照してください。
[認証情報]

[AI モデル] で「OpenAI (GPT-4o mini)」または「OpenAI (GPT-4o)」を選択した場合は、お客様の OpenAI API キーを登録した認証情報を選択します。

お客様の OpenAI API キーを認証情報ストアに登録してください

あらかじめお客様の OpenAI API キーを、ユーザーコンソールの 認証情報ストアに 登録します。認証情報ストアの「認証情報を登録」画面の表示方法については、認証情報を登録する を参照してください。

認証情報は、以下のように登録します。

項目説明
[認証情報 ID]認証情報を識別するために任意の名前を入力します。例: OpenAI-API-Key
[種別]「API トークン認証情報」を選択します。
[API トークン]OpenAI API キーを入力します。
[プロンプト]

AI モデルに送信する指示や質問を入力します。

4096 文字まで入力できます。

  • AI アクションが実行されるトリガーのイベントソースのデータ (この例では、Webhook アクションの実行結果) を扱う場合は、${payload.daily.temperature_2m_max[0]} のように指定します。
  • Flux アプリが起動するトリガーのイベントソースのデータ (この例では、SIM グループに所属する IoT デバイスが Unified Endpoint のエントリポイントに送信したデータ) を扱う場合は、event. を付与して、${event.payload.temp} のように指定します。
[AI からの返答を JSON 形式にする]AI モデルからの返答を JSON 形式に制限する場合は、チェックを入れます。チェックを入れた場合は、[プロンプト] に「JSON で返却する」旨の指示を含めてください。
[AI に画像を読み込ませる]AI モデルに静止画を送信する場合は、チェックを入れて、静止画の URL を指定します。たとえば、この Flux アプリで SORACOM Harvest Files イベントソースを利用する場合は、${event.payload.presignedUrls.get} を指定すると、SORACOM Harvest Files にアップロードしたファイルが生成 AI に送信されます。
[高度なオプション][システムプロンプト]

GPT-4o シリーズで利用可能な「システムプロンプト」を入力します。

システムプロンプトは、[AI モデル] で「Azure OpenAI (GPT-4o)」、「OpenAI (GPT-4o mini)」、または「OpenAI (GPT-4o)」のいずれかを指定した場合だけ使用できます。

OUTPUT

アクションの出力データの取り扱いを設定します。

項目説明
[アクションのアウトプットを別のチャネルに送信する]「有効」にすると、アクションの出力データを別のチャネルに送信できます。
[送信先チャネル]
  • [新しくチャネルを作成する] を選択して、[チャネル名] にチャネルの名前を入力します。
  • [既存のチャネルを選択する] を選択して、既存のチャネルを選択します。

AI アクションの出力データ

AI アクションの出力データは以下のとおりです。

例:

{
  "output": {
    <AIモデルからのレスポンス>
  },
  "usage": {
    "completion_tokens": 10,
    "prompt_tokens": 300,
    "total_tokens": 310,
    "model": "gpt-4o",
    "byol": false,
    "credit": 10
  }
}
項目説明
outoutAI モデルからのレスポンス。たとえば、[アクションのアウトプットを別のチャネルに送信する] を有効化した場合は、次のチャネルからこの AI モデルからのレスポンスを ${payload.output.xxx} で取得できます。
usageAI モデルの使用量に関するデータ。
usage.completion_tokensAI モデルが生成したトークン数。
usage.prompt_tokensAI モデルにプロンプトとして送信したトークン数。
usage.total_tokensusage.completion_tokensusage.prompt_tokens の合計。
usage.model利用した AI モデル。
usage.byolお客様の OpenAI API キーの指定の有無。
usage.credit消費したクレジット。