Pipeline Execution

AgentBaseStepResult

Bases: BaseModel

Base class for agent step results.

Attributes:

Name	Type	Description
step_type	str	Type of the step (e.g., "LLMStep", "ToolStep", "ConditionalStep").
step_id	UUID	Unique identifier for this step execution.
type	str	Discriminator field for polymorphic deserialization ($type field).

GetPipelineExecutionResponse

Bases: BaseModel

Response model for get_pipeline_execution requests.

Attributes:

Name	Type	Description
execution_id	UUID	Execution result ID.
pipeline_id	UUID	Pipeline ID.
tenant_id	UUID	Tenant ID.
project_id	UUID	Project ID.
log_record_details	Optional[PipelineExecutionLogDetails]	Pipeline execution log details.
step_execution_log_records	Optional[list[StepExecutionLogRecord]]	Step execution logs associated to the pipeline.

PipelineExecutionAsyncStreamedResponse

Bases: BaseModel

Response model for streaming pipeline execution requests (asynchronous client).

This model contains an async iterator that yields SSEMessage objects as they are received from the streaming response.

Attributes:

Name	Type	Description
stream	AsyncIterator[SSEMessage]	Async iterator that yields SSEMessage objects from the streaming response

PipelineExecutionLogDetails

Bases: BaseModel

Pipeline execution log details.

Attributes:

Name	Type	Description
duration	Optional[str]	Duration of the execution (e.g., "00:00:00.0000000").
started_at	Optional[datetime]	Start date for the pipeline execution.
finished_at	Optional[datetime]	End date for the pipeline execution.
success	Optional[bool]	Success indicator for the pipeline execution.
exception	Optional[str]	First exception for the pipeline execution if any.

PipelineExecutionResponse

Bases: BaseModel

Response model for pipeline execution requests in mode.

Attributes:

Name	Type	Description
result	Optional[str]	The execution result as a string
report	Optional[Dict[str, PipelineStepResult]]	Optional Dictionary containing debugging information and execution details
is_backup_pipeline	bool	Whether a backup pipeline was used for execution
execution_id	UUID	Unique execution identifier
user_input_id	Optional[UUID]	Identifier for the user input associated with the pipeline execution
files	Optional[List[str]]	Files processed during the pipeline execution
images	Optional[List[str]]	Images processed during the pipeline execution

PipelineExecutionStreamedResponse

Bases: BaseModel

Response model for streaming pipeline execution requests (synchronous client).

This model contains an iterator that yields SSEMessage objects as they are received from the streaming response.

Attributes:

Name	Type	Description
stream	Iterator[SSEMessage]	Iterator that yields SSEMessage objects from the streaming response

PipelineStepResult

Bases: BaseModel

Result of a pipeline step execution.

Attributes:

Name	Type	Description
step_id	UUID	Unique identifier for the step.
step_type	Optional[str]	Type of step that was executed (e.g., "LLMStep", "ToolStep").
step_title	str	Human-readable title/name of the step.
result	Optional[AgentBaseStepResult]	Output result from the step execution. None if step failed or produced no output.
input	List[AgentBaseStepResult]	List of input data that was passed to this step.
success	Optional[bool]	Whether the step executed successfully. None if status is indeterminate.
completion_status	str	Status of step completion (e.g., "Success", "Failed", "Skipped").
time_tracking_data	Optional[TimeTrackingData]	Timing information for this step's execution.
exception_message	Optional[str]	Error message if the step failed. None if successful.
debug_information	Dict[str, Any]	Additional debug data and metadata from step execution.

StepExecutionLogRecord

Bases: BaseModel

Step execution log record.

Attributes:

Name	Type	Description
pipeline_id	UUID	Pipeline ID.
step_id	UUID	Step ID.
step_type	Optional[str]	Step type (e.g., "AIOperation", "dataSearch", etc.).
step_title	Optional[str]	Step title.
duration	Optional[str]	Duration of the execution (e.g., "00:00:00.0000000").
started_at	Optional[datetime]	Start date for the step execution.
finished_at	Optional[datetime]	End date for the step execution.
success	Optional[bool]	Success indicator for the step execution.
exception	Optional[str]	First exception for the step execution if any.

TemporaryAssistantAsyncStreamedResponse

Bases: BaseModel

Response model for streaming TemporaryAssistant requests (asynchronous client).

Attributes:

Name	Type	Description
stream	AsyncIterator[SSEMessage]	Async iterator that yields SSEMessage objects as they arrive from the streaming response. Each message contains incremental data from the assistant's response.

TemporaryAssistantResponse

Bases: BaseModel

Response model for TemporaryAssistant pipeline execution.

This model represents the response from the TemporaryAssistant endpoint, which can return either string or array results based on the discriminator.

Attributes:

Name	Type	Description
type	Literal['string', 'objectArray']	Discriminator field indicating the response type
report	Optional[Dict[str, PipelineStepResult]]	Pipeline execution debug report (optional)
is_backup_pipeline	bool	Whether a backup pipeline was used
execution_id	UUID	Unique execution identifier
user_input_id	Optional[UUID]	Identifier for the user input
files	Optional[List[str]]	Files processed during execution
images	Optional[List[str]]	Images processed during execution

TemporaryAssistantStreamedResponse

Bases: BaseModel

Response model for streaming TemporaryAssistant requests (synchronous client).

Attributes:

Name	Type	Description
stream	Iterator[SSEMessage]	Iterator that yields SSEMessage objects as they arrive from the streaming response. Each message contains incremental data from the assistant's response.

TimeTrackingData

Bases: BaseModel

Time tracking data for pipeline execution.

Attributes:

Name	Type	Description
duration	Optional[str]	Human-readable duration string (e.g., "2.5s", "1m 30s"). None if execution not completed.
started_at	datetime	Timestamp when the execution started.
finished_at	Optional[datetime]	Timestamp when the execution finished. None if still running or failed.