> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/knowledge-base.md). # Knowledge Base Let the llm search for information in your indexed documents. > **Deprecated or unavailable:** The Knowledge Bases provider is deprecated and will be removed on 2025-11-01. Please migrate to the StackAI provider which includes equivalent knowledge base actions. ### Connectors This provider has no standalone connector in the StackAI catalog. Configure any access or service settings in the selected action or feature, using its field reference below. ### Use an action 1. Add the required **Knowledge Base** action to the workflow. 2. Select a connection when the action requests one. 3. Complete the required fields. Use the reference picker when a value comes from another workflow step. 4. Run the workflow and inspect the action’s output. Check the result before using it in a later step. ### Actions #### Search Knowledge Bases Search for information in a single knowledge base or multiple knowledge bases **Inputs** | Field | Type | Required | Description | | ------------------------------------------ | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Query | string | Yes | The query to search for. | | Knowledge Base | knowledge\_base | Yes | The knowledge base to search in. | | Enforce StackAI knowledge base permissions | boolean | No | Use permissions configured in StackAI. The user must be signed in and have access to every selected knowledge base; StackAI file-level restrictions are also enforced before results are returned. Default: false. | | Output Format | select (string) | No | Defines what type of retrieval to use. Available values: Chunks, Pages, Documents. Default: chunks. | | Query Strategy | select (string) | No | Defines the search strategy to use when searching the knowledge base. Available values: Semantic Search, Hybrid Search, Keyword Search. Default: semantic. | | Metadata Filter Strategy | select (string) | No | The metadata filter strategy to use. Available values: No Filter, Strict Filter, Loose Filter. Default: NO\_FILTER. | | Top Results | number | No | Defines the number of results to return. Minimum: 0. Maximum: 100. Default: 10. | | Max Characters | number | No | Defines the maximum length of the result in characters. Minimum: 0. Maximum: 1000000. Default: 15000. | | Answer Multiple Questions | boolean | No | Enable to get the answer from multiple questions in parallel. Default: false. | | Advanced Q\&A | boolean | No | Enable to handle questions to compare documents or summarize documents. Default: false. | | Rerank | boolean | No | Enable to get more precise information retrieval. Default: false. | | Query Transformation | boolean | No | Enable to get more precise information retrieval. Default: false. | **Outputs** | Field | Type | Description | | -------------- | ------------- | ------------------------------------------------------------ | | Query | string | The query that was used to search the knowledge base. | | Search Results | object\_array | The resulting chunks of text from the knowledge base search. | #### Explore Folders List the contents of a knowledge base folder recursively. **Inputs** | Field | Type | Required | Description | | ------------------------------------------ | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Path | string | No | The absolute path to the directory to list inside of the knowledge base. Default: /. | | Max Files Per Folder | number | No | Limit to the number of children files to list per folder. Lower this value to reduce the number of tokens used by the tool. Minimum: 1. Maximum: 1000. Default: 1000. | | List All Children | boolean | No | Whether to recursively list all children files and folders of the directory, or only the immediate children. Default: true. | | Directory | knowledge\_base | Yes | The directory to list. | | Enforce StackAI knowledge base permissions | boolean | No | Require the end user to hold a role on the knowledge base being explored. Default: false. | **Outputs** | Field | Type | Description | | -------------- | ------------- | ------------------------------------------- | | Directory Tree | object\_array | The directory contents as a tree structure. | #### Read File Read the full parsed content of a specific file from a knowledge base **Inputs** | Field | Type | Required | Description | | ------------------------------------------ | --------------- | -------- | ------------------------------------------------------------------------------------------------------------ | | File Path | string | Yes | The absolute path to the file to read within the knowledge base. | | Max Length | number | No | Maximum number of characters to return from the file content. Minimum: 100. Maximum: 100000. Default: 50000. | | Knowledge Base | knowledge\_base | Yes | The knowledge base containing the file to read. | | Enforce StackAI knowledge base permissions | boolean | No | Require the end user to hold a role on the knowledge base containing the file. Default: false. | **Outputs** | Field | Type | Description | | -------------- | ------ | -------------------------------------------------------- | | File Path | string | The path of the file that was read. | | File Content | string | The parsed text content of the file. | | File Type | string | The type/format of the file. | | Content Length | number | The actual length of the returned content in characters. | ### Important behavior Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data. The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings. --- # 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.stackai.com/integrations/catalog/knowledge-base.md?ask=&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.