feat: many new docs

[jamescalam]

PR Type

Documentation

---

Description

• Fixed encoding issues in multiple documentation files, ensuring proper display and readability.
• Added new documentation for several components, including MetricPgVecOperatorMap, PostgresIndex, PostgresIndexRecord, FunctionSchema, and Parameter.
• Updated existing documentation to include new methods and attributes, such as max_retries for OpenAIEncoder and AzureOpenAIEncoder.
• Removed outdated API reference documentation and restructured the index to include new sections.
• Introduced new sections for Route Layer, route_filter parameter, and synchronization strategies, providing detailed usage examples and explanations.

---

Changes walkthrough 📝

Relevant files

Documentation

61 files semantic_router.encoders.AutoEncoder.rst Fix encoding issue in AutoEncoder documentation                    docs/source/_autosummary/semantic_router.encoders.AutoEncoder.rst Fixed encoding issue in the file header. +1/-1      semantic_router.encoders.base.BaseEncoder.rst Fix encoding issue in BaseEncoder documentation                    docs/source/_autosummary/semantic_router.encoders.base.BaseEncoder.rst Fixed encoding issue in the file header. +1/-1      semantic_router.encoders.bedrock.BedrockEncoder.rst Fix encoding issue in BedrockEncoder documentation              docs/source/_autosummary/semantic_router.encoders.bedrock.BedrockEncoder.rst Fixed encoding issue in the file header. +1/-1      semantic_router.encoders.bm25.BM25Encoder.rst Fix encoding issue in BM25Encoder documentation                    docs/source/_autosummary/semantic_router.encoders.bm25.BM25Encoder.rst Fixed encoding issue in the file header. +1/-1      semantic_router.encoders.clip.CLIPEncoder.rst Fix encoding issue in CLIPEncoder documentation                    docs/source/_autosummary/semantic_router.encoders.clip.CLIPEncoder.rst Fixed encoding issue in the file header. +1/-1      semantic_router.encoders.cohere.CohereEncoder.rst Fix encoding issue in CohereEncoder documentation                docs/source/_autosummary/semantic_router.encoders.cohere.CohereEncoder.rst Fixed encoding issue in the file header. +1/-1      semantic_router.encoders.fastembed.FastEmbedEncoder.rst Fix encoding issue in FastEmbedEncoder documentation          docs/source/_autosummary/semantic_router.encoders.fastembed.FastEmbedEncoder.rst Fixed encoding issue in the file header. +1/-1      semantic_router.encoders.google.GoogleEncoder.rst Fix encoding issue in GoogleEncoder documentation                docs/source/_autosummary/semantic_router.encoders.google.GoogleEncoder.rst Fixed encoding issue in the file header. +1/-1      semantic_router.encoders.huggingface.HFEndpointEncoder.rst Fix encoding issue in HFEndpointEncoder documentation        docs/source/_autosummary/semantic_router.encoders.huggingface.HFEndpointEncoder.rst Fixed encoding issue in the file header. +1/-1      semantic_router.encoders.huggingface.HuggingFaceEncoder.rst Fix encoding issue in HuggingFaceEncoder documentation      docs/source/_autosummary/semantic_router.encoders.huggingface.HuggingFaceEncoder.rst Fixed encoding issue in the file header. +1/-1      semantic_router.encoders.mistral.MistralEncoder.rst Fix encoding issue in MistralEncoder documentation              docs/source/_autosummary/semantic_router.encoders.mistral.MistralEncoder.rst Fixed encoding issue in the file header. +1/-1      semantic_router.encoders.openai.OpenAIEncoder.rst Fix encoding issue and add max_retries to OpenAIEncoder    docs/source/_autosummary/semantic_router.encoders.openai.OpenAIEncoder.rst Fixed encoding issue in the file header. Added max_retries attribute to OpenAIEncoder. +2/-1      semantic_router.encoders.tfidf.TfidfEncoder.rst Fix encoding issue in TfidfEncoder documentation                  docs/source/_autosummary/semantic_router.encoders.tfidf.TfidfEncoder.rst Fixed encoding issue in the file header. +1/-1      semantic_router.encoders.vit.VitEncoder.rst Fix encoding issue in VitEncoder documentation                      docs/source/_autosummary/semantic_router.encoders.vit.VitEncoder.rst Fixed encoding issue in the file header. +1/-1      semantic_router.encoders.zure.AzureOpenAIEncoder.rst Fix encoding issue and add max_retries to AzureOpenAIEncoder docs/source/_autosummary/semantic_router.encoders.zure.AzureOpenAIEncoder.rst Fixed encoding issue in the file header. Added max_retries attribute to AzureOpenAIEncoder. +2/-1      semantic_router.hybrid_layer.HybridRouteLayer.rst Fix encoding issue in HybridRouteLayer documentation          docs/source/_autosummary/semantic_router.hybrid_layer.HybridRouteLayer.rst Fixed encoding issue in the file header. +1/-1      semantic_router.index.base.BaseIndex.rst Fix encoding issue and add methods to BaseIndex                    docs/source/_autosummary/semantic_router.index.base.BaseIndex.rst Fixed encoding issue in the file header. Added aget_routes and get_routes methods to BaseIndex. +3/-1      semantic_router.index.local.LocalIndex.rst Fix encoding issue and add method to LocalIndex                    docs/source/_autosummary/semantic_router.index.local.LocalIndex.rst Fixed encoding issue in the file header. Added aget_routes method to LocalIndex. +2/-1      semantic_router.index.pinecone.PineconeIndex.rst Fix encoding issue and add method to PineconeIndex              docs/source/_autosummary/semantic_router.index.pinecone.PineconeIndex.rst Fixed encoding issue in the file header. Added aget_routes method to PineconeIndex. +2/-1      semantic_router.index.pinecone.PineconeRecord.rst Fix encoding issue in PineconeRecord documentation              docs/source/_autosummary/semantic_router.index.pinecone.PineconeRecord.rst Fixed encoding issue in the file header. +1/-1      semantic_router.index.postgres.MetricPgVecOperatorMap.rst Add documentation for MetricPgVecOperatorMap                          docs/source/_autosummary/semantic_router.index.postgres.MetricPgVecOperatorMap.rst Added new documentation for MetricPgVecOperatorMap. +28/-0    semantic_router.index.postgres.PostgresIndex.rst Add documentation for PostgresIndex                                            docs/source/_autosummary/semantic_router.index.postgres.PostgresIndex.rst Added new documentation for PostgresIndex. +65/-0    semantic_router.index.postgres.PostgresIndexRecord.rst Add documentation for PostgresIndexRecord                                docs/source/_autosummary/semantic_router.index.postgres.PostgresIndexRecord.rst Added new documentation for PostgresIndexRecord. +63/-0    semantic_router.index.postgres.clean_route_name.rst Add documentation for clean_route_name function                    docs/source/_autosummary/semantic_router.index.postgres.clean_route_name.rst Added new documentation for clean_route_name function. +6/-0      semantic_router.index.postgres.parse_vector.rst Add documentation for parse_vector function                            docs/source/_autosummary/semantic_router.index.postgres.parse_vector.rst Added new documentation for parse_vector function. +6/-0      semantic_router.index.postgres.rst Add documentation for semantic_router.index.postgres module docs/source/_autosummary/semantic_router.index.postgres.rst Added new documentation for semantic_router.index.postgres module. +41/-0    semantic_router.index.qdrant.QdrantIndex.rst Fix encoding issue and add method to QdrantIndex                  docs/source/_autosummary/semantic_router.index.qdrant.QdrantIndex.rst Fixed encoding issue in the file header. Added aget_routes method to QdrantIndex. +2/-1      semantic_router.index.rst Fix encoding issue and add postgres reference                        docs/source/_autosummary/semantic_router.index.rst Fixed encoding issue in the file header. Added reference to semantic_router.index.postgres. +2/-1      semantic_router.layer.LayerConfig.rst Fix encoding issue in LayerConfig documentation                    docs/source/_autosummary/semantic_router.layer.LayerConfig.rst Fixed encoding issue in the file header. +1/-1      semantic_router.layer.RouteLayer.rst Fix encoding issue in RouteLayer documentation                      docs/source/_autosummary/semantic_router.layer.RouteLayer.rst Fixed encoding issue in the file header. +1/-1      semantic_router.llms.base.BaseLLM.rst Fix encoding issue in BaseLLM documentation                            docs/source/_autosummary/semantic_router.llms.base.BaseLLM.rst Fixed encoding issue in the file header. +1/-1      semantic_router.llms.cohere.CohereLLM.rst Fix encoding issue in CohereLLM documentation                        docs/source/_autosummary/semantic_router.llms.cohere.CohereLLM.rst Fixed encoding issue in the file header. +1/-1      semantic_router.llms.llamacpp.LlamaCppLLM.rst Fix encoding issue in LlamaCppLLM documentation                    docs/source/_autosummary/semantic_router.llms.llamacpp.LlamaCppLLM.rst Fixed encoding issue in the file header. +1/-1      semantic_router.llms.mistral.MistralAILLM.rst Fix encoding issue in MistralAILLM documentation                  docs/source/_autosummary/semantic_router.llms.mistral.MistralAILLM.rst Fixed encoding issue in the file header. +1/-1      semantic_router.llms.ollama.OllamaLLM.rst Fix encoding issue in OllamaLLM documentation                        docs/source/_autosummary/semantic_router.llms.ollama.OllamaLLM.rst Fixed encoding issue in the file header. +1/-1      semantic_router.llms.openai.OpenAILLM.rst Fix encoding issue in OpenAILLM documentation                        docs/source/_autosummary/semantic_router.llms.openai.OpenAILLM.rst Fixed encoding issue in the file header. +1/-1      semantic_router.llms.openrouter.OpenRouterLLM.rst Fix encoding issue in OpenRouterLLM documentation                docs/source/_autosummary/semantic_router.llms.openrouter.OpenRouterLLM.rst Fixed encoding issue in the file header. +1/-1      semantic_router.llms.zure.AzureOpenAILLM.rst Fix encoding issue in AzureOpenAILLM documentation              docs/source/_autosummary/semantic_router.llms.zure.AzureOpenAILLM.rst Fixed encoding issue in the file header. +1/-1      semantic_router.route.Route.rst Fix encoding issue in Route documentation                                docs/source/_autosummary/semantic_router.route.Route.rst Fixed encoding issue in the file header. +1/-1      semantic_router.schema.DocumentSplit.rst Fix encoding issue in DocumentSplit documentation                docs/source/_autosummary/semantic_router.schema.DocumentSplit.rst Fixed encoding issue in the file header. +1/-1      semantic_router.schema.EncoderInfo.rst Fix encoding issue in EncoderInfo documentation                    docs/source/_autosummary/semantic_router.schema.EncoderInfo.rst Fixed encoding issue in the file header. +1/-1      semantic_router.schema.EncoderType.rst Fix encoding issue in EncoderType documentation                    docs/source/_autosummary/semantic_router.schema.EncoderType.rst Fixed encoding issue in the file header. +1/-1      semantic_router.schema.Message.rst Fix encoding issue in Message documentation                            docs/source/_autosummary/semantic_router.schema.Message.rst Fixed encoding issue in the file header. +1/-1      semantic_router.schema.Metric.rst Fix encoding issue in Metric documentation                              docs/source/_autosummary/semantic_router.schema.Metric.rst Fixed encoding issue in the file header. +1/-1      semantic_router.schema.RouteChoice.rst Fix encoding issue in RouteChoice documentation                    docs/source/_autosummary/semantic_router.schema.RouteChoice.rst Fixed encoding issue in the file header. +1/-1      semantic_router.splitters.base.BaseSplitter.rst Fix encoding issue in BaseSplitter documentation                  docs/source/_autosummary/semantic_router.splitters.base.BaseSplitter.rst Fixed encoding issue in the file header. +1/-1      semantic_router.splitters.consecutive_sim.ConsecutiveSimSplitter.rst Fix encoding issue in ConsecutiveSimSplitter documentation docs/source/_autosummary/semantic_router.splitters.consecutive_sim.ConsecutiveSimSplitter.rst Fixed encoding issue in the file header. +1/-1      semantic_router.splitters.cumulative_sim.CumulativeSimSplitter.rst Fix encoding issue in CumulativeSimSplitter documentation docs/source/_autosummary/semantic_router.splitters.cumulative_sim.CumulativeSimSplitter.rst Fixed encoding issue in the file header. +1/-1      semantic_router.splitters.rolling_window.RollingWindowSplitter.rst Fix encoding issue in RollingWindowSplitter documentation docs/source/_autosummary/semantic_router.splitters.rolling_window.RollingWindowSplitter.rst Fixed encoding issue in the file header. +1/-1      semantic_router.splitters.rolling_window.SplitStatistics.rst Fix encoding issue in SplitStatistics documentation            docs/source/_autosummary/semantic_router.splitters.rolling_window.SplitStatistics.rst Fixed encoding issue in the file header. +1/-1      semantic_router.text.Conversation.rst Fix encoding issue in Conversation documentation                  docs/source/_autosummary/semantic_router.text.Conversation.rst Fixed encoding issue in the file header. +1/-1      semantic_router.utils.defaults.EncoderDefault.rst Fix encoding issue in EncoderDefault documentation              docs/source/_autosummary/semantic_router.utils.defaults.EncoderDefault.rst Fixed encoding issue in the file header. +1/-1      semantic_router.utils.function_call.FunctionSchema.rst Add documentation for FunctionSchema                                          docs/source/_autosummary/semantic_router.utils.function_call.FunctionSchema.rst Added new documentation for FunctionSchema. +36/-0    semantic_router.utils.function_call.Parameter.rst Add documentation for Parameter                                                    docs/source/_autosummary/semantic_router.utils.function_call.Parameter.rst Added new documentation for Parameter. +48/-0    semantic_router.utils.function_call.rst Fix encoding issue and add class references                            docs/source/_autosummary/semantic_router.utils.function_call.rst Fixed encoding issue in the file header. Added references to FunctionSchema and Parameter classes. +10/-1    semantic_router.utils.logger.CustomFormatter.rst Fix encoding issue in CustomFormatter documentation            docs/source/_autosummary/semantic_router.utils.logger.CustomFormatter.rst Fixed encoding issue in the file header. +1/-1      api.rst Remove API reference documentation                                              docs/source/api.rst Removed API reference documentation. +0/-9      index.rst Update index with new documentation structure                        docs/source/index.rst Updated index with new toctree structure. Added references to new documentation sections. +9/-7      route_layer.rst Add documentation for Route Layer                                                docs/source/route_layer.rst Added new documentation for Route Layer. +130/-0  route_filter.rst Add documentation for route_filter parameter                          docs/source/route_layer/route_filter.rst Added new documentation for route_filter parameter. +5/-0      sync.rst Add documentation for synchronization strategies                  docs/source/route_layer/sync.rst Added new documentation for synchronization strategies. +68/-0

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[github-actions]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ No key issues to review

[github-actions]

PR Code Suggestions ✨

No code suggestions found for the PR.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.14%. Comparing base (286510f) to head (64c0439).
Report is 3 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #406   +/-   ##
=======================================
  Coverage   63.14%   63.14%           
=======================================
  Files          46       46           
  Lines        3424     3424           
=======================================
  Hits         2162     2162           
  Misses       1262     1262           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.