--- title: embedding | CodeWeaver Docs description: API reference for codeweaver.providers.config.categories.embedding url: "https://docs.knitli.com/api/providers/config/categories/embedding" type: static generatedAt: "2026-04-17T17:21:08.741Z" --- # embedding [Open in ChatGPT](https://chatgpt.com/?q=Read%20https%3A%2F%2Fdocs.knitli.com%2Fcodeweaver%2Fapi%2Fproviders%2Fconfig%2Fcategories%2Fembedding%2F.%20I%20want%20to%20ask%20questions%20about%20it.)[Open in Claude](https://claude.ai/new?q=Read%20https%3A%2F%2Fdocs.knitli.com%2Fcodeweaver%2Fapi%2Fproviders%2Fconfig%2Fcategories%2Fembedding%2F.%20I%20want%20to%20ask%20questions%20about%20it.)[View in Markdown](/codeweaver/api/providers/config/categories/embedding.md) [Share on LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fdocs.knitli.com%2Fcodeweaver%2Fapi%2Fproviders%2Fconfig%2Fcategories%2Fembedding%2F)[Share on X](https://x.com/intent/tweet?url=https%3A%2F%2Fdocs.knitli.com%2Fcodeweaver%2Fapi%2Fproviders%2Fconfig%2Fcategories%2Fembedding%2F&text=embedding)[Share on Threads](https://threads.net/intent/post?url=https%3A%2F%2Fdocs.knitli.com%2Fcodeweaver%2Fapi%2Fproviders%2Fconfig%2Fcategories%2Fembedding%2F&text=embedding)[Share on Bluesky](https://bsky.app/intent/compose?text=embedding%20https%3A%2F%2Fdocs.knitli.com%2Fcodeweaver%2Fapi%2Fproviders%2Fconfig%2Fcategories%2Fembedding%2F)[Share on Facebook](https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Fdocs.knitli.com%2Fcodeweaver%2Fapi%2Fproviders%2Fconfig%2Fcategories%2Fembedding%2F)[Share on Reddit](https://reddit.com/submit?url=https%3A%2F%2Fdocs.knitli.com%2Fcodeweaver%2Fapi%2Fproviders%2Fconfig%2Fcategories%2Fembedding%2F&title=embedding)[Share on Hacker News](https://news.ycombinator.com/submitlink?u=https%3A%2F%2Fdocs.knitli.com%2Fcodeweaver%2Fapi%2Fproviders%2Fconfig%2Fcategories%2Fembedding%2F&t=embedding)[Share on Email](mailto:?subject=embedding&body=https%3A%2F%2Fdocs.knitli.com%2Fcodeweaver%2Fapi%2Fproviders%2Fconfig%2Fcategories%2Fembedding%2F)[Share on WhatsApp](https://wa.me/?text=embedding%20https%3A%2F%2Fdocs.knitli.com%2Fcodeweaver%2Fapi%2Fproviders%2Fconfig%2Fcategories%2Fembedding%2F)[Share on Telegram](https://t.me/share/url?url=https%3A%2F%2Fdocs.knitli.com%2Fcodeweaver%2Fapi%2Fproviders%2Fconfig%2Fcategories%2Fembedding%2F&text=embedding) # `codeweaver.providers.config.categories.embedding` [Section titled “codeweaver.providers.config.categories.embedding”](#codeweaverprovidersconfigcategoriesembedding) Top-level settings classes for embedding providers. ## Class: `AsymmetricEmbeddingProviderSettings` [Section titled “Class: AsymmetricEmbeddingProviderSettings”](#class-asymmetricembeddingprovidersettings) Configuration for asymmetric embedding setup with separate embed and query models. Asymmetric embedding allows using different models for document embedding and query embedding while maintaining compatibility through shared vector spaces. This enables cost optimization (e.g., API for embed, local for queries) while preserving accuracy. Attributes: config_type: Discriminator field for union type matching. embed_provider: Provider settings for document embedding model. query_provider: Provider settings for query embedding model. validate_family_compatibility: Whether to validate models belong to same family. ### Method: `get_embed_kwargs` [Section titled “Method: get_embed_kwargs”](#method-get_embed_kwargs) ** ``` get_embed_kwargs() ``` Get keyword arguments for the embed provider. ### Method: `get_query_kwargs` [Section titled “Method: get_query_kwargs”](#method-get_query_kwargs) ** ``` get_query_kwargs() ``` Get keyword arguments for the query provider. ### Method: `validate_model_compatibility` [Section titled “Method: validate_model_compatibility”](#method-validate_model_compatibility) ** ``` validate_model_compatibility() ``` Validate that embed and query models are compatible. ## Class: `AsymmetricEmbeddingProviderSettingsDict` [Section titled “Class: AsymmetricEmbeddingProviderSettingsDict”](#class-asymmetricembeddingprovidersettingsdict) Dictionary representation of asymmetric embedding configuration. ## Class: `AzureEmbeddingProviderSettings` [Section titled “Class: AzureEmbeddingProviderSettings”](#class-azureembeddingprovidersettings) Provider settings for Azure embedding models (Cohere or OpenAI). ## Class: `BaseEmbeddingProviderSettings` [Section titled “Class: BaseEmbeddingProviderSettings”](#class-baseembeddingprovidersettings) Settings for (dense) embedding models. It validates that the model and provider settings are compatible and complete, reconciling environment variables and config file settings as needed. ### Method: `get_embed_kwargs` [Section titled “Method: get_embed_kwargs”](#method-get_embed_kwargs-1) ** ``` get_embed_kwargs() ``` Get keyword arguments for embedding requests based on the provider settings. ### Method: `get_query_embed_kwargs` [Section titled “Method: get_query_embed_kwargs”](#method-get_query_embed_kwargs) ** ``` get_query_embed_kwargs() ``` Get keyword arguments for query embedding requests based on the provider settings. ### Method: `is_cloud` [Section titled “Method: is_cloud”](#method-is_cloud) ** ``` is_cloud() ``` Return True if the provider settings are for a cloud deployment. ## Class: `BedrockEmbeddingProviderSettings` [Section titled “Class: BedrockEmbeddingProviderSettings”](#class-bedrockembeddingprovidersettings) Provider settings for Bedrock embedding models. ## Class: `CohereEmbeddingProviderSettings` [Section titled “Class: CohereEmbeddingProviderSettings”](#class-cohereembeddingprovidersettings) Provider settings for direct use of Cohere as a provider. ## Class: `EmbeddingProviderSettings` [Section titled “Class: EmbeddingProviderSettings”](#class-embeddingprovidersettings) Settings for dense embedding models. ### Method: `get_embed_kwargs` [Section titled “Method: get_embed_kwargs”](#method-get_embed_kwargs-2) ** ``` get_embed_kwargs() ``` Get keyword arguments for embedding requests based on the provider settings. ### Method: `get_query_embed_kwargs` [Section titled “Method: get_query_embed_kwargs”](#method-get_query_embed_kwargs-1) ** ``` get_query_embed_kwargs() ``` Get keyword arguments for query embedding requests based on the provider settings. ### Method: `is_cloud` [Section titled “Method: is_cloud”](#method-is_cloud-1) ** ``` is_cloud() ``` Return True if the provider settings are for a cloud deployment. ## Class: `FastEmbedEmbeddingProviderSettings` [Section titled “Class: FastEmbedEmbeddingProviderSettings”](#class-fastembedembeddingprovidersettings) Provider settings for FastEmbed embedding models. ## Class: `GoogleEmbeddingProviderSettings` [Section titled “Class: GoogleEmbeddingProviderSettings”](#class-googleembeddingprovidersettings) Provider settings for Google embedding models. ## Class: `HuggingFaceEmbeddingProviderSettings` [Section titled “Class: HuggingFaceEmbeddingProviderSettings”](#class-huggingfaceembeddingprovidersettings) Provider settings for HuggingFace Inference embedding models. ## Class: `MistralEmbeddingProviderSettings` [Section titled “Class: MistralEmbeddingProviderSettings”](#class-mistralembeddingprovidersettings) Provider settings for Mistral embedding models. ## Class: `SentenceTransformersEmbeddingProviderSettings` [Section titled “Class: SentenceTransformersEmbeddingProviderSettings”](#class-sentencetransformersembeddingprovidersettings) Provider settings for Sentence Transformers embedding models. ## Class: `VoyageEmbeddingProviderSettings` [Section titled “Class: VoyageEmbeddingProviderSettings”](#class-voyageembeddingprovidersettings) Provider settings for Voyage embedding models.