llm4s-docs/org.llm4s/org.llm4s.llmconnect/org.llm4s.llmconnect.auth/org.llm4s.llmconnect.auth.vault/VaultSettings

VaultSettings

org.llm4s.llmconnect.auth.vault.VaultSettings

See theVaultSettings companion object

@Experimental

final case class VaultSettings

Where VaultApiKeyProvider reads an API key in HashiCorp Vault (#2479): the field field of the secret at path in the key/value secrets engine mounted at mount.

// the field apiKey of secret/data/llm4s/openai (KV version 2, mounted at secret/)
val settings = VaultSettings("https://vault.internal:8200", Secret(vaultToken), "llm4s/openai", "apiKey")
 .withRefreshInterval(1.minute)

Value parameters

address: Vault's base URL, http(s)://host:port, without /v1
field: the key of the secret's data that holds the API key
kvVersion: the KV engine's version: V2 (versioned, the default) or V1
mount: the path the KV secrets engine is mounted at; secret by default, as in vault server -dev
namespace: the Vault Enterprise / HCP Vault namespace, sent as X-Vault-Namespace
path: the secret's path inside the mount, such as llm4s/openai
refreshInterval: how long a key read from Vault is used before it is read again
requestTimeout: how long one read from Vault may take
token: the Vault token sent as X-Vault-Token; never printed by toString nor put in an error

Attributes

Companion: object
Source: VaultSettings.scala
Graph
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all