> For the complete documentation index, see [llms.txt](https://docs.hyper-space.io/hyperspace-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hyper-space.io/hyperspace-docs/flows.md).

# flows

- [Setting Up](https://docs.hyper-space.io/hyperspace-docs/flows/setting-up.md)
- [Installing the Hyperspace API Client](https://docs.hyper-space.io/hyperspace-docs/flows/setting-up/installing-the-hyperspace-api-client.md)
- [Connecting to the Hyperspace Server](https://docs.hyper-space.io/hyperspace-docs/flows/setting-up/connecting-to-the-hyperspace-server.md)
- [Creating a Database Schema Configuration File](https://docs.hyper-space.io/hyperspace-docs/flows/setting-up/creating-a-database-schema-configuration-file.md)
- [Vector Similarity Metrics](https://docs.hyper-space.io/hyperspace-docs/flows/setting-up/creating-a-database-schema-configuration-file/vector-similarity-metrics.md)
- [Index Type Methods](https://docs.hyper-space.io/hyperspace-docs/flows/setting-up/creating-a-database-schema-configuration-file/index-type-methods.md)
- [Creating a Collection](https://docs.hyper-space.io/hyperspace-docs/flows/setting-up/creating-a-collection.md)
- [Uploading Data to a Collection](https://docs.hyper-space.io/hyperspace-docs/flows/setting-up/uploading-data-to-a-collection.md)
- [Building and Running Queries](https://docs.hyper-space.io/hyperspace-docs/flows/setting-up/building-and-running-queries.md)
- [Building a Lexical Search Query](https://docs.hyper-space.io/hyperspace-docs/flows/setting-up/building-and-running-queries/building-a-lexical-search-query.md): Describes how to build and run a Lexical Search query.
- [Building a Vector Search Query](https://docs.hyper-space.io/hyperspace-docs/flows/setting-up/building-and-running-queries/building-a-vector-search-query.md)
- [Building a Hybrid Search Query](https://docs.hyper-space.io/hyperspace-docs/flows/setting-up/building-and-running-queries/building-a-hybrid-search-query.md)
- [Retrieving Results](https://docs.hyper-space.io/hyperspace-docs/flows/setting-up/retrieving-results.md)
- [Data Collections](https://docs.hyper-space.io/hyperspace-docs/flows/data-collections.md)
- [Uploading Data](https://docs.hyper-space.io/hyperspace-docs/flows/data-collections/uploading-data.md)
- [Accessing Data](https://docs.hyper-space.io/hyperspace-docs/flows/data-collections/accessing-data.md)
- [Supported Data Types](https://docs.hyper-space.io/hyperspace-docs/flows/data-collections/supported-data-types.md)
- [Queries](https://docs.hyper-space.io/hyperspace-docs/flows/queries.md)
- [DSL Query interface](https://docs.hyper-space.io/hyperspace-docs/flows/queries/dsl-query-interface.md)
- [Aggregations](https://docs.hyper-space.io/hyperspace-docs/flows/queries/dsl-query-interface/aggregations.md)
- [Bool Query](https://docs.hyper-space.io/hyperspace-docs/flows/queries/dsl-query-interface/bool-query.md)
- [Candidate Generation and Metadata Filtering](https://docs.hyper-space.io/hyperspace-docs/flows/queries/dsl-query-interface/candidate-generation-and-metadata-filtering.md)
- [Scoring and Ranking](https://docs.hyper-space.io/hyperspace-docs/flows/queries/dsl-query-interface/scoring-and-ranking.md)


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.hyper-space.io/hyperspace-docs/flows.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.