Class ChatKitResponseOutputText
-
- All Implemented Interfaces:
public final class ChatKitResponseOutputText
Assistant response text accompanied by optional annotations.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ChatKitResponseOutputText.Builder
A builder for ChatKitResponseOutputText.
public final class
ChatKitResponseOutputText.Annotation
Annotation object describing a cited source.
-
Method Summary
Modifier and Type Method Description final List<ChatKitResponseOutputText.Annotation>
annotations()
Ordered list of annotations attached to the response text. final String
text()
Assistant generated text. final JsonValue
_type()
Type discriminator that is always output_text
.final JsonField<List<ChatKitResponseOutputText.Annotation>>
_annotations()
Returns the raw JSON value of annotations. final JsonField<String>
_text()
Returns the raw JSON value of text. final Map<String, JsonValue>
_additionalProperties()
final ChatKitResponseOutputText.Builder
toBuilder()
final ChatKitResponseOutputText
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ChatKitResponseOutputText.Builder
builder()
Returns a mutable builder for constructing an instance of ChatKitResponseOutputText. -
-
Method Detail
-
annotations
final List<ChatKitResponseOutputText.Annotation> annotations()
Ordered list of annotations attached to the response text.
-
_type
final JsonValue _type()
Type discriminator that is always
output_text
.Expected to always return the following:
JsonValue.from("output_text")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_annotations
final JsonField<List<ChatKitResponseOutputText.Annotation>> _annotations()
Returns the raw JSON value of annotations.
Unlike annotations, this method doesn't throw if the JSON field has an unexpected type.
-
_text
final JsonField<String> _text()
Returns the raw JSON value of text.
Unlike text, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ChatKitResponseOutputText.Builder toBuilder()
-
validate
final ChatKitResponseOutputText validate()
-
builder
final static ChatKitResponseOutputText.Builder builder()
Returns a mutable builder for constructing an instance of ChatKitResponseOutputText.
The following fields are required:
.annotations() .text()
-
-
-
-