Skip to content

Types Reference

nautilus_adapter_sdk.types

Adapter SDK Pydantic models — independent copies of nautilus core types.

These are standalone mirrors so adapter packages have zero import dependency on the nautilus core library.

IntentAnalysis

Bases: BaseModel

Structured intent analysis forwarded to adapters by the broker.

Contains the parsed user intent, requested data types, stated purpose, and a confidence score used for routing decisions.

Source code in packages/nautilus-adapter-sdk/src/nautilus_adapter_sdk/types.py 
14
15
16
17
18
19
20
21
22
23
24
25
class IntentAnalysis(BaseModel):
    """Structured intent analysis forwarded to adapters by the broker.

    Contains the parsed user intent, requested data types, stated purpose,
    and a confidence score used for routing decisions.
    """

    raw_intent: str
    normalized_intent: str
    data_types: list[str]
    purpose: str
    confidence: float

ScopeConstraint

Bases: BaseModel

Per-source WHERE-clause fragment passed to :meth:Adapter.execute.

Adapters use these constraints to restrict query results at the data-source level (e.g., field-level redaction, row filtering).

Source code in packages/nautilus-adapter-sdk/src/nautilus_adapter_sdk/types.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
class ScopeConstraint(BaseModel):
    """Per-source WHERE-clause fragment passed to :meth:`Adapter.execute`.

    Adapters use these constraints to restrict query results at the
    data-source level (e.g., field-level redaction, row filtering).
    """

    source_id: str
    operator: str
    field: str
    value: Any
    expires_at: str | None = None
    valid_from: str | None = None

AdapterResult

Bases: BaseModel

Result returned by an adapter after executing a scoped query.

The metadata dict should include provenance info such as row counts, query duration, or classification tags.

Source code in packages/nautilus-adapter-sdk/src/nautilus_adapter_sdk/types.py 
43
44
45
46
47
48
49
50
51
52
class AdapterResult(BaseModel):
    """Result returned by an adapter after executing a scoped query.

    The ``metadata`` dict should include provenance info such as row
    counts, query duration, or classification tags.
    """

    source_id: str
    data: Any
    metadata: dict[str, Any]

ErrorRecord

Bases: BaseModel

Structured error report emitted when an adapter fails.

Captured by the broker for audit logging and operator dashboards.

Source code in packages/nautilus-adapter-sdk/src/nautilus_adapter_sdk/types.py 
55
56
57
58
59
60
61
62
63
class ErrorRecord(BaseModel):
    """Structured error report emitted when an adapter fails.

    Captured by the broker for audit logging and operator dashboards.
    """

    source_id: str
    error: str
    error_type: str

AuthConfig

Bases: BaseModel

Authentication credentials for connecting to a data source.

The auth_type field selects the authentication strategy (e.g., "bearer", "basic", "api_key").

Source code in packages/nautilus-adapter-sdk/src/nautilus_adapter_sdk/types.py 
66
67
68
69
70
71
72
73
74
class AuthConfig(BaseModel):
    """Authentication credentials for connecting to a data source.

    The ``auth_type`` field selects the authentication strategy
    (e.g., ``"bearer"``, ``"basic"``, ``"api_key"``).
    """

    auth_type: str
    credentials: dict[str, Any]

EndpointSpec

Bases: BaseModel

HTTP endpoint specification for REST-based adapters.

Provides URL, method, optional headers, and a per-request timeout.

Source code in packages/nautilus-adapter-sdk/src/nautilus_adapter_sdk/types.py 
77
78
79
80
81
82
83
84
85
86
class EndpointSpec(BaseModel):
    """HTTP endpoint specification for REST-based adapters.

    Provides URL, method, optional headers, and a per-request timeout.
    """

    url: str
    method: str = "GET"
    headers: dict[str, str] | None = None
    timeout_s: float = 30.0