Class ChatCompletionMessage.Annotation
-
- All Implemented Interfaces:
public final class ChatCompletionMessage.Annotation
A URL citation when using web search.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ChatCompletionMessage.Annotation.Builder
A builder for Annotation.
public final class
ChatCompletionMessage.Annotation.UrlCitation
A URL citation when using web search.
-
Method Summary
Modifier and Type Method Description final JsonValue
_type()
The type of the URL citation. final ChatCompletionMessage.Annotation.UrlCitation
urlCitation()
A URL citation when using web search. final JsonField<ChatCompletionMessage.Annotation.UrlCitation>
_urlCitation()
Returns the raw JSON value of urlCitation. final Map<String, JsonValue>
_additionalProperties()
final ChatCompletionMessage.Annotation.Builder
toBuilder()
final ChatCompletionMessage.Annotation
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ChatCompletionMessage.Annotation.Builder
builder()
Returns a mutable builder for constructing an instance of Annotation. -
-
Method Detail
-
_type
final JsonValue _type()
The type of the URL citation. Always
url_citation
.Expected to always return the following:
JsonValue.from("url_citation")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
urlCitation
final ChatCompletionMessage.Annotation.UrlCitation urlCitation()
A URL citation when using web search.
-
_urlCitation
final JsonField<ChatCompletionMessage.Annotation.UrlCitation> _urlCitation()
Returns the raw JSON value of urlCitation.
Unlike urlCitation, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ChatCompletionMessage.Annotation.Builder toBuilder()
-
validate
final ChatCompletionMessage.Annotation validate()
-
builder
final static ChatCompletionMessage.Annotation.Builder builder()
Returns a mutable builder for constructing an instance of Annotation.
The following fields are required:
.urlCitation()
-
-
-
-