Richie-rk/encompass-developer-connect-index

Encompass Developer Connect — Hybrid Retrieval Index

Unofficial. Not affiliated with ICE Mortgage Technology. A community-built retrieval index over the publicly available Encompass Developer Connect documentation, intended as a developer reference and for educational/research use. For canonical, up-to-date documentation, always defer to the official source: https://developer.icemortgagetechnology.com/.

What this is

A hybrid (semantic + lexical) retrieval index over the publicly accessible Encompass Developer Connect prose documentation, plus structured Postman endpoint metadata.

Component	Count	Source
Prose chunks	32,295	Crawled from developer.icemortgagetechnology.com (public pages only; auth-gated content is excluded at crawl time)
Postman endpoints	753	The publicly distributed Encompass Developer Connect Postman collection
Embeddings	Jina v3 (jinaai/jina-embeddings-v3, 1024-d)	Computed locally

Files

jsonl_faiss/
├── index.faiss              FAISS-IP index, Jina v3 vectors
└── index.pkl                LangChain docstore for the FAISS index
jsonl_bm25.pkl               BM25Okapi over prose chunks
jsonl_chunks.pkl             Chunk texts + metadata (incl. source URL)
postman_bm25.pkl             BM25Okapi over Postman entries
postman_entries.pkl          PostmanEntry objects (method, url, headers, body)
stats.json                   Build statistics

How to use

from huggingface_hub import snapshot_download

path = snapshot_download(
    repo_id="Richie-rk/encompass-developer-connect-index",
    repo_type="dataset",
)
# `path` now contains the index files; point your retriever at it.

For the RAG pipeline that produced this index, see: https://github.com/richie-rk/EncompassRest-RAG-Assistant

Attribution

Every chunk's metadata includes the original source URL on developer.icemortgagetechnology.com. Always defer to the official documentation as the source of truth.

License

The retrieval index schema and the pipeline code are released under MIT.

The underlying documentation content is owned by ICE Mortgage Technology, Inc. This dataset is provided for developer reference and educational/research use only, and is not affiliated with or endorsed by ICE Mortgage Technology. If you are the rights holder and would like this dataset removed, please open an issue on the GitHub repo linked above and it will be taken down promptly.