Type Alias: AiConnection

type AiConnection = 
  | {
  apiKey: AiCredential;
  baseUrl?: string;
  provider: "anthropic" | "google" | "typesafe";
}
  | {
  api?: AiOpenAiApi;
  apiKey: AiCredential;
  baseUrl?: string;
  organization?: string;
  project?: string;
  provider: "openai";
}
  | {
  api?: AiOpenAiApi;
  apiKey: AiCredential;
  apiVersion?: string;
  baseUrl?: string;
  provider: "azure";
  resourceName?: string;
}
  | {
  auth:   | {
     apiKey: AiCredential;
     type: "api-key";
   }
     | {
     accessKeyId: AiCredential;
     secretAccessKey: AiCredential;
     sessionToken?: AiCredential;
     type: "sigv4";
   };
  baseUrl?: string;
  provider: "bedrock";
  region: string;
}
  | {
  apiKey?: AiCredential;
  apiKeyHeader?: string;
  baseUrl: string;
  headers?: Record<string, string>;
  name: string;
  provider: "openai-compatible";
  queryParams?: Record<string, string>;
  supportsStructuredOutputs?: boolean;
};

Where a model request goes and how it is authenticated, by provider: Anthropic's, Google's (Gemini) and TypeSafe's (Jev) own APIs; OpenAI's, with its organization, project and API; an Azure OpenAI resource, by name or base URL; Amazon Bedrock in a region, with a Bedrock API key or SigV4 keys the host signs with; any server that speaks OpenAI's Chat Completions. A base URL, when given, must be one of the install's hosts; without one, the vendor's own API.

Union Members

Type Literal

{
  apiKey: AiCredential;
  baseUrl?: string;
  provider: "anthropic" | "google" | "typesafe";
}

---

Type Literal

{
  api?: AiOpenAiApi;
  apiKey: AiCredential;
  baseUrl?: string;
  organization?: string;
  project?: string;
  provider: "openai";
}

---

Type Literal

{
  api?: AiOpenAiApi;
  apiKey: AiCredential;
  apiVersion?: string;
  baseUrl?: string;
  provider: "azure";
  resourceName?: string;
}

api?

optional api?: AiOpenAiApi;

apiKey

apiKey: AiCredential;

apiVersion?

optional apiVersion?: string;

v1 (the default) or a dated version.

baseUrl?

optional baseUrl?: string;

provider

provider: "azure";

resourceName?

optional resourceName?: string;

One of resourceName (<resource>.openai.azure.com) and baseUrl.

---

Type Literal

{
  auth:   | {
     apiKey: AiCredential;
     type: "api-key";
   }
     | {
     accessKeyId: AiCredential;
     secretAccessKey: AiCredential;
     sessionToken?: AiCredential;
     type: "sigv4";
   };
  baseUrl?: string;
  provider: "bedrock";
  region: string;
}

---

Type Literal

{
  apiKey?: AiCredential;
  apiKeyHeader?: string;
  baseUrl: string;
  headers?: Record<string, string>;
  name: string;
  provider: "openai-compatible";
  queryParams?: Record<string, string>;
  supportsStructuredOutputs?: boolean;
}

apiKey?

optional apiKey?: AiCredential;

apiKeyHeader?

optional apiKeyHeader?: string;

With apiKey: the header that carries it as it is; authorization: Bearer without.

baseUrl

baseUrl: string;

headers?

optional headers?: Record<string, string>;

Headers besides the key, which never carry a credential.

name

name: string;

Names the server in usage, ollama or openrouter.

provider

provider: "openai-compatible";

queryParams?

optional queryParams?: Record<string, string>;

supportsStructuredOutputs?

optional supportsStructuredOutputs?: boolean;

The server holds a model to a JSON Schema: decisions need it.