Skip to content

API_REFERENCE.md

Latest commit

 

History

History
102 lines (70 loc) · 2.99 KB

API_REFERENCE.md

File metadata and controls

102 lines (70 loc) · 2.99 KB
Raw

Quasar API Reference

This reference describes the public Quasar facade for standalone and host-embedded use. Runtime entrances, registries, adapters, and tools are explicitly assembled; Core does not discover legacy modules or persistence backends.

Import

from Quasar.cai import CAIApp, CAIRuntime, ChatRequest, RuntimeBuilder, StreamEvent

When Quasar is embedded in a host application, the host can import the same facade through Quasar.cai and install plugins into the current CAIApp.

CAIApp

CAIApp(runtime) is the host-facing facade. New integrations should pass an explicitly built runtime.

Main methods:

  • chat_stream(request): accepts ChatRequest or a legacy payload dict; returns an iterator of legacy stream chunks.
  • chat(request): collects chat_stream() into a list.
  • register_tool(tool), register_tools(tools): register tools into the runtime tool registry.
  • register_workflow(workflow): register a workflow into the runtime workflow registry.
  • register_plugin(plugin): install a CAIPlugin into the runtime.
  • reset_session(session_id): clears session state when supported by the conversation store.
  • get_session_info(session_id): returns a session snapshot when supported.
  • shutdown(): shuts down registered plugins.

CAIRuntime

CAIRuntime owns runtime metadata, capabilities, entrance handlers, plugins, and lifecycle. Its defaults are in-memory capabilities only.

Useful methods:

  • get_registry(name): resolve an explicitly registered registry.
  • set_registry(name, registry): override a registry for tests or host integration.
  • set_capability(name, value) and get_capability(name): attach host capabilities to the runtime.
  • register_tool_loader_registrar(registrar): attach host tool loader registration callbacks.
  • register_entrance_handler(name, handler): provide a handler used by legacy-compatible calls.

ChatRequest

ChatRequest is the minimal request object used by the facade.

request = ChatRequest.from_text(
    "请总结这段文字",
    session_id="demo",
    metadata={"request_id": "req_demo"},
)

It can also wrap an existing legacy payload:

request = ChatRequest.from_any(payload)
legacy_payload = request.to_legacy_payload()

StreamEvent

StreamEvent normalizes legacy stream chunks into event-like objects:

event = StreamEvent.from_legacy_chunk(chunk)
print(event.event_type, event.session_id, event.metadata)

Current event detection recognizes data, heartbeat, done, and error from legacy chunk fields.

Plugins

Plugins implement the minimal CAIPlugin protocol:

class MyPlugin:
    name = "my.plugin"
    enabled = True

    def register(self, runtime):
        runtime.set_capability("my_capability", object())
        return {"name": self.name}

Install with:

app.register_plugin(MyPlugin())

Packaging

From this directory:

python -m pip install -e .

Then import with:

from Quasar.cai import CAIApp