Class CitationContentBlockLocationParam
-
- All Implemented Interfaces:
public final class CitationContentBlockLocationParam
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classCitationContentBlockLocationParam.BuilderA builder for CitationContentBlockLocationParam.
-
Method Summary
Modifier and Type Method Description final StringcitedText()The full text of the cited block range, concatenated. final LongdocumentIndex()final Optional<String>documentTitle()final LongendBlockIndex()Exclusive 0-based end index of the cited block range in the source's contentarray.final LongstartBlockIndex()0-based index of the first cited block in the source's contentarray.final JsonValue_type()Expected to always return the following:
However, this method can be useful for debugging and logging (e.g.JsonValue.from("content_block_location")final JsonField<String>_citedText()Returns the raw JSON value of citedText. final JsonField<Long>_documentIndex()Returns the raw JSON value of documentIndex. final JsonField<String>_documentTitle()Returns the raw JSON value of documentTitle. final JsonField<Long>_endBlockIndex()Returns the raw JSON value of endBlockIndex. final JsonField<Long>_startBlockIndex()Returns the raw JSON value of startBlockIndex. final Map<String, JsonValue>_additionalProperties()final CitationContentBlockLocationParam.BuildertoBuilder()final CitationContentBlockLocationParamvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static CitationContentBlockLocationParam.Builderbuilder()Returns a mutable builder for constructing an instance of CitationContentBlockLocationParam. -
-
Method Detail
-
citedText
final String citedText()
The full text of the cited block range, concatenated.
Always equals the contents of
content[start_block_index:end_block_index]joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.
-
documentIndex
final Long documentIndex()
-
documentTitle
final Optional<String> documentTitle()
-
endBlockIndex
final Long endBlockIndex()
Exclusive 0-based end index of the cited block range in the source's
contentarray.Always greater than
start_block_index; a single-block citation hasend_block_index = start_block_index + 1.
-
startBlockIndex
final Long startBlockIndex()
0-based index of the first cited block in the source's
contentarray.
-
_type
final JsonValue _type()
Expected to always return the following:
JsonValue.from("content_block_location")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_citedText
final JsonField<String> _citedText()
Returns the raw JSON value of citedText.
Unlike citedText, this method doesn't throw if the JSON field has an unexpected type.
-
_documentIndex
final JsonField<Long> _documentIndex()
Returns the raw JSON value of documentIndex.
Unlike documentIndex, this method doesn't throw if the JSON field has an unexpected type.
-
_documentTitle
final JsonField<String> _documentTitle()
Returns the raw JSON value of documentTitle.
Unlike documentTitle, this method doesn't throw if the JSON field has an unexpected type.
-
_endBlockIndex
final JsonField<Long> _endBlockIndex()
Returns the raw JSON value of endBlockIndex.
Unlike endBlockIndex, this method doesn't throw if the JSON field has an unexpected type.
-
_startBlockIndex
final JsonField<Long> _startBlockIndex()
Returns the raw JSON value of startBlockIndex.
Unlike startBlockIndex, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final CitationContentBlockLocationParam.Builder toBuilder()
-
validate
final CitationContentBlockLocationParam validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static CitationContentBlockLocationParam.Builder builder()
Returns a mutable builder for constructing an instance of CitationContentBlockLocationParam.
The following fields are required:
.citedText() .documentIndex() .documentTitle() .endBlockIndex() .startBlockIndex()
-
-
-
-