kodexa.model.objects
Module Contents
Classes
The implementation of the assistant |
|
Taxonomies that the assistant uses |
|
The metadata for this store |
|
Generic enumeration. |
|
Generic enumeration. |
|
Generic enumeration. |
|
A list of associated tags |
|
The state of the model in this store |
|
The deployment to use, local means that the model runtime can be re-used across models, while container means that the model store must be deployed with the model runtime |
|
The type of step (ACTION or MODEL) |
|
The metadata for the steps in this pipeline |
|
Generic enumeration. |
|
Generic enumeration. |
|
The stores that will be created with the project template |
|
The type of taxonomy |
|
The category of project template |
|
Generic enumeration. |
|
A list of relationships to other taxons and the purpose of the relationship |
|
The default schedules that the assistant has |
|
If data type is SELECTION, this is the list of available options |
|
The type of object the store will contain |
|
The purpose of the store (used by UI and assistants to understand how to interact with the store events) |
|
Options for viewing this store |
|
Where to get the value for this taxon when extracting |
|
If the type is metadata this will be the metadata option |
|
Expected data type to coalesce to (defaults to STRING) |
|
The type of taxonomy |
|
View presets that have been saved for this store |
|
The classification classes from the latest content object in the family |
|
A list of the content exceptions from the content objects |
|
The type of content |
|
The type of actor |
|
Provides the definition of an actor in a transition |
|
Generic enumeration. |
|
The type of transition |
|
Provides the definition of a transition for a document, where a change was applied by an assistant, user or external process |
|
Generic enumeration. |
|
Generic enumeration. |
|
Generic enumeration. |
|
Generic enumeration. |
|
Generic enumeration. |
|
Generic enumeration. |
|
Generic enumeration. |
|
A list of messages relating to the validity |
|
The current validation state |
|
A list of the data exceptions |
|
A list tag metadata for the data attribute |
|
Generic enumeration. |
|
Generic enumeration. |
|
Generic enumeration. |
|
Entities identified in search content |
|
Generic enumeration. |
|
Generic enumeration. |
|
Generic enumeration. |
|
Generic enumeration. |
|
Provides details on the version, build and environment that is currently running |
|
Generic enumeration. |
|
The current validation state |
|
A user within the Kodexa platform |
|
Options available for this event |
|
Overlays provide the ability to apply validation, normalization and enrichment |
|
Metadata captured when publishing a pipeline definition |
|
The assistants that will be created with the project template |
|
The dashboards that will be created with the project template |
|
A taxon is an individual label within a taxonomy |
|
A list of the assignments to users for this document |
|
A role that can be used to manage rights |
|
Additional metadata for the assistant |
|
A Custom Event allows you to define an subtype of assistant event with options |
|
The taxonomies that will be created with the project template |
|
A document family is the representation of a single piece of external content (ie. a PDF) and all the related document representations of that file |
|
A collection of statistics about the document family |
|
A document family is the representation of a single peice of external content (ie. a PDF) and all the related document representations of that file |
|
An audit event captures a data to a data structure or document |
|
The definition of an available action |
|
A template for new project |
|
Provides the definition and metadata for a store |
|
Provides the taxonomy hierarchy that is used for content and document classification and labeling |
|
- class kodexa.model.objects.ExceptionResponse
Bases:
kodexa.model.base.KodexaBaseModel- date_time :Optional[datetime.datetime]
- message :Optional[str]
- incident_id :Optional[str]
- context_path :Optional[str]
- errors :Optional[Dict[str, Any]]
- stack_trace :Optional[str]
- root_cause_stack_trace :Optional[List[str]]
- class kodexa.model.objects.StatusType
Bases:
kodexa.model.base.KodexaBaseModel- status_code :Optional[int]
- reason_phrase :Optional[str]
- class kodexa.model.objects.StackTraceItem
Bases:
kodexa.model.base.KodexaBaseModel- class_loader_name :Optional[str]
- module_name :Optional[str]
- module_version :Optional[str]
- method_name :Optional[str]
- file_name :Optional[str]
- line_number :Optional[int]
- native_method :Optional[bool]
- class_name :Optional[str]
- class kodexa.model.objects.StackTraceItem1
Bases:
kodexa.model.base.KodexaBaseModel- class_loader_name :Optional[str]
- module_name :Optional[str]
- module_version :Optional[str]
- method_name :Optional[str]
- file_name :Optional[str]
- line_number :Optional[int]
- native_method :Optional[bool]
- class_name :Optional[str]
- class kodexa.model.objects.Cause
Bases:
kodexa.model.base.KodexaBaseModel- stack_trace :Optional[List[StackTraceItem1]]
- message :Optional[str]
- localized_message :Optional[str]
- class kodexa.model.objects.StackTraceItem2
Bases:
kodexa.model.base.KodexaBaseModel- class_loader_name :Optional[str]
- module_name :Optional[str]
- module_version :Optional[str]
- method_name :Optional[str]
- file_name :Optional[str]
- line_number :Optional[int]
- native_method :Optional[bool]
- class_name :Optional[str]
- class kodexa.model.objects.SuppressedItem
Bases:
kodexa.model.base.KodexaBaseModel- cause :Optional[Cause]
- stack_trace :Optional[List[StackTraceItem2]]
- message :Optional[str]
- localized_message :Optional[str]
- class kodexa.model.objects.ThrowableProblem
Bases:
kodexa.model.base.KodexaBaseModel- cause :Optional[ThrowableProblem]
- stack_trace :Optional[List[StackTraceItem]]
- message :Optional[str]
- instance :Optional[pydantic.AnyUrl]
- type :Optional[pydantic.AnyUrl]
- parameters :Optional[Dict[str, Any]]
- status :Optional[StatusType]
- detail :Optional[str]
- title :Optional[str]
- suppressed :Optional[List[SuppressedItem]]
- localized_message :Optional[str]
- class kodexa.model.objects.FavoriteLink
Bases:
kodexa.model.base.KodexaBaseModel- link :Optional[str]
- class kodexa.model.objects.UserStorage
Bases:
kodexa.model.base.KodexaBaseModel- favorite_links :Optional[List[FavoriteLink]]
- class kodexa.model.objects.CompletePasswordReset
Bases:
kodexa.model.base.KodexaBaseModel- reset_token :str
- password :str
- class kodexa.model.objects.Label
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- name :str
- color :Optional[str]
- label :str
- class kodexa.model.objects.Organization
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- created_by :Optional[str]
- updated_by :Optional[str]
- name :str
- labels :Optional[List[Label]]
- slug :constr(regex='^[a-zA-Z0-9\\-_]{0,100}$')
- public_access :Optional[bool]
- description :Optional[str]
- has_image :Optional[bool]
- class kodexa.model.objects.Team
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- name :Optional[str]
- description :Optional[str]
- organization :Optional[Organization]
- class kodexa.model.objects.AssistantImplementation
Bases:
kodexa.model.base.KodexaBaseModelThe implementation of the assistant
- package :Optional[str]
- class_ :Optional[str]
- class kodexa.model.objects.AssistantTaxonomy
Bases:
kodexa.model.base.KodexaBaseModelTaxonomies that the assistant uses
- ref :Optional[str]
- class kodexa.model.objects.Avatar
Bases:
kodexa.model.base.KodexaBaseModel- icon :Optional[str]
- icon_group :Optional[str]
- class kodexa.model.objects.Card
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- type :Optional[str]
- properties :Optional[Dict[str, Any]]
- children :Optional[List[Card]]
- class kodexa.model.objects.ColumnState
Bases:
kodexa.model.base.KodexaBaseModel- field :Optional[str]
- title :Optional[str]
- cell :Optional[str]
- width :Optional[str]
- groupable :Optional[bool]
- sortable :Optional[bool]
- resizeable :Optional[bool]
- class kodexa.model.objects.ContainerResources
Bases:
kodexa.model.base.KodexaBaseModel- memory :Optional[str]
- cpu :Optional[str]
- class kodexa.model.objects.ContentMetadata
Bases:
kodexa.model.base.KodexaBaseModelThe metadata for this store
- type :Optional[str]
- class kodexa.model.objects.DashboardWidget
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- name :Optional[str]
- type :Optional[str]
- height :Optional[str]
- class kodexa.model.objects.DataFormSource
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- name :Optional[str]
- type :Optional[str]
- class kodexa.model.objects.SourceType
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- data_object = DATA_OBJECT
- data_attribute = DATA_ATTRIBUTE
- fixed = FIXED
- class kodexa.model.objects.DataFormView
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- source_type :Optional[SourceType]
- data_source_id :Optional[str]
- name :Optional[str]
- cards :Optional[List[Card]]
- class kodexa.model.objects.DeploymentType
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- kubernetes = KUBERNETES
- aws_lambda = AWS_LAMBDA
- azure_cloud_function = AZURE_CLOUD_FUNCTION
- none = NONE
- class kodexa.model.objects.DocumentColumn
Bases:
kodexa.model.base.KodexaBaseModel- label :Optional[str]
- path :Optional[str]
- class kodexa.model.objects.Status
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- pending = PENDING
- building = BUILDING
- built = BUILT
- available = AVAILABLE
- failed = FAILED
- undeployed = UNDEPLOYED
- awaiting_deployment = AWAITING_DEPLOYMENT
- deploying = DEPLOYING
- deployment_failed = DEPLOYMENT_FAILED
- class kodexa.model.objects.ExtensionPackSource
Bases:
kodexa.model.base.KodexaBaseModel- type :Optional[str]
- class kodexa.model.objects.MatchLabel
Bases:
kodexa.model.base.KodexaBaseModel- label :Optional[str]
- value :Optional[str]
- class kodexa.model.objects.MetadataTag
Bases:
kodexa.model.base.KodexaBaseModelA list of associated tags
- tag :Optional[str]
- image_url :Optional[str]
- class kodexa.model.objects.State
Bases:
enum.EnumThe state of the model in this store
- pending = PENDING
- preparing = PREPARING
- prepared = PREPARED
- training = TRAINING
- trained = TRAINED
- deployed = DEPLOYED
- undeployed = UNDEPLOYED
- failed = FAILED
- class kodexa.model.objects.DeploymentType1
Bases:
enum.EnumThe deployment to use, local means that the model runtime can be re-used across models, while container means that the model store must be deployed with the model runtime
- local = LOCAL
- container = CONTAINER
- class kodexa.model.objects.OverlayCondition
- class kodexa.model.objects.StepType
Bases:
enum.EnumThe type of step (ACTION or MODEL)
- action = ACTION
- model = MODEL
- class kodexa.model.objects.PipelineStepMetadata
Bases:
kodexa.model.base.KodexaBaseModelThe metadata for the steps in this pipeline
- name :Optional[str]
- ref :Optional[str]
- options :Optional[Dict[str, Any]]
- step_type :Optional[StepType]
- class kodexa.model.objects.PossibleValue
Bases:
kodexa.model.base.KodexaBaseModel- label :Optional[str]
- value :Optional[Any]
- description :Optional[str]
- class kodexa.model.objects.StoreType
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- document = DOCUMENT
- table = TABLE
- dictionary = DICTIONARY
- model = MODEL
- class kodexa.model.objects.StorePurpose
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- operational = OPERATIONAL
- training = TRAINING
- class kodexa.model.objects.ProjectStore
Bases:
kodexa.model.base.KodexaBaseModelThe stores that will be created with the project template
- slug :Optional[str]
- name :Optional[str]
- description :Optional[str]
- store_type :Optional[StoreType]
- store_purpose :Optional[StorePurpose]
- template_ref :Optional[str]
- class kodexa.model.objects.TaxonomyType
Bases:
enum.EnumThe type of taxonomy
- content = CONTENT
- classification = CLASSIFICATION
- processing = PROCESSING
- model = MODEL
- class kodexa.model.objects.Category
Bases:
enum.EnumThe category of project template
- task = TASK
- document = DOCUMENT
- connector = CONNECTOR
- machine_learning = MACHINE_LEARNING
- supplemental = SUPPLEMENTAL
- class kodexa.model.objects.Purpose
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- suggestion = SUGGESTION
- source = SOURCE
- class kodexa.model.objects.RelatedTaxon
Bases:
kodexa.model.base.KodexaBaseModelA list of relationships to other taxons and the purpose of the relationship
- path :Optional[str]
- purpose :Optional[Purpose]
- priority :Optional[int]
- class kodexa.model.objects.ScheduleDefinition
Bases:
kodexa.model.base.KodexaBaseModelThe default schedules that the assistant has
- type :Optional[str]
- cron_expression :Optional[str]
- last_event :Optional[datetime.datetime]
- next_event :Optional[datetime.datetime]
- class kodexa.model.objects.SelectionOption
Bases:
kodexa.model.base.KodexaBaseModelIf data type is SELECTION, this is the list of available options
- label :Optional[str]
- id :Optional[str]
- description :Optional[str]
- class kodexa.model.objects.SlugBasedMetadata1
Bases:
kodexa.model.base.KodexaBaseModel- ref :Optional[str]
- schema_version :Optional[int]
- template :Optional[bool]
- org_slug :Optional[str]
- slug :constr(regex='^[a-zA-Z0-9\\-_]{0,255}$')
- type :str
- name :str
- description :Optional[str]
- version :Optional[str]
- deployed :Optional[datetime.datetime]
- public_access :Optional[bool]
- image_url :Optional[str]
- icon :Optional[str]
- overview_markdown :Optional[str]
- metadata_tag :Optional[List[MetadataTag]]
- provider :Optional[str]
- provider_url :Optional[str]
- provider_image_url :Optional[str]
- class kodexa.model.objects.StepImplementation
Bases:
kodexa.model.base.KodexaBaseModel- package :Optional[str]
- class_ :Optional[str]
- class kodexa.model.objects.StoreType1
Bases:
enum.EnumThe type of object the store will contain
- document = DOCUMENT
- table = TABLE
- dictionary = DICTIONARY
- model = MODEL
- class kodexa.model.objects.StorePurpose1
Bases:
enum.EnumThe purpose of the store (used by UI and assistants to understand how to interact with the store events)
- operational = OPERATIONAL
- training = TRAINING
- class kodexa.model.objects.StoreViewOptions
Bases:
kodexa.model.base.KodexaBaseModelOptions for viewing this store
- show_last_event :Optional[bool]
- show_extension :Optional[bool]
- show_created :Optional[bool]
- show_modified :Optional[bool]
- show_path_counts :Optional[bool]
- show_classifications :Optional[bool]
- show_size :Optional[bool]
- show_assignments :Optional[bool]
- show_status :Optional[bool]
- additional_columns :Optional[List[DocumentColumn]]
- column_states :Optional[Dict[str, List[ColumnState]]]
- class kodexa.model.objects.TabGroup
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- name :Optional[str]
- icon :Optional[str]
- show_if :Optional[str]
- class kodexa.model.objects.ValuePath
Bases:
enum.EnumWhere to get the value for this taxon when extracting
- value_or_all_content = VALUE_OR_ALL_CONTENT
- value_only = VALUE_ONLY
- all_content = ALL_CONTENT
- data_path = DATA_PATH
- metadata = METADATA
- expression = EXPRESSION
- class kodexa.model.objects.MetadataValue
Bases:
enum.EnumIf the type is metadata this will be the metadata option
- filename = FILENAME
- transaction_uuid = TRANSACTION_UUID
- created_datetime = CREATED_DATETIME
- class kodexa.model.objects.TaxonType
Bases:
enum.EnumExpected data type to coalesce to (defaults to STRING)
- string = STRING
- date = DATE
- date_time = DATE_TIME
- number = NUMBER
- decimal = DECIMAL
- float = FLOAT
- boolean = BOOLEAN
- currency = CURRENCY
- url = URL
- email_address = EMAIL_ADDRESS
- phone_number = PHONE_NUMBER
- selection = SELECTION
- class kodexa.model.objects.TaxonomyType1
Bases:
enum.EnumThe type of taxonomy
- content = CONTENT
- classification = CLASSIFICATION
- processing = PROCESSING
- model = MODEL
- class kodexa.model.objects.TextboxWidget
Bases:
DashboardWidget- title :Optional[str]
- subtitle :Optional[str]
- body :Optional[str]
- class kodexa.model.objects.ViewPreset
Bases:
kodexa.model.base.KodexaBaseModelView presets that have been saved for this store
- id :Optional[str]
- name :Optional[str]
- filter_string :Optional[str]
- enabled_taxons :Optional[Dict[str, bool]]
- class kodexa.model.objects.ReprocessRequest
Bases:
kodexa.model.base.KodexaBaseModel- assistant_ids :Optional[List[str]]
- family_ids :Optional[List[str]]
- all :Optional[bool]
- class kodexa.model.objects.ContentClassification
Bases:
kodexa.model.base.KodexaBaseModelThe classification classes from the latest content object in the family
- label :Optional[str]
- taxonomy :Optional[str]
- selector :Optional[str]
- confidence :Optional[float]
- class kodexa.model.objects.ContentException
Bases:
kodexa.model.base.KodexaBaseModelA list of the content exceptions from the content objects
- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- tag :Optional[str]
- message :str
- exception_type :str
- severity :str
- exception_details :Optional[str]
- group_uuid :Optional[str]
- tag_uuid :Optional[str]
- class kodexa.model.objects.ContentType
Bases:
enum.EnumThe type of content
- document = DOCUMENT
- native = NATIVE
- class kodexa.model.objects.ContentObject
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- content_type :ContentType
- document_version :Optional[str]
- index :Optional[int]
- labels :Optional[List[Label]]
- metadata :Optional[Dict[str, Any]]
- mixins :Optional[List[str]]
- created :Optional[datetime.datetime]
- modified :Optional[datetime.datetime]
- size :Optional[int]
- store_ref :Optional[str]
- document_family_id :Optional[str]
- class kodexa.model.objects.ActorType
Bases:
enum.EnumThe type of actor
- user = USER
- assistant = ASSISTANT
- access_token = ACCESS_TOKEN
- api = API
- class kodexa.model.objects.DocumentActor
Bases:
kodexa.model.base.KodexaBaseModelProvides the definition of an actor in a transition
- actor_id :Optional[str]
- actor_type :Optional[ActorType]
- class kodexa.model.objects.StatusType1
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- unresolved = UNRESOLVED
- resolved = RESOLVED
- class kodexa.model.objects.DocumentStatus
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- color :Optional[str]
- icon :Optional[str]
- status :str
- status_type :Optional[StatusType1]
- class kodexa.model.objects.TransitionType
Bases:
enum.EnumThe type of transition
- derived = DERIVED
- class kodexa.model.objects.DocumentTransition
Bases:
kodexa.model.base.KodexaBaseModelProvides the definition of a transition for a document, where a change was applied by an assistant, user or external process
- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- unknown_fields :Optional[Dict[str, str]]
- transition_type :Optional[TransitionType]
- index :Optional[int]
- date_time :Optional[datetime.datetime]
- actor :Optional[DocumentActor]
- label :Optional[str]
- destination_content_object_id :Optional[str]
- source_content_object_id :Optional[str]
- class kodexa.model.objects.Status1
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- pending = PENDING
- running = RUNNING
- succeeded = SUCCEEDED
- failed = FAILED
- requested = REQUESTED
- skipped = SKIPPED
- cancelling = CANCELLING
- cancelled = CANCELLED
- pending_reprocessing = PENDING_REPROCESSING
- class kodexa.model.objects.Status2
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- pending = PENDING
- running = RUNNING
- succeeded = SUCCEEDED
- failed = FAILED
- requested = REQUESTED
- skipped = SKIPPED
- cancelling = CANCELLING
- cancelled = CANCELLED
- pending_reprocessing = PENDING_REPROCESSING
- class kodexa.model.objects.StepType1
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- action = ACTION
- model = MODEL
- class kodexa.model.objects.Type
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- document_store = DOCUMENT_STORE
- taxonomy_store = TAXONOMY_STORE
- data_store = DATA_STORE
- class kodexa.model.objects.ExecutionTarget
Bases:
kodexa.model.base.KodexaBaseModel- type :Optional[Type]
- ref :Optional[str]
- document_family_id :Optional[str]
- content_object_id :Optional[str]
- actor :Optional[DocumentActor]
- taxonomy_refs :Optional[List[str]]
- labels_to_apply :Optional[List[str]]
- class kodexa.model.objects.ExecutionTargets
Bases:
kodexa.model.base.KodexaBaseModel- instances :Optional[List[ExecutionTarget]]
- class kodexa.model.objects.PathExtractedData
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- taxonomy_id :Optional[str]
- path :Optional[str]
- label :Optional[str]
- count :Optional[int]
- exception_count :Optional[int]
- class kodexa.model.objects.State1
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- open = OPEN
- closed = CLOSED
- class kodexa.model.objects.Session
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- state :State1
- token :Optional[str]
- last_accessed :Optional[datetime.datetime]
- class kodexa.model.objects.Status3
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- pending = PENDING
- running = RUNNING
- succeeded = SUCCEEDED
- failed = FAILED
- requested = REQUESTED
- skipped = SKIPPED
- cancelling = CANCELLING
- cancelled = CANCELLED
- pending_reprocessing = PENDING_REPROCESSING
- class kodexa.model.objects.StatusDetails
Bases:
kodexa.model.base.KodexaBaseModel- status :Optional[Status3]
- message :Optional[str]
- detail :Optional[str]
- progress_max :Optional[int]
- progress :Optional[int]
- class kodexa.model.objects.ValidationError
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- message :Optional[str]
- option :Optional[str]
- description :Optional[str]
- class kodexa.model.objects.ValidationResults
Bases:
kodexa.model.base.KodexaBaseModel- instances :Optional[List[ValidationError]]
- class kodexa.model.objects.BulkCopy
Bases:
kodexa.model.base.KodexaBaseModel- target_store_ref :Optional[str]
- all :Optional[bool]
- document_family_ids :Optional[List[str]]
- class kodexa.model.objects.FamilyRename
Bases:
kodexa.model.base.KodexaBaseModel- path :str
- class kodexa.model.objects.ContentFeature
Bases:
kodexa.model.base.KodexaBaseModel- feature_type :Optional[str]
- name :Optional[str]
- value :Optional[List[Dict[str, Any]]]
- single :Optional[bool]
- class kodexa.model.objects.NodeFeatures
Bases:
kodexa.model.base.KodexaBaseModel- node_uuid :Optional[str]
- features :Optional[List[ContentFeature]]
- class kodexa.model.objects.StatusType2
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- unresolved = UNRESOLVED
- resolved = RESOLVED
- class kodexa.model.objects.AttributeStatus
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- color :Optional[str]
- icon :Optional[str]
- status :Optional[str]
- status_type :Optional[StatusType2]
- class kodexa.model.objects.AttributeValidationMessage
Bases:
kodexa.model.base.KodexaBaseModelA list of messages relating to the validity
- message :Optional[str]
- validation_features :Optional[Dict[str, Any]]
- class kodexa.model.objects.ValidationState
Bases:
enum.EnumThe current validation state
- valid = VALID
- invalid = INVALID
- warning = WARNING
- class kodexa.model.objects.DataException
Bases:
kodexa.model.base.KodexaBaseModelA list of the data exceptions
- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- message :str
- exception_details :Optional[str]
- severity :Optional[str]
- exception_type :Optional[str]
- closing_comment :Optional[str]
- open :Optional[bool]
- class kodexa.model.objects.DataLineage
Bases:
kodexa.model.base.KodexaBaseModel- store_ref :Optional[str]
- document_family_id :Optional[str]
- execution_id :Optional[str]
- content_object_id :Optional[str]
- class kodexa.model.objects.ExtractedTagMetadata
Bases:
kodexa.model.base.KodexaBaseModel- scaled_bounding_box :Optional[List[float]]
- parent_selector :Optional[str]
- parent_index :Optional[int]
- class kodexa.model.objects.TagMetadata
Bases:
kodexa.model.base.KodexaBaseModelA list tag metadata for the data attribute
- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- metadata :Optional[ExtractedTagMetadata]
- class kodexa.model.objects.ProjectMemory
Bases:
kodexa.model.base.KodexaBaseModel- recent_filters :Optional[Dict[str, List[str]]]
- class kodexa.model.objects.ProjectMetadata
Bases:
kodexa.model.base.KodexaBaseModel- tags :Optional[List[str]]
- class kodexa.model.objects.WorkflowDefinition
Bases:
kodexa.model.base.KodexaBaseModel- description :Optional[str]
- definition_xml :Optional[str]
- class kodexa.model.objects.ProjectResourcesUpdate
Bases:
kodexa.model.base.KodexaBaseModel- taxonomy_refs :Optional[List[str]]
- store_refs :Optional[List[str]]
- dashboard_refs :Optional[List[str]]
- data_form_refs :Optional[List[str]]
- class kodexa.model.objects.AssistantSchedule
Bases:
kodexa.model.base.KodexaBaseModel- type :Optional[str]
- cron_expression :Optional[str]
- last_event :Optional[datetime.datetime]
- next_event :Optional[datetime.datetime]
- id :Optional[str]
- class kodexa.model.objects.Role1
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- owner = OWNER
- read = READ
- write = WRITE
- class kodexa.model.objects.DeploymentType2
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- kubernetes = KUBERNETES
- aws_lambda = AWS_LAMBDA
- azure_cloud_function = AZURE_CLOUD_FUNCTION
- none = NONE
- class kodexa.model.objects.DeploymentOptions
Bases:
kodexa.model.base.KodexaBaseModel- deployment_type :Optional[DeploymentType2]
- max_replicas :Optional[int]
- min_replicas :Optional[int]
- reserved_concurrency :Optional[int]
- memory_assigned :Optional[str]
- cpu :Optional[str]
- pod_match_labels :Optional[List[MatchLabel]]
- class kodexa.model.objects.SourceType1
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- data_object = DATA_OBJECT
- data_attribute = DATA_ATTRIBUTE
- fixed = FIXED
- class kodexa.model.objects.DataFormSourceMethod
Bases:
kodexa.model.base.KodexaBaseModel- name :Optional[str]
- parameters :Optional[Dict[str, str]]
- class kodexa.model.objects.PlatformConfiguration
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- created_by :Optional[str]
- updated_by :Optional[str]
- welcome_markdown :Optional[str]
- news_markdown :Optional[str]
- about_markdown :Optional[str]
- login_message :Optional[str]
- base_org_slug :Optional[str]
- title :Optional[str]
- organization_title :Optional[str]
- organizations_title :Optional[str]
- organization_description :Optional[str]
- project_title :Optional[str]
- projects_title :Optional[str]
- project_description :Optional[str]
- developer_links :Optional[bool]
- allow_registration :Optional[bool]
- allow_password_reset :Optional[bool]
- default_to_design :Optional[bool]
- extension_pack_bridge :Optional[str]
- fallback_feature_flags :Optional[str]
- class kodexa.model.objects.UserActivation
Bases:
kodexa.model.base.KodexaBaseModel- first_name :Optional[str]
- last_name :Optional[str]
- password :Optional[str]
- class kodexa.model.objects.ModelTraining
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- training_date :Optional[datetime.datetime]
- class kodexa.model.objects.SearchEntity
Bases:
kodexa.model.base.KodexaBaseModelEntities identified in search content
- entity :Optional[str]
- value :Optional[str]
- start :Optional[int]
- end :Optional[int]
- class kodexa.model.objects.Status4
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- pending = PENDING
- running = RUNNING
- succeeded = SUCCEEDED
- failed = FAILED
- requested = REQUESTED
- skipped = SKIPPED
- cancelling = CANCELLING
- cancelled = CANCELLED
- pending_reprocessing = PENDING_REPROCESSING
- class kodexa.model.objects.BaseEvent1
Bases:
kodexa.model.base.KodexaBaseModel- type :Optional[str]
- class kodexa.model.objects.ObjectEventType
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- new_object = NEW_OBJECT
- derived_object = DERIVED_OBJECT
- class kodexa.model.objects.Type1
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- start_execution = START_EXECUTION
- step_update = STEP_UPDATE
- assistant_event = ASSISTANT_EVENT
- assistant_response = ASSISTANT_RESPONSE
- class kodexa.model.objects.Status5
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- pending = PENDING
- running = RUNNING
- succeeded = SUCCEEDED
- failed = FAILED
- requested = REQUESTED
- skipped = SKIPPED
- cancelling = CANCELLING
- cancelled = CANCELLED
- pending_reprocessing = PENDING_REPROCESSING
- class kodexa.model.objects.ExecutionLogEntry
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- log_date :Optional[datetime.datetime]
- entry :Optional[str]
- class kodexa.model.objects.LoginRequest
Bases:
kodexa.model.base.KodexaBaseModel- email :str
- password :str
- class kodexa.model.objects.RegisterUser
Bases:
kodexa.model.base.KodexaBaseModel- email :str
- first_name :str
- last_name :str
- class kodexa.model.objects.PasswordReset
Bases:
kodexa.model.base.KodexaBaseModel- email :str
- class kodexa.model.objects.PasswordChange
Bases:
kodexa.model.base.KodexaBaseModel- old_password :str
- new_password :str
- class kodexa.model.objects.PlatformOverview
Bases:
kodexa.model.base.KodexaBaseModelProvides details on the version, build and environment that is currently running
- name :Optional[str]
- release :Optional[str]
- description :Optional[str]
- host_name :Optional[str]
- environment :Optional[str]
- commit_id :Optional[str]
- build_time :Optional[str]
- version :Optional[str]
- recommended_client_version :Optional[str]
- extension_packs :Optional[List[Dict[str, str]]]
- class kodexa.model.objects.QueryContext
Bases:
kodexa.model.base.KodexaBaseModel- page_size :Optional[int]
- page :Optional[int]
- sort :Optional[str]
- filter :Optional[str]
- query :Optional[str]
- class kodexa.model.objects.Sort
Bases:
kodexa.model.base.KodexaBaseModel- empty :Optional[bool]
- sorted :Optional[bool]
- unsorted :Optional[bool]
- class kodexa.model.objects.EventType
Bases:
enum.EnumGeneric enumeration.
Derive from this class to define new enumerations.
- created = CREATED
- deleted = DELETED
- updated = UPDATED
- class kodexa.model.objects.ValidationState1
Bases:
enum.EnumThe current validation state
- valid = VALID
- invalid = INVALID
- warning = WARNING
- class kodexa.model.objects.DataAttributeValues
Bases:
kodexa.model.base.KodexaBaseModel- value :Optional[str]
- truncated :Optional[bool]
- tag :str
- tag_uuid :Optional[str]
- date_value :Optional[datetime.datetime]
- float_value :Optional[float]
- decimal_value :Optional[float]
- number_value :Optional[int]
- boolean_value :Optional[bool]
- string_value :Optional[str]
- attribute_status :Optional[AttributeStatus]
- confidence :Optional[float]
- validation_state :ValidationState1
- class kodexa.model.objects.BulkDelete
Bases:
kodexa.model.base.KodexaBaseModel- all :Optional[bool]
- document_family_ids :Optional[List[str]]
- class kodexa.model.objects.User
Bases:
kodexa.model.base.KodexaBaseModelA user within the Kodexa platform
- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- created_by :Optional[str]
- updated_by :Optional[str]
- email :str
- first_name :str
- last_name :str
- activated :Optional[bool]
- platform_admin :Optional[bool]
- password_reset_date :Optional[datetime.datetime]
- last_connected :Optional[datetime.datetime]
- user_storage :Optional[UserStorage]
- has_image :Optional[bool]
- show_developer_tools :Optional[bool]
- class kodexa.model.objects.ChartWidget
Bases:
DashboardWidget- options :Optional[Dict[str, Any]]
- class kodexa.model.objects.DashboardColumn
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- cols :Optional[str]
- height :Optional[str]
- widgets :Optional[List[DashboardWidget]]
- class kodexa.model.objects.DashboardRow
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- height :Optional[str]
- columns :Optional[List[DashboardColumn]]
- class kodexa.model.objects.DeploymentMetadata
Bases:
kodexa.model.base.KodexaBaseModel- deployment_type :Optional[DeploymentType]
- min_replicas :Optional[int]
- max_replicas :Optional[int]
- reserved_concurrency :Optional[int]
- limits :Optional[ContainerResources]
- requests :Optional[ContainerResources]
- memory_assigned :Optional[str]
- scheduler_token :Optional[str]
- service_name :Optional[str]
- container_name :Optional[str]
- function_arn :Optional[str]
- environment :Optional[Dict[str, str]]
- pod_match_labels :Optional[List[MatchLabel]]
- subscription_id :Optional[str]
- plan_name :Optional[str]
- resource_group :Optional[str]
- function_url :Optional[str]
- app_key :Optional[str]
- class kodexa.model.objects.DockerSource
Bases:
ExtensionPackSource- location :Optional[str]
- class kodexa.model.objects.ExtensionPackProvided
Bases:
kodexa.model.base.KodexaBaseModel- ref :Optional[str]
- schema_version :Optional[int]
- template :Optional[bool]
- org_slug :Optional[str]
- slug :constr(regex='^[a-zA-Z0-9\\-_]{0,255}$')
- type :str
- name :str
- description :Optional[str]
- version :Optional[str]
- deployed :Optional[datetime.datetime]
- public_access :Optional[bool]
- image_url :Optional[str]
- icon :Optional[str]
- overview_markdown :Optional[str]
- metadata_tag :Optional[List[MetadataTag]]
- provider :Optional[str]
- provider_url :Optional[str]
- provider_image_url :Optional[str]
- extension_pack_ref :Optional[str]
- class kodexa.model.objects.Option
Bases:
kodexa.model.base.KodexaBaseModelOptions available for this event
- group_options :Optional[List[Option]]
- tab_name :Optional[str]
- name :Optional[str]
- label :Optional[str]
- false_label :Optional[str]
- hint :Optional[str]
- required :Optional[bool]
- type :Optional[str]
- list_type :Optional[str]
- list_label :Optional[str]
- list_description :Optional[str]
- feature_flag :Optional[str]
- default :Optional[Any]
- description :Optional[str]
- support_article :Optional[str]
- show_if :Optional[str]
- possible_values :Optional[List[PossibleValue]]
- class kodexa.model.objects.Overlay
Bases:
kodexa.model.base.KodexaBaseModelOverlays provide the ability to apply validation, normalization and enrichment
- id :Optional[str]
- name :Optional[str]
- conditions :Optional[List[OverlayCondition]]
- class kodexa.model.objects.PipelineImplementationMetadata
Bases:
kodexa.model.base.KodexaBaseModelMetadata captured when publishing a pipeline definition
- steps :Optional[List[PipelineStepMetadata]]
- class kodexa.model.objects.ProjectAssistant
Bases:
kodexa.model.base.KodexaBaseModelThe assistants that will be created with the project template
- name :Optional[str]
- description :Optional[str]
- assistant_definition_ref :Optional[str]
- options :Optional[Dict[str, Any]]
- stores :Optional[List[str]]
- schedules :Optional[List[ScheduleDefinition]]
- subscription :Optional[str]
- class kodexa.model.objects.ProjectDashboard
Bases:
kodexa.model.base.KodexaBaseModelThe dashboards that will be created with the project template
- slug :Optional[constr(regex='^[a-zA-Z0-9\\-_]{0,255}$')]
- name :Optional[str]
- description :Optional[str]
- rows :Optional[List[DashboardRow]]
- template_ref :Optional[str]
- class kodexa.model.objects.Taxon
Bases:
kodexa.model.base.KodexaBaseModelA taxon is an individual label within a taxonomy
- id :Optional[str]
- label :Optional[str]
- generate_name :Optional[bool]
- group :Optional[bool]
- name :constr(regex='^[a-zA-Z0-9\\-_]{0,255}$')
- external_name :str
- value_path :Optional[ValuePath]
- metadata_value :Optional[MetadataValue]
- data_path :Optional[str]
- expression :Optional[str]
- enable_fallback_expression :Optional[bool]
- fallback_expression :Optional[str]
- nullable :Optional[bool]
- null_value :Optional[str]
- description :Optional[str]
- enabled :Optional[bool]
- color :Optional[str]
- children :Optional[List[Taxon]]
- options :Optional[List[Option]]
- node_types :Optional[List[str]]
- taxon_type :Optional[TaxonType]
- selection_options :Optional[List[SelectionOption]]
- type_features :Optional[Dict[str, Any]]
- path :Optional[str]
- multi_value :Optional[bool]
- user_editable :Optional[bool]
- use_post_expression :Optional[bool]
- post_expression :Optional[str]
- class kodexa.model.objects.DocumentAssignment
Bases:
kodexa.model.base.KodexaBaseModelA list of the assignments to users for this document
- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- user :User
- class kodexa.model.objects.ExceptionDetails
Bases:
kodexa.model.base.KodexaBaseModel- message :Optional[str]
- status_code :Optional[int]
- error_message :Optional[str]
- error_type :Optional[str]
- executed_version :Optional[str]
- advice :Optional[str]
- description :Optional[str]
- cause :Optional[Dict[str, Any]]
- documentation_url :Optional[str]
- stack_trace :Optional[List[Dict[str, Any]]]
- help :Optional[str]
- option_errors :Optional[Dict[str, Any]]
- validation_errors :Optional[List[ValidationError]]
- class kodexa.model.objects.ExecutionStep
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- status :Optional[Status2]
- exception_details :Optional[ExceptionDetails]
- name :Optional[str]
- start :Optional[datetime.datetime]
- end :Optional[datetime.datetime]
- processing_time :Optional[int]
- options :Optional[Dict[str, Any]]
- option_types :Optional[Dict[str, str]]
- context :Optional[Dict[str, Any]]
- content_objects :Optional[List[ContentObject]]
- input_id :Optional[str]
- output_id :Optional[str]
- ref :Optional[str]
- extension_pack_ref :Optional[str]
- step_type :Optional[StepType1]
- class kodexa.model.objects.FeatureSet
Bases:
kodexa.model.base.KodexaBaseModel- node_features :Optional[List[NodeFeatures]]
- class kodexa.model.objects.Note
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- user :Optional[User]
- content :Optional[str]
- class kodexa.model.objects.Role
Bases:
kodexa.model.base.KodexaBaseModelA role that can be used to manage rights
- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- created_by :Optional[str]
- updated_by :Optional[str]
- name :str
- users :Optional[List[User]]
- teams :Optional[List[Team]]
- class kodexa.model.objects.Project
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- organization :Optional[Organization]
- name :Optional[str]
- description :Optional[str]
- metadata :Optional[ProjectMetadata]
- show_tasks :Optional[bool]
- show_thumbnails :Optional[bool]
- has_image :Optional[bool]
- project_template_ref :Optional[str]
- memory :Optional[ProjectMemory]
- document_statuses :Optional[List[DocumentStatus]]
- attribute_statuses :Optional[List[AttributeStatus]]
- class kodexa.model.objects.Membership
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- created_by :Optional[str]
- updated_by :Optional[str]
- role :Optional[Role1]
- organization :Optional[Organization]
- user :Optional[User]
- class kodexa.model.objects.DataFormSourceDefinition
Bases:
kodexa.model.base.KodexaBaseModel- source_type :Optional[SourceType1]
- valid :Optional[bool]
- methods :Optional[List[DataFormSourceMethod]]
- required_parameters :Optional[List[str]]
- class kodexa.model.objects.PageableObject
Bases:
kodexa.model.base.KodexaBaseModel- offset :Optional[int]
- sort :Optional[Sort]
- paged :Optional[bool]
- unpaged :Optional[bool]
- page_number :Optional[int]
- page_size :Optional[int]
- class kodexa.model.objects.PageTeam
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[Team]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PageModelTraining
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[ModelTraining]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PageNote
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[Note]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PageSession
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[Session]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PageRole
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[Role]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PageProject
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[Project]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PageOrganization
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[Organization]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PageMembership
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[Membership]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PageExecutionLogEntry
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[ExecutionLogEntry]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.AssistantMetadata
Bases:
kodexa.model.base.KodexaBaseModelAdditional metadata for the assistant
- avatar :Optional[Avatar]
- tags :Optional[List[str]]
- tabs :Optional[List[TabGroup]]
- options :Optional[List[Option]]
- class kodexa.model.objects.CustomEvent
Bases:
kodexa.model.base.KodexaBaseModelA Custom Event allows you to define an subtype of assistant event with options
- name :Optional[constr(regex='^[a-zA-Z0-9\\-_]{0,40}$')]
- icon :Optional[str]
- label :Optional[str]
- description :Optional[str]
- content_object :Optional[bool]
- options :Optional[List[Option]]
- class kodexa.model.objects.ObjectMetadata
Bases:
kodexa.model.base.KodexaBaseModel- options :Optional[List[Option]]
- class kodexa.model.objects.ProjectTaxonomy
Bases:
kodexa.model.base.KodexaBaseModelThe taxonomies that will be created with the project template
- slug :Optional[str]
- name :Optional[str]
- description :Optional[str]
- taxonomy_type :Optional[TaxonomyType]
- taxons :Optional[List[Taxon]]
- template_ref :Optional[str]
- class kodexa.model.objects.ExecutionPipeline
Bases:
kodexa.model.base.KodexaBaseModel- valid :Optional[bool]
- ref :Optional[str]
- id :Optional[str]
- exceptions :Optional[List[ExceptionDetails]]
- steps :Optional[List[ExecutionStep]]
- class kodexa.model.objects.PageUser
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[User]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.Execution
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- description :Optional[str]
- targets :Optional[ExecutionTargets]
- session :Optional[Session]
- start_date :Optional[datetime.datetime]
- end_date :Optional[datetime.datetime]
- processing_time :Optional[int]
- logging_enabled :Optional[bool]
- status :Optional[Status1]
- exception_details :Optional[ExceptionDetails]
- status_details :Optional[StatusDetails]
- pipeline :Optional[ExecutionPipeline]
- parameters :Optional[Dict[str, Any]]
- custom_options :Optional[Dict[str, Any]]
- context :Optional[Dict[str, Any]]
- child_executions :Optional[List[Execution]]
- content_objects :Optional[List[ContentObject]]
- class kodexa.model.objects.PageExecution
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[Execution]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.ContentMetadata1
- class kodexa.model.objects.SlugBasedMetadata
- class kodexa.model.objects.DocumentFamily
Bases:
kodexa.model.base.KodexaBaseModelA document family is the representation of a single piece of external content (ie. a PDF) and all the related document representations of that file
- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- document_status :Optional[DocumentStatus]
- assignments :Optional[List[DocumentAssignment]]
- store_ref :Optional[str]
- path :str
- locked :Optional[bool]
- created :Optional[datetime.datetime]
- modified :Optional[datetime.datetime]
- size :Optional[int]
- indexed :Optional[bool]
- content_objects :Optional[List[ContentObject]]
- content_exceptions :Optional[List[ContentException]]
- transitions :Optional[List[DocumentTransition]]
- labels :Optional[List[Label]]
- mixins :Optional[List[str]]
- metadata :Optional[Dict[str, Any]]
- statistics :Optional[DocumentFamilyStatistics]
- classes :Optional[List[ContentClassification]]
- class kodexa.model.objects.DocumentFamilyStatistics
Bases:
kodexa.model.base.KodexaBaseModelA collection of statistics about the document family
- path_counts :Optional[List[PathExtractedData]]
- recent_executions :Optional[List[ExecutionOverview]]
- class kodexa.model.objects.ExecutionAssistant
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- subscription :Optional[str]
- name :str
- description :Optional[str]
- assistant_definition_ref :Optional[str]
- logging_enabled :Optional[bool]
- active :Optional[bool]
- run_on_existing_content :Optional[bool]
- validation_errors :Optional[ValidationResults]
- definition :Optional[AssistantDefinition]
- class kodexa.model.objects.ExecutionOverview
Bases:
kodexa.model.base.KodexaBaseModel- assistant :Optional[ExecutionAssistant]
- execution :Optional[Execution]
- class kodexa.model.objects.DataAttribute
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- data_object :DataObject
- value :Optional[str]
- truncated :Optional[bool]
- data_exceptions :Optional[List[DataException]]
- tag_metadata :Optional[List[TagMetadata]]
- tag :str
- tag_uuid :Optional[str]
- date_value :Optional[datetime.datetime]
- float_value :Optional[float]
- decimal_value :Optional[float]
- number_value :Optional[int]
- boolean_value :Optional[bool]
- string_value :Optional[str]
- attribute_status :Optional[AttributeStatus]
- validation_state :ValidationState
- validation_messages :Optional[List[AttributeValidationMessage]]
- confidence :Optional[float]
- data_features :Optional[Dict[str, Any]]
- label :Optional[str]
- number_of_notes :Optional[int]
- class kodexa.model.objects.DataObject
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- document_family :DocumentFamily
- data_exceptions :Optional[List[DataException]]
- tag_metadata :Optional[List[TagMetadata]]
- taxonomy_ref :Optional[str]
- path :Optional[str]
- row_num :Optional[int]
- source_ordering :Optional[str]
- date_time :Optional[datetime.datetime]
- lineage :Optional[DataLineage]
- parent_id :Optional[str]
- store_ref :Optional[str]
- taxon :Optional[Taxon]
- class kodexa.model.objects.Assistant
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- subscription :Optional[str]
- schedules :Optional[List[AssistantSchedule]]
- project :Optional[Project]
- name :str
- description :Optional[str]
- assistant_definition_ref :Optional[str]
- logging_enabled :Optional[bool]
- active :Optional[bool]
- run_on_existing_content :Optional[bool]
- options :Optional[Dict[str, Any]]
- validation_errors :Optional[ValidationResults]
- definition :Optional[AssistantDefinition]
- class kodexa.model.objects.SearchContent
Bases:
kodexa.model.base.KodexaBaseModelA document family is the representation of a single peice of external content (ie. a PDF) and all the related document representations of that file
- id :Optional[str]
- store_ref :Optional[str]
- document_family_id :Optional[str]
- container_type :Optional[str]
- container_uuid :Optional[str]
- container_index :Optional[int]
- source_ordering :Optional[int]
- entities :Optional[List[SearchEntity]]
- node_uuid :Optional[str]
- node_type :Optional[str]
- content :Optional[str]
- child_content :Optional[List[str]]
- document_family :Optional[DocumentFamily]
- class kodexa.model.objects.AssistantExecution
Bases:
kodexa.model.base.KodexaBaseModel- assistant_id :Optional[str]
- assistant_name :Optional[str]
- ref :Optional[str]
- options :Optional[Dict[str, Any]]
- option_types :Optional[Dict[str, str]]
- status :Optional[Status4]
- exception_details :Optional[ExceptionDetails]
- event :Optional[Union[AssistantEvent, ContentEvent, ScheduledEvent]]
- response :Optional[AssistantExecutionResponse]
- start_date :Optional[datetime.datetime]
- end_date :Optional[datetime.datetime]
- processing_time :Optional[int]
- class kodexa.model.objects.AssistantExecutionResponse
Bases:
kodexa.model.base.KodexaBaseModel- text :Optional[str]
- pipelines :Optional[List[AssistantResponsePipeline]]
- class kodexa.model.objects.AssistantResponsePipeline
Bases:
kodexa.model.base.KodexaBaseModel- description :Optional[str]
- pipeline :Optional[Pipeline]
- write_back_to_store :Optional[bool]
- data_source_ref :Optional[str]
- taxonomy_refs :Optional[List[str]]
- labels_to_apply :Optional[List[str]]
- logging_enabled :Optional[bool]
- class kodexa.model.objects.BaseEvent
- class kodexa.model.objects.ExecutionEvent
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- type :Type1
- status :Optional[Status5]
- execution :Optional[Execution]
- store_ref :Optional[str]
- document_family_id :Optional[str]
- session_id :str
- token :str
- pipeline :Optional[ExecutionPipeline]
- assistant :Optional[AssistantExecution]
- source :Optional[Dict[str, Any]]
- payload :Optional[Dict[str, Any]]
- input_id :Optional[str]
- platform_url :Optional[str]
- session_call_back_url :Optional[str]
- created :Optional[datetime.datetime]
- start_date :Optional[datetime.datetime]
- end_date :Optional[datetime.datetime]
- class kodexa.model.objects.PageTaxonomy
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[Taxonomy]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PageStore
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[Store]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PageDocumentFamily
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[DocumentFamily]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PlatformEvent
Bases:
kodexa.model.base.KodexaBaseModel- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- date_time :Optional[datetime.datetime]
- assistant :Optional[Assistant]
- event_detail :Optional[Union[AssistantEvent, ContentEvent, ScheduledEvent]]
- document_family :Optional[DocumentFamily]
- class kodexa.model.objects.PageDataObject
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[DataObject]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.AuditEvent
Bases:
kodexa.model.base.KodexaBaseModelAn audit event captures a data to a data structure or document
- id :Optional[str]
- uuid :Optional[str]
- created_on :Optional[datetime.datetime]
- updated_on :Optional[datetime.datetime]
- platform_user :Optional[User]
- document_family :Optional[DocumentFamily]
- data_object :Optional[DataObject]
- data_attribute :Optional[DataAttribute]
- tag :Optional[str]
- event_type :Optional[EventType]
- old_value :Optional[DataAttributeValues]
- new_value :Optional[DataAttributeValues]
- class kodexa.model.objects.PageAuditEvent
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[AuditEvent]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PageDataAttribute
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[DataAttribute]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PageProjectTemplate
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[ProjectTemplate]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PagePipeline
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[Pipeline]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PageModelRuntime
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[ModelRuntime]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PageSlugBasedMetadata
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[Union[Action, AssistantDefinition, Credential, Dashboard, DataForm, ExtensionPack, ModelRuntime, Pipeline, ProjectTemplate, Store, Taxonomy]]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PageExtensionPack
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[ExtensionPack]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PagePlatformEvent
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[PlatformEvent]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PageDataForm
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[DataForm]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PageDashboard
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[Dashboard]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PageCredential
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[Credential]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PageAssistantDefinition
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[AssistantDefinition]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.PageAction
Bases:
kodexa.model.base.KodexaBaseModel- total_pages :Optional[int]
- total_elements :Optional[int]
- first :Optional[bool]
- last :Optional[bool]
- size :Optional[int]
- content :Optional[List[Action]]
- number :Optional[int]
- sort :Optional[Sort]
- number_of_elements :Optional[int]
- pageable :Optional[PageableObject]
- empty :Optional[bool]
- class kodexa.model.objects.DocumentContentMetadata
Bases:
kodexa.model.base.KodexaBaseModel- type :Optional[str]
- class kodexa.model.objects.ModelContentMetadata
Bases:
kodexa.model.base.KodexaBaseModel- type :Optional[str]
- model_runtime_ref :Optional[str]
- state_hash :Optional[str]
- model_runtime_parameters :Optional[Dict[str, Any]]
- state :Optional[State]
- trainable :Optional[bool]
- use_implementation_from_template :Optional[bool]
- template_ref :Optional[str]
- vue_template :Optional[str]
- training_options :Optional[List[Option]]
- training_parameters :Optional[Dict[str, Any]]
- inference_options :Optional[List[Option]]
- inference_parameters :Optional[Dict[str, Any]]
- build_statistics :Optional[Dict[str, Any]]
- final_statistics :Optional[Dict[str, Any]]
- deployment :Optional[DeploymentMetadata]
- taxonomy :Optional[Taxonomy]
- additional_taxon_options :Optional[List[Option]]
- contents :Optional[List[str]]
- ignored_contents :Optional[List[str]]
- base_dir :Optional[str]
- class kodexa.model.objects.Action
Bases:
ExtensionPackProvidedThe definition of an available action
- step :Optional[StepImplementation]
- metadata :Optional[ObjectMetadata]
- class kodexa.model.objects.AssistantDefinition
Bases:
ExtensionPackProvided- template :Optional[bool]
- schedulable :Optional[bool]
- reactive :Optional[bool]
- assistant :Optional[AssistantImplementation]
- metadata :Optional[AssistantMetadata]
- services :Optional[List[SlugBasedMetadata]]
- processing_taxonomies :Optional[List[AssistantTaxonomy]]
- options :Optional[List[Option]]
- additional_taxon_options :Optional[List[Option]]
- event_types :Optional[List[CustomEvent]]
- default_schedules :Optional[List[ScheduleDefinition]]
- subscription :Optional[str]
- class kodexa.model.objects.Credential
Bases:
ExtensionPackProvided- credential_type :Optional[str]
- properties :Optional[Dict[str, Any]]
- class kodexa.model.objects.Dashboard
Bases:
ExtensionPackProvided- rows :Optional[List[DashboardRow]]
- class kodexa.model.objects.DataForm
Bases:
ExtensionPackProvided- sources :Optional[List[DataFormSource]]
- views :Optional[List[DataFormView]]
- class kodexa.model.objects.ExtensionPack
Bases:
kodexa.model.base.KodexaBaseModel- org_slug :Optional[constr(regex='^[a-zA-Z0-9\\-_]{0,100}$')]
- slug :Optional[constr(regex='^[a-zA-Z0-9\\-_]{0,100}$')]
- name :Optional[str]
- description :Optional[str]
- public_access :Optional[bool]
- pack_uri :Optional[str]
- status :Optional[Status]
- deployable :Optional[bool]
- services :Optional[List[SlugBasedMetadata]]
- source :Optional[ExtensionPackSource]
- deployment :Optional[DeploymentMetadata]
- class kodexa.model.objects.ModelRuntime
Bases:
kodexa.model.base.KodexaBaseModel- extension_pack_ref :Optional[str]
- inference_action :Optional[str]
- training_action :Optional[str]
- deployment_type :Optional[DeploymentType1]
- container_url :Optional[str]
- deployment_defaults :Optional[DeploymentMetadata]
- class kodexa.model.objects.Pipeline
Bases:
kodexa.model.base.KodexaBaseModel- extension_pack_ref :Optional[str]
- metadata :Optional[PipelineImplementationMetadata]
- class kodexa.model.objects.ProjectTemplate
Bases:
ExtensionPackProvidedA template for new project
- stores :Optional[List[ProjectStore]]
- assistants :Optional[List[ProjectAssistant]]
- taxonomies :Optional[List[ProjectTaxonomy]]
- dashboards :Optional[List[ProjectDashboard]]
- help_url :Optional[str]
- category :Optional[Category]
- class kodexa.model.objects.Store
Bases:
ExtensionPackProvidedProvides the definition and metadata for a store
- metadata :Optional[ContentMetadata1]
- store_type :Optional[StoreType1]
- searchable :Optional[bool]
- store_purpose :Optional[StorePurpose1]
- view_options :Optional[StoreViewOptions]
- view_presets :Optional[List[ViewPreset]]
- class kodexa.model.objects.Taxonomy
Bases:
ExtensionPackProvidedProvides the taxonomy hierarchy that is used for content and document classification and labeling
- type :Optional[str]
- taxonomy_type :Optional[TaxonomyType1]
- enabled :Optional[bool]
- taxons :Optional[List[Taxon]]
- overlays :Optional[List[Overlay]]
- total_taxons :Optional[int]
- class kodexa.model.objects.AssistantEvent
Bases:
kodexa.model.base.KodexaBaseModel- type :Optional[str]
- content_object :Optional[ContentObject]
- options :Optional[Dict[str, Any]]
- event_type :Optional[str]
- assistant :Optional[Assistant]
- class kodexa.model.objects.ContentEvent
Bases:
kodexa.model.base.KodexaBaseModel- type :Optional[str]
- content_object :Optional[ContentObject]
- document_family :Optional[DocumentFamily]
- object_event_type :Optional[ObjectEventType]
- class kodexa.model.objects.ScheduledEvent
Bases:
kodexa.model.base.KodexaBaseModel- type :Optional[str]
- last_event :Optional[datetime.datetime]
- next_event :Optional[datetime.datetime]