mirror of
https://github.com/fosrl/docs-v2.git
synced 2026-08-31 03:01:30 +02:00
add screenshots
This commit is contained in:
@@ -190,7 +190,7 @@
|
||||
},
|
||||
{
|
||||
"group": "AI Gateway",
|
||||
"icon": "robot",
|
||||
"icon": "sparkles",
|
||||
"pages": [
|
||||
"manage/ai/overview",
|
||||
"manage/ai/multiple-gateway-resources",
|
||||
|
||||
BIN
images/ai/analytics-overview.png
Normal file
BIN
images/ai/analytics-overview.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 608 KiB |
BIN
images/ai/create-ai-gateway-resource.png
Normal file
BIN
images/ai/create-ai-gateway-resource.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 547 KiB |
BIN
images/ai/create-virtual-api-key.png
Normal file
BIN
images/ai/create-virtual-api-key.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 784 KiB |
BIN
images/ai/public-resource-models.png
Normal file
BIN
images/ai/public-resource-models.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 519 KiB |
BIN
images/ai/public-resource-providers.png
Normal file
BIN
images/ai/public-resource-providers.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 494 KiB |
BIN
images/ai/session-logs.png
Normal file
BIN
images/ai/session-logs.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 951 KiB |
@@ -25,6 +25,10 @@ Create an org-level provider so the gateway has an upstream to call. Sidebar →
|
||||
|
||||
Resources → **Create** → set **Type** to **AI Gateway**, pick a domain, and attach the provider(s) from step 1. You can also attach providers to an existing resource later from its **AI Gateway** settings tab. How public and private AI Gateway resources reach users is covered on the [public](/manage/resources/public/ai-gateway) and [private](/manage/resources/private/ai-gateway) resource type pages.
|
||||
|
||||
<Frame>
|
||||
<img src="/images/ai/create-ai-gateway-resource.png" alt="Create Public Resource form with Type set to AI Gateway" centered />
|
||||
</Frame>
|
||||
|
||||
You can create more than one AI Gateway resource so different users and roles get their own providers. Distinct hostnames are the usual approach; they can also share a FQDN. See [Multiple Gateway Resources](/manage/ai/multiple-gateway-resources).
|
||||
|
||||
## 3. Authenticate to the Gateway
|
||||
|
||||
@@ -11,6 +11,10 @@ See [AI Providers](/manage/ai/providers/overview) for what a provider is, and [P
|
||||
|
||||
On the provider's **Models** tab, every request must match an **allow** entry and must not match a **block** entry. An empty allow list denies all traffic. A key cannot sit on both lists.
|
||||
|
||||
<Frame>
|
||||
<img src="/images/ai/public-resource-models.png" alt="Provider Models tab with allow and block lists for Anthropic" centered />
|
||||
</Frame>
|
||||
|
||||
You add keys three ways:
|
||||
|
||||
| How | What it is | Example |
|
||||
|
||||
@@ -20,27 +20,15 @@ Each provider is:
|
||||
|
||||
Providers are reused across resources. The resource still owns the public URL and the keys clients authenticate with.
|
||||
|
||||
{/*
|
||||
Screenshot: `/images/ai/create-provider.png`
|
||||
The AI Gateway → Providers → Create form, showing the provider type dropdown and API key field filled in for OpenAI or Anthropic.
|
||||
<Frame>
|
||||
<img src="/images/ai/create-provider.png" alt="Creating an AI provider" />
|
||||
</Frame>
|
||||
*/}
|
||||
|
||||
## Attach to a Resource
|
||||
|
||||
On an AI Gateway resource, attach one or more providers from the **AI Gateway** settings tab. For each attachment you can inherit the provider's model lists or select a subset. Details are in [Model Routing](/manage/ai/providers/model-routing#inherit-vs-select).
|
||||
|
||||
The resource only speaks the API formats its attached providers advertise. Attach whichever providers match the [clients](/manage/ai/overview#4-connect-a-client) you plan to connect.
|
||||
|
||||
{/*
|
||||
Screenshot: `/images/ai/create-resource.png`
|
||||
The new resource dialog with Type set to "AI Gateway" and a provider selected in the AI Providers section.
|
||||
<Frame>
|
||||
<img src="/images/ai/create-resource.png" alt="Attaching providers to an AI Gateway resource" />
|
||||
<img src="/images/ai/public-resource-providers.png" alt="AI Gateway resource settings with attached providers" centered />
|
||||
</Frame>
|
||||
*/}
|
||||
|
||||
## Provider Types
|
||||
|
||||
|
||||
@@ -5,6 +5,10 @@ description: "Prompt and response transcripts for AI Gateway requests in an orga
|
||||
|
||||
Session logs store the prompt and response for each AI Gateway call. Open **AI Gateway → Session Logs** to browse them. Use them to see what a client sent, what the upstream returned, and which user, key, provider, and resource handled the call.
|
||||
|
||||
<Frame>
|
||||
<img src="/images/ai/session-logs.png" alt="AI Gateway session logs table in the Pangolin dashboard" centered />
|
||||
</Frame>
|
||||
|
||||
<Note>
|
||||
Session logs are only available in [Pangolin Cloud](https://app.pangolin.net/auth/signup) or self-hosted [Enterprise Edition](/self-host/enterprise-edition).
|
||||
</Note>
|
||||
|
||||
@@ -5,6 +5,10 @@ description: "Cost, token usage, and request volume across providers, resources,
|
||||
|
||||
Usage analytics rolls up every AI Gateway call: how many requests ran, how many tokens they used, and estimated USD. Open **AI Gateway → Usage Analytics**. The numbers come from the same recorded usage that [budgets](/manage/ai/budgets) enforce.
|
||||
|
||||
<Frame>
|
||||
<img src="/images/ai/analytics-overview.png" alt="Usage analytics overview with cost, token, and request charts" centered />
|
||||
</Frame>
|
||||
|
||||
These records are independent of session log retention. For prompt and response text, see [Session Logs](/manage/ai/session-logs). The two share a session id per call.
|
||||
|
||||
## How Numbers Are Calculated
|
||||
|
||||
@@ -55,6 +55,10 @@ You can optionally associate a user. That association is for usage tracking and
|
||||
|
||||
When you create or edit a key, you can attach a [budget](/manage/ai/budgets) so spend or tokens on that key are capped.
|
||||
|
||||
<Frame>
|
||||
<img src="/images/ai/create-virtual-api-key.png" alt="Create Virtual API Key dialog with name, description, and public AI gateway access" centered />
|
||||
</Frame>
|
||||
|
||||
## Where to Get a Key
|
||||
|
||||
Your identity key and any manual keys attributed to you are available in three places:
|
||||
|
||||
Reference in New Issue
Block a user