Interface EmbeddingProviderAuthInfo

Information about a specific auth method, such as HEADER, SHARED_SECRET, or NONE for a specific provider. See EmbeddingProviderInfo.supportedAuthentication for more information.

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

Example

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

Field

enabled - Whether this method of auth is supported for the provider.

Field

tokens - Additional info on how exactly this method of auth is supposed to be used.

See

EmbeddingProviderInfo

interface EmbeddingProviderAuthInfo {
    enabled: boolean;
    tokens: EmbeddingProviderTokenInfo[];
}

Properties

Properties

enabled: boolean

Whether this method of auth is supported for the provider.

Additional info on how exactly this method of auth is supposed to be used.

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

Will be an empty array if enabled is false.