Struct TaskSchema 

pub struct TaskSchema {
    pub entities: Option<EntityTask>,
    pub classifications: Vec<ClassificationTask>,
    pub structures: Vec<StructureTask>,
}

Schema defining what to extract.

Use builder methods to construct complex schemas:

let schema = TaskSchema::new()
    .with_entities(&["person", "organization"])
    .with_classification("sentiment", &["positive", "negative"], false)
    .with_structure(
        StructureTask::new("product")
            .with_field("name", FieldType::String)
            .with_field("price", FieldType::String)
    );

Fields

entities: Option<EntityTask>

Entity types to extract

classifications: Vec<ClassificationTask>

Classification tasks

structures: Vec<StructureTask>

Structure extraction tasks

Implementations

impl TaskSchema

pub fn new() -> Self

Create empty schema.

pub fn with_entities(self, types: &[&str]) -> Self

Add entity types to extract.

pub fn with_entities_described( self, types_with_desc: HashMap<String, String>, ) -> Self

Add entity types with descriptions for better zero-shot.

pub fn with_classification( self, name: &str, labels: &[&str], multi_label: bool, ) -> Self

Add a classification task.

pub fn with_structure(self, task: StructureTask) -> Self

Add a structure extraction task.

Trait Implementations

impl Clone for TaskSchema

fn clone(&self) -> TaskSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TaskSchema

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

Formats the value using the given formatter.

impl Default for TaskSchema

fn default() -> TaskSchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TaskSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TaskSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.