Data Types#

enum AnnotationType(value)#

Member Type:

str

Valid values are as follows:

GOOD = <AnnotationType.GOOD: 'good'>#

BAD = <AnnotationType.BAD: 'bad'>#

UNKNOWN = <AnnotationType.UNKNOWN: 'unknown'>#

The Enum and its members also have the following methods:

__new__(value)#

class Application#

Attributes:

description

log_latest_insert_time_epoch

n_of_interactions

n_of_llm_properties

notifications_enabled

__init__(id: int, name: str, kind: ApplicationType, created_at: datetime, updated_at: datetime, in_progress: bool, versions: List[ApplicationVersion], interaction_types: List[str], description: str | None = None, log_latest_insert_time_epoch: int | None = None, n_of_llm_properties: int | None = None, n_of_interactions: int | None = None, notifications_enabled: bool | None = None) → None#

enum ApplicationType(value)#

Member Type:

str

Valid values are as follows:

QA = <ApplicationType.QA: 'Q&A'>#

OTHER = <ApplicationType.OTHER: 'OTHER'>#

SUMMARIZATION = <ApplicationType.SUMMARIZATION: 'SUMMARIZATION'>#

GENERATION = <ApplicationType.GENERATION: 'GENERATION'>#

CLASSIFICATION = <ApplicationType.CLASSIFICATION: 'CLASSIFICATION'>#

FEATURE_EXTRACTION = <ApplicationType.FEATURE_EXTRACTION: 'FEATURE EXTRACTION'>#

The Enum and its members also have the following methods:

__new__(value)#

class ApplicationVersion#

A dataclass representing an Application Version.

Attributes:

idint

Version id

namestr

Version name

ai_modelstr

AI model used within this version

created_atdatetime

Version created at timestamp

updated_atdatetime

Version updated at timestamp

customlist of dict

Additional details about the version as key-value pairs This member is deprecated. It will be removed in future versions. Use additional_fields instead.

additional_fieldslist of dict

Additional details about the version as key-value pairs

__init__(id: int, name: str, ai_model: str, created_at: datetime, updated_at: datetime, description: str | None = None, custom: List[Dict[str, Any]] | None = None, additional_fields: Dict[str, Any] | None = None) → None#

class ApplicationVersionSchema#

Attributes:

additional_fields

description

Methods

to_json

__init__(name: str, description: str | None = None, additional_fields: Dict[str, Any] | None = None) → None#

enum BuiltInInteractionType(value)#

Member Type:

str

Valid values are as follows:

QA = <BuiltInInteractionType.QA: 'Q&A'>#

OTHER = <BuiltInInteractionType.OTHER: 'Other'>#

SUMMARIZATION = <BuiltInInteractionType.SUMMARIZATION: 'Summarization'>#

CLASSIFICATION = <BuiltInInteractionType.CLASSIFICATION: 'Classification'>#

GENERATION = <BuiltInInteractionType.GENERATION: 'Generation'>#

FEATURE_EXTRACTION = <BuiltInInteractionType.FEATURE_EXTRACTION: 'Feature Extraction'>#

The Enum and its members also have the following methods:

__new__(value)#

enum EnvType(value)#

Member Type:

str

Valid values are as follows:

PROD = <EnvType.PROD: 'PROD'>#

EVAL = <EnvType.EVAL: 'EVAL'>#

PENTEST = <EnvType.PENTEST: 'PENTEST'>#

The Enum and its members also have the following methods:

__new__(value)#

class Interaction#

__init__(user_interaction_id: str, input: str, information_retrieval: str, history: str, full_prompt: str, expected_output: str, output: str, topic: str, output_properties: Dict[str, Any], input_properties: Dict[str, Any], user_value_properties: Dict[str, Any], llm_properties: Dict[str, Any], llm_properties_reasons: Dict[str, Any], created_at: datetime, interaction_datetime: datetime, is_completed: bool, interaction_type: str, session_id: str) → None#

enum InteractionCompleteEvents(value)#

Member Type:

str

Valid values are as follows:

TOPICS_COMPLETED = <InteractionCompleteEvents.TOPICS_COMPLETED: 'topics_completed'>#

PROPERTIES_COMPLETED = <InteractionCompleteEvents.PROPERTIES_COMPLETED: 'properties_completed'>#

SIMILARITY_COMPLETED = <InteractionCompleteEvents.SIMILARITY_COMPLETED: 'similarity_completed'>#

LLM_PROPERTIES_COMPLETED = <InteractionCompleteEvents.LLM_PROPERTIES_COMPLETED: 'llm_properties_completed'>#

ANNOTATION_COMPLETED = <InteractionCompleteEvents.ANNOTATION_COMPLETED: 'annotation_completed'>#

DC_EVALUATION_COMPLETED = <InteractionCompleteEvents.DC_EVALUATION_COMPLETED: 'dc_evaluation_completed'>#

The Enum and its members also have the following methods:

__new__(value)#

class InteractionType#

__init__(id: int, name: str, is_builtin_type: bool, is_active: bool) → None#

class LogInteraction#

A dataclass representing an interaction.

Attributes:

inputstr

Input data

outputstr

Output data

expected_outputstr, optional

Full expected output data, defaults to None

full_promptstr, optional

Full prompt data, defaults to None

annotationAnnotationType, optional

Annotation type of the interaction, defaults to None

user_interaction_idstr, optional

Unique identifier of the interaction, defaults to None

stepslist of Step, optional

List of steps taken during the interaction, defaults to None

user_value_propertieslist of UserValueProperty, optional

Additional user value properties, defaults to None

information_retrievalstr, optional

Information retrieval, defaults to None

historystr, optional

History (for instance “chat history”), defaults to None

annotation_reasonstr, optional

Reason for the annotation, defaults to None

started_atdatetime or float, optional

Timestamp the interaction started at. Datetime format is deprecated, use timestamp instead

finished_atdatetime or float, optional

Timestamp the interaction finished at. Datetime format is deprecated, use timestamp instead

vuln_typestr, optional

Type of vulnerability (Only used in case of EnvType.PENTEST and must be sent there), defaults to None

vuln_trigger_strstr, optional

Vulnerability trigger string (Only used in case of EnvType.PENTEST and is optional there), defaults to None

session_id: str, optional

The identifier for the session associated with this interaction. If not provided, a session ID will be automatically generated.

interaction_type: str, optional

The type of interaction. None is deprecated. If not provided, the interaction type will default to the application’s default type.

Methods

to_json

__init__(input: str | None = None, output: str | None = None, expected_output: str | None = None, full_prompt: str | None = None, annotation: AnnotationType | str | None = None, user_interaction_id: str | int | None = None, steps: List[Step] | None = None, user_value_properties: List[UserValueProperty] | None = None, information_retrieval: str | List[str] | None = None, history: str | List[str] | None = None, annotation_reason: str | None = None, started_at: datetime | float | None = None, finished_at: datetime | float | None = None, vuln_type: str | None = None, vuln_trigger_str: str | None = None, topic: str | None = None, is_completed: bool = True, interaction_type: str | None = None, session_id: str | int | None = None) → None#

enum PropertyColumnType(value)#

Member Type:

str

Valid values are as follows:

CATEGORICAL = <PropertyColumnType.CATEGORICAL: 'categorical'>#

NUMERIC = <PropertyColumnType.NUMERIC: 'numeric'>#

The Enum and its members also have the following methods:

__new__(value)#

class Step#

Methods

as_jsonl
to_json

__init__(name: str, value: str) → None#

class UserValueProperty#

Data class representing user provided property

Attributes:

reason

__init__(name: str, value: Any, reason: str | None = None) → None#

class UserValuePropertyType#

__init__(display_name: str, type: PropertyColumnType | str, description: str) → None#