Interface EmbeddingProviderTokenInfo

Info on how exactly a method of auth may be used.

Example

// openai.supportedAuthentication.HEADER.tokens[0]:
{
  accepted: 'x-embedding-api-key',
  forwarded: 'Authorization',
}

Field

accepted - The accepted token

Field

forwarded - How the token is forwarded to the embedding provider

See

EmbeddingProviderAuthInfo

interface EmbeddingProviderTokenInfo {
    accepted: string;
    forwarded: string;
}

Properties

Properties

accepted: string

The accepted token.

May most often be providerKey for SHARED_SECRET, or x-embedding-api-key for HEADER.

See EmbeddingHeadersProvider for more info about the HEADER auth through the client.

forwarded: string

How the token is forwarded to the embedding provider.