weaviate-client/dist/node/cjs/collections/generate/config.d.ts

JS/TS client for Weaviate

import { ModuleConfig } from '../config/types/index.js';
import { GenerativeAWSConfigRuntime, GenerativeAnthropicConfigRuntime, GenerativeAnyscaleConfigRuntime, GenerativeCohereConfigRuntime, GenerativeConfigRuntimeType, GenerativeDatabricksConfigRuntime, GenerativeFriendliAIConfigRuntime, GenerativeGoogleConfigRuntime, GenerativeMistralConfigRuntime, GenerativeNvidiaConfigRuntime, GenerativeOllamaConfigRuntime, GenerativeOpenAIConfigRuntime, GenerativeXAIConfigRuntime } from '../index.js';
export declare const generativeParameters: {
    /**
     * Create a `ModuleConfig<'generative-anthropic', GenerativeConfigRuntimeType<'generative-anthropic'> | undefined>` object for use when performing runtime-specific AI generation using the `generative-anthropic` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/anthropic/generative) for detailed usage.
     *
     * @param {GenerativeAnthropicConfigCreateRuntime} [config] The configuration for the `generative-anthropic` module.
     * @returns {ModuleConfig<'generative-anthropic', GenerativeAnthropicConfigCreateRuntime | undefined>} The configuration object.
     */
    anthropic(config?: GenerativeAnthropicConfigRuntime): ModuleConfig<'generative-anthropic', GenerativeConfigRuntimeType<'generative-anthropic'> | undefined>;
    /**
     * Create a `ModuleConfig<'generative-anyscale', GenerativeConfigRuntimeType<'generative-anyscale'> | undefined>` object for use when performing runtime-specific AI generation using the `generative-anyscale` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/anyscale/generative) for detailed usage.
     *
     * @param {GenerativeAnyscaleConfigRuntime} [config] The configuration for the `generative-aws` module.
     * @returns {ModuleConfig<'generative-anyscale', GenerativeConfigRuntimeType<'generative-anyscale'> | undefined>} The configuration object.
     */
    anyscale(config?: GenerativeAnyscaleConfigRuntime): ModuleConfig<'generative-anyscale', GenerativeConfigRuntimeType<'generative-anyscale'> | undefined>;
    /**
     * Create a `ModuleConfig<'generative-aws', GenerativeConfigRuntimeType<'generative-aws'> | undefined>` object for use when performing runtime-specific AI generation using the `generative-aws` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/aws/generative) for detailed usage.
     *
     * @param {GenerativeAWSConfigRuntime} [config] The configuration for the `generative-aws` module.
     * @returns {ModuleConfig<'generative-aws', GenerativeConfigRuntimeType<'generative-aws'> | undefined>} The configuration object.
     */
    aws(config?: GenerativeAWSConfigRuntime): ModuleConfig<'generative-aws', GenerativeConfigRuntimeType<'generative-aws'> | undefined>;
    /**
     * Create a `ModuleConfig<'generative-openai', GenerativeConfigRuntimeType<'generative-azure-openai'>>` object for use when performing runtime-specific AI generation using the `generative-openai` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/openai/generative) for detailed usage.
     *
     * @param {GenerativeAzureOpenAIConfigRuntime} [config] The configuration for the `generative-openai` module.
     * @returns {ModuleConfig<'generative-azure-openai', GenerativeConfigRuntimeType<'generative-azure-openai'>>} The configuration object.
     */
    azureOpenAI: (config?: GenerativeOpenAIConfigRuntime) => ModuleConfig<'generative-azure-openai', GenerativeConfigRuntimeType<'generative-azure-openai'>>;
    /**
     * Create a `ModuleConfig<'generative-cohere', GenerativeConfigRuntimeType<'generative-cohere'> | undefined>` object for use when performing runtime-specific AI generation using the `generative-cohere` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/cohere/generative) for detailed usage.
     *
     * @param {GenerativeCohereConfigRuntime} [config] The configuration for the `generative-cohere` module.
     * @returns {ModuleConfig<'generative-cohere', GenerativeConfigRuntimeType<'generative-cohere'> | undefined>} The configuration object.
     */
    cohere: (config?: GenerativeCohereConfigRuntime) => ModuleConfig<'generative-cohere', GenerativeConfigRuntimeType<'generative-cohere'> | undefined>;
    /**
     * Create a `ModuleConfig<'generative-databricks', GenerativeConfigRuntimeType<'generative-databricks'> | undefined>` object for use when performing runtime-specific AI generation using the `generative-databricks` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/databricks/generative) for detailed usage.
     *
     * @param {GenerativeDatabricksConfigRuntime} [config] The configuration for the `generative-databricks` module.
     * @returns {ModuleConfig<'generative-databricks', GenerativeConfigRuntimeType<'generative-databricks'> | undefined>} The configuration object.
     */
    databricks: (config?: GenerativeDatabricksConfigRuntime) => ModuleConfig<'generative-databricks', GenerativeConfigRuntimeType<'generative-databricks'> | undefined>;
    /**
     * Create a `ModuleConfig<'generative-friendliai', GenerativeConfigRuntimeType<'generative-friendliai'> | undefined>` object for use when performing runtime-specific AI generation using the `generative-friendliai` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/friendliai/generative) for detailed usage.
     *
     * @param {GenerativeFriendliAIConfigRuntime} [config] The configuration for the `generative-friendliai` module.
     * @returns {ModuleConfig<'generative-databricks', GenerativeConfigRuntimeType<'generative-friendliai'> | undefined>} The configuration object.
     */
    friendliai(config?: GenerativeFriendliAIConfigRuntime): ModuleConfig<'generative-friendliai', GenerativeConfigRuntimeType<'generative-friendliai'> | undefined>;
    /**
     * Create a `ModuleConfig<'generative-mistral', GenerativeConfigRuntimeType<'generative-mistral'> | undefined>` object for use when performing runtime-specific AI generation using the `generative-mistral` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/mistral/generative) for detailed usage.
     *
     * @param {GenerativeMistralConfigRuntime} [config] The configuration for the `generative-mistral` module.
     * @returns {ModuleConfig<'generative-mistral', GenerativeConfigRuntimeType<'generative-mistral'> | undefined>} The configuration object.
     */
    mistral(config?: GenerativeMistralConfigRuntime): ModuleConfig<'generative-mistral', GenerativeConfigRuntimeType<'generative-mistral'> | undefined>;
    /**
     * Create a `ModuleConfig<'generative-nvidia', GenerativeConfigRuntimeType<'generative-nvidia'> | undefined>` object for use when performing runtime-specific 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', GenerativeConfigRuntimeType<'generative-nvidia'> | undefined>} The configuration object.
     */
    nvidia(config?: GenerativeNvidiaConfigRuntime): ModuleConfig<'generative-nvidia', GenerativeConfigRuntimeType<'generative-nvidia'> | undefined>;
    /**
     * Create a `ModuleConfig<'generative-ollama', GenerativeConfigRuntimeType<'generative-ollama'> | undefined>` object for use when performing runtime-specific AI generation using the `generative-ollama` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/ollama/generative) for detailed usage.
     *
     * @param {GenerativeOllamaConfigRuntime} [config] The configuration for the `generative-openai` module.
     * @returns {ModuleConfig<'generative-ollama', GenerativeConfigRuntimeType<'generative-ollama'> | undefined>} The configuration object.
     */
    ollama(config?: GenerativeOllamaConfigRuntime): ModuleConfig<'generative-ollama', GenerativeConfigRuntimeType<'generative-ollama'> | undefined>;
    /**
     * Create a `ModuleConfig<'generative-openai', GenerativeConfigRuntimeType<'generative-openai'>>` object for use when performing runtime-specific AI generation using the `generative-openai` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/openai/generative) for detailed usage.
     *
     * @param {GenerativeOpenAIConfigRuntime} [config] The configuration for the `generative-openai` module.
     * @returns {ModuleConfig<'generative-openai', GenerativeConfigRuntimeType<'generative-openai'>>} The configuration object.
     */
    openAI: (config?: GenerativeOpenAIConfigRuntime) => ModuleConfig<'generative-openai', GenerativeConfigRuntimeType<'generative-openai'>>;
    /**
     * Create a `ModuleConfig<'generative-google', GenerativeConfigRuntimeType<'generative-openai'> | undefined>` object for use when performing runtime-specific AI generation using the `generative-google` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/google/generative) for detailed usage.
     *
     * @param {GenerativeGoogleConfigRuntime} [config] The configuration for the `generative-palm` module.
     * @returns {ModuleConfig<'generative-google', GenerativeConfigRuntimeType<'generative-google'> | undefined>} The configuration object.
     */
    google: (config?: GenerativeGoogleConfigRuntime) => ModuleConfig<'generative-google', GenerativeConfigRuntimeType<'generative-google'> | undefined>;
    /**
     * Create a `ModuleConfig<'generative-xai', GenerativeConfigRuntimeType<'generative-xai'> | undefined>` object for use when performing runtime-specific AI generation using the `generative-xai` module.
     *
     * See the [documentation](https://weaviate.io/developers/weaviate/model-providers/xai/generative) for detailed usage.
     */
    xai: (config?: GenerativeXAIConfigRuntime) => ModuleConfig<'generative-xai', GenerativeConfigRuntimeType<'generative-xai'> | undefined>;
};