Interface OpenAiConnectionDetails
- All Superinterfaces:
org.springframework.boot.autoconfigure.service.connection.ConnectionDetails
public interface OpenAiConnectionDetails
extends org.springframework.boot.autoconfigure.service.connection.ConnectionDetails
Details required to establish a connection to an OpenAI-compatible API.
- Since:
- 2.1.0
- Author:
- Thomas Vitale
-
Method Summary
-
Method Details
-
getBaseUrl
@Nullable String getBaseUrl()The base URL of the OpenAI-compatible API, ornullto let the client resolve its default (for example, from theOPENAI_BASE_URLenvironment variable).- Returns:
- the base URL
-
getApiKey
@Nullable String getApiKey()The API key used to authenticate against the OpenAI-compatible API. An empty string is the deliberate no-auth signal, whilenullmeans "not configured" and lets the client resolve a key from the environment.- Returns:
- the API key
-