Skip to content

Literalai

literalai_callback_handler #

literalai_callback_handler(batch_size: int = 5, api_key: Optional[str] = None, url: Optional[str] = None, environment: Optional[str] = None, disabled: bool = False) -> BaseCallbackHandler
Source code in llama-index-integrations/callbacks/llama-index-callbacks-literalai/llama_index/callbacks/literalai/base.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
def literalai_callback_handler(
    batch_size: int = 5,
    api_key: Optional[str] = None,
    url: Optional[str] = None,
    environment: Optional[str] = None,
    disabled: bool = False,
) -> BaseCallbackHandler:
    try:
        from literalai import LiteralClient
        from literalai.my_types import Environment

        literalai_client = LiteralClient(
            batch_size=batch_size,
            api_key=api_key,
            url=url,
            environment=cast(Environment, environment),
            disabled=disabled,
        )
        literalai_client.instrument_llamaindex()

        class QueryEndEventHandler(BaseEventHandler):
            """This handler will flush the Literal Client cache to Literal AI at the end of each query."""

            @classmethod
            def class_name(cls) -> str:
                """Class name."""
                return "QueryEndEventHandler"

            def handle(self, event: BaseEvent, **kwargs) -> None:
                """Flushes the Literal cache when receiving the QueryEnd event."""
                try:
                    if isinstance(event, QueryEndEvent):
                        literalai_client.flush()
                except Exception as e:
                    logging.error(
                        "Error in Literal AI global handler : %s",
                        str(e),
                        exc_info=True,
                    )

        dispatcher = get_dispatcher()
        event_handler = QueryEndEventHandler()
        dispatcher.add_event_handler(event_handler)

    except ImportError:
        raise ImportError(
            "Please install the Literal AI Python SDK with `pip install -U literalai`"
        )