Alba Core Logo

About

  • Introduction
    • What Alba Core owns
    • What Alba Core does not own yet

Getting started

  • Setting up Alba Core
    • Useful commands
  • Running your first search
    • Expected flow

Manual

  • Requirement Extraction
    • Inputs
    • Outputs
    • Common Fields
    • Extension Rule
  • Matching Pipeline
    • Hard Filters
    • Soft Scoring
  • Lead Summaries

Alba Core details

  • Architecture
    • Subsystem Overview
    • Design Principles
  • Data Flow
    • Stateful Conversations
  • PropertyMe Cache
    • Why cache data?
    • Cache Rules

Class reference

  • Class Reference
    • Pipeline
      • AlbaCore
        • AlbaCore.from_environment()
        • AlbaCore.search()
      • Example
      • Environment-based setup
    • Requirements And Records
      • RentalRequirements
        • RentalRequirements.is_search_ready
        • RentalRequirements.merge()
        • RentalRequirements.missing_required_fields
        • RentalRequirements.to_dict()
      • Example: merge conversation turns
        • PropertyRecord
      • Example: public API output
        • MatchResult
      • Example: serialise a match result
        • clean_text()
    • Requirement Extraction
      • ExtractionOutput
        • ExtractionOutput.to_dict()
      • RequirementExtractor
        • RequirementExtractor.extract()
      • Example
      • Continuing a conversation
    • Matching
      • MatchingOutput
        • MatchingOutput.to_dict()
      • PropertyMatcher
        • PropertyMatcher.match()
      • Example
      • No-match handling
    • Lead Summaries
      • build_lead_summary()
      • money()
      • Example
      • No-match example
    • PropertyMe Cache And OAuth
      • load_property_cache()
      • Example: load the local cache
        • PropertyMeOAuthConfig
        • build_authorization_url()
        • token_exchange_payload()
        • refresh_payload()
      • Example: build OAuth requests
        • PropertyMeClient
      • Example: refresh a raw rental cache
    • HTTP API
      • SearchRequest
        • SearchRequest.model_config
      • search()
      • Example: request body
      • Example: curl
      • Example: Python client

Contributing

  • Contributing to Alba Core
    • Contribution Loop
    • Commands
  • Code Commenting Guidelines
    • Module Comments
    • Class Comments
    • Function Comments
    • Good Comments

API reference

  • Alba Core API Reference
  • PropertyMe API Reference
  • HTTP API Reference
Alba Core
  • Class Reference
  • View page source

Class Reference

This section is the quick reference pane for Alba Core classes and functions. Each page shows the public API, what it is for, and a small highlighted example using the real local PropertyMe cache.

  • Pipeline
    • AlbaCore
    • Example
    • Environment-based setup
  • Requirements And Records
    • RentalRequirements
    • Example: merge conversation turns
    • Example: public API output
    • Example: serialise a match result
  • Requirement Extraction
    • ExtractionOutput
    • RequirementExtractor
    • Example
    • Continuing a conversation
  • Matching
    • MatchingOutput
    • PropertyMatcher
    • Example
    • No-match handling
  • Lead Summaries
    • build_lead_summary()
    • money()
    • Example
    • No-match example
  • PropertyMe Cache And OAuth
    • load_property_cache()
    • Example: load the local cache
    • Example: build OAuth requests
    • Example: refresh a raw rental cache
  • HTTP API
    • SearchRequest
    • search()
    • Example: request body
    • Example: curl
    • Example: Python client
Previous Next

© Copyright .

Built with Sphinx using a theme provided by Read the Docs.