ApiChatCompletionsResponseChoiceMessage (formcycle: bom 8.5.6 API)

java.lang.Object
- de.xima.fc.prompt.ms.impl.service.generic_oai.client.json.ApiChatCompletionsResponseChoiceMessage

public final class ApiChatCompletionsResponseChoiceMessage
extends Object

A chat completion message generated by the model.

Since:: 8.5.0

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<ApiChatCompletionsResponseMessageAnnotation>`	`annotations()`	Annotations for the message, when applicable, as when using the web search tool.
`ApiChatCompletionsResponseMessageAudio`	`audio()`	If the audio output modality is requested, this object contains data about the audio response from the model.
`String`	`content()`	The contents of the message.
`String`	`refusal()`	The refusal message generated by the model.
`String`	`role()`	The role of the author of this message.
`List<ApiChatCompletionsResponseMessageToolCall>`	`toolCalls()`	The tool calls generated by the model, such as function calls.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - annotations
```
public List<ApiChatCompletionsResponseMessageAnnotation> annotations()
```
    Annotations for the message, when applicable, as when using the web search tool.
    
    Returns:
    
    The list of annotations.
  - audio
```
public ApiChatCompletionsResponseMessageAudio audio()
```
    If the audio output modality is requested, this object contains data about the audio response from the model.
    
    Returns:
    
    The audio response data.
  - content
```
public String content()
```
    The contents of the message.
    
    Returns:
    
    The message content.
  - refusal
```
public String refusal()
```
    The refusal message generated by the model.
    
    Returns:
    
    The refusal message.
  - role
```
public String role()
```
    The role of the author of this message.
    
    Returns:
    
    The message role.
  - toolCalls
```
public List<ApiChatCompletionsResponseMessageToolCall> toolCalls()
```
    The tool calls generated by the model, such as function calls.
    
    Returns:
    
    The list of tool calls.