morpheus_llm.stages.output.write_to_vector_db_stage.WriteToVectorDBStage#

class WriteToVectorDBStage(

config,

service,

resource_name,

embedding_column_name='embedding',

recreate=False,

resource_kwargs=None,

batch_size=1024,

write_time_interval=3.0,

resource_schemas=None,

**service_kwargs,

)[source]#

Bases: PassThruTypeMixin, SinglePortStage

Writes messages to a Vector Database.

Parameters:

configConfig: Pipeline configuration instance.
servicetyping.Union[str, VectorDBService]: Either the name of the vector database service to use or an instance of VectorDBService for managing the resource.
resource_namestr: The identifier of the resource on which operations are to be performed in the vector database.
embedding_column_namestr, optional: Name of the embedding column, by default “embedding”.
recreatebool, optional: Specifies whether to recreate the resource if it already exists, by default False.
resource_kwargsdict, optional: Additional keyword arguments to pass when performing vector database writes on a given resource.
batch_sizeint: Accumulates messages until reaching the specified batch size for writing to VDB.
write_time_intervalfloat: Specifies the time interval (in seconds) for writing messages, or writing messages when the accumulated batch size is reached.
**service_kwargsdict: Additional keyword arguments to pass when creating a VectorDBService instance.

Raises:

ValueError: If service is not a valid string (service name) or an instance of VectorDBService.

Attributes:

has_multi_input_ports: Indicates if this stage has multiple input ports.
has_multi_output_ports: Indicates if this stage has multiple output ports.
input_ports: Input ports to this stage.
is_built: Indicates if this stage has been built.
is_pre_built: Indicates if this stage has been built.
name: The name of the stage.
output_ports: Output ports from this stage.
unique_name: Unique name of stage.

Methods

`accepted_types`()	Returns accepted input types for this stage.
`build`(builder[, do_propagate])	Build this stage.
`can_build`([check_ports])	Determines if all inputs have been built allowing this node to be built.
`can_pre_build`([check_ports])	Determines if all inputs have been built allowing this node to be built.
`get_all_input_stages`()	Get all input stages to this stage.
`get_all_inputs`()	Get all input senders to this stage.
`get_all_output_stages`()	Get all output stages from this stage.
`get_all_outputs`()	Get all output receivers from this stage.
`get_needed_columns`()	Stages which need to have columns inserted into the dataframe, should populate the `self._needed_columns` dictionary with mapping of column names to `morpheus.common.TypeId`.
`join`()	Awaitable method that stages can implement this to perform cleanup steps when pipeline is stopped.
`start_async`()	This function is called along with on_start during stage initialization.
`stop`()	Stages can implement this to perform cleanup steps when pipeline is stopped.
`supported_execution_modes`()	Returns a tuple of supported execution modes of this stage.
`supports_cpp_node`()	Indicates whether this stage supports a C++ node.

compute_schema

_build(builder, input_nodes)[source]#

This function is responsible for constructing this stage’s internal mrc.SegmentObject object. The input of this function contains the returned value from the upstream stage.

The input values are the mrc.Builder for this stage and a list of parent nodes.

Parameters:

buildermrc.Builder: mrc.Builder object for the pipeline. This should be used to construct/attach the internal mrc.SegmentObject.
input_nodeslist[mrc.SegmentObject]: List containing the input mrc.SegmentObject objects.

Returns:

list[mrc.SegmentObject]: List of tuples containing the output mrc.SegmentObject object from this stage.

accepted_types()[source]#

Returns accepted input types for this stage.

Returns:

typing.Tuple(ControlMessage,): Accepted input types.

build(builder, do_propagate=True)[source]#

Build this stage.

Parameters:

buildermrc.Builder: MRC segment for this stage.
do_propagatebool, optional: Whether to propagate to build output stages, by default True.

can_build(check_ports=False)[source]#

Determines if all inputs have been built allowing this node to be built.

Parameters:

check_portsbool, optional: Check if we can build based on the input ports, by default False.

Returns:

bool: True if we can build, False otherwise.

can_pre_build(check_ports=False)[source]#

Determines if all inputs have been built allowing this node to be built.

Parameters:

check_portsbool, optional: Check if we can build based on the input ports, by default False.

Returns:

bool: True if we can build, False otherwise.

compute_schema(schema)[source]#

Compute the schema for this stage based on the incoming schema from upstream stages.

Incoming schema and type information from upstream stages is available via the schema.input_schemas and schema.input_types properties.

Derived classes need to override this method, can set the output type(s) on schema by calling set_type for all output ports. For example a simple pass-thru stage might perform the following:

>>> for (port_idx, port_schema) in enumerate(schema.input_schemas):
...     schema.output_schemas[port_idx].set_type(port_schema.get_type())
>>>

If the port types in upstream_schema are incompatible the stage should raise a RuntimeError.

get_all_input_stages()[source]#

Get all input stages to this stage.

Returns:

list[morpheus.pipeline.pipeline.StageBase]: All input stages.

get_all_inputs()[source]#

Get all input senders to this stage.

Returns:

list[morpheus.pipeline.pipeline.Sender]: All input senders.

get_all_output_stages()[source]#

Get all output stages from this stage.

Returns:

list[morpheus.pipeline.pipeline.StageBase]: All output stages.

get_all_outputs()[source]#

Get all output receivers from this stage.

Returns:

list[morpheus.pipeline.pipeline.Receiver]: All output receivers.

get_needed_columns()[source]#: Stages which need to have columns inserted into the dataframe, should populate the self._needed_columns dictionary with mapping of column names to morpheus.common.TypeId. This will ensure that the columns are allocated and populated with null values.

property has_multi_input_ports: bool#

Indicates if this stage has multiple input ports.

Returns:

bool: True if stage has multiple input ports, False otherwise.

property has_multi_output_ports: bool#

Indicates if this stage has multiple output ports.

Returns:

bool: True if stage has multiple output ports, False otherwise.

property input_ports: list[Receiver]#

Input ports to this stage.

Returns:

list[morpheus.pipeline.pipeline.Receiver]: Input ports to this stage.

property is_built: bool#

Indicates if this stage has been built.

Returns:

bool: True if stage is built, False otherwise.

property is_pre_built: bool#

Indicates if this stage has been built.

Returns:

bool: True if stage is built, False otherwise.

async join()[source]#: Awaitable method that stages can implement this to perform cleanup steps when pipeline is stopped. Typically this is called after stop during a graceful shutdown, but may not be called if the pipeline is terminated.

property name: str#

The name of the stage. Used in logging. Each derived class should override this property with a unique name.

Returns:

str: Name of a stage.

property output_ports: list[Sender]#

Output ports from this stage.

Returns:

list[morpheus.pipeline.pipeline.Sender]: Output ports from this stage.

async start_async()[source]#: This function is called along with on_start during stage initialization. Allows stages to utilize the asyncio loop if needed.

stop()[source]#: Stages can implement this to perform cleanup steps when pipeline is stopped.

supported_execution_modes()[source]#

Returns a tuple of supported execution modes of this stage. By default this returns (ExecutionMode.GPU,). Subclasses can override this method to specify different execution modes.

For most stages the values will be static, and this can be accomplished by making use of either the CpuOnlyMixin or GpuAndCpuMixin mixins.

However, complex stages may choose to make this decision at runtime, in which case this method should be overridden. directly within the stage class.

supports_cpp_node()[source]#: Indicates whether this stage supports a C++ node.

property unique_name: str#

Unique name of stage. Generated by appending stage id to stage name.

Returns:

str: Unique name of stage.