Index

A

api_server (veil.config.pipeline.PipelineConfig attribute) (veil.config.PipelineConfig attribute), [1] api_url (veil.config.entity_detectors.MaskerApiEntityDetectorConfig attribute) (veil.config.MaskerApiEntityDetectorConfig attribute), [1]

ApiServer (class in veil.api_server), [1] ApiServerConfig (class in veil.config), [1] (class in veil.config.api_server)

B

BaseEntityDetectorConfig (class in veil.config), [1] (class in veil.config.entity_detectors) BaseEntityResolverConfig (class in veil.config), [1] (class in veil.config.entity_resolvers)

batch_size (veil.config.entity_detectors.GlinerEntityDetectorConfig attribute) (veil.config.GlinerEntityDetectorConfig attribute), [1]

C

case_sensitive (veil.config.entity_detectors.RegexEntityDetectorConfig attribute) (veil.config.RegexEntityDetectorConfig attribute), [1] chunk_char_limit (veil.config.entity_detectors.MaskerApiEntityDetectorConfig attribute) (veil.config.MaskerApiEntityDetectorConfig attribute), [1] (veil.entity_detectors.api.HostedMaskerApiEntityDetector attribute) (veil.entity_detectors.HostedMaskerApiEntityDetector attribute) chunk_on_truncation (veil.config.entity_detectors.MaskerApiEntityDetectorConfig attribute) (veil.config.MaskerApiEntityDetectorConfig attribute), [1] (veil.entity_detectors.api.HostedMaskerApiEntityDetector attribute) (veil.entity_detectors.HostedMaskerApiEntityDetector attribute) chunk_overlap (veil.config.entity_detectors.GlinerEntityDetectorConfig attribute) (veil.config.GlinerEntityDetectorConfig attribute), [1]

concurrency (veil.config.pipeline.PipelineConfig attribute) (veil.config.PipelineConfig attribute), [1] ConfusionCounts (class in veil.evaluator) context_chars (veil.config.EmbeddingsEntityResolverConfig attribute), [1] (veil.config.entity_resolvers.EmbeddingsEntityResolverConfig attribute) create_from_cli_args() (veil.config.pipeline.PipelineConfig class method) (veil.config.PipelineConfig class method), [1] cuda_device (veil.config.entity_detectors.GlinerEntityDetectorConfig attribute) (veil.config.entity_detectors.SpacyEntityDetectorConfig attribute) (veil.config.GlinerEntityDetectorConfig attribute), [1] (veil.config.SpacyEntityDetectorConfig attribute), [1]

D

datahandler (veil.config.pipeline.PipelineConfig attribute) (veil.config.PipelineConfig attribute), [1] DataHandlerConfig (class in veil.config), [1] (class in veil.config.datahandler) detect_entities() (veil.entity_detectors.api.MaskerApiEntityDetector method) (veil.entity_detectors.gliner.GlinerEntityDetector method) (veil.entity_detectors.GlinerEntityDetector method), [1] (veil.entity_detectors.regex.RegexEntityDetector method) (veil.entity_detectors.RegexEntityDetector method), [1] (veil.entity_detectors.spacy.SpacyEntityDetector method) (veil.entity_detectors.SpacyEntityDetector method), [1]

doc_id_field (veil.config.datahandler.DataHandlerConfig attribute) (veil.config.DataHandlerConfig attribute), [1]

E

EmbeddingsEntityResolver (class in veil.entity_resolvers), [1] EmbeddingsEntityResolverConfig (class in veil.config), [1] (class in veil.config.entity_resolvers) enable_validation (veil.config.entity_detectors.RegexEntityDetectorConfig attribute) (veil.config.RegexEntityDetectorConfig attribute), [1] enabled (veil.config.evaluator.EvaluatorConfig attribute) (veil.config.EvaluatorConfig attribute), [1] (veil.config.metric_store.MetricStoreConfig attribute) (veil.config.MetricStoreConfig attribute), [1] end_document() (veil.metric_store.MetricStore method) entity_detectors (veil.config.pipeline.PipelineConfig attribute) (veil.config.PipelineConfig attribute), [1] entity_resolvers (veil.config.pipeline.PipelineConfig attribute) (veil.config.PipelineConfig attribute), [1] ENTITY_TYPES (veil.entity_detectors.api.HostedMaskerApiEntityDetector attribute) (veil.entity_detectors.api.MaskerApiEntityDetector attribute) (veil.entity_detectors.gliner.GlinerEntityDetector attribute) (veil.entity_detectors.GlinerEntityDetector attribute), [1] (veil.entity_detectors.HostedMaskerApiEntityDetector attribute), [1] (veil.entity_detectors.regex.RegexEntityDetector attribute) (veil.entity_detectors.RegexEntityDetector attribute), [1] (veil.entity_detectors.spacy.SpacyEntityDetector attribute) (veil.entity_detectors.SpacyEntityDetector attribute), [1]

EntityDetectorRegistry (class in veil.entity_detectors), [1] EntityResolverRegistry (class in veil.entity_resolvers), [1] evaluate_document() (veil.evaluator.Evaluator method) Evaluator (class in veil.evaluator) evaluator (veil.config.pipeline.PipelineConfig attribute) (veil.config.PipelineConfig attribute), [1] EvaluatorConfig (class in veil.config), [1] (class in veil.config.evaluator)

F

finalize() (veil.metric_store.MetricStore method) fn (veil.evaluator.ConfusionCounts attribute) fp (veil.evaluator.ConfusionCounts attribute)

frequency_penalty (veil.config.entity_detectors.MaskerApiEntityDetectorConfig attribute) (veil.config.MaskerApiEntityDetectorConfig attribute), [1] (veil.entity_detectors.api.HostedMaskerApiEntityDetector attribute) (veil.entity_detectors.HostedMaskerApiEntityDetector attribute)

G

get_key_from_str() (veil.entity_detectors.EntityDetectorRegistry class method), [1] (veil.entity_resolvers.EntityResolverRegistry class method), [1] get_pattern_info() (veil.entity_detectors.regex.RegexEntityDetector method) (veil.entity_detectors.RegexEntityDetector method), [1] get_type() (veil.config.BaseEntityDetectorConfig class method), [1] (veil.config.BaseEntityResolverConfig class method), [1] (veil.config.EmbeddingsEntityResolverConfig class method), [1] (veil.config.entity_detectors.BaseEntityDetectorConfig class method) (veil.config.entity_detectors.GlinerEntityDetectorConfig class method) (veil.config.entity_detectors.HostedMaskerApiEntityDetectorConfig class method) (veil.config.entity_detectors.MaskerApiEntityDetectorConfig class method) (veil.config.entity_detectors.RegexEntityDetectorConfig class method) (veil.config.entity_detectors.SpacyEntityDetectorConfig class method) (veil.config.entity_resolvers.BaseEntityResolverConfig class method) (veil.config.entity_resolvers.EmbeddingsEntityResolverConfig class method) (veil.config.GlinerEntityDetectorConfig class method), [1] (veil.config.HostedMaskerApiEntityDetectorConfig class method), [1] (veil.config.MaskerApiEntityDetectorConfig class method), [1] (veil.config.RegexEntityDetectorConfig class method), [1] (veil.config.SpacyEntityDetectorConfig class method), [1]

GlinerEntityDetector (class in veil.entity_detectors), [1] (class in veil.entity_detectors.gliner) GlinerEntityDetectorConfig (class in veil.config), [1] (class in veil.config.entity_detectors) ground_truth_field (veil.config.datahandler.DataHandlerConfig attribute) (veil.config.DataHandlerConfig attribute), [1]

H

headers (veil.config.entity_detectors.MaskerApiEntityDetectorConfig attribute) (veil.config.MaskerApiEntityDetectorConfig attribute), [1] (veil.entity_detectors.api.HostedMaskerApiEntityDetector attribute) (veil.entity_detectors.HostedMaskerApiEntityDetector attribute) hierarchy_position (veil.config.BaseEntityDetectorConfig attribute), [1] (veil.config.entity_detectors.BaseEntityDetectorConfig attribute)

host (veil.config.api_server.ApiServerConfig attribute) (veil.config.ApiServerConfig attribute), [1] HostedMaskerApiEntityDetector (class in veil.entity_detectors), [1] (class in veil.entity_detectors.api) HostedMaskerApiEntityDetectorConfig (class in veil.config), [1] (class in veil.config.entity_detectors)

I

input_path (veil.config.datahandler.DataHandlerConfig attribute) (veil.config.DataHandlerConfig attribute), [1]

iou_threshold (veil.config.overlap_resolver.OverlapResolverConfig attribute) (veil.config.OverlapResolverConfig attribute), [1]

L

labels (veil.config.entity_detectors.GlinerEntityDetectorConfig attribute) (veil.config.GlinerEntityDetectorConfig attribute), [1]

log_level (veil.config.pipeline.PipelineConfig attribute) (veil.config.PipelineConfig attribute), [1]

M

mask() (veil.masker.Masker method), [1] Masker (class in veil.masker), [1] masker (veil.config.pipeline.PipelineConfig attribute) (veil.config.PipelineConfig attribute), [1] MaskerApiEntityDetector (class in veil.entity_detectors.api) MaskerApiEntityDetectorConfig (class in veil.config), [1] (class in veil.config.entity_detectors) MaskerConfig (class in veil.config), [1] (class in veil.config.masker) max_length (veil.config.entity_detectors.GlinerEntityDetectorConfig attribute) (veil.config.GlinerEntityDetectorConfig attribute), [1] max_span_chars (veil.config.entity_detectors.GlinerEntityDetectorConfig attribute) (veil.config.GlinerEntityDetectorConfig attribute), [1] max_tokens (veil.config.entity_detectors.MaskerApiEntityDetectorConfig attribute) (veil.config.MaskerApiEntityDetectorConfig attribute), [1] (veil.entity_detectors.api.HostedMaskerApiEntityDetector attribute) (veil.entity_detectors.HostedMaskerApiEntityDetector attribute) mean_docs_per_second() (veil.metric_store.MetricStore method) method (veil.config.masker.MaskerConfig attribute) (veil.config.MaskerConfig attribute), [1] metric_store (veil.config.pipeline.PipelineConfig attribute) (veil.config.PipelineConfig attribute), [1] MetricStore (class in veil.metric_store) MetricStoreConfig (class in veil.config), [1] (class in veil.config.metric_store) min_confidence (veil.config.entity_detectors.RegexEntityDetectorConfig attribute) (veil.config.RegexEntityDetectorConfig attribute), [1] min_span_chars (veil.config.entity_detectors.GlinerEntityDetectorConfig attribute) (veil.config.GlinerEntityDetectorConfig attribute), [1] mode (veil.config.pipeline.PipelineConfig attribute) (veil.config.PipelineConfig attribute), [1]

model (veil.config.entity_detectors.GlinerEntityDetectorConfig attribute) (veil.config.entity_detectors.MaskerApiEntityDetectorConfig attribute) (veil.config.entity_detectors.SpacyEntityDetectorConfig attribute) (veil.config.GlinerEntityDetectorConfig attribute), [1] (veil.config.MaskerApiEntityDetectorConfig attribute), [1] (veil.config.SpacyEntityDetectorConfig attribute), [1] (veil.entity_detectors.api.HostedMaskerApiEntityDetector attribute) (veil.entity_detectors.HostedMaskerApiEntityDetector attribute) module veil.api_server, [1] veil.config, [1] veil.config.api_server veil.config.datahandler veil.config.entity_detectors veil.config.entity_resolvers veil.config.evaluator veil.config.masker veil.config.metric_store veil.config.overlap_resolver veil.config.pipeline veil.entity_detectors, [1] veil.entity_detectors.api veil.entity_detectors.gliner veil.entity_detectors.regex veil.entity_detectors.spacy veil.entity_resolvers, [1] veil.evaluator veil.masker, [1] veil.metric_store veil.overlap_resolver veil.pipeline, [1]

N

nms_iou_threshold (veil.config.entity_detectors.GlinerEntityDetectorConfig attribute) (veil.config.GlinerEntityDetectorConfig attribute), [1]

O

output_dir (veil.config.metric_store.MetricStoreConfig attribute) (veil.config.MetricStoreConfig attribute), [1] output_path (veil.config.datahandler.DataHandlerConfig attribute) (veil.config.DataHandlerConfig attribute), [1] overall_duration_seconds() (veil.metric_store.MetricStore method) overlap_policy (veil.config.overlap_resolver.OverlapResolverConfig attribute) (veil.config.OverlapResolverConfig attribute), [1]

overlap_resolver (veil.config.pipeline.PipelineConfig attribute) (veil.config.PipelineConfig attribute), [1] OverlapResolver (class in veil.overlap_resolver) OverlapResolverConfig (class in veil.config), [1] (class in veil.config.overlap_resolver)

P

path_in_run_dir() (veil.metric_store.MetricStore method) Pipeline (class in veil.pipeline), [1] PipelineConfig (class in veil.config), [1] (class in veil.config.pipeline) port (veil.config.api_server.ApiServerConfig attribute) (veil.config.ApiServerConfig attribute), [1] presence_penalty (veil.config.entity_detectors.MaskerApiEntityDetectorConfig attribute) (veil.config.MaskerApiEntityDetectorConfig attribute), [1] (veil.entity_detectors.api.HostedMaskerApiEntityDetector attribute) (veil.entity_detectors.HostedMaskerApiEntityDetector attribute) preserve_format (veil.config.entity_detectors.RegexEntityDetectorConfig attribute) (veil.config.RegexEntityDetectorConfig attribute), [1]

priority (veil.config.BaseEntityDetectorConfig attribute), [1] (veil.config.entity_detectors.BaseEntityDetectorConfig attribute) (veil.config.entity_detectors.GlinerEntityDetectorConfig attribute) (veil.config.entity_detectors.MaskerApiEntityDetectorConfig attribute) (veil.config.entity_detectors.RegexEntityDetectorConfig attribute) (veil.config.entity_detectors.SpacyEntityDetectorConfig attribute) (veil.config.GlinerEntityDetectorConfig attribute) (veil.config.MaskerApiEntityDetectorConfig attribute) (veil.config.RegexEntityDetectorConfig attribute) (veil.config.SpacyEntityDetectorConfig attribute) process() (veil.pipeline.Pipeline method), [1]

R

record_component_step() (veil.metric_store.MetricStore method) record_error() (veil.metric_store.MetricStore method) record_evaluation_variant() (veil.metric_store.MetricStore method) RegexEntityDetector (class in veil.entity_detectors), [1] (class in veil.entity_detectors.regex) RegexEntityDetectorConfig (class in veil.config), [1] (class in veil.config.entity_detectors) reload (veil.config.api_server.ApiServerConfig attribute) (veil.config.ApiServerConfig attribute), [1] report_exact (veil.config.evaluator.EvaluatorConfig attribute) (veil.config.EvaluatorConfig attribute), [1] report_exact_by_id (veil.config.evaluator.EvaluatorConfig attribute) (veil.config.EvaluatorConfig attribute), [1] report_iou_thresholds (veil.config.evaluator.EvaluatorConfig attribute) (veil.config.EvaluatorConfig attribute), [1]

resolve() (veil.entity_resolvers.EmbeddingsEntityResolver method), [1] (veil.overlap_resolver.OverlapResolver method) retries (veil.config.entity_detectors.MaskerApiEntityDetectorConfig attribute) (veil.config.MaskerApiEntityDetectorConfig attribute), [1] (veil.entity_detectors.api.HostedMaskerApiEntityDetector attribute) (veil.entity_detectors.HostedMaskerApiEntityDetector attribute) retry_backoff_base (veil.config.entity_detectors.MaskerApiEntityDetectorConfig attribute) (veil.config.MaskerApiEntityDetectorConfig attribute), [1] (veil.entity_detectors.api.HostedMaskerApiEntityDetector attribute) (veil.entity_detectors.HostedMaskerApiEntityDetector attribute) retry_on_truncation (veil.config.entity_detectors.MaskerApiEntityDetectorConfig attribute) (veil.config.MaskerApiEntityDetectorConfig attribute), [1] (veil.entity_detectors.api.HostedMaskerApiEntityDetector attribute) (veil.entity_detectors.HostedMaskerApiEntityDetector attribute) run() (veil.api_server.ApiServer method), [1]

S

save_config() (veil.metric_store.MetricStore method) save_config_json (veil.config.metric_store.MetricStoreConfig attribute) (veil.config.MetricStoreConfig attribute), [1] send_request() (veil.entity_detectors.api.MaskerApiEntityDetector method) send_request_with_retries() (veil.entity_detectors.api.MaskerApiEntityDetector method) SpacyEntityDetector (class in veil.entity_detectors), [1] (class in veil.entity_detectors.spacy) SpacyEntityDetectorConfig (class in veil.config), [1] (class in veil.config.entity_detectors)

start_document() (veil.metric_store.MetricStore method) strict_type (veil.config.evaluator.EvaluatorConfig attribute) (veil.config.EvaluatorConfig attribute), [1] system_prompt (veil.config.entity_detectors.MaskerApiEntityDetectorConfig attribute) (veil.config.MaskerApiEntityDetectorConfig attribute), [1] (veil.entity_detectors.api.HostedMaskerApiEntityDetector attribute) (veil.entity_detectors.HostedMaskerApiEntityDetector attribute)

T

temperature (veil.config.entity_detectors.MaskerApiEntityDetectorConfig attribute) (veil.config.MaskerApiEntityDetectorConfig attribute), [1] (veil.entity_detectors.api.HostedMaskerApiEntityDetector attribute) (veil.entity_detectors.HostedMaskerApiEntityDetector attribute) test_pattern() (veil.entity_detectors.regex.RegexEntityDetector method) (veil.entity_detectors.RegexEntityDetector method), [1] text_encoding (veil.config.datahandler.DataHandlerConfig attribute) (veil.config.DataHandlerConfig attribute), [1] text_field (veil.config.datahandler.DataHandlerConfig attribute) (veil.config.DataHandlerConfig attribute), [1] threshold (veil.config.EmbeddingsEntityResolverConfig attribute), [1] (veil.config.entity_detectors.GlinerEntityDetectorConfig attribute) (veil.config.entity_resolvers.EmbeddingsEntityResolverConfig attribute) (veil.config.GlinerEntityDetectorConfig attribute), [1] timeout (veil.config.entity_detectors.MaskerApiEntityDetectorConfig attribute) (veil.config.MaskerApiEntityDetectorConfig attribute), [1] (veil.entity_detectors.api.HostedMaskerApiEntityDetector attribute) (veil.entity_detectors.HostedMaskerApiEntityDetector attribute)

to_dict() (veil.evaluator.ConfusionCounts method) top_k (veil.config.entity_detectors.MaskerApiEntityDetectorConfig attribute) (veil.config.MaskerApiEntityDetectorConfig attribute), [1] (veil.entity_detectors.api.HostedMaskerApiEntityDetector attribute) (veil.entity_detectors.HostedMaskerApiEntityDetector attribute) top_k_per_chunk (veil.config.entity_detectors.GlinerEntityDetectorConfig attribute) (veil.config.GlinerEntityDetectorConfig attribute), [1] top_p (veil.config.entity_detectors.MaskerApiEntityDetectorConfig attribute) (veil.config.MaskerApiEntityDetectorConfig attribute), [1] (veil.entity_detectors.api.HostedMaskerApiEntityDetector attribute) (veil.entity_detectors.HostedMaskerApiEntityDetector attribute) tp (veil.evaluator.ConfusionCounts attribute) truncation_min_fraction (veil.config.entity_detectors.MaskerApiEntityDetectorConfig attribute) (veil.config.MaskerApiEntityDetectorConfig attribute), [1] (veil.entity_detectors.api.HostedMaskerApiEntityDetector attribute) (veil.entity_detectors.HostedMaskerApiEntityDetector attribute)

U

use_hungarian_id_mapping (veil.config.evaluator.EvaluatorConfig attribute) (veil.config.EvaluatorConfig attribute), [1]

V

veil.api_server module, [1] veil.config module, [1] veil.config.api_server module veil.config.datahandler module veil.config.entity_detectors module veil.config.entity_resolvers module veil.config.evaluator module veil.config.masker module veil.config.metric_store module veil.config.overlap_resolver module veil.config.pipeline module

veil.entity_detectors module, [1] veil.entity_detectors.api module veil.entity_detectors.gliner module veil.entity_detectors.regex module veil.entity_detectors.spacy module veil.entity_resolvers module, [1] veil.evaluator module veil.masker module, [1] veil.metric_store module veil.overlap_resolver module veil.pipeline module, [1]