WorldClient

class WorldClient(transport)

Bases: object

Provide typed synchronous access to the NOSIBLE World API.

Parameters:

transport (NosibleTransport)

events(date, limit=None, offset=None, sort_by=None, desc=None)

Return events for one archive date.

Parameters:

  • date (str) – Archive date in YYYY-MM-DD form.

  • limit (int | None) – Maximum number of events.

  • offset (int | None) – Zero-based result offset.

  • sort_by (str | None) – Optional server-supported sort field.

  • desc (bool | None) – Whether to sort descending.

  • self (WorldClient)

Returns:

Iterable page of World events.

Return type:

WorldEventPage

entity_events(entity_type, name, from_=None, to=None, limit=None, cursor=None, order='desc', include='event_lite', include_vector=None, include_live=None)

Return the event timeline for an entity.

Parameters:

  • entity_type (str) – Named-entity type or ANY.

  • name (str) – Canonical entity name.

  • from – Optional inclusive first archive date.

  • to (str | None) – Optional inclusive last archive date.

  • limit (int | None) – Maximum number of events.

  • cursor (str | None) – Opaque continuation cursor.

  • order (str) – Timeline order, asc or desc.

  • include (str) – Event projection, event_lite or event_full.

  • include_vector (bool | None) – Whether to include event vectors.

  • include_live (bool | None) – Whether to include live event slices.

  • self (WorldClient)

  • from_ (str | None)

Returns:

Iterable cursor page of World events.

Return type:

WorldEventPage

ticker_events(symbol, id_type='symbol', from_=None, to=None, limit=None, cursor=None, order='desc', include='event_lite', include_vector=None, include_live=None)

Return the event timeline for a ticker identifier.

Parameters:

  • symbol (str) – Ticker symbol or alternate identifier.

  • id_type (str) – Identifier type.

  • from – Optional inclusive first archive date.

  • to (str | None) – Optional inclusive last archive date.

  • limit (int | None) – Maximum number of events.

  • cursor (str | None) – Opaque continuation cursor.

  • order (str) – Timeline order, asc or desc.

  • include (str) – Event projection, event_lite or event_full.

  • include_vector (bool | None) – Whether to include event vectors.

  • include_live (bool | None) – Whether to include live event slices.

  • self (WorldClient)

  • from_ (str | None)

Returns:

Iterable cursor page of World events.

Return type:

WorldEventPage

ontology_events(field, value, match='top3', from_=None, to=None, limit=None, cursor=None, order='desc', include='event_lite', include_vector=None)

Return the event timeline for an ontology value.

Parameters:

  • field (str) – World ontology base slot.

  • value (str) – Ontology value to match.

  • match (str) – Candidate depth, top1 or top3.

  • from – Optional inclusive first archive date.

  • to (str | None) – Optional inclusive last archive date.

  • limit (int | None) – Maximum number of events.

  • cursor (str | None) – Opaque continuation cursor.

  • order (str) – Timeline order, asc or desc.

  • include (str) – Event projection, event_lite or event_full.

  • include_vector (bool | None) – Whether to include event vectors.

  • self (WorldClient)

  • from_ (str | None)

Returns:

Iterable cursor page of World events.

Return type:

WorldEventPage

search(query=None, vector=None, search_type=None, date=None, filters=None, sort=None, facets=None, limit=None, offset=None, include=None, explain=None, embedding_model=None, semantic_filter_mode=None, semantic_candidates=None, exact_vector_max_candidates=None, max_dates=None)

Search the full World archive.

Parameters:

  • query (str | None) – Lexical or semantic query text.

  • vector (List[float] | None) – Optional caller-provided query vector.

  • search_type (str | None) – Metadata, lexical, semantic, or hybrid mode.

  • date (Dict[str, Any] | None) – Optional date-window object.

  • filters (Dict[str, Any] | None) – World filter DSL.

  • sort (List[Dict[str, Any]] | None) – Ordered sort clauses.

  • facets (List[str] | None) – Facet fields to return.

  • limit (int | None) – Maximum number of events.

  • offset (int | None) – Zero-based result offset.

  • include (List[str] | None) – Event projection and explanation selections.

  • explain (bool | None) – Whether to return scoring explanations.

  • embedding_model (str | None) – Embedding model used for semantic retrieval.

  • semantic_filter_mode (str | None) – Semantic filtering strategy.

  • semantic_candidates (int | None) – Approximate semantic candidate count.

  • exact_vector_max_candidates (int | None) – Exact-vector candidate ceiling.

  • max_dates (int | None) – Maximum number of archive dates to inspect.

  • self (WorldClient)

Returns:

Iterable World search result page.

Return type:

WorldEventPage

aggregate(filters=None, date=None, bucket=None, metrics=None, co_mentions=None)

Aggregate World events into date buckets and metrics.

Parameters:

  • filters (Dict[str, Any] | None) – World filter DSL.

  • date (Dict[str, str] | None) – Inclusive aggregation date window.

  • bucket (str | None) – Day, week, month, or year bucket.

  • metrics (List[str] | None) – Count, sentiment, and materiality metrics.

  • co_mentions (Dict[str, Any] | None) – Co-mention request configuration.

  • self (WorldClient)

Returns:

World aggregate response.

Return type:

Dict[str, Any]

resolve(query, types=None, limit=None, min_events=None)

Resolve free text to canonical World entities.

Parameters:

  • query (str) – Text to resolve.

  • types (List[str] | None) – Optional entity types to search.

  • limit (int | None) – Maximum number of matches.

  • min_events (int | None) – Minimum event-count threshold.

  • self (WorldClient)

Returns:

Entity-resolution response.

Return type:

Dict[str, Any]

version()

Return the public World deployment and data version.

Returns:

Public World version response.

Parameters:

self (WorldClient)

Return type:

Dict[str, Any]

dates()

Return World archive dates available to the caller.

Returns:

Available-date response.

Parameters:

self (WorldClient)

Return type:

Dict[str, Any]

entity_summary(entity_type, name)

Return the all-time indexed summary for an entity.

Parameters:

  • entity_type (str) – Named-entity type or ANY.

  • name (str) – Canonical entity name.

  • self (WorldClient)

Returns:

All-time entity summary.

Return type:

Dict[str, Any]

ticker(symbol, id_type='symbol')

Return metadata for a ticker identifier.

Parameters:

  • symbol (str) – Ticker symbol or alternate identifier.

  • id_type (str) – Identifier type.

  • self (WorldClient)

Returns:

Ticker metadata response.

Return type:

Dict[str, Any]

search_schema()

Return the public World filter and search schema.

Returns:

Public World search-schema response.

Parameters:

self (WorldClient)

Return type:

Dict[str, Any]

autocomplete(date, query, limit=None)

Return dated autocomplete matches.

Parameters:

  • date (str) – Archive date in YYYY-MM-DD form.

  • query (str) – Autocomplete prefix.

  • limit (int | None) – Maximum number of matches.

  • self (WorldClient)

Returns:

Iterable autocomplete result page.

Return type:

WorldEventPage

Run semantic search against one archive date.

Parameters:

  • date (str) – Archive date in YYYY-MM-DD form.

  • query (str) – Semantic query text.

  • limit (int | None) – Maximum number of events.

  • embedding_model (str | None) – Embedding model identifier.

  • self (WorldClient)

Returns:

Iterable semantic result page.

Return type:

WorldEventPage

Run structured search against one archive date.

Parameters:

  • date (str) – Archive date in YYYY-MM-DD form.

  • query (str | None) – Optional query text.

  • filters (Dict[str, Any] | None) – World filter DSL.

  • sort (Dict[str, Any] | None) – Sort configuration.

  • limit (int | None) – Maximum number of events.

  • offset (int | None) – Zero-based result offset.

  • self (WorldClient)

Returns:

Iterable dated result page.

Return type:

WorldEventPage

snapshot(date)

Return the compact World snapshot for one date.

Parameters:

  • date (str) – Archive date in YYYY-MM-DD form.

  • self (WorldClient)

Returns:

Snapshot response.

Return type:

Dict[str, Any]

event(date, event_id)

Return one full World event.

Parameters:

  • date (str) – Archive date in YYYY-MM-DD form.

  • event_id (str) – Canonical World event identifier.

  • self (WorldClient)

Returns:

Full World event.

Return type:

WorldEvent

similar_events(date, event_id, limit=None, include_live=None, include_thread=None, floor=None)

Return events semantically similar to one World event.

Parameters:

  • date (str) – Archive date in YYYY-MM-DD form.

  • event_id (str) – Canonical World event identifier.

  • limit (int | None) – Maximum number of neighboring events.

  • include_live (bool | None) – Whether to include live event slices.

  • include_thread (bool | None) – Whether to include thread neighbors.

  • floor (float | None) – Minimum HNSW neighbor similarity.

  • self (WorldClient)

Returns:

Similar-event response.

Return type:

Dict[str, Any]

event_aggregates(date, event_id)

Return source and document aggregates for one event.

Parameters:

  • date (str) – Archive date in YYYY-MM-DD form.

  • event_id (str) – Canonical World event identifier.

  • self (WorldClient)

Returns:

Event aggregate response.

Return type:

Dict[str, Any]

coverage(date, event_id, cursor=None, limit=None, query=None)

Return paginated source coverage for one event.

Parameters:

  • date (str) – Archive date in YYYY-MM-DD form.

  • event_id (str) – Canonical World event identifier.

  • cursor (str | None) – Opaque continuation cursor.

  • limit (int | None) – Maximum number of source documents.

  • query (str | None) – Optional source-text query.

  • self (WorldClient)

Returns:

Event coverage response.

Return type:

Dict[str, Any]

markdown_index(date, query=None, top=None)

Return a dated Markdown event index.

Parameters:

  • date (str) – Archive date in YYYY-MM-DD form.

  • query (List[str] | None) – Optional Markdown filter terms.

  • top (int | None) – Maximum number of events.

  • self (WorldClient)

Returns:

Markdown document.

Return type:

str

markdown_today(query=None, top=None)

Return the current Markdown event index.

Parameters:

  • query (List[str] | None) – Optional Markdown filter terms.

  • top (int | None) – Maximum number of events.

  • self (WorldClient)

Returns:

Markdown document.

Return type:

str

markdown_yesterday(query=None, top=None)

Return the previous Markdown event index.

Parameters:

  • query (List[str] | None) – Optional Markdown filter terms.

  • top (int | None) – Maximum number of events.

  • self (WorldClient)

Returns:

Markdown document.

Return type:

str

markdown_resolve(query)

Return entity resolution as Markdown.

Parameters:
Returns:

Markdown document.

Return type:

str

markdown_entity(entity_type, name, query=None, top=None)

Return one entity timeline as Markdown.

Parameters:

  • entity_type (str) – Named-entity type or ANY.

  • name (str) – Canonical entity name.

  • query (List[str] | None) – Optional Markdown filter terms.

  • top (int | None) – Maximum number of events.

  • self (WorldClient)

Returns:

Markdown document.

Return type:

str

markdown_ticker(symbol, query=None, top=None)

Return one ticker timeline as Markdown.

Parameters:

  • symbol (str) – Canonical ticker symbol.

  • query (List[str] | None) – Optional Markdown filter terms.

  • top (int | None) – Maximum number of events.

  • self (WorldClient)

Returns:

Markdown document.

Return type:

str

markdown_event(event_id)

Return one event as Markdown.

Parameters:

  • event_id (str) – Canonical World event identifier.

  • self (WorldClient)

Returns:

Markdown document.

Return type:

str

markdown_bulk(date)

Return the dated Markdown bulk ZIP.

Parameters:

  • date (str) – Archive date in YYYY-MM-DD form.

  • self (WorldClient)

Returns:

ZIP archive bytes.

Return type:

bytes