Enum TextCitation 

pub enum TextCitation {
    CharLocation(CitationCharLocation),
    PageLocation(CitationPageLocation),
    ContentBlockLocation(CitationContentBlockLocation),
    WebSearchResultLocation(CitationWebSearchResultLocation),
}

Available on crate feature anthropic-client only.

A citation reference in a TextBlock.

This enum represents the different types of citations that can be included in a text block’s content.

Variants

CharLocation(CitationCharLocation)

A character-based location citation

PageLocation(CitationPageLocation)

A page-based location citation

ContentBlockLocation(CitationContentBlockLocation)

A content block-based location citation

WebSearchResultLocation(CitationWebSearchResultLocation)

A web search result location citation

Implementations

impl TextCitation

pub fn char_location( cited_text: String, document_index: i32, start_char_index: i32, end_char_index: i32, document_title: Option<String>, ) -> TextCitation

Creates a new character-based location citation

pub fn page_location( cited_text: String, document_index: i32, start_page_number: i32, end_page_number: i32, document_title: Option<String>, ) -> TextCitation

Creates a new page-based location citation

pub fn content_block_location( cited_text: String, document_index: i32, start_block_index: i32, end_block_index: i32, document_title: Option<String>, ) -> TextCitation

Creates a new content block-based location citation

pub fn web_search_result_location( cited_text: String, encrypted_index: String, url: String, title: Option<String>, ) -> TextCitation

Creates a new web search result location citation

Trait Implementations

impl Clone for TextCitation

fn clone(&self) -> TextCitation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TextCitation

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TextCitation

fn deserialize<__D>( __deserializer: __D, ) -> Result<TextCitation, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TextCitation

fn eq(&self, other: &TextCitation) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TextCitation

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TextCitation