DevelopmentFromDB
development_idLogical identifier for the development across updates.
timestampCanonical backtest system timestamp of this development version.
source_timestampMost recent timestamp of any source used for the development.
occurrence_timestampActual (estimate of) real world time that the development took place.
occurrence_timestamp_confidence_scoreConfidence score in estimate of occurrence_timestamp.
nameName of the development.
descriptionDescription of the development.
development_typeType of the development.
occurrence_statusStatus of the real world occurrence.
rationaleExplanation for all decisions made.
List of involved stakeholders and their impacts.
importance_scoreLLM heuristic of general development importance.
surprise_scoreLLM heuristic of how surprising the development is to the market.
confidence_scoreLLM heuristic of its confidence in everything it presents.
List of events this development is associated with, resolved to their most recent known state.
List of sources used for this development.
DevelopmentSearchParams
Semantic search query. If None, retrieves all developments matching the filters.
Filter for results >= this integer unix timestamp. None means realtime mode.
Filter for results <= this integer unix timestamp. None means realtime mode.
Filter for occurrence_timestamp >= this integer unix timestamp. None means no limit.
Filter for occurrence_timestamp <= this integer unix timestamp. None means no limit.
Filter by development type.
Filter by stakeholder symbol.
Minimum impact score filter in [-1, 1]. If both min and max are provided, matching is directional OR (impact >= min OR impact <= max).
Maximum impact score filter in [-1, 1]. If both min and max are provided, matching is directional OR (impact >= min OR impact <= max).
Minimum importance score in [0, 1].
Minimum surprise score in [0, 1].
Minimum confidence score in [0, 1].
limitMaximum number of results to return.
DevelopmentSummary
development_idLogical identifier for the development across updates.
timestampCanonical backtest system timestamp of this development version.
occurrence_timestampActual (estimate of) real world time that the development took place.
occurrence_timestamp_confidence_scoreConfidence score in estimate of occurrence_timestamp.
nameName of the development.
descriptionDescription of the development.
development_typeType of the development.
occurrence_statusStatus of the real world occurrence.
importance_scoreLLM heuristic of general development importance.
surprise_scoreLLM heuristic of how surprising the development is to the market.
confidence_scoreLLM heuristic of its confidence in everything it presents.
event_idsRaw list of event IDs this development is associated with.
EventFromDB
event_idLogical identifier for the event.
nameName of the event.
descriptionDescription of the event.
event_typeType of the event.
Most recent developments for this event (count controlled by developments_per_event param), ordered by occurrence_timestamp descending.
EventSearchParams
Semantic search query over event descriptions. If None, returns events ordered by recency of event creation.
Filter for events with development activity >= this unix timestamp.
Filter for events with development activity <= this unix timestamp. None means realtime mode.
Filter by event type.
limitMaximum number of events to return.
developments_per_eventNumber of most recent developments to embed per event result, ordered by occurrence_timestamp descending.
include_future_developmentsWhether to include developments whose occurrence_timestamp is in the future (relative to end_timestamp, or current time if end_timestamp is None) in the embedded per-event development list. Set to False to restrict to already-occurred developments.
EventSummary
event_idLogical identifier for the event across updates.
nameName of the event.
descriptionDescription of the event.
event_typeType of the event.
EventWithDevelopments
event_idLogical identifier for the event.
nameName of the event.
descriptionDescription of the event.
event_typeType of the event.
Developments associated with this event, ordered by occurrence_timestamp descending (real-world timeline).
Factor
nameUnique snake_case primary key for the factor. Name must be entirely self contained and describe the situation unambiguously. Name should be consistent and reusable across separate calls.
descriptionWhat the factor represents. This will be embedded for semantic retrieval, so write it as a clean, general definition.
factor_scaleScale of factor.
rubricMandatory scoring rubric for consistency. Keep it short but explicit. This should ensure absolute consistency globally across separate calls.
Only for CATEGORICAL: enum of allowed category strings.
FactorAssessment
rationaleA brief explanation of the reasoning behind the assessment for this stakeholder given the factor.
Assessed value (type depends on factor_type). 1. BINARY -> bool; 2. CONTINUOUS -> float in [0,1]; 3. SIGNED_CONTINUOUS -> float in [-1,1]; 4. CATEGORICAL -> str in allowed_values.
List of sources that support this factor assessment.
FactorMatrixRow
Factor definition.
Map: stakeholder symbol -> assessment object for this factor.
RetrieveDevelopmentParams
development_idThe ID of the development to retrieve.
Filter for results <= this integer unix timestamp. None means realtime mode.
RetrieveEventDevelopmentsParams
event_idThe event_id to retrieve developments for.
Filter developments with timestamp >= this unix timestamp. None means no lower bound.
Filter developments with timestamp <= this unix timestamp. None means realtime mode.
limitMaximum number of developments to return, ordered by occurrence_timestamp descending.
include_future_developmentsWhether to include developments whose occurrence_timestamp is in the future (relative to end_timestamp, or current time if end_timestamp is None). Set to False to restrict results to developments that have already occurred.
SemanticSearchMultiParams
queriesList of semantic search queries.
total_top_kBest-effort target number of results to return after flattening and deduplication.
filter for results >= this integer unix timestamp.
filter for results <= this integer unix timestamp.
minimum_cosine_similarityfilters results for cosine similarity >= this value.
List of exact match keywords. If provided, returns results containing at least one.
List of tags to filter by. If provided, returns results containing all specified tags.
filters results for quality rating >= this value.
strategyRanking strategy for consolidating results across queries. Final output is always ordered by cosine_similarity. - 'cosine_similarity': rank purely by cosine similarity. - 'round_robin': interleave results from each query in a round-robin fashion to promote diversity across queries. - 'rank_sum': assign a score to each chunk based on its rank in each query's results and sum these scores across queries, promotes duplicates.
SemanticSearchParams
queryThe semantic search query string.
filter for results >= this integer unix timestamp.
filter for results <= this integer unix timestamp.
top_kNumber of results to return.
minimum_cosine_similarityfilters results for cosine similarity >= this value.
List of exact match keywords. If provided, returns results containing at least one.
List of tags to filter by. If provided, returns results containing all specified tags.
filters results for quality rating >= this value.
SemanticSearchResult
cosine_similarityCosine similarity score between the query and the chunk embedding.
idUnique identifier for the chunk.
timestampUnix timestamp of the source document.
document_idIdentifier of the source document.
tagsList of tags associated with the chunk.
titleTitle of the source document.
contentContent of the chunk.
named_entitiesList of named entities extracted from the chunk.
ratingQuality rating of the chunk between 0.0 and 1.0.
Source information.
Source
source_timestampTimestamp of the source item (unix epoch).
source_tableTable (Type) of the source item (e.g., 'news', 'earnings_calls', 'press_releases', etc.)
source_id'id' of the source item
Additional metadata about the source item.
SourceMetadata
URL of the source material, if applicable.
Title of the source material, if applicable.
Publisher of the source material, if applicable.
SourceWithQuotes
source_timestampTimestamp of the source item (unix epoch).
source_tableTable (Type) of the source item (e.g., 'news', 'earnings_calls', 'press_releases', etc.)
source_id'id' of the source item
Additional metadata about the source item.
quotesList of EXACT quotes from the source material.
StakeholderBase
nameName of the stakeholder
stakeholder_typeThe type of stakeholder. ONLY the following are allowed: [PUBLIC_COMPANY].
symbolTicker symbol of the stakeholder
StakeholderIdentificationParams
queryThe query / subject for which to identify stakeholders for.
Optional additional context to help identify stakeholders.
Optional additional instructions to guide stakeholder identification.
Optional start timestamp (unix epoch) to consider for time-sensitive queries.
Optional end timestamp (unix epoch) to consider for time-sensitive queries.
StakeholderIdentificationResponse
List of identified stakeholders with their impact details.
Factor matrix providing scoring for each stakeholder across defined factors.
StakeholderImpact
The stakeholder being identified.
impact_scoreImpact score (-1.0 to 1.0) indicating the estimated magnitude and direction of the impact on the stakeholder.
confidence_scoreConfidence score (0.0 to 1.0) indicating level of certainty in the stakeholder being materially impacted.
rationaleA brief explanation of why this stakeholder is relevant to the query
List of sources (with quotes) that support the identification of this stakeholder.
WebhookCreationResponse
messageConfirmation message indicating successful creation of the webhook.
webhook_idThe unique identifier of the created webhook.
sample_dataA sample of the data that will be sent to the webhook receiver URL upon execution.
WebhookInstructions
pathThe path of the desired endpoint.
A dictionary of arguments to call the endpoint with. Note: Do not include 'start_timestamp' or 'end_timestamp' as these are handled by the webhook.
intervalThe interval (in minutes) at which the webhook will check the endpoint. Must be a multiple of 5.
receiver_urlThe URL to which the webhook payloads will be sent.
Optional headers to include in the webhook requests to your url.
WebhookRecord
webhook_idUnique identifier for the webhook.
statusCurrent status of the webhook either 'active' or 'paused'.
User defined webhook configuration.
created_atTimestamp indicating when the webhook was created.