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], 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: 'QA'>

OTHER = <ApplicationType.OTHER: 'OTHER'>

SUMMARIZATION = <ApplicationType.SUMMARIZATION: 'SUMMARIZATION'>

GENERATION = <ApplicationType.GENERATION: 'GENERATION'>

CLASSIFICATION = <ApplicationType.CLASSIFICATION: 'CLASSIFICATION'>

The Enum and its members also have the following methods:

__new__(value)

class ApplicationVersion

Attributes:

custom

description

__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) → 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

class CustomPropertyType

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

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, full_prompt: str, output: str, topic: str, output_properties: Dict[str, Any], input_properties: Dict[str, Any], custom_properties: Dict[str, Any], llm_properties: Dict[str, Any], llm_properties_reasons: Dict[str, Any], created_at: datetime, interaction_datetime: datetime) → 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 LogInteractionType

A dataclass representing an interaction.

Attributes:

inputstr

Input data

outputstr

Output data

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

custom_propsdict, optional

Additional custom properties, defaults to None

information_retrievalstr, optional

Information retrieval, 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

Methods

to_json

__init__(input: str, output: str, full_prompt: str | None = None, annotation: AnnotationType | None = None, user_interaction_id: str | None = None, steps: List[Step] | None = None, custom_props: Dict[str, Any] | None = None, information_retrieval: 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) → 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

Attributes:

annotation

attributes

error

finished_at

input

output

Methods

as_jsonl
to_json

__init__(name: str, type: ~deepchecks_llm_client.data_types.StepType, attributes: ~typing.Dict[str, ~typing.Any] | None = None, started_at: ~datetime.datetime | float = <factory>, annotation: ~deepchecks_llm_client.data_types.AnnotationType | None = None, finished_at: ~datetime.datetime | float | None = None, input: str | None = None, output: str | None = None, error: str | None = None) → None

enum StepType(value)

Member Type:

str

Valid values are as follows:

LLM = <StepType.LLM: 'LLM'>

INFORMATION_RETRIEVAL = <StepType.INFORMATION_RETRIEVAL: 'INFORMATION_RETRIEVAL'>

TRANSFORMATION = <StepType.TRANSFORMATION: 'TRANSFORMATION'>

FILTER = <StepType.FILTER: 'FILTER'>

FINE_TUNING = <StepType.FINE_TUNING: 'FINE_TUNING'>

PII_REMOVAL = <StepType.PII_REMOVAL: 'PII_REMOVAL'>

UDF = <StepType.UDF: 'UDF'>

The Enum and its members also have the following methods:

__new__(value)