Search

class Search(question=None, expansions=None, sql_filter=None, n_results=None, n_probes=None, n_contextify=None, algorithm=None, min_similarity=None, must_include=None, must_exclude=None, autogenerate_expansions=False, publish_start=None, publish_end=None, visited_start=None, visited_end=None, certain=None, include_netlocs=None, exclude_netlocs=None, include_companies=None, exclude_companies=None, include_docs=None, exclude_docs=None, brand_safety=None, language=None, continent=None, region=None, country=None, sector=None, industry_group=None, industry=None, sub_industry=None, iab_tier_1=None, iab_tier_2=None, iab_tier_3=None, iab_tier_4=None, instruction=None, companies=None, collection=None, deduplicate=None, internal_use=None)

Bases: object

Parameters for a NOSIBLE Search request.

Attributes

question
expansions
sql_filter
n_results
n_probes
n_contextify
algorithm
min_similarity
must_include
must_exclude
autogenerate_expansions
publish_start
publish_end
visited_start
visited_end
certain
include_netlocs
exclude_netlocs
include_companies
exclude_companies
include_docs
exclude_docs
brand_safety
language
continent
region
country
sector
industry_group
industry
sub_industry
iab_tier_1
iab_tier_2
iab_tier_3
iab_tier_4
instruction
companies
collection
deduplicate
internal_use

Methods

from_dict(data)	Create a search from known dictionary fields.
read_json(path)	Read a search from a JSON file.
write_json(path)	Write the search to a JSON file.
to_dict()	Convert the search to a dictionary.

Parameters:

• question (str | None)

• expansions (List[str] | None)

• sql_filter (str | None)

• n_results (int | None)

• n_probes (int | None)

• n_contextify (int | None)

• algorithm (str | None)

• min_similarity (float | None)

• must_include (List[str] | None)

• must_exclude (List[str] | None)

• autogenerate_expansions (bool)

• publish_start (str | None)

• publish_end (str | None)

• visited_start (str | None)

• visited_end (str | None)

• certain (bool | None)

• include_netlocs (List[str] | None)

• exclude_netlocs (List[str] | None)

• include_companies (List[str] | None)

• exclude_companies (List[str] | None)

• include_docs (List[str] | None)

• exclude_docs (List[str] | None)

• brand_safety (str | None)

• language (str | None)

• continent (str | None)

• region (str | None)

• country (str | None)

• sector (str | None)

• industry_group (str | None)

• industry (str | None)

• sub_industry (str | None)

• iab_tier_1 (str | None)

• iab_tier_2 (str | None)

• iab_tier_3 (str | None)

• iab_tier_4 (str | None)

• instruction (str | None)

• companies (List[str] | None)

• collection (str | None)

• deduplicate (bool | None)

• internal_use (Dict[str, Any] | None)

write_json(path)

Write the search to a JSON file.

Parameters:

• path (str) – Destination file path.

• self (Search)

Returns:

None.

Return type:

None

to_dict()

Convert the search to a dictionary.

Returns:

Search parameters.

Parameters:

self (Search)

Return type:

Dict[str, Any]

classmethod read_json(path)

Read a search from a JSON file.

Parameters:

path (str) – Source file path.

Returns:

Parsed search.

Return type:

Search

classmethod from_dict(data)

Create a search from known dictionary fields.

Parameters:

data (Dict[str, Any]) – Search parameters.

Returns:

Parsed search.

Return type:

Search