Constructor Detail

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.

• endBlockIndex

   final Long endBlockIndex()

  Exclusive 0-based end index of the cited block range in the source's content array.

  Always greater than start_block_index; a single-block citation has end_block_index = start_block_index + 1.

• searchResultIndex

   final Long searchResultIndex()

  0-based index of the cited search result among all search_result content blocks in the request, in the order they appear across messages and tool results.

  Counted separately from document_index; server-side web search results are not included in this count.

• source

   final String source()

• startBlockIndex

   final Long startBlockIndex()

  0-based index of the first cited block in the source's content array.

• title

   final Optional<String> title()

• _type

   final JsonValue _type()

  Expected to always return the following:

  JsonValue.from("search_result_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.

• _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.

• _searchResultIndex

   final JsonField<Long> _searchResultIndex()

  Returns the raw JSON value of searchResultIndex.

  Unlike searchResultIndex, this method doesn't throw if the JSON field has an unexpected type.

• _source

   final JsonField<String> _source()

  Returns the raw JSON value of source.

  Unlike source, 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.

• _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.

• _additionalProperties

   final Map<String, JsonValue> _additionalProperties()

• toBuilder

   final BetaCitationSearchResultLocationParam.Builder toBuilder()

• validate

   final BetaCitationSearchResultLocationParam 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.

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static BetaCitationSearchResultLocationParam.Builder builder()

  Returns a mutable builder for constructing an instance of BetaCitationSearchResultLocationParam.

  The following fields are required:

  .citedText()
  .endBlockIndex()
  .searchResultIndex()
  .source()
  .startBlockIndex()
  .title()