> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neuronsearchlab.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Key concepts

> Every NeuronSearchLab term in one place, with a link to the page that explains it in full.

Read this page once and the rest of the documentation will make sense. Each term links to the page that covers it in depth.

## Your data

> [accordion] Workspace
>
> Everything you configure and send lives in one workspace (also called a team or project). Members, credentials, plan and usage belong to the workspace. You can belong to several and switch between them from the profile menu. See [Members](https://docs.neuronsearchlab.com/console/members.md) and [Account and settings](https://docs.neuronsearchlab.com/console/account.md).

> [accordion] Item
>
> Anything NSL can recommend: a product, listing, article, video or course. An item has a `name`, an optional `description`, free-form `metadata` (category, price, brand, availability and so on) and an `active` flag. NSL assigns each item an integer `id`. Items can come from the API, a feed, a shop platform or a crawl of your website. See [Catalogue](https://docs.neuronsearchlab.com/integrate/catalogue.md) and [Items](https://docs.neuronsearchlab.com/console/items.md).

> [accordion] User
>
> The person a request is for, identified by your own `user_id` string. Anonymous visitors can use a session or device identifier. NSL keeps a profile per user that is built from their events. See [Users](https://docs.neuronsearchlab.com/console/users.md) and [Identity](https://docs.neuronsearchlab.com/integrate/identity.md).

> [accordion] Event and event type
>
> An event records that a user did something with an item: viewed it, clicked it, bought it, skipped it. Each event refers to an **event type** by its integer ID. Event types have a label, a **weight** from 0 to 100 that says how much the action counts, and a **polarity** (positive, neutral or negative). See [Events](https://docs.neuronsearchlab.com/integrate/events.md).

> [accordion] Signal
>
> A fixed concept that NSL defines, such as `view`, `rec_click`, `add_to_cart` or `purchase`. Integrations (the embed, the Shopify app, importers) report signals rather than event names, and your workspace binds each signal to one of your event types. This keeps purchases from Shopify, your server and a CSV import on the same event type. See [Integration signals](https://docs.neuronsearchlab.com/integrate/events.md#integration-signals).

> [accordion] Search event
>
> A search is recorded as an event with a `query` and no item. Recent searches steer a user's later recommendations by the weight of your Search event type. See [Searches are events](https://docs.neuronsearchlab.com/integrate/events.md#searches-are-events).

## Serving

> [accordion] Context
>
> One place in your product where recommendations appear: a homepage feed, a "similar items" rail, a basket upsell, an email digest. Your code sends a `context_id`; the context decides the model, the recipe, the rules and the filters. Operators change a context without a code release. See [Contexts](https://docs.neuronsearchlab.com/console/contexts.md).

> [accordion] Recommendation type
>
> The kind of surface a context serves: **Personalised discovery** (a feed for one user), **Related items** ("more like this", seeded by an `item_id`), **Search results**, **Continue watching**, **Email digest** or **Merchandising**. The type sets sensible defaults; the recipe and rules do the rest.

> [accordion] Recipe
>
> A context's ranking strategy: which candidate sources feed it, how each event signal is weighted, how much room is given to discovery, and which guardrails apply. You edit it in the context's **Inputs**, **Ranking** and **Safety** tabs. Templates give you a ready-made recipe for common use cases. See [Contexts](https://docs.neuronsearchlab.com/console/contexts.md#recipe).

> [accordion] Pipeline
>
> The ordered stages a request runs through: candidate generation, enrichment, scoring, learned ranking, rules and post-processing. Each context has its own pipeline, which you can inspect and tune. See [Pipeline](https://docs.neuronsearchlab.com/console/pipeline.md).

> [accordion] Rule
>
> Business logic applied after scoring: boost, bury, pin, filter, cap, diversify, dedupe, reorder, group and more. Rules can be scheduled and targeted at segments. See [Rules Engine](https://docs.neuronsearchlab.com/console/rules.md).

> [accordion] Segment
>
> A reusable group of users defined by behaviour, profile metadata, computed statistics or interactions with a specific item. Segments target rules. See [Segments](https://docs.neuronsearchlab.com/console/segments.md).

> [accordion] Recommendation set and context group
>
> A page with several rails can request them together as **recommendation sets** in one call. A **context group** adds rules across those rails, such as "never show the same item twice on this page". See [Several rails on one page](https://docs.neuronsearchlab.com/integrate/recommendations.md#several-rails-on-one-page) and [Context groups](https://docs.neuronsearchlab.com/console/context-groups.md).

> [accordion] Request ID
>
> Every recommendation and search response carries a `request_id`. Sending it with the events that follow ties clicks and purchases to the exact list that produced them, which is what analytics, experiments and Explainability rely on.

## Models and measurement

> [accordion] Recommender and model
>
> A recommender is an architecture you can train, chosen from the catalogue on the **Models** page: neighbourhood models such as item-KNN, matrix factorisation, sequential models such as SASRec and BERT4Rec, graph models such as LightGCN, two-tower retrieval with a ranking stage, and generative models. Training one on your events produces a **model version**. Contexts serve from a model you choose, or from **Automatic**, which uses the best deployed model for your workspace. See [Models](https://docs.neuronsearchlab.com/console/models.md).

> [accordion] Model family
>
> A group of models built for one job, such as general recommendations, similar items or trending. NSL publishes a base model for each family; your trained versions override it for your workspace. If nothing in a family is ready, serving falls back to the family base and then the general base.

> [accordion] Signal template
>
> The training input: which event types a model learns from, their weights, and the minimum event counts required before training can start. See [Events page](https://docs.neuronsearchlab.com/console/events.md#signal-templates).

> [accordion] Experiment
>
> A live A/B test that splits users between variants with different models, recipes or rules, and reports click-through, conversion and other metrics per variant. See [Experiments](https://docs.neuronsearchlab.com/console/experiments.md).

> [accordion] Explanation
>
> A breakdown of why an item ranked where it did: its score at each stage, the rules that matched and the pipeline trace. See [Explainability](https://docs.neuronsearchlab.com/console/explainability.md).

## Access and billing

> [accordion] SDK credentials
>
> An OAuth client ID and secret for your servers. Exchanged for a short-lived access token that calls the Core API. See [Authentication](https://docs.neuronsearchlab.com/integrate/authentication.md).

> [accordion] API key
>
> A long-lived `nsl_…` bearer token, scoped to specific areas, for automation and AI assistants that call the Platform API. See [API keys](https://docs.neuronsearchlab.com/console/api-keys.md).

> [accordion] Publishable key
>
> An `nsl_pk_…` key that is safe to put in a web page. It can only fetch recommendations and report engagement for the website embed, from origins you allow. See [Website embed](https://docs.neuronsearchlab.com/console/website-embed.md).

> [accordion] Core API and Platform API
>
> The **Core API** (`api.neuronsearchlab.com`) is what your application calls: items, events, recommendations and search. The **Platform API** (`console.neuronsearchlab.com/api`) is what the console itself uses, and what you call to automate configuration. See the [API reference](https://docs.neuronsearchlab.com/api-reference/introduction.md).

> [accordion] Plan and usage
>
> Each plan includes a monthly allowance of recommendation requests and limits on contexts, rules, event types and seats. A request is one recommendation list or search. See [Billing and plans](https://docs.neuronsearchlab.com/console/billing.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.