Index

A

AbstractDocumentProcessor (class in kor.documents.typedefs) AbstractSchemaNode (class in kor.nodes) AbstractVisitor (class in kor.nodes) accept() (kor.Bool method) (kor.nodes.AbstractSchemaNode method) (kor.nodes.Bool method) (kor.nodes.Number method) (kor.nodes.Object method) (kor.nodes.Option method) (kor.nodes.Selection method) (kor.nodes.Text method) (kor.Number method) (kor.Object method) (kor.Option method) (kor.Selection method) (kor.Text method)

arbitrary_types_allowed (kor.extraction.KorParser.Config attribute) (kor.extraction.parser.KorParser.Config attribute) (kor.prompts.ExtractionPromptTemplate.Config attribute) (kor.prompts.ExtractionPromptValue.Config attribute) attributes (kor.nodes.Object attribute) (kor.Object attribute)

B

Bool (class in kor) (class in kor.nodes)

BulletPointDescriptor (class in kor) (class in kor.type_descriptors)

C

clean_data() (kor.validators.PydanticValidator method) (kor.validators.Validator method) create_extraction_chain() (in module kor) (in module kor.extraction) (in module kor.extraction.api)

create_langchain_prompt() (in module kor.prompts) CSVEncoder (class in kor) (class in kor.encoders) (class in kor.encoders.csv_data)

D

data (kor.DocumentExtraction attribute) (kor.Extraction attribute) (kor.extraction.DocumentExtraction attribute) (kor.extraction.Extraction attribute) (kor.extraction.typedefs.DocumentExtraction attribute) (kor.extraction.typedefs.Extraction attribute) decode() (kor.CSVEncoder method) (kor.encoders.csv_data.CSVEncoder method) (kor.encoders.CSVEncoder method) (kor.encoders.Encoder method) (kor.encoders.json_data.JSONEncoder method) (kor.encoders.JSONEncoder method) (kor.encoders.typedefs.Encoder method) (kor.encoders.xml.XMLEncoder method) (kor.encoders.XMLEncoder method) (kor.JSONEncoder method) (kor.XMLEncoder method)

describe() (kor.BulletPointDescriptor method) (kor.type_descriptors.BulletPointDescriptor method) (kor.type_descriptors.TypeDescriptor method) (kor.type_descriptors.TypeScriptDescriptor method) (kor.TypeDescriptor method) (kor.TypeScriptDescriptor method) description (kor.Bool attribute) (kor.nodes.AbstractSchemaNode attribute) (kor.Number attribute) (kor.Object attribute) (kor.Option attribute) (kor.Selection attribute) (kor.Text attribute) DocumentExtraction (class in kor) (class in kor.extraction) (class in kor.extraction.typedefs)

E

encode() (kor.CSVEncoder method) (kor.encoders.csv_data.CSVEncoder method) (kor.encoders.CSVEncoder method) (kor.encoders.Encoder method) (kor.encoders.json_data.JSONEncoder method) (kor.encoders.JSONEncoder method) (kor.encoders.typedefs.Encoder method) (kor.encoders.xml.XMLEncoder method) (kor.encoders.XMLEncoder method) (kor.JSONEncoder method) (kor.XMLEncoder method) encode_examples() (in module kor.encoders) (in module kor.encoders.encode) Encoder (class in kor.encoders) (class in kor.encoders.typedefs) encoder (kor.extraction.KorParser attribute) (kor.extraction.parser.KorParser attribute) (kor.prompts.ExtractionPromptTemplate attribute) errors (kor.DocumentExtraction attribute) (kor.Extraction attribute) (kor.extraction.DocumentExtraction attribute) (kor.extraction.Extraction attribute) (kor.extraction.typedefs.DocumentExtraction attribute) (kor.extraction.typedefs.Extraction attribute) examples (kor.Bool attribute) (kor.nodes.Bool attribute) (kor.nodes.ExtractionSchemaNode attribute) (kor.nodes.Number attribute) (kor.nodes.Object attribute) (kor.nodes.Option attribute) (kor.nodes.Selection attribute) (kor.nodes.Text attribute) (kor.Number attribute) (kor.Object attribute) (kor.Option attribute) (kor.Selection attribute) (kor.Text attribute)

extra (kor.extraction.KorParser.Config attribute) (kor.extraction.parser.KorParser.Config attribute) (kor.prompts.ExtractionPromptTemplate.Config attribute) (kor.prompts.ExtractionPromptValue.Config attribute) extract_from_documents() (in module kor) (in module kor.extraction) (in module kor.extraction.api) Extraction (class in kor) (class in kor.extraction) (class in kor.extraction.typedefs) ExtractionPromptTemplate (class in kor.prompts) ExtractionPromptTemplate.Config (class in kor.prompts) ExtractionPromptValue (class in kor.prompts) ExtractionPromptValue.Config (class in kor.prompts) ExtractionSchemaNode (class in kor.nodes)

F

format() (kor.prompts.ExtractionPromptTemplate method) format_instruction_segment() (kor.prompts.ExtractionPromptTemplate method) format_prompt() (kor.prompts.ExtractionPromptTemplate method)

format_text() (in module kor.encoders.encode) from_pydantic() (in module kor) (in module kor.adapters)

G

generate_encoded_examples() (kor.prompts.ExtractionPromptTemplate method) generate_examples() (in module kor.examples) get_instruction_segment() (kor.CSVEncoder method) (kor.encoders.csv_data.CSVEncoder method) (kor.encoders.CSVEncoder method) (kor.encoders.Encoder method) (kor.encoders.json_data.JSONEncoder method) (kor.encoders.JSONEncoder method) (kor.encoders.typedefs.Encoder method) (kor.encoders.xml.XMLEncoder method) (kor.encoders.XMLEncoder method) (kor.JSONEncoder method) (kor.XMLEncoder method)

H

handle_data() (kor.encoders.xml.TagParser method)

handle_endtag() (kor.encoders.xml.TagParser method) handle_starttag() (kor.encoders.xml.TagParser method)

I

id (kor.Bool attribute) (kor.nodes.AbstractSchemaNode attribute) (kor.Number attribute) (kor.Object attribute) (kor.Option attribute) (kor.Selection attribute) (kor.Text attribute)

initialize_encoder() (in module kor.encoders) (in module kor.encoders.encode) initialize_type_descriptors() (in module kor.type_descriptors) input_formatter (kor.prompts.ExtractionPromptTemplate attribute) instruction_template (kor.prompts.ExtractionPromptTemplate attribute)

J

JSONEncoder (class in kor) (class in kor.encoders) (class in kor.encoders.json_data)

K

kor module kor.adapters module kor.documents module kor.documents.html module kor.documents.typedefs module kor.encoders module kor.encoders.csv_data module kor.encoders.encode module kor.encoders.json_data module kor.encoders.typedefs module kor.encoders.utils module kor.encoders.xml module kor.examples module

kor.exceptions module kor.extraction module kor.extraction.api module kor.extraction.parser module kor.extraction.typedefs module kor.nodes module kor.prompts module kor.type_descriptors module kor.validators module kor.version module KorException KorParser (class in kor.extraction) (class in kor.extraction.parser) KorParser.Config (class in kor.extraction) (class in kor.extraction.parser)

M

many (kor.Bool attribute) (kor.nodes.AbstractSchemaNode attribute) (kor.Number attribute) (kor.Object attribute) (kor.Option attribute) (kor.Selection attribute) (kor.Text attribute) MarkdownifyHTMLProcessor (class in kor.documents.html) messages (kor.prompts.ExtractionPromptValue attribute) model_computed_fields (kor.Bool attribute) (kor.nodes.AbstractSchemaNode attribute) (kor.nodes.Bool attribute) (kor.nodes.ExtractionSchemaNode attribute) (kor.nodes.Number attribute) (kor.nodes.Object attribute) (kor.nodes.Option attribute) (kor.nodes.Selection attribute) (kor.nodes.Text attribute) (kor.Number attribute) (kor.Object attribute) (kor.Option attribute) (kor.Selection attribute) (kor.Text attribute) model_config (kor.Bool attribute) (kor.nodes.AbstractSchemaNode attribute) (kor.nodes.Bool attribute) (kor.nodes.ExtractionSchemaNode attribute) (kor.nodes.Number attribute) (kor.nodes.Object attribute) (kor.nodes.Option attribute) (kor.nodes.Selection attribute) (kor.nodes.Text attribute) (kor.Number attribute) (kor.Object attribute) (kor.Option attribute) (kor.Selection attribute) (kor.Text attribute)

model_fields (kor.Bool attribute) (kor.nodes.AbstractSchemaNode attribute) (kor.nodes.Bool attribute) (kor.nodes.ExtractionSchemaNode attribute) (kor.nodes.Number attribute) (kor.nodes.Object attribute) (kor.nodes.Option attribute) (kor.nodes.Selection attribute) (kor.nodes.Text attribute) (kor.Number attribute) (kor.Object attribute) (kor.Option attribute) (kor.Selection attribute) (kor.Text attribute) module kor kor.adapters kor.documents kor.documents.html kor.documents.typedefs kor.encoders kor.encoders.csv_data kor.encoders.encode kor.encoders.json_data kor.encoders.typedefs kor.encoders.utils kor.encoders.xml kor.examples kor.exceptions kor.extraction kor.extraction.api kor.extraction.parser kor.extraction.typedefs kor.nodes kor.prompts kor.type_descriptors kor.validators kor.version

N

node (kor.prompts.ExtractionPromptTemplate attribute) null_examples (kor.nodes.Selection attribute) (kor.Selection attribute)

Number (class in kor) (class in kor.nodes)

O

Object (class in kor) (class in kor.nodes) Option (class in kor) (class in kor.nodes)

options (kor.nodes.Selection attribute) (kor.Selection attribute)

P

parse() (kor.extraction.KorParser method) (kor.extraction.parser.KorParser method) parse_obj() (kor.nodes.ExtractionSchemaNode class method) (kor.nodes.Object class method) (kor.Object class method)

parse_raw() (kor.nodes.Object class method) (kor.Object class method) ParseError process() (kor.documents.html.MarkdownifyHTMLProcessor method) (kor.documents.typedefs.AbstractDocumentProcessor method) PydanticValidator (class in kor.validators)

R

raw (kor.DocumentExtraction attribute) (kor.Extraction attribute) (kor.extraction.DocumentExtraction attribute) (kor.extraction.Extraction attribute) (kor.extraction.typedefs.DocumentExtraction attribute) (kor.extraction.typedefs.Extraction attribute)

replace() (kor.nodes.AbstractSchemaNode method)

S

schema_ (kor.extraction.KorParser attribute) (kor.extraction.parser.KorParser attribute) SchemaBasedEncoder (class in kor.encoders) (class in kor.encoders.typedefs) Selection (class in kor) (class in kor.nodes)

SimpleExampleAggregator (class in kor.examples) source_uid (kor.DocumentExtraction attribute) (kor.extraction.DocumentExtraction attribute) (kor.extraction.typedefs.DocumentExtraction attribute) string (kor.prompts.ExtractionPromptValue attribute)

T

TagParser (class in kor.encoders.xml) Text (class in kor) (class in kor.nodes) to_messages() (kor.prompts.ExtractionPromptTemplate method) (kor.prompts.ExtractionPromptValue method) to_string() (kor.prompts.ExtractionPromptTemplate method) (kor.prompts.ExtractionPromptValue method)

type_descriptor (kor.prompts.ExtractionPromptTemplate attribute) TypeDescriptor (class in kor) (class in kor.type_descriptors) TypeScriptDescriptor (class in kor) (class in kor.type_descriptors)

U

uid (kor.DocumentExtraction attribute) (kor.extraction.DocumentExtraction attribute) (kor.extraction.typedefs.DocumentExtraction attribute)

unwrap_tag() (in module kor.encoders.utils)

V

validate() (kor.nodes.ExtractionSchemaNode class method) validated_data (kor.DocumentExtraction attribute) (kor.Extraction attribute) (kor.extraction.DocumentExtraction attribute) (kor.extraction.Extraction attribute) (kor.extraction.typedefs.DocumentExtraction attribute) (kor.extraction.typedefs.Extraction attribute) ValidationError Validator (class in kor.validators) validator (kor.extraction.KorParser attribute) (kor.extraction.parser.KorParser attribute) visit() (kor.examples.SimpleExampleAggregator method) visit_bool() (kor.nodes.AbstractVisitor method) visit_default() (kor.BulletPointDescriptor method) (kor.examples.SimpleExampleAggregator method) (kor.nodes.AbstractVisitor method) (kor.type_descriptors.BulletPointDescriptor method) (kor.type_descriptors.TypeScriptDescriptor method) (kor.TypeScriptDescriptor method)

visit_number() (kor.nodes.AbstractVisitor method) visit_object() (kor.BulletPointDescriptor method) (kor.examples.SimpleExampleAggregator method) (kor.nodes.AbstractVisitor method) (kor.type_descriptors.BulletPointDescriptor method) (kor.type_descriptors.TypeScriptDescriptor method) (kor.TypeScriptDescriptor method) visit_option() (kor.examples.SimpleExampleAggregator method) (kor.nodes.AbstractVisitor method) visit_selection() (kor.examples.SimpleExampleAggregator method) (kor.nodes.AbstractVisitor method) visit_text() (kor.nodes.AbstractVisitor method)

W

wrap_in_tag() (in module kor.encoders.utils)

X

XMLEncoder (class in kor) (class in kor.encoders) (class in kor.encoders.xml)