Struct RetrievalResultContent

#[non_exhaustive]
pub struct RetrievalResultContent {
    pub type: Option<RetrievalResultContentType>,
    pub text: String,
    pub byte_content: Option<String>,
    pub row: Option<Vec<RetrievalResultContentColumn>>,
}

Contains information about a chunk of text from a data source in the knowledge base. If the result is from a structured data source, the cell in the database and the type of the value is also identified.

This data type is used in the following API operations:

• Retrieve response – in the content field

• RetrieveAndGenerate response – in the content field

• InvokeAgent response – in the content field

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

type: Option<RetrievalResultContentType>

The type of content in the retrieval result.

text: String

The cited text from the data source.

byte_content: Option<String>

A data URI with base64-encoded content from the data source. The URI is in the following format: returned in the following format: data:image/jpeg;base64,${base64-encoded string}.

row: Option<Vec<RetrievalResultContentColumn>>

Specifies information about the rows with the cells to return in retrieval.

Implementations

impl RetrievalResultContent

pub fn type(&self) -> Option<&RetrievalResultContentType>

The type of content in the retrieval result.

pub fn text(&self) -> &str

The cited text from the data source.

pub fn byte_content(&self) -> Option<&str>

A data URI with base64-encoded content from the data source. The URI is in the following format: returned in the following format: data:image/jpeg;base64,${base64-encoded string}.

pub fn row(&self) -> &[RetrievalResultContentColumn]

Specifies information about the rows with the cells to return in retrieval.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .row.is_none().

impl RetrievalResultContent

pub fn builder() -> RetrievalResultContentBuilder

Creates a new builder-style object to manufacture RetrievalResultContent.

Trait Implementations

impl Clone for RetrievalResultContent

fn clone(&self) -> RetrievalResultContent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetrievalResultContent

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

Formats the value using the given formatter.

impl PartialEq for RetrievalResultContent

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

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

const 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 StructuralPartialEq for RetrievalResultContent