Aether Docs

Explore the strongly typed return objects defined by the Aether SDK.

Models Breakdown

Type definitions for all objects returned by the Aether SDK. Use these as a reference when working with API responses or building your own client.

@dataclass
class DocumentRecord:
    doc_id: str
    cid: str
    title: Optional[str] = None
    content_type: str = "text/plain"
    size_bytes: int = 0
    chunks: int = 0
    vectors: int = 0
    version: int = 1
    created_at: Optional[str] = None
    updated_at: Optional[str] = None

@dataclass
class SearchResult:
    doc_id: str
    score: int                    # relevance score, 0-100; higher is better
    title: Optional[str] = None
    content_type: str = "text/plain"
    content: Optional[str] = None    # populated when inline content is requested
    passage: Optional[str] = None    # the specific chunk that matched the query

@dataclass
class RetrievalResult:
    doc_id: str
    score: int                    # relevance score, 0-100; higher is better
    content: str                     # full document text, for use in RAG prompts
    title: Optional[str] = None
    content_type: str = "text/plain"
    passage: Optional[str] = None