Types

All types are importable from proxima_sdk:

from proxima_sdk import SearchResult, SearchResults, Citation, QueryMetadata

SearchResults

@dataclass
class SearchResults:
    answer: str                  # synthesized answer
    results: list[SearchResult]  # ranked source chunks
    citations: list[Citation]    # source references
    metadata: QueryMetadata      # latency, confidence, etc.

SearchResult

@dataclass
class SearchResult:
    id: str
    content: str
    score: float
    source: str
    metadata: dict

Citation

@dataclass
class Citation:
    source: str       # source ID (e.g. "invoices-gold")
    title: str        # human-readable label
    excerpt: str      # relevant passage
    url: str | None   # link if available

QueryMetadata

@dataclass
class QueryMetadata:
    latency_ms: int
    sources_searched: int
    confidence: float     # 0.0–1.0
    kb_id: str

Usage example

results = ctx.knowledge.query("overdue invoices")

print(results.answer)
# "There are 14 invoices overdue by more than 30 days..."

for citation in results.citations:
    print(f"{citation.title}: {citation.excerpt}")

print(f"Confidence: {results.metadata.confidence:.0%}")
print(f"Latency: {results.metadata.latency_ms}ms")