💡 All-in-one AI framework for semantic search, LLM orchestration and language model workflows
Python agentsaiai-agentsembeddingsinformation-retrievallanguage-modellarge-language-modelsllmnlppythonragretrieval-augmented-generationsearchsearch-enginesemantic-searchsentence-embeddingstransformerstxtaivector-databasevector-search
Add FAQ section to documentation, closes #413
davidmezzettide5aeca831cf
diff --git a/docs/faq.md b/docs/faq.mdnew file mode 100644index 00000000..a448d1f8--- /dev/null+++ b/docs/faq.md@@ -0,0 +1,29 @@+# FAQ++Below is a list of frequently asked questions and common issues encountered.++----------++__Issue__++Embeddings query errors like this:++```+SQLError: no such function: json_extract+```++__Solution__++Upgrade Python version as it doesn't have SQLite support for json_extract++----------++__Issue__++Segmentation faults and similar errors on macOS++__Solution__++Downgrade PyTorch to <= 1.12. See issue [#377](https://github.com/neuml/txtai/issues/377) for more on this issue.++----------diff --git a/docs/install.md b/docs/install.mdindex f188322e..fce1582c 100644--- a/docs/install.md+++ b/docs/install.md@@ -120,15 +120,11 @@ Optional audio transcription requires a [system library to be installed](https:/Run `brew install libomp` see [this link](https://github.com/kyamagu/faiss-wheels#prerequisite)-_Note: Older versions of Python had issues with PyTorch 1.12+. If issues are encountered, either upgrade Python or downgrade PyTorch._-### WindowsOptional dependencies require [C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/)-_Note: Older versions of Python did not have SQLite JSON support. If issues are encountered, upgrade to a later version of Python._--The [txtai build workflow](https://github.com/neuml/txtai/blob/master/.github/workflows/build.yml) occasionally has work arounds for other known but temporary dependency issues.+The [txtai build workflow](https://github.com/neuml/txtai/blob/master/.github/workflows/build.yml) occasionally has work arounds for other known but temporary dependency issues. The [FAQ](../faq) also has a list of common problems, including common installation issues.## Install from sourcediff --git a/mkdocs.yml b/mkdocs.ymlindex 5b0c36ca..1332a376 100644--- a/mkdocs.yml+++ b/mkdocs.yml@@ -102,4 +102,5 @@ nav:- Configuration: api/configuration.md- Methods: api/methods.md- Cloud: cloud.md+ - FAQ: faq.md- Further Reading: further.md