diff --git a/CHANGELOG.md b/CHANGELOG.md index 4e6c463e1..c8b3c62b7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -29,6 +29,7 @@ ### Fixes - The document index client now correctly URL-encodes document names in its queries. - The `ArgillaEvaluator` not properly supports `dataset_name` + - Update broken README links to Read The Docs ### Deprecations ... diff --git a/README.md b/README.md index 79c35b412..e7067d01a 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ The key features of the Intelligence Layer are: - [How to use the Intelligence Layer in Docker](#how-to-use-the-intelligence-layer-in-docker) - [Via the GitHub repository](#via-the-github-repository) - [Getting started](#getting-started) - - [Setup LLM access](#setup-llm-access) + - [Setup LLM access](#setup-llm-access) - [Tutorial Notebooks](#tutorial-notebooks) - [How-Tos](#how-tos) - [Models](#models) @@ -176,20 +176,20 @@ To give you a starting point for using the Intelligence Layer, we provide some p | Type | Task | Description | |-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Classify | [EmbeddingBasedClassify](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.use_cases.html#intelligence_layer.use_cases.EmbeddingBasedClassify) | Classify a short text by computing its similarity with example texts for each class. | -| Classify | [PromptBasedClassify](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.use_cases.html#intelligence_layer.use_cases.PromptBasedClassify) | Classify a short text by assessing each class' probability using zero-shot prompting. | -| Classify | [PromptBasedClassifyWithDefinitions](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.use_cases.html#intelligence_layer.use_cases.PromptBasedClassifyWithDefinitions) | Classify a short text by assessing each class' probability using zero-shot prompting. Each class is defined by a natural language description. | -| Classify | [KeywordExtract](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.use_cases.html#intelligence_layer.use_cases.KeywordExtract) | Generate matching labels for a short text. | -| QA | [MultipleChunkRetrieverQa](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.use_cases.html#intelligence_layer.use_cases.MultipleChunkRetrieverQa) | Answer a question based on an entire knowledge base. Recommended for most RAG-QA use-cases. | -| QA | [LongContextQa](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.use_cases.html#intelligence_layer.use_cases.LongContextQa) | Answer a question based on one document of any length. | -| QA | [MultipleChunkQa](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.use_cases.html#intelligence_layer.use_cases.MultipleChunkQa) | Answer a question based on a list of short texts. | -| QA | [SingleChunkQa](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.use_cases.html#intelligence_layer.use_cases.SingleChunkQa) | Answer a question based on a short text. | -| QA | [RetrieverBasedQa (deprecated)](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.use_cases.html#intelligence_layer.use_cases.RetrieverBasedQa) | Answer a question based on a document base using a [BaseRetriever](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.connectors.html#intelligence_layer.connectors.BaseRetriever) implementation. | -| Search | [Search](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.use_cases.html#intelligence_layer.use_cases.Search) | Search for texts in a document base using a [BaseRetriever](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.connectors.html#intelligence_layer.connectors.BaseRetriever) implementation. | -| Search | [ExpandChunks](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.use_cases.html#intelligence_layer.use_cases.ExpandChunks) | Expand chunks retrieved with a [BaseRetriever](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.connectors.html#intelligence_layer.connectors.BaseRetriever) implementation. | -| Summarize | [SteerableLongContextSummarize](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.use_cases.html#intelligence_layer.use_cases.SteerableLongContextSummarize) | Condense a long text into a summary with a natural language instruction. | -| Summarize | [SteerableSingleChunkSummarize](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.use_cases.html#intelligence_layer.use_cases.SteerableSingleChunkSummarize) | Condense a short text into a summary with a natural language instruction. | -| Summarize | [RecursiveSummarize](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.use_cases.html#intelligence_layer.use_cases.RecursiveSummarize) | Recursively condense a text into a summary. | +| Classify | [EmbeddingBasedClassify](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.examples.html#intelligence_layer.examples.EmbeddingBasedClassify) | Classify a short text by computing its similarity with example texts for each class. | +| Classify | [PromptBasedClassify](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.examples.html#intelligence_layer.examples.PromptBasedClassify) | Classify a short text by assessing each class' probability using zero-shot prompting. | +| Classify | [PromptBasedClassifyWithDefinitions](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.examples.html#intelligence_layer.examples.PromptBasedClassifyWithDefinitions) | Classify a short text by assessing each class' probability using zero-shot prompting. Each class is defined by a natural language description. | +| Classify | [KeywordExtract](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.examples.html#intelligence_layer.examples.KeywordExtract) | Generate matching labels for a short text. | +| QA | [MultipleChunkRetrieverQa](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.examples.html#intelligence_layer.examples.MultipleChunkRetrieverQa) | Answer a question based on an entire knowledge base. Recommended for most RAG-QA use-cases. | +| QA | [LongContextQa](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.examples.html#intelligence_layer.examples.LongContextQa) | Answer a question based on one document of any length. | +| QA | [MultipleChunkQa](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.examples.html#intelligence_layer.examples.MultipleChunkQa) | Answer a question based on a list of short texts. | +| QA | [SingleChunkQa](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.examples.html#intelligence_layer.examples.SingleChunkQa) | Answer a question based on a short text. | +| QA | [RetrieverBasedQa (deprecated)](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.examples.html#intelligence_layer.examples.RetrieverBasedQa) | Answer a question based on a document base using a [BaseRetriever](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.connectors.html#intelligence_layer.connectors.BaseRetriever) implementation. | +| Search | [Search](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.examples.html#intelligence_layer.examples.Search) | Search for texts in a document base using a [BaseRetriever](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.connectors.html#intelligence_layer.connectors.BaseRetriever) implementation. | +| Search | [ExpandChunks](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.examples.html#intelligence_layer.examples.ExpandChunks) | Expand chunks retrieved with a [BaseRetriever](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.connectors.html#intelligence_layer.connectors.BaseRetriever) implementation. | +| Summarize | [SteerableLongContextSummarize](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.examples.html#intelligence_layer.examples.SteerableLongContextSummarize) | Condense a long text into a summary with a natural language instruction. | +| Summarize | [SteerableSingleChunkSummarize](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.examples.html#intelligence_layer.examples.SteerableSingleChunkSummarize) | Condense a short text into a summary with a natural language instruction. | +| Summarize | [RecursiveSummarize](https://aleph-alpha-intelligence-layer.readthedocs-hosted.com/en/latest/intelligence_layer.examples.html#intelligence_layer.examples.RecursiveSummarize) | Recursively condense a text into a summary. | Note that we do not expect the above use cases to solve all of your issues. Instead, we encourage you to think of our pre-configured use cases as a foundation to fast-track your development process. diff --git a/docs/index.rst b/docs/index.rst index 68eb2fb3f..38d20788e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,11 +6,20 @@ Welcome to Intelligence Layer's documentation! ============================================== +This documentation provides API-level code documentation for the Intelligence Layer, covering modules such as connectors, core, evaluation, and examples. + +A comprehensive overview of the Intelligence Layer can be found on GitHub, including `tutorials `_ and `how-tos `_. +This code documentation is intended to serve as a reference companion to the main documentation, providing detailed information on the Intelligence Layer's API and implementation. + .. toctree:: :maxdepth: 1 :caption: Contents: - intelligence_layer + intelligence_layer.connectors + intelligence_layer.core + intelligence_layer.evaluation + intelligence_layer.examples + Indices and tables ================== diff --git a/docs/intelligence_layer.connectors.rst b/docs/intelligence_layer.connectors.rst index 0e9570b37..f38f9fe72 100644 --- a/docs/intelligence_layer.connectors.rst +++ b/docs/intelligence_layer.connectors.rst @@ -1,4 +1,4 @@ -intelligence\_layer.connectors package +intelligence\_layer.connectors ====================================== Module contents diff --git a/docs/intelligence_layer.core.rst b/docs/intelligence_layer.core.rst index cce640699..e1dbd4dfe 100644 --- a/docs/intelligence_layer.core.rst +++ b/docs/intelligence_layer.core.rst @@ -1,4 +1,4 @@ -intelligence\_layer.core package +intelligence\_layer.core ================================ Module contents diff --git a/docs/intelligence_layer.evaluation.rst b/docs/intelligence_layer.evaluation.rst index a871a800a..47a5cae5e 100644 --- a/docs/intelligence_layer.evaluation.rst +++ b/docs/intelligence_layer.evaluation.rst @@ -1,4 +1,4 @@ -intelligence\_layer.evaluation package +intelligence\_layer.evaluation ====================================== diff --git a/docs/intelligence_layer.use_cases.rst b/docs/intelligence_layer.examples.rst similarity index 75% rename from docs/intelligence_layer.use_cases.rst rename to docs/intelligence_layer.examples.rst index b620902f5..dacae35b8 100644 --- a/docs/intelligence_layer.use_cases.rst +++ b/docs/intelligence_layer.examples.rst @@ -1,4 +1,4 @@ -intelligence\_layer.use\_cases package +intelligence\_layer.examples ====================================== diff --git a/docs/intelligence_layer.rst b/docs/intelligence_layer.rst deleted file mode 100644 index 0e4ba8eef..000000000 --- a/docs/intelligence_layer.rst +++ /dev/null @@ -1,18 +0,0 @@ -intelligence\_layer package -=========================== - -Subpackages ------------ - -.. toctree:: - :maxdepth: 3 - - intelligence_layer.connectors - intelligence_layer.core - intelligence_layer.evaluation - intelligence_layer.use_cases - -Module contents ---------------- - -.. automodule:: intelligence_layer