Index

A

active (redshred.models.api.RedShredUser attribute) advanced_ocr (redshred.models.configuration.Tokenizers attribute) AdvancedOCRTokenizerConfig (class in redshred.models.configuration) AdvancedOCRTokenizerConfig.Config (class in redshred.models.configuration) AdvancedOCRTokenizerConfigOptions (class in redshred.models.configuration) AdvancedOCRTokenizerConfigOptions.Config (class in redshred.models.configuration) allow_anonymous_downloads (redshred.CollectionConfiguration attribute) (redshred.models.configuration.CollectionConfiguration attribute) always (redshred.models.configuration.DocumentUniqueness attribute) antialiasing (redshred.enrichments.page_images.PageImagesPerspectiveConfig attribute) api (redshred.microservices.generic.Microservice attribute) (redshred.microservices.segment_cropper.SegmentCropper attribute) (redshred.microservices.token_lookup.TokenLookup attribute) ApiObject (class in redshred.models.api) APIObjectIterator (class in redshred.models.api) arbitrary_types_allowed (redshred.enrichments.defined_acronyms.DefinedAcronymsPerspectiveConfig.Config attribute) (redshred.enrichments.external_api.ExternalAPIPerspectiveConfig.Config attribute) (redshred.enrichments.grouper.GrouperPerspectiveConfig.Config attribute) (redshred.enrichments.huggingface.HuggingfacePerspectiveConfig.Config attribute) (redshred.enrichments.iris.IrisPerspectiveConfig.Config attribute) (redshred.enrichments.page_images.PageImagesPerspectiveConfig.Config attribute) (redshred.enrichments.pdftotext.PdftotextPerspectiveConfig.Config attribute) (redshred.enrichments.preprocess.PreprocessPerspectiveConfig.Config attribute) (redshred.enrichments.regex.RegexPerspectiveConfig.Config attribute) (redshred.enrichments.sentences.SentencesPerspectiveConfig.Config attribute) (redshred.enrichments.spacy.SpacyPerspectiveConfig.Config attribute) (redshred.enrichments.tfidf.TFIDFPerspectiveConfig.Config attribute) (redshred.enrichments.typography.TypographyPerspectiveConfig.Config attribute) (redshred.models.api.SerializableModel.Config attribute)

as_boundingbox() (redshred.spatial.BoundingBox method) (redshred.spatial.GeoJSON method) as_geojson() (redshred.spatial.BoundingBox method) (redshred.spatial.GeoJSON method) as_numpy() (redshred.spatial.BoundingBox method) as_shape() (redshred.spatial.BoundingBox method) (redshred.spatial.GeoJSON method)

B

backend (redshred.enrichments.page_images.PageImagesPerspectiveConfig attribute) backend_options (redshred.enrichments.page_images.PageImagesPerspectiveConfig attribute) BackendOptions (class in redshred.enrichments.page_images) bboxes (redshred.models.api.Token attribute) between() (redshred.models.api.Segment method) (redshred.Segment method)

bounding_box (redshred.enrichments.grouper.GrouperPerspectiveHullMethod attribute) (redshred.models.api.Segment attribute) (redshred.Segment attribute) BoundingBox (class in redshred.spatial) bulk_create_segments() (redshred.models.api.Perspective method) (redshred.Perspective method)

C

cache_id (redshred.models.api.Perspective attribute) (redshred.models.api.Segment attribute) (redshred.Perspective attribute) (redshred.Segment attribute) capitalize (redshred.enrichments.preprocess.StringMethodStepMethod attribute) case_sensitive (redshred.enrichments.preprocess.StopwordStep attribute) client (redshred.Collection attribute) (redshred.models.api.Collection attribute) Collection (class in redshred) (class in redshred.models.api) collection (redshred.cli.GetTypes attribute) collection() (redshred.api.client.RedShredClient method) (redshred.Document method) (redshred.models.api.Document method) (redshred.models.api.Page method) (redshred.models.api.Perspective method) (redshred.models.api.Segment method) (redshred.Page method) (redshred.Perspective method) (redshred.RedShredClient method) (redshred.Segment method) collection_link (redshred.Document attribute) (redshred.models.api.Document attribute) (redshred.models.api.Page attribute) (redshred.models.api.Perspective attribute) (redshred.models.api.Segment attribute) (redshred.Page attribute) (redshred.Perspective attribute) (redshred.Segment attribute) collection_slug (redshred.Document attribute) (redshred.models.api.Document attribute) (redshred.models.api.Page attribute) (redshred.models.api.Perspective attribute) (redshred.models.api.Segment attribute) (redshred.Page attribute) (redshred.Perspective attribute) (redshred.Segment attribute) CollectionConfiguration (class in redshred) (class in redshred.models.configuration) CollectionConfiguration.Config (class in redshred) (class in redshred.models.configuration) CollectionIterator (class in redshred.models.api) collections() (redshred.api.client.RedShredClient method) (redshred.RedShredClient method) comment (redshred.enrichments.preprocess.LemmatizingStep attribute) (redshred.enrichments.preprocess.RegexStep attribute) (redshred.enrichments.preprocess.StemmingStep attribute) (redshred.enrichments.preprocess.StopwordStep attribute) (redshred.enrichments.preprocess.StringMethodStep attribute) concave_hull (redshred.enrichments.grouper.GrouperPerspectiveHullMethod attribute) condition (redshred.models.configuration.NotificationConfiguration attribute) confidence_threshold (redshred.enrichments.iris.IrisPerspectiveConfig attribute) config (redshred.Collection attribute) (redshred.Document attribute) (redshred.enrichments.base.PerspectiveConfiguration attribute) (redshred.enrichments.defined_acronyms.DefinedAcronymsPerspective attribute) (redshred.enrichments.external_api.ExternalAPIPerspective attribute) (redshred.enrichments.grouper.GrouperPerspective attribute) (redshred.enrichments.huggingface.HuggingfacePerspective attribute) (redshred.enrichments.iris.IrisPerspective attribute) (redshred.enrichments.page_images.PageImagesPerspective attribute) (redshred.enrichments.pdftotext.PdftotextPerspective attribute) (redshred.enrichments.preprocess.PreprocessPerspective attribute) (redshred.enrichments.regex.RegexPerspective attribute) (redshred.enrichments.sentences.SentencesPerspective attribute) (redshred.enrichments.spacy.SpacyPerspective attribute) (redshred.enrichments.tfidf.TFIDFPerspective attribute) (redshred.enrichments.typography.TypographyPerspective attribute) (redshred.models.api.Collection attribute) (redshred.models.api.Document attribute) (redshred.models.configuration.AdvancedOCRTokenizerConfig attribute) (redshred.models.configuration.ConfiguredTokenizer attribute) (redshred.models.configuration.PerspectiveConfiguration attribute) (redshred.models.configuration.TesseractTokenizerConfig attribute) (redshred.PerspectiveConfiguration attribute)

Configuration (class in redshred.configuration) ConfigurationError ConfigurationFileError ConfiguredTokenizer (class in redshred.models.configuration) ConfiguredTokenizer.Config (class in redshred.models.configuration) content_hash (redshred.Document attribute) (redshred.models.api.Document attribute) (redshred.models.api.Page attribute) (redshred.Page attribute) contents (redshred.models.configuration.DocumentUniqueness attribute) context (redshred.configuration.Configuration attribute) convex_hull (redshred.enrichments.grouper.GrouperPerspectiveHullMethod attribute) convex_hull() (redshred.spatial.GeoJSON method) count (redshred.models.api.APIObjectIterator attribute) create() (redshred.Collection method) (redshred.Document method) (redshred.models.api.ApiObject method) (redshred.models.api.Collection method) (redshred.models.api.Document method) (redshred.models.api.Perspective method) (redshred.models.api.Segment method) (redshred.Perspective method) (redshred.Segment method) create_collection() (in module redshred.cli) created_at (redshred.Collection attribute) (redshred.Document attribute) (redshred.models.api.Collection attribute) (redshred.models.api.Document attribute) (redshred.models.api.Page attribute) (redshred.models.api.Perspective attribute) (redshred.models.api.Segment attribute) (redshred.Page attribute) (redshred.Perspective attribute) (redshred.Segment attribute) created_by (redshred.Collection attribute) (redshred.Document attribute) (redshred.models.api.Collection attribute) (redshred.models.api.Document attribute) (redshred.models.api.Page attribute) (redshred.models.api.Perspective attribute) (redshred.models.api.Segment attribute) (redshred.Page attribute) (redshred.Perspective attribute) (redshred.Segment attribute) cropbox (redshred.enrichments.page_images.BackendOptions attribute) csv_metadata (redshred.Document attribute) (redshred.models.api.Document attribute)

D

dashboard() (redshred.models.api.ApiObject method) debug (redshred.enrichments.base.PerspectiveConfiguration attribute) (redshred.models.configuration.PerspectiveConfiguration attribute) (redshred.PerspectiveConfiguration attribute) decode_datetime() (in module redshred.util) DefinedAcronymsPerspective (class in redshred.enrichments.defined_acronyms) DefinedAcronymsPerspectiveConfig (class in redshred.enrichments.defined_acronyms) DefinedAcronymsPerspectiveConfig.Config (class in redshred.enrichments.defined_acronyms) delete() (redshred.Collection method) (redshred.models.api.ApiObject method) (redshred.models.api.Collection method) dep (redshred.enrichments.spacy.SpacyPerspectiveTask attribute) description (redshred.Collection attribute) (redshred.Document attribute) (redshred.enrichments.base.PerspectiveConfiguration attribute) (redshred.models.api.Collection attribute) (redshred.models.api.Document attribute) (redshred.models.api.Perspective attribute) (redshred.models.configuration.PerspectiveConfiguration attribute) (redshred.Perspective attribute) (redshred.PerspectiveConfiguration attribute) detection_model (redshred.models.configuration.AdvancedOCRTokenizerConfigOptions attribute) dict() (redshred.CollectionConfiguration method) (redshred.models.configuration.CollectionConfiguration method) dict_to_geojson() (redshred.models.api.SerializableModel class method) Document (class in redshred) (class in redshred.models.api) document (redshred.cli.GetTypes attribute) document() (redshred.Collection method) (redshred.models.api.Collection method) (redshred.models.api.Page method) (redshred.models.api.Perspective method) (redshred.models.api.Segment method) (redshred.Page method) (redshred.Perspective method) (redshred.Segment method)

document_index (redshred.models.api.Page attribute) (redshred.Page attribute) document_link (redshred.models.api.Perspective attribute) (redshred.models.api.Segment attribute) (redshred.Perspective attribute) (redshred.Segment attribute) document_name (redshred.models.api.Page attribute) (redshred.models.api.Perspective attribute) (redshred.models.api.Segment attribute) (redshred.Page attribute) (redshred.Perspective attribute) (redshred.Segment attribute) document_segment_link (redshred.Document attribute) (redshred.models.api.Document attribute) document_uniqueness (redshred.CollectionConfiguration attribute) (redshred.models.configuration.CollectionConfiguration attribute) DocumentIterator (class in redshred.models.api) documents() (redshred.Collection method) (redshred.models.api.Collection method) documents_link (redshred.Collection attribute) (redshred.models.api.Collection attribute) DocumentUniqueness (class in redshred.models.configuration) download() (redshred.Document method) (redshred.models.api.Document method) download_bytes() (redshred.Document method) (redshred.models.api.Document method) dpi (redshred.enrichments.page_images.PageImagesPerspectiveConfig attribute) (redshred.models.api.Page attribute) (redshred.models.configuration.AdvancedOCRTokenizerConfigOptions attribute) (redshred.Page attribute)

E

email (redshred.models.api.RedShredUser attribute) endpoint (redshred.microservices.generic.Microservice attribute) (redshred.microservices.segment_cropper.SegmentCropper attribute) (redshred.microservices.token_lookup.TokenLookup attribute) enrichment_config (redshred.models.api.Perspective attribute) (redshred.Perspective attribute) enrichment_data (redshred.models.api.Segment attribute) (redshred.Segment attribute) enrichment_name (redshred.models.api.Perspective attribute) (redshred.models.api.Segment attribute) (redshred.Perspective attribute) (redshred.Segment attribute)

enrichments (redshred.CollectionConfiguration attribute) (redshred.models.configuration.CollectionConfiguration attribute) errors (redshred.Document attribute) (redshred.models.api.Document attribute) (redshred.models.api.Perspective attribute) (redshred.models.api.Segment attribute) (redshred.Perspective attribute) (redshred.Segment attribute) ExternalAPIPerspective (class in redshred.enrichments.external_api) ExternalAPIPerspectiveConfig (class in redshred.enrichments.external_api) ExternalAPIPerspectiveConfig.Config (class in redshred.enrichments.external_api) extra (redshred.models.api.SerializableModel.Config attribute) (redshred.models.api.Token.Config attribute)

F

file() (redshred.api.client.RedShredClient method) (redshred.RedShredClient method) file_link (redshred.Document attribute) (redshred.models.api.Document attribute) file_size (redshred.Document attribute) (redshred.models.api.Document attribute) filename (redshred.models.configuration.DocumentUniqueness attribute) first() (redshred.models.api.APIObjectIterator method) first_name (redshred.models.api.RedShredUser attribute) flags (redshred.enrichments.preprocess.RegexStep attribute) (redshred.enrichments.regex.RegexPattern attribute)

Formats (class in redshred.cli) from_bounds() (redshred.spatial.GeoJSON class method) from_coords() (redshred.spatial.GeoJSON class method) from_dict() (redshred.CollectionConfiguration class method) (redshred.models.configuration.CollectionConfiguration class method) from_http_error() (redshred.exceptions.RedShredHTTPError class method) (redshred.RedShredHTTPError class method) from_shape() (redshred.spatial.BoundingBox class method) (redshred.spatial.GeoJSON class method)

G

GeoJSON (class in redshred.spatial) get() (in module redshred.cli) get_bounds() (redshred.spatial.BoundingBox method) (redshred.spatial.GeoJSON method) get_coordinates() (redshred.spatial.GeoJSON method) get_crop() (redshred.microservices.segment_cropper.SegmentCropper method) get_offsets() (redshred.spatial.BoundingBox method) (redshred.spatial.GeoJSON method) get_segment_image() (redshred.models.api.Segment method) (redshred.Segment method) get_segments_from_perspective() (redshred.models.api.Segment method) (redshred.Segment method)

get_text() (redshred.api.client.RedShredClient method) (redshred.microservices.token_lookup.TokenLookup method) (redshred.models.api.Segment method) (redshred.RedShredClient method) (redshred.Segment method) get_type() (in module redshred.models.api) GetTypes (class in redshred.cli) global_callback() (in module redshred.cli) GrouperPerspective (class in redshred.enrichments.grouper) GrouperPerspectiveConfig (class in redshred.enrichments.grouper) GrouperPerspectiveConfig.Config (class in redshred.enrichments.grouper) GrouperPerspectiveHullMethod (class in redshred.enrichments.grouper)

H

height (redshred.models.api.Page attribute) (redshred.Page attribute) (redshred.spatial.BoundingBox property) (redshred.spatial.GeoJSON property) host (redshred.configuration.Configuration attribute)

HuggingfacePerspective (class in redshred.enrichments.huggingface) HuggingfacePerspectiveConfig (class in redshred.enrichments.huggingface) HuggingfacePerspectiveConfig.Config (class in redshred.enrichments.huggingface) hull_method (redshred.enrichments.grouper.GrouperPerspectiveConfig attribute) hull_method_options (redshred.enrichments.grouper.GrouperPerspectiveConfig attribute)

I

id (redshred.Collection attribute) (redshred.Document attribute) (redshred.models.api.Collection attribute) (redshred.models.api.Document attribute) (redshred.models.api.Page attribute) (redshred.models.api.Perspective attribute) (redshred.models.api.Segment attribute) (redshred.Page attribute) (redshred.Perspective attribute) (redshred.Segment attribute) id_from_any() (in module redshred.util) images_only (redshred.models.configuration.AdvancedOCRTokenizerConfigOptions attribute) (redshred.models.configuration.TesseractTokenizerConfigOptions attribute)

index (redshred.Document attribute) (redshred.models.api.Document attribute) (redshred.models.api.Page attribute) (redshred.models.api.Token attribute) (redshred.Page attribute) info() (redshred.configuration.Configuration method) init_client() (in module redshred.cli) IrisPerspective (class in redshred.enrichments.iris) IrisPerspectiveConfig (class in redshred.enrichments.iris) IrisPerspectiveConfig.Config (class in redshred.enrichments.iris) iter_dict() (redshred.models.api.APIObjectIterator method)

J

jmespath_source (redshred.enrichments.external_api.ExternalAPIPerspectiveConfig attribute) jmespath_transformation (redshred.enrichments.external_api.ExternalAPIPerspectiveConfig attribute) joined (redshred.models.api.RedShredUser attribute) json (redshred.cli.Formats attribute)

json() (redshred.CollectionConfiguration method) (redshred.models.configuration.CollectionConfiguration method) (redshred.spatial.BoundingBox method) (redshred.spatial.GeoJSON method) json_encoders (redshred.models.api.SerializableModel.Config attribute)

L

l1 (redshred.enrichments.tfidf.TFIDFPerspectiveNorm attribute) l2 (redshred.enrichments.tfidf.TFIDFPerspectiveNorm attribute) label (redshred.enrichments.regex.RegexPattern attribute) (redshred.models.configuration.NotificationConfiguration attribute) labels (redshred.models.api.Segment attribute) (redshred.Segment attribute) last_login (redshred.models.api.RedShredUser attribute) last_name (redshred.models.api.RedShredUser attribute) layout (redshred.enrichments.pdftotext.PdftotextPerspectiveConfig attribute)

LemmatizingStep (class in redshred.enrichments.preprocess) LemmatizingStepMethod (class in redshred.enrichments.preprocess) list_to_bbox() (redshred.models.api.SerializableModel class method) lists_to_bboxes() (redshred.models.api.SerializableModel class method) load() (redshred.Collection class method) (redshred.models.api.ApiObject class method) (redshred.models.api.Collection class method) lower (redshred.enrichments.preprocess.StringMethodStepMethod attribute) lowercase (redshred.enrichments.tfidf.TFIDFPerspectiveConfig attribute)

M

marked_for_delete (redshred.Collection attribute) (redshred.models.api.Collection attribute) max_df (redshred.enrichments.tfidf.TFIDFPerspectiveConfig attribute) max_features (redshred.enrichments.tfidf.TFIDFPerspectiveConfig attribute) max_x (redshred.models.api.Segment attribute) (redshred.Segment attribute) max_y (redshred.models.api.Segment attribute) (redshred.Segment attribute) metadata (redshred.Collection attribute) (redshred.Document attribute) (redshred.models.api.Collection attribute) (redshred.models.api.Document attribute) (redshred.models.api.Page attribute) (redshred.models.api.Perspective attribute) (redshred.models.api.Segment attribute) (redshred.models.api.Token attribute) (redshred.Page attribute) (redshred.Perspective attribute) (redshred.Segment attribute) method (redshred.enrichments.preprocess.LemmatizingStep attribute) (redshred.enrichments.preprocess.StemmingStep attribute) (redshred.enrichments.preprocess.StringMethodStep attribute) (redshred.enrichments.sentences.SentencesPerspectiveConfig attribute) Microservice (class in redshred.microservices.generic) min_df (redshred.enrichments.tfidf.TFIDFPerspectiveConfig attribute) min_x (redshred.models.api.Segment attribute) (redshred.Segment attribute) (redshred.spatial.BoundingBox property) (redshred.spatial.GeoJSON property) min_y (redshred.models.api.Segment attribute) (redshred.Segment attribute) (redshred.spatial.BoundingBox property) (redshred.spatial.GeoJSON property) minimum_rotated_rectangle (redshred.enrichments.grouper.GrouperPerspectiveHullMethod attribute) model (redshred.enrichments.huggingface.HuggingfacePerspectiveConfig attribute) (redshred.enrichments.iris.IrisPerspectiveConfig attribute) (redshred.enrichments.spacy.SpacyPerspectiveConfig attribute)

model_class (redshred.enrichments.huggingface.HuggingfacePerspectiveConfig attribute) model_source (redshred.enrichments.huggingface.HuggingfacePerspectiveConfig attribute) module redshred redshred.api redshred.api.client redshred.api.http redshred.cli redshred.configuration redshred.enrichments redshred.enrichments.base redshred.enrichments.defined_acronyms redshred.enrichments.external_api redshred.enrichments.grouper redshred.enrichments.huggingface redshred.enrichments.iris redshred.enrichments.page_images redshred.enrichments.pdftotext redshred.enrichments.preprocess redshred.enrichments.regex redshred.enrichments.sentences redshred.enrichments.spacy redshred.enrichments.tfidf redshred.enrichments.typography redshred.exceptions redshred.microservices redshred.microservices.generic redshred.microservices.segment_cropper redshred.microservices.token_lookup redshred.models redshred.models.api redshred.models.configuration redshred.spatial redshred.util redshred.visualize morphology (redshred.enrichments.spacy.SpacyPerspectiveTask attribute)

N

n_pages (redshred.Document attribute) (redshred.models.api.Document attribute) name (redshred.Collection attribute) (redshred.Document attribute) (redshred.enrichments.base.PerspectiveConfiguration attribute) (redshred.enrichments.defined_acronyms.DefinedAcronymsPerspective attribute) (redshred.enrichments.external_api.ExternalAPIPerspective attribute) (redshred.enrichments.grouper.GrouperPerspective attribute) (redshred.enrichments.huggingface.HuggingfacePerspective attribute) (redshred.enrichments.iris.IrisPerspective attribute) (redshred.enrichments.page_images.PageImagesPerspective attribute) (redshred.enrichments.pdftotext.PdftotextPerspective attribute) (redshred.enrichments.preprocess.PreprocessPerspective attribute) (redshred.enrichments.regex.RegexPerspective attribute) (redshred.enrichments.sentences.SentencesPerspective attribute) (redshred.enrichments.spacy.SpacyPerspective attribute) (redshred.enrichments.tfidf.TFIDFPerspective attribute) (redshred.enrichments.typography.TypographyPerspective attribute) (redshred.models.api.Collection attribute) (redshred.models.api.Document attribute) (redshred.models.api.Page attribute) (redshred.models.api.Perspective attribute) (redshred.models.configuration.AdvancedOCRTokenizerConfig attribute) (redshred.models.configuration.ConfiguredTokenizer attribute) (redshred.models.configuration.PerspectiveConfiguration attribute) (redshred.models.configuration.TesseractTokenizerConfig attribute) (redshred.Page attribute) (redshred.Perspective attribute) (redshred.PerspectiveConfiguration attribute)

ner (redshred.enrichments.spacy.SpacyPerspectiveTask attribute) next() (redshred.models.api.Page method) (redshred.Page method) ngram_range (redshred.enrichments.tfidf.TFIDFPerspectiveConfig attribute) nltk (redshred.enrichments.preprocess.StopwordStepStopwords attribute) (redshred.enrichments.sentences.SentencesPerspectiveMethod attribute) nms_threshold (redshred.enrichments.iris.IrisPerspectiveConfig attribute) norm (redshred.enrichments.tfidf.TFIDFPerspectiveConfig attribute) normalize_to_page() (redshred.spatial.BoundingBox method) (redshred.spatial.GeoJSON method) normalize_whitespace (redshred.enrichments.preprocess.StopwordStep attribute) NotificationConfiguration (class in redshred.models.configuration) NotificationConfiguration.Config (class in redshred.models.configuration) notifications (redshred.CollectionConfiguration attribute) (redshred.models.configuration.CollectionConfiguration attribute) noun_chunks (redshred.enrichments.spacy.SpacyPerspectiveTask attribute)

O

object_setattr() (in module redshred.enrichments.defined_acronyms) (in module redshred.enrichments.external_api) (in module redshred.enrichments.grouper) (in module redshred.enrichments.huggingface) (in module redshred.enrichments.iris) (in module redshred.enrichments.page_images) (in module redshred.enrichments.pdftotext) (in module redshred.enrichments.preprocess) (in module redshred.enrichments.regex) (in module redshred.enrichments.sentences) (in module redshred.enrichments.spacy) (in module redshred.enrichments.tfidf) (in module redshred.enrichments.typography)

ok() (redshred.api.http.RedShredAPI method) operation (redshred.enrichments.preprocess.LemmatizingStep attribute) (redshred.enrichments.preprocess.RegexStep attribute) (redshred.enrichments.preprocess.StemmingStep attribute) (redshred.enrichments.preprocess.StopwordStep attribute) (redshred.enrichments.preprocess.StringMethodStep attribute) operation_labels (redshred.enrichments.grouper.GrouperPerspectiveConfig attribute) operations (redshred.enrichments.grouper.GrouperPerspectiveConfig attribute) options (redshred.configuration.Configuration attribute) (redshred.enrichments.typography.TypographyPerspectiveConfig attribute) original_name (redshred.Document attribute) (redshred.models.api.Document attribute) owner (redshred.Collection attribute) (redshred.models.api.Collection attribute)

P

Page (class in redshred) (class in redshred.models.api) page (redshred.cli.GetTypes attribute) page() (redshred.Document method) (redshred.models.api.Document method) page_segment_link (redshred.models.api.Page attribute) (redshred.Page attribute) PageImagesPerspective (class in redshred.enrichments.page_images) PageImagesPerspectiveBackend (class in redshred.enrichments.page_images) PageImagesPerspectiveConfig (class in redshred.enrichments.page_images) PageImagesPerspectiveConfig.Config (class in redshred.enrichments.page_images) PageIterator (class in redshred.models.api) pages (redshred.enrichments.page_images.PageImagesPerspectiveConfig attribute) pages() (redshred.Document method) (redshred.models.api.Document method) pages_link (redshred.Document attribute) (redshred.models.api.Document attribute) paginate() (redshred.api.http.RedShredAPI method) params (redshred.microservices.generic.Microservice attribute) (redshred.microservices.segment_cropper.SegmentCropper attribute) (redshred.microservices.token_lookup.TokenLookup attribute) path (redshred.models.api.APIObjectIterator attribute) pattern (redshred.enrichments.preprocess.RegexStep attribute) (redshred.enrichments.regex.RegexPattern attribute) pdf_link (redshred.Document attribute) (redshred.models.api.Document attribute) pdfium (redshred.enrichments.page_images.PageImagesPerspectiveBackend attribute) pdfminer (redshred.enrichments.typography.TypographyPerspectiveSegmenter attribute) (redshred.models.configuration.Tokenizers attribute) pdftoppm (redshred.enrichments.page_images.PageImagesPerspectiveBackend attribute) pdftotext (redshred.enrichments.typography.TypographyPerspectiveSegmenter attribute) (redshred.models.configuration.Tokenizers attribute) PdftotextPerspective (class in redshred.enrichments.pdftotext) PdftotextPerspectiveConfig (class in redshred.enrichments.pdftotext) PdftotextPerspectiveConfig.Config (class in redshred.enrichments.pdftotext) Perspective (class in redshred) (class in redshred.models.api) perspective (redshred.cli.GetTypes attribute) (redshred.enrichments.base.PerspectiveConfiguration attribute) (redshred.models.configuration.PerspectiveConfiguration attribute) (redshred.PerspectiveConfiguration attribute)

perspective() (redshred.Collection method) (redshred.Document method) (redshred.models.api.Collection method) (redshred.models.api.Document method) (redshred.models.api.Page method) (redshred.models.api.Segment method) (redshred.Page method) (redshred.Segment method) perspective_link (redshred.models.api.Segment attribute) (redshred.Segment attribute) PerspectiveConfiguration (class in redshred) (class in redshred.enrichments.base) (class in redshred.models.configuration) PerspectiveConfiguration.Config (class in redshred) (class in redshred.enrichments.base) (class in redshred.models.configuration) PerspectiveIterator (class in redshred.models.api) perspectives() (redshred.Collection method) (redshred.Document method) (redshred.models.api.Collection method) (redshred.models.api.Document method) (redshred.models.api.Page method) (redshred.Page method) perspectives_link (redshred.Collection attribute) (redshred.Document attribute) (redshred.models.api.Collection attribute) (redshred.models.api.Document attribute) (redshred.models.api.Page attribute) (redshred.Page attribute) pipeline_task (redshred.enrichments.huggingface.HuggingfacePerspectiveConfig attribute) porter (redshred.enrichments.preprocess.StemmingStepMethod attribute) pos (redshred.enrichments.spacy.SpacyPerspectiveTask attribute) PreprocessPerspective (class in redshred.enrichments.preprocess) PreprocessPerspectiveConfig (class in redshred.enrichments.preprocess) PreprocessPerspectiveConfig.Config (class in redshred.enrichments.preprocess) prerequisites (redshred.enrichments.base.SegmentQuery attribute) previous() (redshred.models.api.Page method) (redshred.Page method) pysbd (redshred.enrichments.sentences.SentencesPerspectiveMethod attribute)

Q

q() (redshred.models.api.ApiObject method) (redshred.models.api.Segment method) (redshred.Segment method)

queries (redshred.enrichments.base.SegmentQuery attribute) query (redshred.models.api.APIObjectIterator attribute) (redshred.models.configuration.NotificationConfiguration attribute)

R

read() (redshred.models.api.ApiObject method) read_state (redshred.Document attribute) (redshred.models.api.Document attribute) read_state_updated_at (redshred.Document attribute) (redshred.models.api.Document attribute) reason (redshred.exceptions.RedShredAPIError attribute) (redshred.RedShredAPIError attribute) recipients (redshred.models.configuration.NotificationConfiguration attribute) recognition_model (redshred.models.configuration.AdvancedOCRTokenizerConfigOptions attribute) redshred module redshred.api module redshred.api.client module redshred.api.http module redshred.cli module redshred.configuration module redshred.enrichments module redshred.enrichments.base module redshred.enrichments.defined_acronyms module redshred.enrichments.external_api module redshred.enrichments.grouper module redshred.enrichments.huggingface module redshred.enrichments.iris module redshred.enrichments.page_images module redshred.enrichments.pdftotext module redshred.enrichments.preprocess module redshred.enrichments.regex module redshred.enrichments.sentences module redshred.enrichments.spacy module redshred.enrichments.tfidf module redshred.enrichments.typography module

redshred.exceptions module redshred.microservices module redshred.microservices.generic module redshred.microservices.segment_cropper module redshred.microservices.token_lookup module redshred.models module redshred.models.api module redshred.models.configuration module redshred.spatial module redshred.util module redshred.visualize module RedShredAPI (class in redshred.api.http) RedShredAPIError, [1] RedShredClient (class in redshred) (class in redshred.api.client) RedShredFileExistsError, [1] RedShredHTTPError, [1] RedShredUser (class in redshred.models.api) RegexPattern (class in redshred.enrichments.regex) RegexPerspective (class in redshred.enrichments.regex) RegexPerspectiveConfig (class in redshred.enrichments.regex) RegexPerspectiveConfig.Config (class in redshred.enrichments.regex) RegexStep (class in redshred.enrichments.preprocess) region (redshred.Document attribute) (redshred.models.api.Document attribute) (redshred.models.api.Page attribute) (redshred.Page attribute) regions (redshred.models.api.Segment attribute) (redshred.models.api.Token attribute) (redshred.Segment attribute) replacement (redshred.enrichments.preprocess.RegexStep attribute) reread_document() (in module redshred.cli) (redshred.Document method) (redshred.models.api.Document method) root_label (redshred.enrichments.grouper.GrouperPerspectiveConfig attribute) rotate() (redshred.spatial.BoundingBox method) (redshred.spatial.GeoJSON method) rotation (redshred.models.api.Token attribute)

S

scale() (redshred.spatial.BoundingBox method) (redshred.spatial.GeoJSON method) search_patterns (redshred.enrichments.regex.RegexPerspectiveConfig attribute) Segment (class in redshred) (class in redshred.models.api) segment (redshred.cli.GetTypes attribute) segment() (redshred.Collection method) (redshred.Document method) (redshred.models.api.Collection method) (redshred.models.api.Document method) (redshred.models.api.Page method) (redshred.models.api.Perspective method) (redshred.Page method) (redshred.Perspective method) segment_type (redshred.models.api.Segment attribute) (redshred.Segment attribute) segment_types (redshred.models.api.Perspective attribute) (redshred.Perspective attribute) SegmentCropper (class in redshred.microservices.segment_cropper) segmenter (redshred.enrichments.typography.TypographyPerspectiveConfig attribute) SegmentIterator (class in redshred.models.api) SegmentQuery (class in redshred.enrichments.base) SegmentQuery.Config (class in redshred.enrichments.base) segments (redshred.enrichments.base.PerspectiveConfiguration attribute) (redshred.models.configuration.PerspectiveConfiguration attribute) (redshred.PerspectiveConfiguration attribute) segments() (redshred.Collection method) (redshred.Document method) (redshred.models.api.Collection method) (redshred.models.api.Document method) (redshred.models.api.Page method) (redshred.models.api.Perspective method) (redshred.Page method) (redshred.Perspective method) segments_link (redshred.Collection attribute) (redshred.Document attribute) (redshred.models.api.Collection attribute) (redshred.models.api.Document attribute) (redshred.models.api.Page attribute) (redshred.models.api.Perspective attribute) (redshred.Page attribute) (redshred.Perspective attribute) self_link (redshred.Collection attribute) (redshred.Document attribute) (redshred.models.api.ApiObject attribute) (redshred.models.api.Collection attribute) (redshred.models.api.Document attribute) (redshred.models.api.Page attribute) (redshred.models.api.Perspective attribute) (redshred.models.api.Segment attribute) (redshred.Page attribute) (redshred.Perspective attribute) (redshred.Segment attribute)

SentencesPerspective (class in redshred.enrichments.sentences) SentencesPerspectiveConfig (class in redshred.enrichments.sentences) SentencesPerspectiveConfig.Config (class in redshred.enrichments.sentences) SentencesPerspectiveMethod (class in redshred.enrichments.sentences) SerializableModel (class in redshred.models.api) SerializableModel.Config (class in redshred.models.api) short (redshred.cli.Formats attribute) show_annotations (redshred.enrichments.page_images.PageImagesPerspectiveConfig attribute) slug (redshred.Collection attribute) (redshred.Document attribute) (redshred.models.api.Collection attribute) (redshred.models.api.Document attribute) (redshred.models.api.Perspective attribute) (redshred.Perspective attribute) source (redshred.configuration.Configuration attribute) (redshred.Document attribute) (redshred.models.api.Document attribute) spacy (redshred.enrichments.sentences.SentencesPerspectiveMethod attribute) SpacyPerspective (class in redshred.enrichments.spacy) SpacyPerspectiveConfig (class in redshred.enrichments.spacy) SpacyPerspectiveConfig.Config (class in redshred.enrichments.spacy) SpacyPerspectiveTask (class in redshred.enrichments.spacy) spans (redshred.enrichments.spacy.SpacyPerspectiveTask attribute) staff (redshred.models.api.RedShredUser attribute) stats() (redshred.api.client.RedShredClient method) (redshred.RedShredClient method) StemmingStep (class in redshred.enrichments.preprocess) StemmingStepMethod (class in redshred.enrichments.preprocess) steps (redshred.enrichments.preprocess.PreprocessPerspectiveConfig attribute) stop_words (redshred.enrichments.tfidf.TFIDFPerspectiveConfig attribute) stopwords (redshred.enrichments.preprocess.StopwordStep attribute) StopwordStep (class in redshred.enrichments.preprocess) StopwordStepStopwords (class in redshred.enrichments.preprocess) StringMethodStep (class in redshred.enrichments.preprocess) StringMethodStepMethod (class in redshred.enrichments.preprocess) summary (redshred.Document attribute) (redshred.models.api.Document attribute) (redshred.models.api.Page attribute) (redshred.models.api.Segment attribute) (redshred.Page attribute) (redshred.Segment attribute) super (redshred.models.api.RedShredUser attribute)

T

task (redshred.enrichments.spacy.SpacyPerspectiveConfig attribute) task_config (redshred.enrichments.huggingface.HuggingfacePerspectiveConfig attribute) task_config_class (redshred.enrichments.huggingface.HuggingfacePerspectiveConfig attribute) task_specific_template (redshred.enrichments.huggingface.HuggingfacePerspectiveConfig attribute) template (redshred.cli.Formats attribute) (redshred.enrichments.external_api.ExternalAPIPerspectiveConfig attribute) template() (in module redshred.cli) template_variables (redshred.enrichments.external_api.ExternalAPIPerspectiveConfig attribute) tesseract (redshred.enrichments.typography.TypographyPerspectiveSegmenter attribute) (redshred.models.configuration.Tokenizers attribute) TesseractTokenizerConfig (class in redshred.models.configuration) TesseractTokenizerConfig.Config (class in redshred.models.configuration) TesseractTokenizerConfigOptions (class in redshred.models.configuration) TesseractTokenizerConfigOptions.Config (class in redshred.models.configuration) tet (redshred.models.configuration.Tokenizers attribute) text (redshred.Document attribute) (redshred.models.api.Document attribute) (redshred.models.api.Page attribute) (redshred.models.api.Segment attribute) (redshred.models.api.Token attribute) (redshred.Page attribute) (redshred.Segment attribute) text_field (redshred.enrichments.spacy.SpacyPerspectiveConfig attribute) text_with_ws (redshred.models.api.Token attribute) TFIDFPerspective (class in redshred.enrichments.tfidf) TFIDFPerspectiveConfig (class in redshred.enrichments.tfidf)

TFIDFPerspectiveConfig.Config (class in redshred.enrichments.tfidf) TFIDFPerspectiveNorm (class in redshred.enrichments.tfidf) threshold (redshred.models.configuration.AdvancedOCRTokenizerConfigOptions attribute) title (redshred.enrichments.preprocess.StringMethodStepMethod attribute) to_list() (redshred.models.api.APIObjectIterator method) Token (class in redshred.models.api) token (redshred.configuration.Configuration attribute) (redshred.models.api.RedShredUser attribute) Token.Config (class in redshred.models.api) tokenizer (redshred.CollectionConfiguration attribute) (redshred.enrichments.huggingface.HuggingfacePerspectiveConfig attribute) (redshred.models.configuration.CollectionConfiguration attribute) tokenizer_class (redshred.enrichments.huggingface.HuggingfacePerspectiveConfig attribute) Tokenizers (class in redshred.models.configuration) TokenLookup (class in redshred.microservices.token_lookup) tokens() (redshred.models.api.Page method) (redshred.Page method) tokens_file_link (redshred.models.api.Page attribute) (redshred.Page attribute) translate() (redshred.spatial.BoundingBox method) (redshred.spatial.GeoJSON method) try_get() (in module redshred.cli) try_get_collections() (in module redshred.cli) TypographyPerspective (class in redshred.enrichments.typography) TypographyPerspectiveConfig (class in redshred.enrichments.typography) TypographyPerspectiveConfig.Config (class in redshred.enrichments.typography) TypographyPerspectiveSegmenter (class in redshred.enrichments.typography)

U

underscore_attrs_are_private (redshred.models.api.SerializableModel.Config attribute) uniqueness_id (redshred.Document attribute) (redshred.models.api.Document attribute) units (redshred.models.api.Page attribute) (redshred.Page attribute) update() (redshred.models.api.ApiObject method) updated_at (redshred.Collection attribute) (redshred.Document attribute) (redshred.models.api.Collection attribute) (redshred.models.api.Document attribute) (redshred.models.api.Page attribute) (redshred.models.api.Perspective attribute) (redshred.models.api.Segment attribute) (redshred.Page attribute) (redshred.Perspective attribute) (redshred.Segment attribute) updated_by (redshred.Collection attribute) (redshred.Document attribute) (redshred.models.api.Collection attribute) (redshred.models.api.Document attribute) (redshred.models.api.Page attribute) (redshred.models.api.Perspective attribute) (redshred.models.api.Segment attribute) (redshred.Page attribute) (redshred.Perspective attribute) (redshred.Segment attribute) upload_csv() (redshred.Collection method) (redshred.models.api.Collection method) upload_document() (in module redshred.cli) upload_file() (redshred.Collection method) (redshred.models.api.Collection method) upload_text() (redshred.Collection method) (redshred.models.api.Collection method)

upload_url() (redshred.Collection method) (redshred.models.api.Collection method) upper (redshred.enrichments.preprocess.StringMethodStepMethod attribute) use_enum_values (redshred.enrichments.defined_acronyms.DefinedAcronymsPerspectiveConfig.Config attribute) (redshred.enrichments.external_api.ExternalAPIPerspectiveConfig.Config attribute) (redshred.enrichments.grouper.GrouperPerspectiveConfig.Config attribute) (redshred.enrichments.huggingface.HuggingfacePerspectiveConfig.Config attribute) (redshred.enrichments.iris.IrisPerspectiveConfig.Config attribute) (redshred.enrichments.page_images.PageImagesPerspectiveConfig.Config attribute) (redshred.enrichments.pdftotext.PdftotextPerspectiveConfig.Config attribute) (redshred.enrichments.preprocess.PreprocessPerspectiveConfig.Config attribute) (redshred.enrichments.regex.RegexPerspectiveConfig.Config attribute) (redshred.enrichments.sentences.SentencesPerspectiveConfig.Config attribute) (redshred.enrichments.spacy.SpacyPerspectiveConfig.Config attribute) (redshred.enrichments.tfidf.TFIDFPerspectiveConfig.Config attribute) (redshred.enrichments.typography.TypographyPerspectiveConfig.Config attribute) (redshred.models.api.SerializableModel.Config attribute) user (redshred.api.client.RedShredClient property) (redshred.configuration.Configuration attribute) (redshred.RedShredClient property) user_data (redshred.Collection attribute) (redshred.Document attribute) (redshred.models.api.Collection attribute) (redshred.models.api.Document attribute) (redshred.models.api.Page attribute) (redshred.models.api.Perspective attribute) (redshred.models.api.Segment attribute) (redshred.Page attribute) (redshred.Perspective attribute) (redshred.Segment attribute) username (redshred.models.api.RedShredUser attribute)

V

validate_remote_schema() (redshred.CollectionConfiguration method) (redshred.models.configuration.CollectionConfiguration method)

vectors (redshred.enrichments.spacy.SpacyPerspectiveTask attribute) verify (redshred.configuration.Configuration attribute) version_callback() (in module redshred.cli)

W

wait_until_read() (redshred.Document method) (redshred.models.api.Document method) warnings (redshred.Document attribute) (redshred.models.api.Document attribute) (redshred.models.api.Perspective attribute) (redshred.models.api.Segment attribute) (redshred.Perspective attribute) (redshred.Segment attribute)

whitespace_calculation_method (redshred.enrichments.grouper.GrouperPerspectiveConfig attribute) whitespace_method_options (redshred.enrichments.grouper.GrouperPerspectiveConfig attribute) width (redshred.models.api.Page attribute) (redshred.Page attribute) (redshred.spatial.BoundingBox property) (redshred.spatial.GeoJSON property) wordnet (redshred.enrichments.preprocess.LemmatizingStepMethod attribute)

X

x_gap (redshred.enrichments.grouper.GrouperPerspectiveConfig attribute)

Y

y_gap (redshred.enrichments.grouper.GrouperPerspectiveConfig attribute) yaml (redshred.cli.Formats attribute)

yaml() (redshred.CollectionConfiguration method) (redshred.models.api.SerializableModel method) (redshred.models.configuration.CollectionConfiguration method)