prefactor_http.models package
prefactor_http.models package
Section titled “prefactor_http.models package”Prefactor HTTP Client models.
class prefactor_http.models.ActionProfile(, create_data: Literal[‘unknown’, ‘allowed’, ‘disallowed’] = ‘unknown’, read_data: Literal[‘unknown’, ‘allowed’, ‘disallowed’] = ‘unknown’, update_data: Literal[‘unknown’, ‘allowed’, ‘disallowed’] = ‘unknown’, destroy_data: Literal[‘unknown’, ‘allowed’, ‘disallowed’] = ‘unknown’, financial_transactions: Literal[‘unknown’, ‘allowed’, ‘disallowed’] = ‘unknown’, external_communication: Literal[‘unknown’, ‘allowed’, ‘disallowed’] = ‘unknown’)
Section titled “class prefactor_http.models.ActionProfile(, create_data: Literal[‘unknown’, ‘allowed’, ‘disallowed’] = ‘unknown’, read_data: Literal[‘unknown’, ‘allowed’, ‘disallowed’] = ‘unknown’, update_data: Literal[‘unknown’, ‘allowed’, ‘disallowed’] = ‘unknown’, destroy_data: Literal[‘unknown’, ‘allowed’, ‘disallowed’] = ‘unknown’, financial_transactions: Literal[‘unknown’, ‘allowed’, ‘disallowed’] = ‘unknown’, external_communication: Literal[‘unknown’, ‘allowed’, ‘disallowed’] = ‘unknown’)”Bases: BaseModel
Action profile defining what actions a span type performs.
create_data
Section titled “create_data”Whether this span creates data
- Type: Literal[‘unknown’, ‘allowed’, ‘disallowed’]
read_data
Section titled “read_data”Whether this span reads data
- Type: Literal[‘unknown’, ‘allowed’, ‘disallowed’]
update_data
Section titled “update_data”Whether this span updates data
- Type: Literal[‘unknown’, ‘allowed’, ‘disallowed’]
destroy_data
Section titled “destroy_data”Whether this span destroys data
- Type: Literal[‘unknown’, ‘allowed’, ‘disallowed’]
financial_transactions
Section titled “financial_transactions”Whether this span performs financial transactions
- Type: Literal[‘unknown’, ‘allowed’, ‘disallowed’]
external_communication
Section titled “external_communication”Whether this span sends external communications
- Type: Literal[‘unknown’, ‘allowed’, ‘disallowed’]
create_data : Literal[‘unknown’, ‘allowed’, ‘disallowed’]
Section titled “create_data : Literal[‘unknown’, ‘allowed’, ‘disallowed’]”destroy_data : Literal[‘unknown’, ‘allowed’, ‘disallowed’]
Section titled “destroy_data : Literal[‘unknown’, ‘allowed’, ‘disallowed’]”external_communication : Literal[‘unknown’, ‘allowed’, ‘disallowed’]
Section titled “external_communication : Literal[‘unknown’, ‘allowed’, ‘disallowed’]”financial_transactions : Literal[‘unknown’, ‘allowed’, ‘disallowed’]
Section titled “financial_transactions : Literal[‘unknown’, ‘allowed’, ‘disallowed’]”model_config = {}
Section titled “model_config = {}”Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
read_data : Literal[‘unknown’, ‘allowed’, ‘disallowed’]
Section titled “read_data : Literal[‘unknown’, ‘allowed’, ‘disallowed’]”update_data : Literal[‘unknown’, ‘allowed’, ‘disallowed’]
Section titled “update_data : Literal[‘unknown’, ‘allowed’, ‘disallowed’]”class prefactor_http.models.AgentInstance(, type: Literal[‘agent_instance’], id: str, account_id: str, agent_id: str, agent_version_id: str, environment_id: str, status: Literal[‘pending’, ‘active’, ‘complete’, ‘failed’, ‘cancelled’], inserted_at: datetime, updated_at: datetime, started_at: datetime | None = None, finished_at: datetime | None = None, span_counts: AgentInstanceSpanCounts | None = None)
Section titled “class prefactor_http.models.AgentInstance(, type: Literal[‘agent_instance’], id: str, account_id: str, agent_id: str, agent_version_id: str, environment_id: str, status: Literal[‘pending’, ‘active’, ‘complete’, ‘failed’, ‘cancelled’], inserted_at: datetime, updated_at: datetime, started_at: datetime | None = None, finished_at: datetime | None = None, span_counts: AgentInstanceSpanCounts | None = None)”Bases: BaseModel
Agent instance model.
Resource type (always “agent_instance”)
- Type: Literal[‘agent_instance’]
Instance ID
- Type: str
account_id
Section titled “account_id”Account ID
- Type: str
agent_id
Section titled “agent_id”Agent ID
- Type: str
agent_version_id
Section titled “agent_version_id”Agent version ID
- Type: str
environment_id
Section titled “environment_id”Environment ID
- Type: str
status
Section titled “status”Instance status
- Type: AgentStatus
inserted_at
Section titled “inserted_at”When the instance was created
- Type: datetime
updated_at
Section titled “updated_at”When the instance was last updated
- Type: datetime
started_at
Section titled “started_at”When the instance started (null if not started)
- Type: datetime | None
finished_at
Section titled “finished_at”When the instance finished (null if not finished)
- Type: datetime | None
span_counts
Section titled “span_counts”Span counts for this instance
- Type: AgentInstanceSpanCounts | None
account_id : str
Section titled “account_id : str”agent_id : str
Section titled “agent_id : str”agent_version_id : str
Section titled “agent_version_id : str”environment_id : str
Section titled “environment_id : str”finished_at : datetime | None
Section titled “finished_at : datetime | None”id : str
Section titled “id : str”inserted_at : datetime
Section titled “inserted_at : datetime”model_config = {}
Section titled “model_config = {}”Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
span_counts : AgentInstanceSpanCounts | None
Section titled “span_counts : AgentInstanceSpanCounts | None”started_at : datetime | None
Section titled “started_at : datetime | None”status : AgentStatus
Section titled “status : AgentStatus”type : Literal[‘agent_instance’]
Section titled “type : Literal[‘agent_instance’]”updated_at : datetime
Section titled “updated_at : datetime”class prefactor_http.models.AgentInstanceSpanCounts(, total: int, pending: int, active: int, complete: int, failed: int, cancelled: int, finished: int)
Section titled “class prefactor_http.models.AgentInstanceSpanCounts(, total: int, pending: int, active: int, complete: int, failed: int, cancelled: int, finished: int)”Bases: BaseModel
Span counts for an agent instance.
Total number of spans
- Type: int
pending
Section titled “pending”Number of pending spans
- Type: int
active
Section titled “active”Number of active spans
- Type: int
complete
Section titled “complete”Number of completed spans
- Type: int
failed
Section titled “failed”Number of failed spans
- Type: int
cancelled
Section titled “cancelled”Number of cancelled spans
- Type: int
finished
Section titled “finished”Number of finished spans (complete + failed + cancelled)
- Type: int
active : int
Section titled “active : int”cancelled : int
Section titled “cancelled : int”complete : int
Section titled “complete : int”failed : int
Section titled “failed : int”finished : int
Section titled “finished : int”model_config = {}
Section titled “model_config = {}”Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
pending : int
Section titled “pending : int”total : int
Section titled “total : int”class prefactor_http.models.AgentSchemaVersionForRegister(, external_identifier: str | None = None, span_schemas: dict[str, dict] | None = None, span_result_schemas: dict[str, dict] | None = None, span_type_schemas: list[SpanTypeSchemaForCreate] | None = None)
Section titled “class prefactor_http.models.AgentSchemaVersionForRegister(, external_identifier: str | None = None, span_schemas: dict[str, dict] | None = None, span_result_schemas: dict[str, dict] | None = None, span_type_schemas: list[SpanTypeSchemaForCreate] | None = None)”Bases: BaseModel
Schema version information for registration.
external_identifier
Section titled “external_identifier”External identifier for the schema version
- Type: str | None
span_schemas
Section titled “span_schemas”Map of span type names to JSON schemas
- Type: dict[str, dict] | None
span_result_schemas
Section titled “span_result_schemas”Map of span type names to result JSON schemas
- Type: dict[str, dict] | None
span_type_schemas
Section titled “span_type_schemas”List of span type schema details
- Type: list[SpanTypeSchemaForCreate] | None
external_identifier : str | None
Section titled “external_identifier : str | None”model_config = {}
Section titled “model_config = {}”Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
span_result_schemas : dict[str, dict] | None
Section titled “span_result_schemas : dict[str, dict] | None”span_schemas : dict[str, dict] | None
Section titled “span_schemas : dict[str, dict] | None”span_type_schemas : list[SpanTypeSchemaForCreate] | None
Section titled “span_type_schemas : list[SpanTypeSchemaForCreate] | None”class prefactor_http.models.AgentSpan(*, type: ~typing.Literal[‘agent_span’], id: str, account_id: str | None = None, agent_id: str | None = None, agent_instance_id: str, parent_span_id: str | None = None, schema_name: str, schema_title: str | None = None, status: ~typing.Literal[‘pending’, ‘active’, ‘complete’, ‘failed’, ‘cancelled’], payload: dict = , result_payload: dict | None = None, summary: str | None = None, started_at: ~datetime.datetime | None = None, inserted_at: ~datetime.datetime | None = None, updated_at: ~datetime.datetime | None = None, finished_at: ~datetime.datetime | None = None)
Section titled “class prefactor_http.models.AgentSpan(*, type: ~typing.Literal[‘agent_span’], id: str, account_id: str | None = None, agent_id: str | None = None, agent_instance_id: str, parent_span_id: str | None = None, schema_name: str, schema_title: str | None = None, status: ~typing.Literal[‘pending’, ‘active’, ‘complete’, ‘failed’, ‘cancelled’], payload: dict = , result_payload: dict | None = None, summary: str | None = None, started_at: ~datetime.datetime | None = None, inserted_at: ~datetime.datetime | None = None, updated_at: ~datetime.datetime | None = None, finished_at: ~datetime.datetime | None = None)”Bases: BaseModel
Agent span model.
Resource type (always “agent_span”)
- Type: Literal[‘agent_span’]
Span ID
- Type: str
account_id
Section titled “account_id”Account ID
- Type: str | None
agent_id
Section titled “agent_id”Agent ID
- Type: str | None
agent_instance_id
Section titled “agent_instance_id”Agent instance ID
- Type: str
parent_span_id
Section titled “parent_span_id”Parent span ID (None if root span)
- Type: str | None
schema_name
Section titled “schema_name”Name of the schema for this span
- Type: str
schema_title
Section titled “schema_title”Title of the schema for this span
- Type: str | None
status
Section titled “status”Span status
- Type: Literal[‘pending’, ‘active’, ‘complete’, ‘failed’, ‘cancelled’]
payload
Section titled “payload”Span payload data
- Type: dict
result_payload
Section titled “result_payload”Result payload data
- Type: dict | None
summary
Section titled “summary”Optional span summary
- Type: str | None
started_at
Section titled “started_at”When the span started
- Type: datetime.datetime | None
inserted_at
Section titled “inserted_at”When the span was created
- Type: datetime.datetime | None
updated_at
Section titled “updated_at”When the span was last updated
- Type: datetime.datetime | None
finished_at
Section titled “finished_at”When the span finished (None if in progress)
- Type: datetime.datetime | None
account_id : str | None
Section titled “account_id : str | None”agent_id : str | None
Section titled “agent_id : str | None”agent_instance_id : str
Section titled “agent_instance_id : str”finished_at : datetime | None
Section titled “finished_at : datetime | None”id : str
Section titled “id : str”inserted_at : datetime | None
Section titled “inserted_at : datetime | None”model_config = {}
Section titled “model_config = {}”Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
parent_span_id : str | None
Section titled “parent_span_id : str | None”payload : dict
Section titled “payload : dict”result_payload : dict | None
Section titled “result_payload : dict | None”schema_name : str
Section titled “schema_name : str”schema_title : str | None
Section titled “schema_title : str | None”started_at : datetime | None
Section titled “started_at : datetime | None”status : Literal[‘pending’, ‘active’, ‘complete’, ‘failed’, ‘cancelled’]
Section titled “status : Literal[‘pending’, ‘active’, ‘complete’, ‘failed’, ‘cancelled’]”summary : str | None
Section titled “summary : str | None”type : Literal[‘agent_span’]
Section titled “type : Literal[‘agent_span’]”updated_at : datetime | None
Section titled “updated_at : datetime | None”class prefactor_http.models.AgentVersionForRegister(, name: str | None = None, external_identifier: str | None = None, description: str | None = None)
Section titled “class prefactor_http.models.AgentVersionForRegister(, name: str | None = None, external_identifier: str | None = None, description: str | None = None)”Bases: BaseModel
Agent version information for registration.
Name of the agent version
- Type: str | None
external_identifier
Section titled “external_identifier”External identifier for the version (e.g., “v1.0.0”)
- Type: str | None
description
Section titled “description”Optional description of the version
- Type: str | None
description : str | None
Section titled “description : str | None”external_identifier : str | None
Section titled “external_identifier : str | None”model_config = {}
Section titled “model_config = {}”Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
name : str | None
Section titled “name : str | None”class prefactor_http.models.ApiResponse(, status: str, details: T)
Section titled “class prefactor_http.models.ApiResponse(, status: str, details: T)”Bases: BaseModel, Generic[T]
Generic API response wrapper.
status
Section titled “status”Response status (always “success” for successful requests)
- Type: str
details
Section titled “details”Detailed response data
- Type: prefactor_http.models.base.T
details : T
Section titled “details : T”model_config = {}
Section titled “model_config = {}”Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
status : str
Section titled “status : str”class prefactor_http.models.BulkItem(, _type: str, idempotency_key: Annotated[str, MinLen(min_length=8), MaxLen(max_length=64)], **extra_data: Any)
Section titled “class prefactor_http.models.BulkItem(, _type: str, idempotency_key: Annotated[str, MinLen(min_length=8), MaxLen(max_length=64)], **extra_data: Any)”Bases: BaseModel
A single item in a bulk request.
Each item must include _type and idempotency_key, plus any additional parameters required by the specific action type.
idempotency_key : str
Section titled “idempotency_key : str”Required unique idempotency key for this item. Must be at least 8 characters long and unique within the request.
model_config = {‘extra’: ‘allow’}
Section titled “model_config = {‘extra’: ‘allow’}”Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
type : str
Section titled “type : str”The type of query/action to execute (e.g., ‘agents/list’, ‘agents/create’).
class prefactor_http.models.BulkOutput(, status: str, **extra_data: Any)
Section titled “class prefactor_http.models.BulkOutput(, status: str, **extra_data: Any)”Bases: BaseModel
Output from a query or action.
Contains either a success response (with ‘status’: ‘success’ and operation-specific data) or an error response (with ‘status’: ‘error’, ‘code’, ‘message’, and optionally ‘errors’).
model_config = {‘extra’: ‘allow’}
Section titled “model_config = {‘extra’: ‘allow’}”Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
status : str
Section titled “status : str”‘success’ or ‘error’.
- Type: Status of the operation
classmethod validate_status(v: str) → str
Section titled “classmethod validate_status(v: str) → str”class prefactor_http.models.BulkRequest(, items: Annotated[list[BulkItem], MinLen(min_length=1)])
Section titled “class prefactor_http.models.BulkRequest(, items: Annotated[list[BulkItem], MinLen(min_length=1)])”Bases: BaseModel
Request body for bulk query/action operations.
Allows executing multiple API operations in a single request.
items : list[BulkItem]
Section titled “items : list[BulkItem]”List of items to process in bulk. Each item will be processed independently in its own transaction.
model_config = {}
Section titled “model_config = {}”Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
classmethod validate_unique_idempotency_keys(items: list[BulkItem]) → list[BulkItem]
Section titled “classmethod validate_unique_idempotency_keys(items: list[BulkItem]) → list[BulkItem]”Validate that all idempotency keys are unique within the request.
class prefactor_http.models.BulkResponse(, status: str = ‘success’, outputs: dict[str, BulkOutput])
Section titled “class prefactor_http.models.BulkResponse(, status: str = ‘success’, outputs: dict[str, BulkOutput])”Bases: BaseModel
Response from bulk query/action operations.
Contains a map of results keyed by the idempotency_key from each request item.
model_config = {}
Section titled “model_config = {}”Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
outputs : dict[str, BulkOutput]
Section titled “outputs : dict[str, BulkOutput]”Map where keys are the idempotency_key values from the request, and values are the corresponding query/action outputs or error responses.
status : str
Section titled “status : str”Response status, always ‘success’ when the request is processed.
class prefactor_http.models.DataCategories(, personal_identifiers: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, contact_information: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, financial_information: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, health_and_medical: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, criminal_justice: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, authentication_and_secrets: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, organisational_confidential: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, minors_data: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, location_and_tracking: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, behavioural_and_inferred: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, gdpr_racial_or_ethnic_origin: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, gdpr_political_opinions: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, gdpr_religious_or_philosophical_beliefs: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, gdpr_trade_union_membership: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, gdpr_genetic_data: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, gdpr_biometric_for_identification: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, gdpr_sex_life_or_sexual_orientation: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, classification: Literal[‘unknown’, ‘public’, ‘internal’, ‘confidential’, ‘restricted’, ‘secret’] = ‘unknown’)
Section titled “class prefactor_http.models.DataCategories(, personal_identifiers: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, contact_information: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, financial_information: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, health_and_medical: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, criminal_justice: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, authentication_and_secrets: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, organisational_confidential: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, minors_data: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, location_and_tracking: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, behavioural_and_inferred: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, gdpr_racial_or_ethnic_origin: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, gdpr_political_opinions: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, gdpr_religious_or_philosophical_beliefs: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, gdpr_trade_union_membership: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, gdpr_genetic_data: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, gdpr_biometric_for_identification: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, gdpr_sex_life_or_sexual_orientation: Literal[‘unknown’, ‘included’, ‘excluded’] = ‘unknown’, classification: Literal[‘unknown’, ‘public’, ‘internal’, ‘confidential’, ‘restricted’, ‘secret’] = ‘unknown’)”Bases: BaseModel
Data categories present in span data.
personal_identifiers
Section titled “personal_identifiers”Personal identifiers present
- Type: Literal[‘unknown’, ‘included’, ‘excluded’]
contact_information
Section titled “contact_information”Contact information present
- Type: Literal[‘unknown’, ‘included’, ‘excluded’]
financial_information
Section titled “financial_information”Financial information present
- Type: Literal[‘unknown’, ‘included’, ‘excluded’]
health_and_medical
Section titled “health_and_medical”Health and medical data present
- Type: Literal[‘unknown’, ‘included’, ‘excluded’]
criminal_justice
Section titled “criminal_justice”Criminal justice data present
- Type: Literal[‘unknown’, ‘included’, ‘excluded’]
authentication_and_secrets
Section titled “authentication_and_secrets”Authentication and secrets present
- Type: Literal[‘unknown’, ‘included’, ‘excluded’]
organisational_confidential
Section titled “organisational_confidential”Organisational confidential data present
- Type: Literal[‘unknown’, ‘included’, ‘excluded’]
minors_data
Section titled “minors_data”Minors data present
- Type: Literal[‘unknown’, ‘included’, ‘excluded’]
location_and_tracking
Section titled “location_and_tracking”Location and tracking data present
- Type: Literal[‘unknown’, ‘included’, ‘excluded’]
behavioural_and_inferred
Section titled “behavioural_and_inferred”Behavioural and inferred data present
- Type: Literal[‘unknown’, ‘included’, ‘excluded’]
gdpr_racial_or_ethnic_origin
Section titled “gdpr_racial_or_ethnic_origin”GDPR: racial or ethnic origin
- Type: Literal[‘unknown’, ‘included’, ‘excluded’]
gdpr_political_opinions
Section titled “gdpr_political_opinions”GDPR: political opinions
- Type: Literal[‘unknown’, ‘included’, ‘excluded’]
gdpr_religious_or_philosophical_beliefs
Section titled “gdpr_religious_or_philosophical_beliefs”GDPR: religious or philosophical beliefs
- Type: Literal[‘unknown’, ‘included’, ‘excluded’]
gdpr_trade_union_membership
Section titled “gdpr_trade_union_membership”GDPR: trade union membership
- Type: Literal[‘unknown’, ‘included’, ‘excluded’]
gdpr_genetic_data
Section titled “gdpr_genetic_data”GDPR: genetic data
- Type: Literal[‘unknown’, ‘included’, ‘excluded’]
gdpr_biometric_for_identification
Section titled “gdpr_biometric_for_identification”GDPR: biometric data for identification
- Type: Literal[‘unknown’, ‘included’, ‘excluded’]
gdpr_sex_life_or_sexual_orientation
Section titled “gdpr_sex_life_or_sexual_orientation”GDPR: sex life or sexual orientation
- Type: Literal[‘unknown’, ‘included’, ‘excluded’]
classification
Section titled “classification”Classification level (unknown, public, internal, confidential, restricted, secret)
- Type: Literal[‘unknown’, ‘public’, ‘internal’, ‘confidential’, ‘restricted’, ‘secret’]
authentication_and_secrets : Literal[‘unknown’, ‘included’, ‘excluded’]
Section titled “authentication_and_secrets : Literal[‘unknown’, ‘included’, ‘excluded’]”behavioural_and_inferred : Literal[‘unknown’, ‘included’, ‘excluded’]
Section titled “behavioural_and_inferred : Literal[‘unknown’, ‘included’, ‘excluded’]”classification : Literal[‘unknown’, ‘public’, ‘internal’, ‘confidential’, ‘restricted’, ‘secret’]
Section titled “classification : Literal[‘unknown’, ‘public’, ‘internal’, ‘confidential’, ‘restricted’, ‘secret’]”contact_information : Literal[‘unknown’, ‘included’, ‘excluded’]
Section titled “contact_information : Literal[‘unknown’, ‘included’, ‘excluded’]”criminal_justice : Literal[‘unknown’, ‘included’, ‘excluded’]
Section titled “criminal_justice : Literal[‘unknown’, ‘included’, ‘excluded’]”financial_information : Literal[‘unknown’, ‘included’, ‘excluded’]
Section titled “financial_information : Literal[‘unknown’, ‘included’, ‘excluded’]”gdpr_biometric_for_identification : Literal[‘unknown’, ‘included’, ‘excluded’]
Section titled “gdpr_biometric_for_identification : Literal[‘unknown’, ‘included’, ‘excluded’]”gdpr_genetic_data : Literal[‘unknown’, ‘included’, ‘excluded’]
Section titled “gdpr_genetic_data : Literal[‘unknown’, ‘included’, ‘excluded’]”gdpr_political_opinions : Literal[‘unknown’, ‘included’, ‘excluded’]
Section titled “gdpr_political_opinions : Literal[‘unknown’, ‘included’, ‘excluded’]”gdpr_racial_or_ethnic_origin : Literal[‘unknown’, ‘included’, ‘excluded’]
Section titled “gdpr_racial_or_ethnic_origin : Literal[‘unknown’, ‘included’, ‘excluded’]”gdpr_religious_or_philosophical_beliefs : Literal[‘unknown’, ‘included’, ‘excluded’]
Section titled “gdpr_religious_or_philosophical_beliefs : Literal[‘unknown’, ‘included’, ‘excluded’]”gdpr_sex_life_or_sexual_orientation : Literal[‘unknown’, ‘included’, ‘excluded’]
Section titled “gdpr_sex_life_or_sexual_orientation : Literal[‘unknown’, ‘included’, ‘excluded’]”gdpr_trade_union_membership : Literal[‘unknown’, ‘included’, ‘excluded’]
Section titled “gdpr_trade_union_membership : Literal[‘unknown’, ‘included’, ‘excluded’]”health_and_medical : Literal[‘unknown’, ‘included’, ‘excluded’]
Section titled “health_and_medical : Literal[‘unknown’, ‘included’, ‘excluded’]”location_and_tracking : Literal[‘unknown’, ‘included’, ‘excluded’]
Section titled “location_and_tracking : Literal[‘unknown’, ‘included’, ‘excluded’]”minors_data : Literal[‘unknown’, ‘included’, ‘excluded’]
Section titled “minors_data : Literal[‘unknown’, ‘included’, ‘excluded’]”model_config = {}
Section titled “model_config = {}”Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
organisational_confidential : Literal[‘unknown’, ‘included’, ‘excluded’]
Section titled “organisational_confidential : Literal[‘unknown’, ‘included’, ‘excluded’]”personal_identifiers : Literal[‘unknown’, ‘included’, ‘excluded’]
Section titled “personal_identifiers : Literal[‘unknown’, ‘included’, ‘excluded’]”class prefactor_http.models.DataRisk(, action_profile: ActionProfile, params_data_categories: DataCategories, result_data_categories: DataCategories, **extra_data: Any)
Section titled “class prefactor_http.models.DataRisk(, action_profile: ActionProfile, params_data_categories: DataCategories, result_data_categories: DataCategories, **extra_data: Any)”Bases: BaseModel
Data risk specification for a span type.
action_profile
Section titled “action_profile”Actions this span performs
- Type: ActionProfile
params_data_categories
Section titled “params_data_categories”Data categories present in params
- Type: DataCategories
result_data_categories
Section titled “result_data_categories”Data categories present in result
- Type: DataCategories
action_profile : ActionProfile
Section titled “action_profile : ActionProfile”model_config = {‘extra’: ‘allow’}
Section titled “model_config = {‘extra’: ‘allow’}”Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
params_data_categories : DataCategories
Section titled “params_data_categories : DataCategories”result_data_categories : DataCategories
Section titled “result_data_categories : DataCategories”class prefactor_http.models.FinishInstanceRequest(, status: Literal[‘complete’, ‘failed’, ‘cancelled’] | None = None, timestamp: str | None = None, idempotency_key: str | None = None)
Section titled “class prefactor_http.models.FinishInstanceRequest(, status: Literal[‘complete’, ‘failed’, ‘cancelled’] | None = None, timestamp: str | None = None, idempotency_key: str | None = None)”Bases: BaseModel
Request to finish an agent instance.
status
Section titled “status”Optional finish status (complete, failed, cancelled)
- Type: FinishStatus | None
timestamp
Section titled “timestamp”Optional ISO 8601 timestamp (defaults to current time)
- Type: str | None
idempotency_key
Section titled “idempotency_key”Optional idempotency key
- Type: str | None
idempotency_key : str | None
Section titled “idempotency_key : str | None”model_config = {}
Section titled “model_config = {}”Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
status : FinishStatus | None
Section titled “status : FinishStatus | None”timestamp : str | None
Section titled “timestamp : str | None”class prefactor_http.models.SpanTypeSchemaForCreate(, name: str, params_schema: dict, result_schema: dict | None = None, title: str | None = None, description: str | None = None, template: str | None = None, data_risk: DataRisk | None = None)
Section titled “class prefactor_http.models.SpanTypeSchemaForCreate(, name: str, params_schema: dict, result_schema: dict | None = None, title: str | None = None, description: str | None = None, template: str | None = None, data_risk: DataRisk | None = None)”Bases: BaseModel
Span type schema details for registration.
Name of the span type
- Type: str
params_schema
Section titled “params_schema”JSON schema for span parameters
- Type: dict
result_schema
Section titled “result_schema”Optional JSON schema for span results
- Type: dict | None
Optional human-readable title
- Type: str | None
description
Section titled “description”Optional description
- Type: str | None
template
Section titled “template”Optional template string
- Type: str | None
data_risk
Section titled “data_risk”Optional data risk classification
- Type: DataRisk | None
data_risk : DataRisk | None
Section titled “data_risk : DataRisk | None”description : str | None
Section titled “description : str | None”model_config = {}
Section titled “model_config = {}”Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
name : str
Section titled “name : str”params_schema : dict
Section titled “params_schema : dict”result_schema : dict | None
Section titled “result_schema : dict | None”template : str | None
Section titled “template : str | None”title : str | None
Section titled “title : str | None”Submodules
Section titled “Submodules”- prefactor_http.models.agent_instance module
ActionProfileActionProfile.create_dataActionProfile.read_dataActionProfile.update_dataActionProfile.destroy_dataActionProfile.financial_transactionsActionProfile.external_communicationActionProfile.create_dataActionProfile.destroy_dataActionProfile.external_communicationActionProfile.financial_transactionsActionProfile.model_configActionProfile.read_dataActionProfile.update_data
AgentInstanceAgentInstance.typeAgentInstance.idAgentInstance.account_idAgentInstance.agent_idAgentInstance.agent_version_idAgentInstance.environment_idAgentInstance.statusAgentInstance.inserted_atAgentInstance.updated_atAgentInstance.started_atAgentInstance.finished_atAgentInstance.span_countsAgentInstance.account_idAgentInstance.agent_idAgentInstance.agent_version_idAgentInstance.environment_idAgentInstance.finished_atAgentInstance.idAgentInstance.inserted_atAgentInstance.model_configAgentInstance.span_countsAgentInstance.started_atAgentInstance.statusAgentInstance.typeAgentInstance.updated_at
AgentInstanceSpanCountsAgentInstanceSpanCounts.totalAgentInstanceSpanCounts.pendingAgentInstanceSpanCounts.activeAgentInstanceSpanCounts.completeAgentInstanceSpanCounts.failedAgentInstanceSpanCounts.cancelledAgentInstanceSpanCounts.finishedAgentInstanceSpanCounts.activeAgentInstanceSpanCounts.cancelledAgentInstanceSpanCounts.completeAgentInstanceSpanCounts.failedAgentInstanceSpanCounts.finishedAgentInstanceSpanCounts.model_configAgentInstanceSpanCounts.pendingAgentInstanceSpanCounts.total
AgentSchemaVersionForRegisterAgentSchemaVersionForRegister.external_identifierAgentSchemaVersionForRegister.span_schemasAgentSchemaVersionForRegister.span_result_schemasAgentSchemaVersionForRegister.span_type_schemasAgentSchemaVersionForRegister.external_identifierAgentSchemaVersionForRegister.model_configAgentSchemaVersionForRegister.span_result_schemasAgentSchemaVersionForRegister.span_schemasAgentSchemaVersionForRegister.span_type_schemas
AgentVersionForRegisterDataCategoriesDataCategories.personal_identifiersDataCategories.contact_informationDataCategories.financial_informationDataCategories.health_and_medicalDataCategories.criminal_justiceDataCategories.authentication_and_secretsDataCategories.organisational_confidentialDataCategories.minors_dataDataCategories.location_and_trackingDataCategories.behavioural_and_inferredDataCategories.gdpr_racial_or_ethnic_originDataCategories.gdpr_political_opinionsDataCategories.gdpr_religious_or_philosophical_beliefsDataCategories.gdpr_trade_union_membershipDataCategories.gdpr_genetic_dataDataCategories.gdpr_biometric_for_identificationDataCategories.gdpr_sex_life_or_sexual_orientationDataCategories.classificationDataCategories.authentication_and_secretsDataCategories.behavioural_and_inferredDataCategories.classificationDataCategories.contact_informationDataCategories.criminal_justiceDataCategories.financial_informationDataCategories.gdpr_biometric_for_identificationDataCategories.gdpr_genetic_dataDataCategories.gdpr_political_opinionsDataCategories.gdpr_racial_or_ethnic_originDataCategories.gdpr_religious_or_philosophical_beliefsDataCategories.gdpr_sex_life_or_sexual_orientationDataCategories.gdpr_trade_union_membershipDataCategories.health_and_medicalDataCategories.location_and_trackingDataCategories.minors_dataDataCategories.model_configDataCategories.organisational_confidentialDataCategories.personal_identifiers
DataRiskFinishInstanceRequestRegisterAgentInstanceRequestRegisterAgentInstanceRequest.agent_idRegisterAgentInstanceRequest.agent_versionRegisterAgentInstanceRequest.agent_schema_versionRegisterAgentInstanceRequest.idRegisterAgentInstanceRequest.idempotency_keyRegisterAgentInstanceRequest.update_current_versionRegisterAgentInstanceRequest.agent_idRegisterAgentInstanceRequest.agent_schema_versionRegisterAgentInstanceRequest.agent_versionRegisterAgentInstanceRequest.idRegisterAgentInstanceRequest.idempotency_keyRegisterAgentInstanceRequest.model_configRegisterAgentInstanceRequest.update_current_version
SpanTypeSchemaForCreateSpanTypeSchemaForCreate.nameSpanTypeSchemaForCreate.params_schemaSpanTypeSchemaForCreate.result_schemaSpanTypeSchemaForCreate.titleSpanTypeSchemaForCreate.descriptionSpanTypeSchemaForCreate.templateSpanTypeSchemaForCreate.data_riskSpanTypeSchemaForCreate.data_riskSpanTypeSchemaForCreate.descriptionSpanTypeSchemaForCreate.model_configSpanTypeSchemaForCreate.nameSpanTypeSchemaForCreate.params_schemaSpanTypeSchemaForCreate.result_schemaSpanTypeSchemaForCreate.templateSpanTypeSchemaForCreate.title
TimestampRequest
- prefactor_http.models.agent_span module
AgentSpanAgentSpan.typeAgentSpan.idAgentSpan.account_idAgentSpan.agent_idAgentSpan.agent_instance_idAgentSpan.parent_span_idAgentSpan.schema_nameAgentSpan.schema_titleAgentSpan.statusAgentSpan.payloadAgentSpan.result_payloadAgentSpan.summaryAgentSpan.started_atAgentSpan.inserted_atAgentSpan.updated_atAgentSpan.finished_atAgentSpan.account_idAgentSpan.agent_idAgentSpan.agent_instance_idAgentSpan.finished_atAgentSpan.idAgentSpan.inserted_atAgentSpan.model_configAgentSpan.parent_span_idAgentSpan.payloadAgentSpan.result_payloadAgentSpan.schema_nameAgentSpan.schema_titleAgentSpan.started_atAgentSpan.statusAgentSpan.summaryAgentSpan.typeAgentSpan.updated_at
CreateAgentSpanRequestCreateAgentSpanRequest.agent_instance_idCreateAgentSpanRequest.schema_nameCreateAgentSpanRequest.statusCreateAgentSpanRequest.payloadCreateAgentSpanRequest.result_payloadCreateAgentSpanRequest.idCreateAgentSpanRequest.parent_span_idCreateAgentSpanRequest.started_atCreateAgentSpanRequest.finished_atCreateAgentSpanRequest.idempotency_keyCreateAgentSpanRequest.agent_instance_idCreateAgentSpanRequest.finished_atCreateAgentSpanRequest.idCreateAgentSpanRequest.idempotency_keyCreateAgentSpanRequest.model_configCreateAgentSpanRequest.parent_span_idCreateAgentSpanRequest.payloadCreateAgentSpanRequest.result_payloadCreateAgentSpanRequest.schema_nameCreateAgentSpanRequest.started_atCreateAgentSpanRequest.status
FinishSpanRequest
- prefactor_http.models.base module
ApiErrorApiResponseDetailedApiErrorListResponsePaginationOutputPaginationOutput.item_countPaginationOutput.item_endPaginationOutput.item_startPaginationOutput.next_page_offsetPaginationOutput.page_countPaginationOutput.page_indexPaginationOutput.page_offsetPaginationOutput.page_sizePaginationOutput.previous_page_offsetPaginationOutput.item_countPaginationOutput.item_endPaginationOutput.item_startPaginationOutput.model_configPaginationOutput.next_page_offsetPaginationOutput.page_countPaginationOutput.page_indexPaginationOutput.page_offsetPaginationOutput.page_sizePaginationOutput.previous_page_offset
Sorting
- prefactor_http.models.bulk module
- prefactor_http.models.types module