Struct DocumentBlock 

pub struct DocumentBlock {
    pub source: DocumentSource,
    pub cache_control: Option<CacheControlEphemeral>,
    pub citations: Option<CitationsConfig>,
    pub context: Option<String>,
    pub title: Option<String>,
}

Parameters for a document block.

Fields

source: DocumentSource

The source of the document.

cache_control: Option<CacheControlEphemeral>

Create a cache control breakpoint at this content block.

citations: Option<CitationsConfig>

Configuration for citations in this document.

context: Option<String>

Optional context for the document.

title: Option<String>

Optional title for the document.

Implementations

impl DocumentBlock

pub fn new(source: DocumentSource) -> Self

Create a new DocumentBlock with the given source.

pub fn new_with_base64_pdf(source: Base64PdfSource) -> Self

Create a new DocumentBlock with a Base64 PDF source.

pub fn new_with_plain_text(source: PlainTextSource) -> Self

Create a new DocumentBlock with a plain text source.

pub fn new_with_content_block(source: ContentBlockSourceParam) -> Self

Create a new DocumentBlock with a content block source.

pub fn new_with_url_pdf(source: UrlPdfSource) -> Self

Create a new DocumentBlock with a URL PDF source.

pub fn with_cache_control(self, cache_control: CacheControlEphemeral) -> Self

Add a cache control to this document block.

pub fn with_citations(self, citations: CitationsConfig) -> Self

Add citations configuration to this document block.

pub fn with_context(self, context: String) -> Self

Add context to this document block.

pub fn with_title(self, title: String) -> Self

Add a title to this document block.

Trait Implementations

impl Clone for DocumentBlock

fn clone(&self) -> DocumentBlock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentBlock

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentBlock

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<DocumentBlock> for ContentBlock

fn from(block: DocumentBlock) -> Self

Converts to this type from the input type.

impl PartialEq for DocumentBlock

fn eq(&self, other: &DocumentBlock) -> 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 DocumentBlock

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DocumentBlock