Enums Documentation

EntityType

from enum import Enum

class EntityType(Enum):
    '''
    Enum representing different types of entities in the Rumorz Graph.
    '''
    FINANCIAL_ASSET = "financial_asset"
    COMPANY = "company"
    ORGANIZATION = "organization"
    PERSON = "person"
    PLACE = "place"

AssetClass

from enum import Enum

class AssetClass(Enum):
    '''
    Enum representing different classes of financial assets.
    '''
    CRYPTO = "crypto"
    COMMODITIES = "commodities"

Lookback

from enum import Enum

class Lookback(Enum):
    '''
    Enum representing different lookback periods for data metrics.
    '''
    ONE_HOUR = "1H"
    SIX_HOURS = "6H"
    TWELVE_HOURS = "12H"
    ONE_DAY = "1D"
    ONE_WEEK = "7D"
    ONE_MONTH = "30D"
    THREE_MONTHS = "90D"

EntityMetrics

from enum import Enum

class EntityMetrics(Enum):
    '''
    Enum representing different metrics for evaluating entities.
    '''
    MENTIONS = 'mentions'
    SENTIMENT = 'sentiment'
    EXCITEMENT = 'excitement'
    OPTIMISM = 'optimism'
    PESSIMISM = 'pessimism'
    FEAR = 'fear'
    UNCERTAINTY = 'uncertainty'
    SURPRISE = 'surprise'

FinancialAssetMetrics

from enum import Enum

class FinancialAssetMetrics(Enum):
    '''
    Enum representing different metrics for evaluating financial assets.
    '''
    PRICE = 'price'

TimeSeriesResample

from enum import Enum

class TimeSeriesResample(Enum):
    '''
    Enum representing different resampling intervals for time series data.
    '''
    ONE_MINUTE = '1T'
    FIVE_MINUTES = '5T'
    FIFTEEN_MINUTES = '15T'
    THIRTY_MINUTES = '30T'
    ONE_HOUR = '1H'
    ONE_DAY = '1D'

TimeHorizon

from enum import Enum

class TimeHorizon(Enum):
    '''
    Enum representing different time horizons for data analysis.
    '''
    SHORT = 'short'
    LONG = 'long'