Constructor Detail

Method Detail

• citedText

   final BetaCitationSearchResultLocationParam.Builder citedText(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.

• citedText

   final BetaCitationSearchResultLocationParam.Builder citedText(JsonField<String> citedText)

  Sets Builder.citedText to an arbitrary JSON value.

  You should usually call Builder.citedText with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• endBlockIndex

   final BetaCitationSearchResultLocationParam.Builder endBlockIndex(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.

• endBlockIndex

   final BetaCitationSearchResultLocationParam.Builder endBlockIndex(JsonField<Long> endBlockIndex)

  Sets Builder.endBlockIndex to an arbitrary JSON value.

  You should usually call Builder.endBlockIndex with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• searchResultIndex

   final BetaCitationSearchResultLocationParam.Builder searchResultIndex(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.

• searchResultIndex

   final BetaCitationSearchResultLocationParam.Builder searchResultIndex(JsonField<Long> searchResultIndex)

  Sets Builder.searchResultIndex to an arbitrary JSON value.

  You should usually call Builder.searchResultIndex with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• source

   final BetaCitationSearchResultLocationParam.Builder source(String source)

• source

   final BetaCitationSearchResultLocationParam.Builder source(JsonField<String> source)

  Sets Builder.source to an arbitrary JSON value.

  You should usually call Builder.source with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• startBlockIndex

   final BetaCitationSearchResultLocationParam.Builder startBlockIndex(Long startBlockIndex)

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

• startBlockIndex

   final BetaCitationSearchResultLocationParam.Builder startBlockIndex(JsonField<Long> startBlockIndex)

  Sets Builder.startBlockIndex to an arbitrary JSON value.

  You should usually call Builder.startBlockIndex with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• title

   final BetaCitationSearchResultLocationParam.Builder title(String title)

• title

   final BetaCitationSearchResultLocationParam.Builder title(Optional<String> title)

  Alias for calling Builder.title with title.orElse(null).

• title

   final BetaCitationSearchResultLocationParam.Builder title(JsonField<String> title)

  Sets Builder.title to an arbitrary JSON value.

  You should usually call Builder.title with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• type

   final BetaCitationSearchResultLocationParam.Builder type(JsonValue type)

  Sets the field to an arbitrary JSON value.

  It is usually unnecessary to call this method because the field defaults to the following:

  JsonValue.from("search_result_location")

  This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalProperties

   final BetaCitationSearchResultLocationParam.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final BetaCitationSearchResultLocationParam.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final BetaCitationSearchResultLocationParam.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final BetaCitationSearchResultLocationParam.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final BetaCitationSearchResultLocationParam.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final BetaCitationSearchResultLocationParam build()

  Returns an immutable instance of BetaCitationSearchResultLocationParam.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

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