> For the complete documentation index, see [llms.txt](https://docs.airops.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.airops.com/docs/pt/acoes/workflow-concepts/workflow-steps/memory-steps/knowledge-base-read.md).

# Obter Ficheiro da Base de Conhecimento

Leia dados das suas Bases de Conhecimento usando filtros.

## O que é uma etapa de leitura da base de conhecimento?

A etapa de leitura da base de conhecimento permite consultar as suas bases de conhecimento através de filtros, para obter dados relevantes para utilizar nos seus fluxos de trabalho. É especialmente útil ao fazer [Geração aumentada por recuperação](https://en.wikipedia.org/wiki/Retrieval-augmented_generation) (RAG).

A principal diferença entre esta etapa e a etapa de [pesquisa na base de conhecimento](https://docs.airops.com/docs/pt/acoes/workflow-concepts/workflow-steps/memory-steps/memory-search.md) é que, enquanto na etapa de pesquisa pode fazer consultas e obter blocos de texto, a etapa de leitura permite aplicar filtros e obter documentos completos.

Para obter mais informações sobre como configurar uma base de conhecimento, consulte a nossa página de documentação [aqui](https://docs.airops.com/docs/pt/contexto/knowledge-bases.md).

## Como configurar uma etapa de leitura da base de conhecimento <a href="#how-to-configure-a-memory-search-step" id="how-to-configure-a-memory-search-step"></a>

### Selecione uma base de conhecimento

Selecione no menu pendente a base de conhecimento que pretende utilizar.

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-156b4e9680ccc76892cabd1dd789d66311d255f7%2Fkb-fetch-step-01-select-kb.png?alt=media" alt="Get Knowledge Base File step with the Knowledge Base dropdown open and Products selected"><figcaption><p>Selecione a base de conhecimento de onde pretende ler.</p></figcaption></figure>

### Selecione ficheiros específicos (opcional)

Opcionalmente, pode selecionar vários documentos de uma lista para ler:

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-7bf235014e7a8bf37e56a8def0eec672d8f31bdf%2Fkb-fetch-step-02-select-files.png?alt=media" alt="Get Knowledge Base File step with marketing_data.csv and marketing_data_2.csv selected"><figcaption><p>Opcionalmente, escolha os ficheiros a ler.</p></figcaption></figure>

### Adicionar filtros (opcional)

Pode adicionar filtros para restringir os resultados com base em campos de metadados. Estes incluem:

* **Metadados padrão** herdados da origem (por exemplo, nome do ficheiro, URL da origem)
* **Metadados personalizados** que adicionou para etiquetar ficheiros (por exemplo, país, produto, público-alvo)
* **Colunas de CSV/folha de cálculo** quando a base de conhecimento contém dados estruturados

**Exemplo: Filtrar por metadados personalizados**

Se tiver estudos de caso de clientes etiquetados com um campo de metadados personalizados `country` , pode aplicar um filtro para obter apenas estudos de caso de uma região específica:

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-52f3db88479573aaed3f9de4cf13ba919d0b93fa%2Fkb-fetch-step-03-filters.png?alt=media" alt="Get Knowledge Base File filters for Country equal United Kingdom and UnitPrice less than 3"><figcaption><p>Filtre registos por metadados ou colunas CSV.</p></figcaption></figure>

{% hint style="success" %}
**Filtragem dinâmica**

Utilize as entradas do fluxo de trabalho para tornar os filtros dinâmicos. Por exemplo, defina o filtro como `country` igual a `{{input.region}}` e o fluxo de trabalho irá obter os ficheiros correspondentes à região fornecida durante a execução.
{% endhint %}

Para que a filtragem seja eficaz, recomendamos que consulte [Metadados das bases de conhecimento](https://docs.airops.com/docs/pt/contexto/knowledge-bases/knowledge-base-metadata.md) para saber como adicionar etiquetas de metadados personalizados aos ficheiros da sua base de conhecimento.

## Saída da etapa de leitura da base de conhecimento

A etapa de leitura da base de conhecimento gera uma lista de documentos com os respetivos registos. No exemplo anterior dos produtos filtrados, a saída será semelhante a esta:

```json
[
  {
    "document_name": "marketing_data.csv",
    "records": [
      {
        "__text": "WHITE HANGING HEART T-LIGHT HOLDER\n\n-----\n\nUnited Kingdom",
        "InvoiceNo": 536365,
        "StockCode": "85123A",
        "Description": "WHITE HANGING HEART T-LIGHT HOLDER",
        "Quantity": 6,
        "InvoiceDate": "12/1/2010 8:26",
        "UnitPrice": 2.55,
        "CustomerID": 17850,
        "Country": "Reino Unido"
      },
      ...
    ]
  },
  {
    "document_name": "marketing_data_2.csv",
    "records": [
      {
        "__text": "CREAM CUPID HEARTS COAT HANGER\n\n-----\n\nReino Unido",
        "InvoiceNo": 536365,
        "StockCode": "84406B",
        "Description": "CREAM CUPID HEARTS COAT HANGER",
        "Quantity": 8,
        "InvoiceDate": "12/1/2010 8:26",
        "UnitPrice": 2.75,
        "CustomerID": 17850,
        "Country": "Reino Unido"
      },
      ...
    ]
  }
]
```

Pode notar que:

* São devolvidos apenas os documentos selecionados no menu pendente.
* Cada documento tem uma lista de registos associada. Como estes documentos são ficheiros CSV, cada registo representa uma linha diferente.
* São devolvidos apenas os registos que correspondem aos filtros selecionados (Reino Unido e UnitPrice < 3).
* Existe um campo especial "\_\_text" que mostra o texto pesquisável selecionado durante o carregamento do ficheiro CSV. Neste caso, como apenas as colunas "Description" e "Country" foram selecionadas como pesquisáveis, são essas as colunas incorporadas no campo "\_\_text".

Segue-se um exemplo do resultado da obtenção de um documento PDF:

```json
[
  {
    "document_name": "US_Congress-2023-SB546-Enrolled.pdf",
    "records": [
      {
        "__text": "S. 546  \n\nOne Hundred Eighteenth Congress of the United States of America\n\nAT T H E S E C O N D S E S S I O N\n\nBegun and held at the City of Washington on Wednesday, the third day of January, two thousand and twenty four\n\nAn Act\n\nTo amend the Omnibus Crime Control and Safe Streets Act of 1968 to authorize law enforcement agencies to use COPS grants for recruitment activities, and for other purposes...",
        "__languages": [
          "eng"
        ],
      }
    ]
  }
]
```

## Utilizar o resultado do passo para fazer RAG

Podemos passar o resultado do passo Knowledge Base Fetch para um passo LLM para fazer geração aumentada por recuperação (RAG).

Continuando com o exemplo dos nossos produtos, podemos obter a lista completa de produtos e passá-la para um passo LLM, desta forma:

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-ebd8daf0a590d8381a6257fa6b065127bb72af42%2Fkb-fetch-step-04-rag-workflow.png?alt=media" alt="UK Product Finder Workflow passing the Get Knowledge Base File output into a Prompt LLM step"><figcaption><p>Passar os registos obtidos para um passo LLM.</p></figcaption></figure>

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-68a19f1b74f47559da563ce92f93816ea64d842e%2Fkb-fetch-step-05-rag-llm.png?alt=media" alt="Prompt LLM step that references the fetched records, with its answer listing three products under the step on the canvas"><figcaption><p>O LLM responde usando os registos obtidos.</p></figcaption></figure>


---

# 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://docs.airops.com/docs/pt/acoes/workflow-concepts/workflow-steps/memory-steps/knowledge-base-read.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.
