Skip to content
Snippets Groups Projects
Commit 6f12d74b authored by James Briggs's avatar James Briggs
Browse files

feat: many new docs

parent 9a573f3c
No related branches found
No related tags found
No related merge requests found
Showing
with 26 additions and 20 deletions
semantic\_router.encoders.AutoEncoder semantic\_router.encoders.AutoEncoder
===================================== =====================================
.. currentmodule:: semantic_router.encoders .. currentmodule:: semantic_router.encoders
......
semantic\_router.encoders.base.BaseEncoder semantic\_router.encoders.base.BaseEncoder
========================================== ==========================================
.. currentmodule:: semantic_router.encoders.base .. currentmodule:: semantic_router.encoders.base
......
semantic\_router.encoders.bedrock.BedrockEncoder semantic\_router.encoders.bedrock.BedrockEncoder
================================================ ================================================
.. currentmodule:: semantic_router.encoders.bedrock .. currentmodule:: semantic_router.encoders.bedrock
......
semantic\_router.encoders.bm25.BM25Encoder semantic\_router.encoders.bm25.BM25Encoder
========================================== ==========================================
.. currentmodule:: semantic_router.encoders.bm25 .. currentmodule:: semantic_router.encoders.bm25
......
semantic\_router.encoders.clip.CLIPEncoder semantic\_router.encoders.clip.CLIPEncoder
========================================== ==========================================
.. currentmodule:: semantic_router.encoders.clip .. currentmodule:: semantic_router.encoders.clip
......
semantic\_router.encoders.cohere.CohereEncoder semantic\_router.encoders.cohere.CohereEncoder
============================================== ==============================================
.. currentmodule:: semantic_router.encoders.cohere .. currentmodule:: semantic_router.encoders.cohere
......
semantic\_router.encoders.fastembed.FastEmbedEncoder semantic\_router.encoders.fastembed.FastEmbedEncoder
==================================================== ====================================================
.. currentmodule:: semantic_router.encoders.fastembed .. currentmodule:: semantic_router.encoders.fastembed
......
semantic\_router.encoders.google.GoogleEncoder semantic\_router.encoders.google.GoogleEncoder
============================================== ==============================================
.. currentmodule:: semantic_router.encoders.google .. currentmodule:: semantic_router.encoders.google
......
semantic\_router.encoders.huggingface.HFEndpointEncoder semantic\_router.encoders.huggingface.HFEndpointEncoder
======================================================= =======================================================
.. currentmodule:: semantic_router.encoders.huggingface .. currentmodule:: semantic_router.encoders.huggingface
......
semantic\_router.encoders.huggingface.HuggingFaceEncoder semantic\_router.encoders.huggingface.HuggingFaceEncoder
======================================================== ========================================================
.. currentmodule:: semantic_router.encoders.huggingface .. currentmodule:: semantic_router.encoders.huggingface
......
semantic\_router.encoders.mistral.MistralEncoder semantic\_router.encoders.mistral.MistralEncoder
================================================ ================================================
.. currentmodule:: semantic_router.encoders.mistral .. currentmodule:: semantic_router.encoders.mistral
......
semantic\_router.encoders.openai.OpenAIEncoder semantic\_router.encoders.openai.OpenAIEncoder
============================================== ==============================================
.. currentmodule:: semantic_router.encoders.openai .. currentmodule:: semantic_router.encoders.openai
...@@ -45,6 +45,7 @@ semantic\_router.encoders.openai.OpenAIEncoder ...@@ -45,6 +45,7 @@ semantic\_router.encoders.openai.OpenAIEncoder
~OpenAIEncoder.dimensions ~OpenAIEncoder.dimensions
~OpenAIEncoder.token_limit ~OpenAIEncoder.token_limit
~OpenAIEncoder.type ~OpenAIEncoder.type
~OpenAIEncoder.max_retries
~OpenAIEncoder.name ~OpenAIEncoder.name
~OpenAIEncoder.score_threshold ~OpenAIEncoder.score_threshold
semantic\_router.encoders.tfidf.TfidfEncoder semantic\_router.encoders.tfidf.TfidfEncoder
============================================ ============================================
.. currentmodule:: semantic_router.encoders.tfidf .. currentmodule:: semantic_router.encoders.tfidf
......
semantic\_router.encoders.vit.VitEncoder semantic\_router.encoders.vit.VitEncoder
======================================== ========================================
.. currentmodule:: semantic_router.encoders.vit .. currentmodule:: semantic_router.encoders.vit
......
semantic\_router.encoders.zure.AzureOpenAIEncoder semantic\_router.encoders.zure.AzureOpenAIEncoder
================================================= =================================================
.. currentmodule:: semantic_router.encoders.zure .. currentmodule:: semantic_router.encoders.zure
...@@ -49,6 +49,7 @@ semantic\_router.encoders.zure.AzureOpenAIEncoder ...@@ -49,6 +49,7 @@ semantic\_router.encoders.zure.AzureOpenAIEncoder
~AzureOpenAIEncoder.azure_endpoint ~AzureOpenAIEncoder.azure_endpoint
~AzureOpenAIEncoder.api_version ~AzureOpenAIEncoder.api_version
~AzureOpenAIEncoder.model ~AzureOpenAIEncoder.model
~AzureOpenAIEncoder.max_retries
~AzureOpenAIEncoder.name ~AzureOpenAIEncoder.name
~AzureOpenAIEncoder.score_threshold ~AzureOpenAIEncoder.score_threshold
semantic\_router.hybrid\_layer.HybridRouteLayer semantic\_router.hybrid\_layer.HybridRouteLayer
=============================================== ===============================================
.. currentmodule:: semantic_router.hybrid_layer .. currentmodule:: semantic_router.hybrid_layer
......
semantic\_router.index.base.BaseIndex semantic\_router.index.base.BaseIndex
===================================== =====================================
.. currentmodule:: semantic_router.index.base .. currentmodule:: semantic_router.index.base
...@@ -18,6 +18,7 @@ semantic\_router.index.base.BaseIndex ...@@ -18,6 +18,7 @@ semantic\_router.index.base.BaseIndex
~BaseIndex.__init__ ~BaseIndex.__init__
~BaseIndex.add ~BaseIndex.add
~BaseIndex.aget_routes
~BaseIndex.aquery ~BaseIndex.aquery
~BaseIndex.construct ~BaseIndex.construct
~BaseIndex.copy ~BaseIndex.copy
...@@ -26,6 +27,7 @@ semantic\_router.index.base.BaseIndex ...@@ -26,6 +27,7 @@ semantic\_router.index.base.BaseIndex
~BaseIndex.describe ~BaseIndex.describe
~BaseIndex.dict ~BaseIndex.dict
~BaseIndex.from_orm ~BaseIndex.from_orm
~BaseIndex.get_routes
~BaseIndex.json ~BaseIndex.json
~BaseIndex.parse_file ~BaseIndex.parse_file
~BaseIndex.parse_obj ~BaseIndex.parse_obj
......
semantic\_router.index.local.LocalIndex semantic\_router.index.local.LocalIndex
======================================= =======================================
.. currentmodule:: semantic_router.index.local .. currentmodule:: semantic_router.index.local
...@@ -18,6 +18,7 @@ semantic\_router.index.local.LocalIndex ...@@ -18,6 +18,7 @@ semantic\_router.index.local.LocalIndex
~LocalIndex.__init__ ~LocalIndex.__init__
~LocalIndex.add ~LocalIndex.add
~LocalIndex.aget_routes
~LocalIndex.aquery ~LocalIndex.aquery
~LocalIndex.construct ~LocalIndex.construct
~LocalIndex.copy ~LocalIndex.copy
......
semantic\_router.index.pinecone.PineconeIndex semantic\_router.index.pinecone.PineconeIndex
============================================= =============================================
.. currentmodule:: semantic_router.index.pinecone .. currentmodule:: semantic_router.index.pinecone
...@@ -18,6 +18,7 @@ semantic\_router.index.pinecone.PineconeIndex ...@@ -18,6 +18,7 @@ semantic\_router.index.pinecone.PineconeIndex
~PineconeIndex.__init__ ~PineconeIndex.__init__
~PineconeIndex.add ~PineconeIndex.add
~PineconeIndex.aget_routes
~PineconeIndex.aquery ~PineconeIndex.aquery
~PineconeIndex.construct ~PineconeIndex.construct
~PineconeIndex.copy ~PineconeIndex.copy
......
semantic\_router.index.pinecone.PineconeRecord semantic\_router.index.pinecone.PineconeRecord
============================================== ==============================================
.. currentmodule:: semantic_router.index.pinecone .. currentmodule:: semantic_router.index.pinecone
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment