5.2.1.20.5. チャット¶

入力メッセージを通して対話を行うためのタスクです。

5.2.1.20.5.1. プロパティ¶

項目名	必須/任意	型	初期値	説明
出力違反ハンドリング	任意	flag	false	AIサービスが出力コンテンツを違反と判定した際に処理を続行する場合は、チェックボックスをオンにしてください。 ※入力コンテンツが違反と判定された場合は、このプロパティに関わらずエラーとして扱われます。

5.2.1.20.5.2. 入力値¶

im_chat <object> *
  ├─ messages <object[]> *
  │   ├─ content <string>
  │   ├─ contents <object[]>
  │   │   ├─ image <binary>
  │   │   └─ text <string>
  │   └─ role <string> *
  └─ option <object>
       ├─ maxTokens <integer>
       ├─ model <string>
       ├─ reasoningEffort <string>
       ├─ stops <string[]>
       ├─ streaming <boolean>
       ├─ temperature <double>
       ├─ topP <double>
       └─ verbosity <string>

項目名	必須/任意	型	配列/リスト	説明
im_chat	必須	object	なし	-
messages	必須	object	リスト	入力メッセージのリストを指定してください。
role	必須	string	なし	役割を指定してください。
content	任意	string	なし	メッセージ本文を指定してください。
contents	任意	object	リスト	メッセージ本文、画像のリストを指定してください。
image	任意	binary	なし	画像を指定してください。
text	任意	string	なし	メッセージ本文を指定してください。
option	任意	object	なし	-
model	任意	string	なし	モデルを指定してください。
maxTokens	任意	integer	なし	トークン最大数を指定してください ※OpenAI および Azure OpenAI Service が提供する推論モデルを利用する場合、maxTokensパラメータに関する注意事項を参照してください。
temperature	任意	double	なし	出力ランダム性を指定してください。 ※モデルで利用できるパラメータに関する制約事項を参照してください。
topP	任意	double	なし	top-pサンプリングを指定してください。 ※モデルで利用できるパラメータに関する制約事項を参照してください。
stops	任意	string	リスト	トークン生成停止シーケンスを指定してください。 ※モデルで利用できるパラメータに関する制約事項を参照してください。
streaming	任意	boolean	なし	ストリーミング機能を有効にしたい場合、trueを指定します。
reasoningEffort	任意	string	なし	推論の深さを指定してください。 ※モデルで利用できるパラメータに関する制約事項を参照してください。
verbosity	任意	string	なし	出力の文章量・説明の密度を指定してください。 ※OpenAI および Azure OpenAI Service でサポートされているパラメータです。モデルで利用できるパラメータに関する制約事項を参照してください。

コラム

各生成AIサービスで指定可能なroleは、以下の通りです。

user

system

assistant

Amazon Bedrockの場合は、system のメッセージは1つしか受け付けません。

また、user のメッセージと、assistant のメッセージを交互に指定する必要があります。

コラム

model に指定する値は、各生成AIサービスにより異なります。

設定可能（利用検証済み）チャットモデル名は「IM-Copilot 利用ガイド」の「サポートモデル」を参照してください。

注意

messages[x] において content を指定した場合は、contents は指定できません。

messages[x] において contents を指定した場合は、content は指定できません。

content、または、contentsのいずれか片方のみに値を指定してください。

注意

contents[x] において、text を指定した場合は、image は指定できません。

contents[x] において、image を指定した場合は、text は指定できません。

text、または、imageのいずれか片方のみに値を指定してください。

注意

ストリーミング機能は、ロジックフローを生成AIアシスタントとして登録、実行した場合のみ利用可能です。

ストリーミング機能を有効にするとチャットタスクの返答がリアルタイムでクライアントへ送信されます。

注意

OpenAI および Azure OpenAI Service が提供する推論モデルを利用し、かつストリーミング出力を無効にする場合、モデルの仕様により、返答内容のトークン数より maxTokens の値が小さいと返答が空文字になる可能性があるため、maxTokens は十分大きな値を設定することを推奨します。

注意

モデルの仕様により一部のパラメータに制約が生じます。

制約については各AIサービスの公式ドキュメントを参照してください。

5.2.1.20.5.3. 出力値¶

im_chat <object>
  ├─ chatMessage <object[]>
  │   ├─ content <string>
  │   ├─ contents <object[]>
  │   │   ├─ image <binary>
  │   │   └─ text <string>
  │   └─ role <string>
  ├─ contentFilter <object>
  │   ├─ input <string>
  │   ├─ inputReason <string>
  │   ├─ output <string>
  │   └─ outputReason <string>
  └─ usage <object>
      ├─ cacheReadInputTokens <integer>
      ├─ inputTokens <integer>
      └─ outputTokens <integer>

項目名	型	配列/リスト	説明
im_chat	object	なし	-
chatMessage	object	リスト	メッセージリスト。末尾に返ってきたメッセージが追加されます。
content	string	なし	メッセージ本文
contents	object	リスト	メッセージ本文、画像のリスト
image	binary	なし	画像
text	string	なし	メッセージ本文
role	string	なし	役割
contentFilter	object	なし	コンテンツフィルタ入出力コンテンツに対するフィルタリング情報
input	string	なし	入力コンテンツのフィルタリング結果 `masked`: 機密情報がマスクされた状態、`null`: フィルタリングなし
inputReason	string	なし	入力コンテンツがフィルタリングされた理由違反カテゴリを返します。複数ある場合は、カンマ区切りで列挙されます。
output	string	なし	出力コンテンツのフィルタリング結果 `blocked`: 不適切な内容のため出力をブロック、`masked`: 機密情報がマスクされた状態、`null`: フィルタリングなし
outputReason	string	なし	出力コンテンツがフィルタリングされた理由違反カテゴリを返します。複数ある場合は、カンマ区切りで列挙されます。
usage	object	なし	トークン使用量 AIサービスからトークン使用量が取得できなかった場合は、nullが出力されます。
cacheReadInputTokens	integer	なし	キャッシュから読み出された入力トークン数この値は `inputTokens` の内訳です。トークン使用量の内訳にキャッシュ入力トークン数が含まれていなかった場合は、キャッシュ未使用とみなし、0が出力されます。
inputTokens	integer	なし	入力トークン数この値は `cacheReadInputTokens` を含んだ値です。
outputTokens	integer	なし	出力トークン数

目次

5.2.1.20.5. チャット¶

5.2.1.20.5.1. プロパティ¶

5.2.1.20.5.2. 入力値¶

5.2.1.20.5.3. 出力値¶

目次