weaviate-client/dist/node/cjs/collections/configure/generative.d.ts

JS/TS client for Weaviate

import { GenerativeAWSConfig, GenerativeAnthropicConfig, GenerativeAnyscaleConfig, GenerativeAzureOpenAIConfig, GenerativeCohereConfig, GenerativeDatabricksConfig, GenerativeFriendliAIConfig, GenerativeGoogleConfig, GenerativeMistralConfig, GenerativeNvidiaConfig, GenerativeOllamaConfig, GenerativeOpenAIConfig, GenerativePaLMConfig, GenerativeXAIConfig, ModuleConfig } from '../config/types/index.js';
import { GenerativeAWSConfigCreate, GenerativeAnthropicConfigCreate, GenerativeAnyscaleConfigCreate, GenerativeAzureOpenAIConfigCreate, GenerativeCohereConfigCreate, GenerativeDatabricksConfigCreate, GenerativeFriendliAIConfigCreate, GenerativeMistralConfigCreate, GenerativeNvidiaConfigCreate, GenerativeOllamaConfigCreate, GenerativeOpenAIConfigCreate, GenerativePaLMConfigCreate, GenerativeXAIConfigCreate } from '../index.js';
declare const _default: {
    /**
     * Create a `ModuleConfig<'generative-anthropic', GenerativeAnthropicConfig | undefined>` object for use when performing AI generation using the `generative-anthropic` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/anthropic/generative) for detailed usage.
     *
     * @param {GenerativeAnthropicConfigCreate} [config] The configuration for the `generative-anthropic` module.
     * @returns {ModuleConfig<'generative-anthropic', GenerativeAnthropicConfig | undefined>} The configuration object.
     */
    anthropic(config?: GenerativeAnthropicConfigCreate): ModuleConfig<'generative-anthropic', GenerativeAnthropicConfig | undefined>;
    /**
     * Create a `ModuleConfig<'generative-anyscale', GenerativeAnyscaleConfig | undefined>` object for use when performing AI generation using the `generative-anyscale` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/anyscale/generative) for detailed usage.
     *
     * @param {GenerativeAnyscaleConfigCreate} [config] The configuration for the `generative-aws` module.
     * @returns {ModuleConfig<'generative-anyscale', GenerativeAnyscaleConfig | undefined>} The configuration object.
     */
    anyscale(config?: GenerativeAnyscaleConfigCreate): ModuleConfig<'generative-anyscale', GenerativeAnyscaleConfig | undefined>;
    /**
     * Create a `ModuleConfig<'generative-aws', GenerativeAWSConfig>` object for use when performing AI generation using the `generative-aws` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/aws/generative) for detailed usage.
     *
     * @param {GenerativeAWSConfigCreate} config The configuration for the `generative-aws` module.
     * @returns {ModuleConfig<'generative-aws', GenerativeAWSConfig>} The configuration object.
     */
    aws(config: GenerativeAWSConfigCreate): ModuleConfig<'generative-aws', GenerativeAWSConfig>;
    /**
     * Create a `ModuleConfig<'generative-openai', GenerativeAzureOpenAIConfig>` object for use when performing AI generation using the `generative-openai` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/openai/generative) for detailed usage.
     *
     * @param {GenerativeAzureOpenAIConfigCreate} config The configuration for the `generative-openai` module.
     * @returns {ModuleConfig<'generative-openai', GenerativeAzureOpenAIConfig>} The configuration object.
     */
    azureOpenAI: (config: GenerativeAzureOpenAIConfigCreate) => ModuleConfig<'generative-openai', GenerativeAzureOpenAIConfig>;
    /**
     * Create a `ModuleConfig<'generative-cohere', GenerativeCohereConfig>` object for use when performing AI generation using the `generative-cohere` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/cohere/generative) for detailed usage.
     *
     * @param {GenerativeCohereConfigCreate} [config] The configuration for the `generative-cohere` module.
     * @returns {ModuleConfig<'generative-cohere', GenerativeCohereConfig | undefined>} The configuration object.
     */
    cohere: (config?: GenerativeCohereConfigCreate) => ModuleConfig<'generative-cohere', GenerativeCohereConfig | undefined>;
    /**
     * Create a `ModuleConfig<'generative-databricks', GenerativeDatabricksConfig>` object for use when performing AI generation using the `generative-databricks` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/databricks/generative) for detailed usage.
     *
     * @param {GenerativeDatabricksConfigCreate} config The configuration for the `generative-databricks` module.
     * @returns {ModuleConfig<'generative-databricks', GenerativeDatabricksConfig>} The configuration object.
     */
    databricks: (config: GenerativeDatabricksConfigCreate) => ModuleConfig<'generative-databricks', GenerativeDatabricksConfig>;
    /**
     * Create a `ModuleConfig<'generative-friendliai', GenerativeFriendliAIConfig | undefined>` object for use when performing AI generation using the `generative-friendliai` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/friendliai/generative) for detailed usage.
     */
    friendliai(config?: GenerativeFriendliAIConfigCreate): ModuleConfig<'generative-friendliai', GenerativeFriendliAIConfig | undefined>;
    /**
     * Create a `ModuleConfig<'generative-mistral', GenerativeMistralConfig | undefined>` object for use when performing AI generation using the `generative-mistral` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/mistral/generative) for detailed usage.
     *
     * @param {GenerativeMistralConfigCreate} [config] The configuration for the `generative-mistral` module.
     * @returns {ModuleConfig<'generative-mistral', GenerativeMistralConfig | undefined>} The configuration object.
     */
    mistral(config?: GenerativeMistralConfigCreate): ModuleConfig<'generative-mistral', GenerativeMistralConfig | undefined>;
    /**
     * Create a `ModuleConfig<'generative-nvidia', GenerativeNvidiaConfig | undefined>` object for use when performing AI generation using the `generative-mistral` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/nvidia/generative) for detailed usage.
     *
     * @param {GenerativeNvidiaConfigCreate} [config] The configuration for the `generative-nvidia` module.
     * @returns {ModuleConfig<'generative-nvidia', GenerativeNvidiaConfig | undefined>} The configuration object.
     */
    nvidia(config?: GenerativeNvidiaConfigCreate): ModuleConfig<'generative-nvidia', GenerativeNvidiaConfig | undefined>;
    /**
     * Create a `ModuleConfig<'generative-ollama', GenerativeOllamaConfig | undefined>` object for use when performing AI generation using the `generative-ollama` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/ollama/generative) for detailed usage.
     *
     * @param {GenerativeOllamaConfigCreate} [config] The configuration for the `generative-openai` module.
     * @returns {ModuleConfig<'generative-ollama', GenerativeOllamaConfig | undefined>} The configuration object.
     */
    ollama(config?: GenerativeOllamaConfigCreate): ModuleConfig<'generative-ollama', GenerativeOllamaConfig | undefined>;
    /**
     * Create a `ModuleConfig<'generative-openai', GenerativeOpenAIConfig | undefined>` object for use when performing AI generation using the `generative-openai` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/openai/generative) for detailed usage.
     *
     * @param {GenerativeOpenAIConfigCreate} [config] The configuration for the `generative-openai` module.
     * @returns {ModuleConfig<'generative-openai', GenerativeOpenAIConfig | undefined>} The configuration object.
     */
    openAI: (config?: GenerativeOpenAIConfigCreate) => ModuleConfig<'generative-openai', GenerativeOpenAIConfig | undefined>;
    /**
     * Create a `ModuleConfig<'generative-palm', GenerativePaLMConfig>` object for use when performing AI generation using the `generative-palm` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/google/generative) for detailed usage.
     *
     * @param {GenerativePaLMConfigCreate} [config] The configuration for the `generative-palm` module.
     * @returns {ModuleConfig<'generative-palm', GenerativePaLMConfig>} The configuration object.
     * @deprecated Use `google` instead.
     */
    palm: (config?: GenerativePaLMConfigCreate) => ModuleConfig<'generative-palm', GenerativePaLMConfig | undefined>;
    /**
     * Create a `ModuleConfig<'generative-google', GenerativeGoogleConfig>` object for use when performing AI generation using the `generative-google` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/google/generative) for detailed usage.
     *
     * @param {GenerativePaLMConfigCreate} [config] The configuration for the `generative-palm` module.
     * @returns {ModuleConfig<'generative-palm', GenerativePaLMConfig>} The configuration object.
     */
    google: (config?: GenerativePaLMConfigCreate) => ModuleConfig<'generative-google', GenerativeGoogleConfig | undefined>;
    /**
     * Create a `ModuleConfig<'generative-xai', GenerativeXAIConfig | undefined>` object for use when performing AI generation using the `generative-xai` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/xai/generative) for detailed usage.
     *
     * @param {GenerativeXAIConfigCreate} [config] The configuration for the `generative-xai` module.
     * @returns {ModuleConfig<'generative-xai', GenerativeXAIConfig | undefined>} The configuration object.
     */
    xai: (config?: GenerativeXAIConfigCreate) => ModuleConfig<'generative-xai', GenerativeXAIConfig | undefined>;
};
export default _default;