Search

Nosible API Client

---

Nosible API Client / Search

Class: Search

Defined in: src/search/search.ts:102

Core classes for interacting with the Nosible AI Search API.

• NosibleClient: Main client class for all API operations
• Search: Represents a single search configuration with parameters
• SearchSet: Collection of Search instances for batch operations
• ResultSet: Collection of search results with analysis and export methods
• WebPageData: Structured data from scraped web pages
• TopicTrend: Analysis of topic popularity trends over time

Constructors

Constructor

new Search(params): Search

Defined in: src/search/search.ts:170

Creates a new Search instance with the specified parameters.

The constructor accepts all search parameters including filters, algorithm settings, and result options. All parameters are optional except for the question when used in certain contexts.

Parameters

params

Search parameters including question, filters, and options

question?

string = ...

autoGenerateExpansions?

boolean = ...

expansions?

string[] = ...

sqlFilter?

string = ...

algorithm?

"string" | "baseline" | "lexical" | "hamming" | "hybrid-1" | "hybrid-2" | "hybrid-3" | "company" = ...

nResults?

number = ...

nProbes?

number = ...

nContextify?

number = ...

minSimilarity?

number = ...

mustInclude?

string[] = ...

mustExclude?

string[] = ...

brandSafety?

"safe" | "sensitive" | "unsafe" = ...

language?

string = ...

continent?

"Africa" | "Asia" | "Europe" | "North America" | "Oceania" | "South America" | "Worldwide" = ...

region?

"North America" | "Oceania" | "South America" | "Worldwide" | "Caribbean" | "Central Africa" | "Central America" | "Central Asia" | "Central Europe" | "East Africa" | "East Asia" | "Eastern Europe" | "Middle East" | "North Africa" | "Northern Europe" | "South Asia" | "Southeast Asia" | "Southern Africa" | "Southern Europe" | "Sub-Saharan Africa" | "The Amazon Basin" | "The Andes" | "The Arctic Region" | "The Balkans" | "The Caucasus" | "The Horn of Africa" | "The Levant" | "The Middle East" | "The Sahel" | "West Africa" | "Western Europe" = ...

country?

string = ...

sector?

string = ...

industryGroup?

string = ...

industry?

string = ...

subIndustry?

string = ...

iabTier1?

string = ...

iabTier2?

string = ...

iabTier3?

string = ...

iabTier4?

string = ...

companies?

string[] = ...

publishStart?

Date = ...

publishEnd?

Date = ...

visitedStart?

Date = ...

visitedEnd?

Date = ...

certain?

boolean = ...

includeNetlocs?

string[] = ...

excludeNetlocs?

string[] = ...

includeCompanies?

string[] = ...

excludeCompanies?

string[] = ...

includeDocs?

string[] = ...

excludeDocs?

string[] = ...

Returns

Search

Example

// Simple search with just a question
const search = new Search({
  question: "machine learning applications",
  nResults: 15
});

// Search with geographic and temporal filters
const filteredSearch = new Search({
  question: "climate change policy",
  nResults: 25,
  country: "United States",
  publishStart: new Date("2022-01-01"),
  publishEnd: new Date("2023-12-31"),
  language: "en"
});

Properties

question

question: string

Defined in: src/search/search.ts:103

---

nResults

nResults: number

Defined in: src/search/search.ts:104

---

expansions?

optional expansions: string[]

Defined in: src/search/search.ts:105

---

autoGenerateExpansions?

optional autoGenerateExpansions: boolean

Defined in: src/search/search.ts:106

---

nProbes?

optional nProbes: number

Defined in: src/search/search.ts:107

---

nContextify?

optional nContextify: number

Defined in: src/search/search.ts:108

---

algorithm?

optional algorithm: "string" | "baseline" | "lexical" | "hamming" | "hybrid-1" | "hybrid-2" | "hybrid-3" | "company"

Defined in: src/search/search.ts:109

---

sqlFilter?

optional sqlFilter: string

Defined in: src/search/search.ts:110

---

minSimilarity?

optional minSimilarity: number

Defined in: src/search/search.ts:111

---

mustInclude?

optional mustInclude: string[]

Defined in: src/search/search.ts:112

---

mustExclude?

optional mustExclude: string[]

Defined in: src/search/search.ts:113

---

brandSafety?

optional brandSafety: "safe" | "sensitive" | "unsafe"

Defined in: src/search/search.ts:114

---

language?

optional language: string

Defined in: src/search/search.ts:115

---

continent?

optional continent: "Africa" | "Asia" | "Europe" | "North America" | "Oceania" | "South America" | "Worldwide"

Defined in: src/search/search.ts:116

---

region?

optional region: "North America" | "Oceania" | "South America" | "Worldwide" | "Caribbean" | "Central Africa" | "Central America" | "Central Asia" | "Central Europe" | "East Africa" | "East Asia" | "Eastern Europe" | "Middle East" | "North Africa" | "Northern Europe" | "South Asia" | "Southeast Asia" | "Southern Africa" | "Southern Europe" | "Sub-Saharan Africa" | "The Amazon Basin" | "The Andes" | "The Arctic Region" | "The Balkans" | "The Caucasus" | "The Horn of Africa" | "The Levant" | "The Middle East" | "The Sahel" | "West Africa" | "Western Europe"

Defined in: src/search/search.ts:117

---

country?

optional country: string

Defined in: src/search/search.ts:118

---

sector?

optional sector: string

Defined in: src/search/search.ts:119

---

industryGroup?

optional industryGroup: string

Defined in: src/search/search.ts:120

---

industry?

optional industry: string

Defined in: src/search/search.ts:121

---

subIndustry?

optional subIndustry: string

Defined in: src/search/search.ts:122

---

iabTier1?

optional iabTier1: string

Defined in: src/search/search.ts:123

---

iabTier2?

optional iabTier2: string

Defined in: src/search/search.ts:124

---

iabTier3?

optional iabTier3: string

Defined in: src/search/search.ts:125

---

iabTier4?

optional iabTier4: string

Defined in: src/search/search.ts:126

---

companies?

optional companies: string[]

Defined in: src/search/search.ts:127

---

publishStart?

optional publishStart: Date

Defined in: src/search/search.ts:129

---

publishEnd?

optional publishEnd: Date

Defined in: src/search/search.ts:130

---

visitedStart?

optional visitedStart: Date

Defined in: src/search/search.ts:131

---

visitedEnd?

optional visitedEnd: Date

Defined in: src/search/search.ts:132

---

certain?

optional certain: boolean

Defined in: src/search/search.ts:133

---

includeNetlocs?

optional includeNetlocs: string[]

Defined in: src/search/search.ts:134

---

excludeNetlocs?

optional excludeNetlocs: string[]

Defined in: src/search/search.ts:135

---

includeCompanies?

optional includeCompanies: string[]

Defined in: src/search/search.ts:136

---

excludeCompanies?

optional excludeCompanies: string[]

Defined in: src/search/search.ts:137

---

includeDocs?

optional includeDocs: string[]

Defined in: src/search/search.ts:138

---

excludeDocs?

optional excludeDocs: string[]

Defined in: src/search/search.ts:139

Methods

searchBody()

searchBody(options): Promise<{ question: string; expansions?: string[]; sql_filter?: string; algorithm?: "string" | "baseline" | "lexical" | "hamming" | "hybrid-1" | "hybrid-2" | "hybrid-3" | "company"; n_results: number; n_probes?: number; n_contextify?: number; min_similarity?: number; must_include?: string[]; must_exclude?: string[]; brand_safety?: "safe" | "sensitive" | "unsafe"; language?: string; continent?: "Africa" | "Asia" | "Europe" | "North America" | "Oceania" | "South America" | "Worldwide"; region?: "North America" | "Oceania" | "South America" | "Worldwide" | "Caribbean" | "Central Africa" | "Central America" | "Central Asia" | "Central Europe" | "East Africa" | "East Asia" | "Eastern Europe" | "Middle East" | "North Africa" | "Northern Europe" | "South Asia" | "Southeast Asia" | "Southern Africa" | "Southern Europe" | "Sub-Saharan Africa" | "The Amazon Basin" | "The Andes" | "The Arctic Region" | "The Balkans" | "The Caucasus" | "The Horn of Africa" | "The Levant" | "The Middle East" | "The Sahel" | "West Africa" | "Western Europe"; country?: string; sector?: string; industry_group?: string; industry?: string; sub_industry?: string; iab_tier_1?: string; iab_tier_2?: string; iab_tier_3?: string; iab_tier_4?: string; companies?: string[]; }>

Defined in: src/search/search.ts:200

Generates the API request body for this search.

This method prepares the search parameters for the API call by:

• Generating automatic expansions if enabled
• Converting date and filter parameters to SQL filter format
• Mapping parameter names to API format
• Removing undefined values

Parameters

options

Options containing the NosibleClient instance

client

NosibleClient

The NosibleClient to use for expansion generation

Returns

Promise<{ question: string; expansions?: string[]; sql_filter?: string; algorithm?: "string" | "baseline" | "lexical" | "hamming" | "hybrid-1" | "hybrid-2" | "hybrid-3" | "company"; n_results: number; n_probes?: number; n_contextify?: number; min_similarity?: number; must_include?: string[]; must_exclude?: string[]; brand_safety?: "safe" | "sensitive" | "unsafe"; language?: string; continent?: "Africa" | "Asia" | "Europe" | "North America" | "Oceania" | "South America" | "Worldwide"; region?: "North America" | "Oceania" | "South America" | "Worldwide" | "Caribbean" | "Central Africa" | "Central America" | "Central Asia" | "Central Europe" | "East Africa" | "East Asia" | "Eastern Europe" | "Middle East" | "North Africa" | "Northern Europe" | "South Asia" | "Southeast Asia" | "Southern Africa" | "Southern Europe" | "Sub-Saharan Africa" | "The Amazon Basin" | "The Andes" | "The Arctic Region" | "The Balkans" | "The Caucasus" | "The Horn of Africa" | "The Levant" | "The Middle East" | "The Sahel" | "West Africa" | "Western Europe"; country?: string; sector?: string; industry_group?: string; industry?: string; sub_industry?: string; iab_tier_1?: string; iab_tier_2?: string; iab_tier_3?: string; iab_tier_4?: string; companies?: string[]; }>

Promise that resolves to the standardized API search parameters

Example

const search = new Search({
  question: "blockchain technology",
  autoGenerateExpansions: true,
  nResults: 10
});

const apiBody = await search.searchBody({ client });
console.log(apiBody.question); // "blockchain technology"
console.log(apiBody.expansions); // Array of generated expansions