ChatMessage.ChatMessageBuilder (javadoc-all-dev 8.0.0 API)

java.lang.Object
- jp.co.intra_mart.foundation.copilot.action.chat.ChatMessage.ChatMessageBuilder

含まれているクラス:

ChatMessage
```
public static final class ChatMessage.ChatMessageBuilder
extends Object
```
メッセージの内容のビルダークラスです。
このクラスのインスタンスは、メッセージリストのビルダーから作成されます。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`ChatMessage.ChatMessageBuilder`	`addImageData(byte[] image)` メッセージ本文として画像のバイナリデータを追加します。
`ChatMessage.ChatMessageBuilder`	`addImageData(byte[] image, ImageUnderstandingFidelity detail)` メッセージ本文として画像のバイナリデータを追加します。
`ChatMessage.ChatMessageBuilder`	`addImageUrl(String url)` メッセージ本文として画像のURLを追加します。
`ChatMessage.ChatMessageBuilder`	`addImageUrl(String url, ImageUnderstandingFidelity detail)` メッセージ本文として画像のURLを追加します。
`ChatMessage.ChatMessageBuilder`	`addTextContent(String text)` メッセージの本文としてテキストを設定します。
`ChatMessage.ChatMessageBuilder`	`addToolCall(ToolCall toolCall)` メッセージに関数呼び出し情報を追加します。
`ChatMessage.ChatMessageBuilder`	`addToolImageData(byte[] image, String toolCallId)` 関数実行結果メッセージの本文として、画像のバイナリデータを追加します。
`ChatMessage.ChatMessageBuilder`	`addToolImageData(String dataUrl, String toolCallId)` 関数実行結果メッセージの本文として、DataURL形式の画像データを追加します。
`ChatMessage.ChatMessageBuilder`	`addToolTextContent(String text, String toolCallId)` 関数実行結果メッセージの本文として、テキストを設定します。
`List<ChatMessage>`	`build()` 現在操作しているメッセージの設定を終え、メッセージリストのビルダーに与えられた情報からメッセージのリストを生成して返します。
`ChatMessage.ChatMessageBuilder`	`contentFilter(ContentFilterInfo contentFilter)` メッセージにコンテンツフィルタを設定します。
`ChatMessage.ChatMessageListBuilder`	`finish()` 現在操作しているメッセージの設定を終え、メッセージリストのビルダーを返します。
`ChatMessage.ChatMessageBuilder`	`newMessage()` 現在操作しているメッセージの設定を終え、新しいメッセージを追加してそのメッセージを設定するビルダーを返します。
`ChatMessage.ChatMessageBuilder`	`toolCalls(List<ToolCall> toolCalls)` メッセージに関数呼び出し情報を設定します。
`ChatMessage.ChatMessageBuilder`	`withRole(String role)` メッセージに役割を設定します。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- メソッドの詳細
  - addImageData
```
public ChatMessage.ChatMessageBuilder addImageData(byte[] image)
                                            throws CopilotServiceException
```
    メッセージ本文として画像のバイナリデータを追加します。
    画像フォーマットはバイト配列から自動的に判別します。png, jpeg, gif形式が指定可能です。
    メッセージの本文はリストになります。
    
    パラメータ:
    
    image - 画像のバイト配列
    
    戻り値:
    
    このビルダー自身
    
    例外:
    
    CopilotServiceException - 画像フォーマットが非対応である場合
  - addImageData
```
public ChatMessage.ChatMessageBuilder addImageData(byte[] image,
                                                   ImageUnderstandingFidelity detail)
                                            throws CopilotServiceException
```
    メッセージ本文として画像のバイナリデータを追加します。画像詳細も指定します。
    画像フォーマットはバイト配列から自動的に判別します。png, jpeg, gif形式が指定可能です。
    メッセージの本文はリストになります。
```
 ※注意※
 Amazon Bedrockドライバを利用する場合、画像詳細（detail）は無視されます。
 
```
    パラメータ:
    
    image - 画像のバイト配列
    
    detail - 画像詳細（low, high, autoのいずれか）
    
    戻り値:
    
    このビルダー自身
    
    例外:
    
    CopilotServiceException - 画像フォーマットが非対応である場合
  - addImageUrl
```
public ChatMessage.ChatMessageBuilder addImageUrl(String url)
```
    メッセージ本文として画像のURLを追加します。
    メッセージの本文はリストになります。
```
 ※注意※
 Amazon Bedrockドライバを利用する場合、addImageUrlメソッドは利用できません。
 
```
    パラメータ:
    
    url - 画像にアクセス可能なURL
    
    戻り値:
    
    このビルダー自身
  - addImageUrl
```
public ChatMessage.ChatMessageBuilder addImageUrl(String url,
                                                  ImageUnderstandingFidelity detail)
```
    メッセージ本文として画像のURLを追加します。画像詳細も指定します。
    メッセージの本文はリストになります。
```
 ※注意※
 Amazon Bedrockドライバを利用する場合、addImageUrlメソッドは利用できません。
 
```
    パラメータ:
    
    url - 画像にアクセス可能なURL
    
    detail - 画像詳細（low, high, autoのいずれか）
    
    戻り値:
    
    このビルダー自身
  - addTextContent
```
public ChatMessage.ChatMessageBuilder addTextContent(String text)
```
    メッセージの本文としてテキストを設定します。
    複数回呼び出した場合は、メッセージの本文はリストになります。
    
    パラメータ:
    
    text - メッセージの本文に設定するテキスト
    
    戻り値:
    
    このビルダー自身
  - addToolCall
```
public ChatMessage.ChatMessageBuilder addToolCall(ToolCall toolCall)
```
    メッセージに関数呼び出し情報を追加します。
    
    パラメータ:
    
    toolCall - 関数呼び出し情報
    
    戻り値:
    
    このビルダー自身
  - addToolImageData
```
public ChatMessage.ChatMessageBuilder addToolImageData(byte[] image,
                                                       String toolCallId)
                                                throws CopilotServiceException
```
    関数実行結果メッセージの本文として、画像のバイナリデータを追加します。
    画像フォーマットはバイト配列から自動的に判別します。png, jpeg, gif形式が指定可能です。
    メッセージの本文はリストになります。
    
    パラメータ:
    
    image - 画像のバイト配列
    
    toolCallId - 関数呼び出しID
    
    戻り値:
    
    このビルダー自身
    
    例外:
    
    CopilotServiceException - 画像フォーマットが非対応である場合
  - addToolImageData
```
public ChatMessage.ChatMessageBuilder addToolImageData(String dataUrl,
                                                       String toolCallId)
```
    関数実行結果メッセージの本文として、DataURL形式の画像データを追加します。
    メッセージの本文はリストになります。
    
    パラメータ:
    
    dataUrl - DataURL形式の文字列
    
    toolCallId - 関数呼び出しID
    
    戻り値:
    
    このビルダー自身
  - addToolTextContent
```
public ChatMessage.ChatMessageBuilder addToolTextContent(String text,
                                                         String toolCallId)
```
    関数実行結果メッセージの本文として、テキストを設定します。
    メッセージの本文はリストになります。
    
    パラメータ:
    
    text - メッセージの本文に設定するテキスト
    
    toolCallId - 関数呼び出しID
    
    戻り値:
    
    このビルダー自身
  - build
```
public List<ChatMessage> build()
```
    現在操作しているメッセージの設定を終え、メッセージリストのビルダーに与えられた情報からメッセージのリストを生成して返します。
    
    戻り値:
    
    メッセージのリスト
  - contentFilter
```
public ChatMessage.ChatMessageBuilder contentFilter(ContentFilterInfo contentFilter)
```
    メッセージにコンテンツフィルタを設定します。
    
    パラメータ:
    
    contentFilter - コンテンツフィルタ
    
    戻り値:
    
    このビルダー自身
  - finish
```
public ChatMessage.ChatMessageListBuilder finish()
```
    現在操作しているメッセージの設定を終え、メッセージリストのビルダーを返します。
    
    戻り値:
    
    メッセージリストのビルダー
  - newMessage
```
public ChatMessage.ChatMessageBuilder newMessage()
```
    現在操作しているメッセージの設定を終え、新しいメッセージを追加してそのメッセージを設定するビルダーを返します。
    
    戻り値:
    
    メッセージのビルダー
  - toolCalls
```
public ChatMessage.ChatMessageBuilder toolCalls(List<ToolCall> toolCalls)
```
    メッセージに関数呼び出し情報を設定します。
    
    パラメータ:
    
    toolCalls - 関数呼び出し情報
    
    戻り値:
    
    このビルダー自身
  - withRole
```
public ChatMessage.ChatMessageBuilder withRole(String role)
```
    メッセージに役割を設定します。
    複数回呼び出した場合は、最後に設定したものが有効となります。
    生成AIサービスがAmazon Bedrockの場合、システムメッセージは最新の1つのみが有効となります。
    
    パラメータ:
    
    role - 役割の文字列（user, system, assistantなど）
    
    戻り値:
    
    このビルダー自身

クラス ChatMessage.ChatMessageBuilder

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

メソッドの詳細

addImageData

addImageData

addImageUrl

addImageUrl

addTextContent

addToolCall

addToolImageData

addToolImageData

addToolTextContent

build

contentFilter

finish

newMessage

toolCalls

withRole