> For the complete documentation index, see [llms.txt](https://icij.gitbook.io/datashare/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://icij.gitbook.io/datashare/usage/search-documents.md).

# Search documents

Search with the main search bar and configure settings to display your search's results.

You must have added documents in Datashare before. Check how for [Mac](/datashare/local-mode/install-datashare-on-mac/add-documents-to-datashare-on-mac.md), [Windows](/datashare/local-mode/install-datashare-on-windows/add-documents-to-datashare-on-windows.md) and [Linux](/datashare/local-mode/install-datashare-on-linux/add-documents-to-datashare-on-linux.md).

## Search bar

Expand the menu to go to '**Search**' > '**Documents**':

<figure><img src="https://2881303961-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LWCyd3pDXO_H4jk9DgG%2Fuploads%2Fgit-blob-efc64183ce2e200d85af72599fcf2a2c406c046e%2FScreenshot%202025-06-07%20at%2007.18.13.png?alt=media" alt="Screenshot of a Datashare&#x27;s search documents page with the &#x27;Documents&#x27; entry in the &#x27;Search&#x27; category in the menu highlighted"><figcaption></figcaption></figure>

Make room by closing the menu:

<figure><img src="https://2881303961-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LWCyd3pDXO_H4jk9DgG%2Fuploads%2Fgit-blob-47d0a4641fdfa4f3c9f3b8dd1a3ea24f2686c2eb%2FScreenshot%202025-06-07%20at%2007.21.04.png?alt=media" alt="Screenshot of a Datashare&#x27;s search documents page with the menu open and its top right X icon highlighted"><figcaption></figcaption></figure>

**Type terms** in the search bar and **press Enter**:

<figure><img src="https://2881303961-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LWCyd3pDXO_H4jk9DgG%2Fuploads%2Fgit-blob-35571621efc53c6eddfa4049a4cf9a07528fffd8%2FScreenshot%202025-06-07%20at%2007.23.54.png?alt=media" alt="Screenshot of a Datashare&#x27;s search documents page with highlighted &#x27;Ikea&#x27; typed in the search bar"><figcaption></figcaption></figure>

## Default operator is OR

If you type **several terms** separated by space, as the **default operator is OR**, Datashare will search for all documents containing at least one of the searched terms.

For instance, Datashare finds documents containing **either 'ikea' or 'paris' or both terms here**:

<figure><img src="https://2881303961-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LWCyd3pDXO_H4jk9DgG%2Fuploads%2Fgit-blob-35d282408d95e9d45403ccb95662f96447bee455%2FScreenshot%202025-06-07%20at%2007.26.51.png?alt=media" alt="Screenshot of a Datashare&#x27;s search documents page with highlighted &#x27;Ikea paris&#x27; typed in the search bar"><figcaption></figcaption></figure>

Switch to **AND** by changing the [results settings](https://icij.gitbook.io/datashare/usage/search-documents#results-settings).

## Linked entities

As you type a term, Datashare **suggest linked entities** - only if a task to find entities in this project was completed.

Press **Esc** on your keyboard to close the dropdown or **click on one of the entities** to replace your term in the search bar:

<figure><img src="https://2881303961-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LWCyd3pDXO_H4jk9DgG%2Fuploads%2Fgit-blob-65526dc28070e7930d9a2f3634f81fb308d611b2%2FScreenshot%202025-06-07%20at%2007.35.23.png?alt=media" alt="Screenshot of a Datashare&#x27;s search documents page with &#x27;Ikea paris&#x27; typed in the search bar and a dropdown with linked entities below highligted"><figcaption></figcaption></figure>

## Search in a field

Search within a specific field only, by using the dropdown '**All fields**':

<figure><img src="https://2881303961-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LWCyd3pDXO_H4jk9DgG%2Fuploads%2Fgit-blob-8191ce8d30c24c5d927675516b22df32bc21c514%2FScreenshot%202025-06-07%20at%2007.43.06.png?alt=media" alt="Screenshot of a Datashare&#x27;s search documents page with &#x27;Ikea&#x27; typed in the search bar and the &#x27;All fields&#x27; dropdown button highlighted at the right of the search bar"><figcaption></figcaption></figure>

<figure><img src="https://2881303961-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LWCyd3pDXO_H4jk9DgG%2Fuploads%2Fgit-blob-50fe5fc2e85b9cef9cc3a4a7de2cf0ec90dac32a%2FScreenshot%202025-06-07%20at%2007.43.39.png?alt=media" alt="Screenshot of a Datashare&#x27;s search documents page with &#x27;Ikea&#x27; typed in the search bar and the &#x27;All fields&#x27; dropdown highlighted at the right of the search bar"><figcaption></figcaption></figure>

## Search breadcrumb

To see your queries in the **search breadcrumb**, click on the icon on the left of the search bar:

<figure><img src="https://2881303961-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LWCyd3pDXO_H4jk9DgG%2Fuploads%2Fgit-blob-bc674db8a99c9633fe37c536ae31a897e9178b83%2FScreenshot%202025-06-07%20at%2007.40.14.png?alt=media" alt="Screenshot of a Datashare&#x27;s search documents page with &#x27;Ikea&#x27; typed in the search bar and the &#x27;Your search&#x27; icon button highlighted at the left of the search bar"><figcaption></figcaption></figure>

<figure><img src="https://2881303961-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LWCyd3pDXO_H4jk9DgG%2Fuploads%2Fgit-blob-94c6a609e582d831ee044f802ab8b47539362bc5%2FScreenshot%202025-06-07%20at%2007.44.52.png?alt=media" alt="Screenshot of a Datashare&#x27;s search documents page with &#x27;Ikea&#x27; typed in the search bar and the &#x27;Your search&#x27; breadcrumb open and highlighted below the search bar"><figcaption></figcaption></figure>

If you'd like to remove all searched terms from the search bar, click '**Clear query**':

<figure><img src="https://2881303961-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LWCyd3pDXO_H4jk9DgG%2Fuploads%2Fgit-blob-f1f89921f1a600a9bbd7651d0af345b5661ad890%2FScreenshot%202025-06-07%20at%2007.46.32.png?alt=media" alt="Screenshot of a Datashare&#x27;s search documents page with &#x27;Ikea&#x27; typed in the search bar and the &#x27;Your search&#x27; breadcrumb open and its &#x27;Clear query&#x27; button highlighted"><figcaption></figcaption></figure>

## Results settings

To change the page settings, click the **Settings icon** on the top right:

<figure><img src="https://2881303961-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LWCyd3pDXO_H4jk9DgG%2Fuploads%2Fgit-blob-a19bde1e576f3553709c1825eb714c47c03348f4%2FScreenshot%202025-06-07%20at%2007.51.56.png?alt=media" alt="Screenshot of a Datashare&#x27;s search documents page with &#x27;Ikea paris&#x27; typed in the search bar and the top right Settings icon button highlighted"><figcaption></figcaption></figure>

<figure><img src="https://2881303961-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LWCyd3pDXO_H4jk9DgG%2Fuploads%2Fgit-blob-3b77499650c110145deb92266a23bc0b48933f76%2FScreenshot%202025-06-07%20at%2007.51.25.png?alt=media" alt="Screenshot of a Datashare&#x27;s search documents page with &#x27;Ikea&#x27; typed in the search bar and and the &#x27;Results settings&#x27; panel open and highlighted at the right of the page"><figcaption></figcaption></figure>

You can change **Sort by**, **Documents per page**, **Layout** and also **Properties**:

<figure><img src="https://2881303961-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LWCyd3pDXO_H4jk9DgG%2Fuploads%2Fgit-blob-6ea0aab40009c27064bfaf5ba92db679109d05e8%2FScreenshot%202025-06-07%20at%2007.54.47.png?alt=media" alt="Screenshot of a Datashare&#x27;s search documents page with &#x27;Ikea&#x27; typed in the search bar and and the &#x27;Results settings&#x27; panel open and its &#x27;Properties&#x27; category highlighted at the right of the page"><figcaption></figcaption></figure>

Ticking these properties will change **which document's metadata are displayed in the results**, in the document cards, in all 3 layouts (List, Grid, Table):

<figure><img src="https://2881303961-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LWCyd3pDXO_H4jk9DgG%2Fuploads%2Fgit-blob-105eeabc74db39544f39c7bae1d788ac6bff9eeb%2FScreenshot%202025-06-07%20at%2007.56.25.png?alt=media" alt="Screenshot of a Datashare&#x27;s search documents page with &#x27;Ikea paris&#x27; typed in the search bar and the &#x27;Results&#x27; column open and highlighted at the left of the page in a List layout"><figcaption></figcaption></figure>

<figure><img src="https://2881303961-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LWCyd3pDXO_H4jk9DgG%2Fuploads%2Fgit-blob-a5e426d9421ab061cde4ad851debc7fba9e24853%2FScreenshot%202025-06-07%20at%2007.58.17.png?alt=media" alt="Screenshot of a Datashare&#x27;s search documents page with &#x27;Ikea paris&#x27; typed in the search bar and the first document card highlighted at the left of the page in a Grid layout"><figcaption></figcaption></figure>

<figure><img src="https://2881303961-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LWCyd3pDXO_H4jk9DgG%2Fuploads%2Fgit-blob-ad28f0d7e23d4e69afc915db8eda95ebe640043c%2FScreenshot%202025-06-07%20at%2007.58.48.png?alt=media" alt="Screenshot of a Datashare&#x27;s search documents page with &#x27;Ikea paris&#x27; typed in the search bar and the first document card highlighted at the top of the results in a Table layout"><figcaption></figcaption></figure>

You can now make your search more precise [with operators or Regex (Regular Expressions)](/datashare/usage/search-with-operators.md).

## **Characters that cannot be searched**

Some characters **cannot be found** in Datashare, even if you can see them in your documents. This includes most **symbols and punctuation marks**, for instance:

> $ € £ ¥ % # @ & + = , ; ! ? ( ) « » " ' / –

This is because Datashare uses [the Standard tokenizer](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-standard-tokenizer.html). When your documents are indexed, their text is split into **terms** (mostly words and numbers), and **most symbols and punctuation are removed**. These characters are not stored in the index, so the search engine cannot find them.

{% hint style="info" %}
**Why does it work this way?** The Standard tokenizer follows [Unicode's rules for splitting text into words](https://unicode.org/reports/tr29/). It is designed to find **words**, whatever punctuation surrounds them. Thanks to this, searching for **contract** also finds "contract,", "(contract)" or "contract." without you having to think about it. It also keeps the index smaller, which helps make searches **faster**, especially on very large datasets.
{% endhint %}

A document containing "€ 2 million" is indexed as the terms **2** and **million**. The **€** is not kept.

The same thing happens to your query. If you search for:

> €

Datashare has no term to look for, and **returns no results**, even if many of your documents contain the euro sign.

**Escaping the character with a backslash (\€), using double quotes ("€") or using Regex (/€/) does not help:** the character is still not in the index.

#### **How to find these mentions anyway**

Instead of searching for the symbol, search for the **words or numbers around it**.

* Use an **exact phrase** with the amount, as the symbol is removed on both sides:

> "2 million" (this query will catch "€ 2 million", "€2 million", etc., with any currency)

* Use a **proximity search** if you don't know the exact amount:

> "million euros"\~2 (this query will catch "2 million euros", "1.5 million euros", etc.)

* Search for **other ways of writing** the same thing with <kbd>OR</kbd>. You need to write <kbd>OR</kbd> with **all letters uppercase:**

> EUR OR euro OR euros

* Use the <kbd>**AND**</kbd> operator to combine terms that **usually appear together** in the documents you are looking for:

> "2 million" AND contract


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://icij.gitbook.io/datashare/usage/search-documents.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
