Interface TextChatResultChoice

A tool related result.

interface TextChatResultChoice {
    finish_reason?: string;
    index?: number;
    message?: WatsonXAI.TextChatResultMessage;
}

Index

Properties

finish_reason? index? message?

Properties

`Optional` finish_reason

finish_reason?: string

The reason why the call stopped, can be one of:

stop - The model hit a natural stop point or a provided stop sequence.
length - The maximum number of tokens specified in the request was reached.
tool_calls - The model called a tool.
`time_limit`` - Time limit reached.
`cancelled`` - Request canceled by the client.
`error`` - Error encountered.
null - API response still in progress or incomplete.

`Optional` index

index?: number

The index of this result.

`Optional` message

message?: WatsonXAI.TextChatResultMessage

A message result.