Class ResponseOutputText.Annotation.UrlCitation
-
- All Implemented Interfaces:
public final class ResponseOutputText.Annotation.UrlCitation
A citation for a web resource used to generate a model response.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseOutputText.Annotation.UrlCitation.Builder
A builder for UrlCitation.
-
Method Summary
Modifier and Type Method Description final Long
endIndex()
The index of the last character of the URL citation in the message. final Long
startIndex()
The index of the first character of the URL citation in the message. final String
title()
The title of the web resource. final JsonValue
_type()
The type of the URL citation. final String
url()
The URL of the web resource. final JsonField<Long>
_endIndex()
Returns the raw JSON value of endIndex. final JsonField<Long>
_startIndex()
Returns the raw JSON value of startIndex. final JsonField<String>
_title()
Returns the raw JSON value of title. final JsonField<String>
_url()
Returns the raw JSON value of url. final Map<String, JsonValue>
_additionalProperties()
final ResponseOutputText.Annotation.UrlCitation.Builder
toBuilder()
final ResponseOutputText.Annotation.UrlCitation
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseOutputText.Annotation.UrlCitation.Builder
builder()
Returns a mutable builder for constructing an instance of UrlCitation. -
-
Method Detail
-
startIndex
final Long startIndex()
The index of the first character of the URL citation in the message.
-
_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).
-
_endIndex
final JsonField<Long> _endIndex()
Returns the raw JSON value of endIndex.
Unlike endIndex, this method doesn't throw if the JSON field has an unexpected type.
-
_startIndex
final JsonField<Long> _startIndex()
Returns the raw JSON value of startIndex.
Unlike startIndex, this method doesn't throw if the JSON field has an unexpected type.
-
_title
final JsonField<String> _title()
Returns the raw JSON value of title.
Unlike title, this method doesn't throw if the JSON field has an unexpected type.
-
_url
final JsonField<String> _url()
Returns the raw JSON value of url.
Unlike url, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseOutputText.Annotation.UrlCitation.Builder toBuilder()
-
validate
final ResponseOutputText.Annotation.UrlCitation validate()
-
builder
final static ResponseOutputText.Annotation.UrlCitation.Builder builder()
Returns a mutable builder for constructing an instance of UrlCitation.
The following fields are required:
.endIndex() .startIndex() .title() .url()
-
-
-
-