Skip to main content

Generative AI Settings - API Keys and Vector Database Configuration in ConvyAI

Overview​

The Settings page contains the credentials and infrastructure configuration required for the Knowledge Base indexing service. It has two sections: GenerativeAI Configs and Redis Configs.

Navigate to Generative AI → Settings to access this page.

GenerativeAI Configs​

This section holds the API credentials for the LLM providers used during indexing. Configure only the providers you intend to use.

OpenAI​

FieldDescription
API KeyThe API key obtained from your OpenAI platform subscription. Required for OpenAI-based indexing and models.

Amazon Bedrock​

FieldDescription
Access KeyAWS access key with Bedrock permissions.
Secret KeyAWS secret key associated with the access key.
RegionThe AWS region where your Bedrock service is deployed (e.g., us-east-1).

Azure OpenAI​

FieldDescription
KeyThe API key associated with your Azure OpenAI resource instance. Used to authenticate all requests from ConvyAI.
EndpointThe HTTPS endpoint of your Azure OpenAI resource. Identifies the specific instance and deployment called during indexing batches.

Xference​

FieldDescription
API KeyThe API key for your Xference instance.
EndpointThe URL of your Xference instance. Identifies the instance called during indexing batches.

Redis Configs​

ConvyAI includes a managed Redis service out of the box - no installation or configuration is required for most deployments.

If you need to use an existing Redis instance (for example, to keep indexed data on-premises or within your own infrastructure), configure the connection details here.

Redis Configs section

FieldDescription
HostThe hostname or IP address of your Redis instance.
PortThe Redis port (default: 6379).
PasswordAuthentication password for the Redis instance, if required.
note

When using a custom Redis instance, the embedding model used during indexing must match the one used at query time. Mismatching models will result in incorrect retrieval results.