π Typical Uses
Use the Ingestion API when:- You have documents not tied to any connector but useful for search.
- You want to programmatically ingest documents instead of setting up a connector.
- You want to edit existing docs without altering their original source.
- You want to enhance connector docs (e.g., attach a README to a GitHub project).
π Example: Ingesting a Web Document
This example sends a document of type"web"
to Hymalaia via curl
.
βΉοΈ Note: The bearer token is generated at server startup in Hymalaia MIT. For more robust auth, API Keys are available in Hymalaia EE.
π Field Breakdown
Field | Description |
---|---|
id | Unique document ID. If omitted, itβs generated from semantic_identifier . Existing docs with same ID are updated. |
sections | List of content sections. Each has text and optionally a link . Sections are used for chunking and influence search results. |
source | Source type (e.g. "web" ). Full list found under DocumentSource in Hymalaia code. |
semantic_identifier | Acts as the title of the document in the UI. |
metadata | Metadata such as tag or topics . These are displayed as document tags. Accepts string or array. |
doc_updated_at | Timestamp of last update. Hymalaia uses this to apply recency-based scoring. |
cc_pair_id | Connector ID the doc should belong to. Use 1 for default. This links the doc to connector groups and deletion. |
π₯ Checking Ingested Documents
You can view all documents that have been indexed through the ingestion API using the corresponding endpoint (e.g./hymalaia-api/ingestion-docs
).
π See Also
DocumentBase
β Backend object used for ingestion.Connector Status
β See your connector IDs and metadata.
Need help or want to go deeper? Ping the Hymalaia team on Slack or Discord!