Skip to content

Protocol Reference

nautilus_adapter_sdk.protocols

Protocol definitions for Nautilus adapters and embedders.

Adapter

Bases: Protocol

Protocol that all data-source adapters must satisfy.

Source code in packages/nautilus-adapter-sdk/src/nautilus_adapter_sdk/protocols.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
@runtime_checkable
class Adapter(Protocol):
    """Protocol that all data-source adapters must satisfy."""

    source_type: ClassVar[str]

    async def connect(self, config: SourceConfig) -> None: ...

    async def execute(
        self,
        intent: IntentAnalysis,
        scope: list[ScopeConstraint],
        context: dict,
    ) -> AdapterResult: ...

    async def close(self) -> None: ...

    async def get_schema(self) -> AdapterSchema:
        """Return the adapter's schema fingerprint surface (AC-21.a).

        Default raises NotImplementedError until per-adapter impl lands
        (task-006).  Shared.md line 315-322.
        """
        raise NotImplementedError("AC-21.b: this adapter must implement get_schema() (task-006)")

get_schema() async

Return the adapter's schema fingerprint surface (AC-21.a).

Default raises NotImplementedError until per-adapter impl lands (task-006). Shared.md line 315-322.

Source code in packages/nautilus-adapter-sdk/src/nautilus_adapter_sdk/protocols.py 
30
31
32
33
34
35
36
async def get_schema(self) -> AdapterSchema:
    """Return the adapter's schema fingerprint surface (AC-21.a).

    Default raises NotImplementedError until per-adapter impl lands
    (task-006).  Shared.md line 315-322.
    """
    raise NotImplementedError("AC-21.b: this adapter must implement get_schema() (task-006)")

Embedder

Bases: Protocol

Protocol for text embedding providers.

Source code in packages/nautilus-adapter-sdk/src/nautilus_adapter_sdk/protocols.py 
39
40
41
42
43
@runtime_checkable
class Embedder(Protocol):
    """Protocol for text embedding providers."""

    async def embed(self, text: str) -> list[float]: ...