Skip to content

Rapidata flow

RapidataFlow #

RapidataFlow(
    id: str,
    name: str,
    openapi_service: OpenAPIService,
    flow_type: FlowType,
)
Source code in src/rapidata/rapidata_client/flow/rapidata_flow.py 
19
20
21
22
23
24
25
26
27
28
29
def __init__(
    self,
    id: str,
    name: str,
    openapi_service: OpenAPIService,
    flow_type: FlowType,
):
    self.id = id
    self.name = name
    self._openapi_service = openapi_service
    self._flow_type: FlowType = flow_type

get_flow_items #

get_flow_items(
    amount: int = 10, page: int = 1
) -> list[RapidataFlowItem]

Query flow items for this flow, newest first.

Source code in src/rapidata/rapidata_client/flow/rapidata_flow.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
def get_flow_items(self, amount: int = 10, page: int = 1) -> list[RapidataFlowItem]:
    """Query flow items for this flow, newest first."""
    with tracer.start_as_current_span("RapidataFlow.get_flow_items"):
        from rapidata.rapidata_client.flow.rapidata_flow_item import (
            RapidataFlowItem,
        )

        logger.debug("Getting flow items for flow '%s'", self.name)

        response = self._openapi_service.flow.ranking_flow_item_api.flow_ranking_flow_id_item_get(
            flow_id=self.id,
            sort=["-created_at"],
            page=page,
            page_size=amount,
        )

        return [
            RapidataFlowItem(
                id=item.id,
                flow_id=self.id,
                openapi_service=self._openapi_service,
                flow_type=self._flow_type,
            )
            for item in response.items
        ]

delete #

delete() -> None

Soft delete this flow.

Source code in src/rapidata/rapidata_client/flow/rapidata_flow.py 
85
86
87
88
89
def delete(self) -> None:
    """Soft delete this flow."""
    with tracer.start_as_current_span("RapidataFlow.delete"):
        logger.debug("Deleting flow '%s'", self.name)
        self._openapi_service.flow.flow_api.flow_flow_id_delete(flow_id=self.id)