ResultSet

class ResultSet(results=<factory>, message=None, query=None)

Bases: Iterator[Any]

Ordered, iterable collection of NOSIBLE Search results.

Attributes

results

Methods

`analyze`([by])	Summarize a supported result field.
`close`()	Release held resources.
`find_in_search_results`(query[, top_k])	Rank existing results with an in-memory lexical index.
`from_dict`(data)	Create results from an envelope, result dictionary, or result list.
`from_dicts`(dicts)	Create results from dictionaries.
`from_pandas`(df)	Create results from a pandas DataFrame.
`from_polars`(df)	Create results from a Polars DataFrame.
`read_duckdb`(file_path)	Read results from the first DuckDB table.
`read_ipc`(file_path)	Read results from Apache Arrow IPC.
`read_csv`(file_path)	Read results from CSV.
`read_json`(file_path)	Read results from JSON.
`read_ndjson`(file_path)	Read results from newline-delimited JSON.
`read_parquet`(file_path)	Read results from Apache Parquet.
`to_dict`()	Convert results to a URL-hash-keyed dictionary.
`to_dicts`()	Convert results to dictionaries.
`to_pandas`()	Convert results to a pandas DataFrame.
`to_polars`()	Convert results to a Polars DataFrame.
`write_csv`([file_path, delimiter, encoding])	Write results to CSV.
`write_ipc`([file_path])	Write results to Apache Arrow IPC.
`write_duckdb`([file_path, table_name])	Write results to a DuckDB table.
`write_json`([file_path])	Serialize results and optionally write them to disk.
`write_ndjson`([file_path])	Serialize results as newline-delimited JSON.
`write_parquet`([file_path])	Write results to Apache Parquet.

Parameters:

results (List[Any])
message (str | None)
query (Dict[str, Any] | None)

message: str | None = None

query: Dict[str, Any] | None = None

index: int = 0

find_in_search_results(query, top_k=10)

Rank existing results with an in-memory lexical index.

Parameters:

query (str) – Text to find within the current results.
top_k (int) – Maximum number of results to return.
self (ResultSet)

Returns:

Ranked result subset.

Return type:

ResultSet

analyze(by='published')

Summarize a supported result field.

Parameters:

by (str) – Field to summarize.
self (ResultSet)

Returns:

Field-dependent summary.

Return type:

Dict[str, Any]

write_csv(file_path=None, delimiter=',', encoding='utf-8')

Write results to CSV.

Parameters:

file_path (str | None) – Optional destination path.
delimiter (str) – CSV delimiter.
encoding (str) – Text encoding.
self (ResultSet)

Returns:

Written file path.

Return type:

str

to_pandas()

Convert results to a pandas DataFrame.

Returns:: pandas DataFrame.
Parameters:: self (ResultSet)
Return type:: DataFrame

write_json(file_path=None)

Serialize results and optionally write them to disk.

Parameters:

file_path (str | None) – Optional destination path.
self (ResultSet)

Returns:

File path when written, otherwise JSON text.

Return type:

str

to_dict()

Convert results to a URL-hash-keyed dictionary.

Returns:: Result payloads keyed by URL hash.
Parameters:: self (ResultSet)
Return type:: Dict[str, Dict[str, Any]]

write_ndjson(file_path=None)

Serialize results as newline-delimited JSON.

Parameters:

file_path (str | None) – Optional destination path.
self (ResultSet)

Returns:

File path when written, otherwise NDJSON text.

Return type:

str

write_parquet(file_path=None)

Write results to Apache Parquet.

Parameters:

file_path (str | None) – Optional destination path.
self (ResultSet)

Returns:

Written file path.

Return type:

str

write_ipc(file_path=None)

Write results to Apache Arrow IPC.

Parameters:

file_path (str | None) – Optional destination path.
self (ResultSet)

Returns:

Written file path.

Return type:

str

write_duckdb(file_path=None, table_name='results')

Write results to a DuckDB table.

Parameters:

file_path (str | None) – Optional database path.
table_name (str) – Destination table name.
self (ResultSet)

Returns:

Written database path.

Return type:

str

to_polars()

Convert results to a Polars DataFrame.

Returns:: Polars DataFrame.
Parameters:: self (ResultSet)
Return type:: DataFrame

to_dicts()

Convert results to dictionaries.

Returns:: Ordered result payloads.
Parameters:: self (ResultSet)
Return type:: List[Dict[str, Any]]

classmethod read_csv(file_path)

Read results from CSV.

Parameters:: file_path (str) – Source file path.
Returns:: Parsed result set.
Return type:: ResultSet

classmethod read_json(file_path)

Read results from JSON.

Parameters:: file_path (str) – Source file path.
Returns:: Parsed result set.
Return type:: ResultSet

classmethod from_pandas(df)

Create results from a pandas DataFrame.

Parameters:: df (DataFrame) – Source pandas DataFrame.
Returns:: Parsed result set.
Return type:: ResultSet

classmethod read_ndjson(file_path)

Read results from newline-delimited JSON.

Parameters:: file_path (str) – Source file path.
Returns:: Parsed result set.
Return type:: ResultSet

classmethod read_parquet(file_path)

Read results from Apache Parquet.

Parameters:: file_path (str) – Source file path.
Returns:: Parsed result set.
Return type:: ResultSet

classmethod read_ipc(file_path)

Read results from Apache Arrow IPC.

Parameters:: file_path (str) – Source file path.
Returns:: Parsed result set.
Return type:: ResultSet

classmethod read_duckdb(file_path)

Read results from the first DuckDB table.

Parameters:: file_path (str) – Source database path.
Returns:: Parsed result set.
Return type:: ResultSet

classmethod from_polars(df)

Create results from a Polars DataFrame.

Parameters:: df (DataFrame) – Source Polars DataFrame.
Returns:: Parsed result set.
Return type:: ResultSet

classmethod from_dict(data)

Create results from an envelope, result dictionary, or result list.

Parameters:: data (Dict[str, Any] | List[Dict[str, Any]]) – Search response or result payloads.
Returns:: Parsed result set.
Return type:: ResultSet

classmethod from_dicts(dicts)

Create results from dictionaries.

Parameters:: dicts (List[Dict[str, Any]]) – Search result payloads.
Returns:: Parsed result set.
Return type:: ResultSet

close()

Release held resources.

Returns:: None.
Parameters:: self (ResultSet)
Return type:: None

CSV files written by ResultSet include SDK metadata that preserves nested JSON values, unknown fields, scalar types, explicit nulls, and omitted fields for lossless round trips. read_csv also accepts legacy SDK CSV files that do not contain this metadata.