Skip to content

Commit b824cf0

Browse files
headers glossary initial documentation
1 parent 7668e4b commit b824cf0

File tree

2 files changed

+61
-0
lines changed

2 files changed

+61
-0
lines changed
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Glossary
3+
pcx_content_type: glossary
4+
---
5+
6+
import { Glossary } from "~/components";
7+
8+
Review the definitions for headers used across Cloudflare's AI Gateway documentation.
9+
10+
<Glossary product="ai-gateway" />
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
productName: AI Gateway
3+
entries:
4+
- term: cf-aig-event-id
5+
general_definition: |-
6+
Unique identifier for an AI Gateway event, used to trace specific events through the system.
7+
8+
- term: cf-aig-step
9+
general_definition: |-
10+
Identifies the processing step in the AI Gateway flow for better tracking and debugging.
11+
12+
- term: cf-aig-log-id
13+
general_definition: |-
14+
Identifier for logging specific to the AI Gateway, enabling detailed tracking of requests.
15+
16+
- term: cf-aig-collect-log
17+
general_definition: |-
18+
Specifies if logging data should be collected for a particular request in the AI Gateway.
19+
20+
- term: cf-aig-custom-cost
21+
general_definition: |-
22+
Allows the customization of request cost within AI Gateway to reflect user-defined parameters.
23+
24+
- term: cf-aig-cache-key
25+
general_definition: |-
26+
Custom key to determine cache storage and retrieval in the AI Gateway.
27+
28+
- term: cf-aig-cache-status
29+
general_definition: |-
30+
Status indicator for AI Gateway caching, showing if a request was served from cache.
31+
32+
- term: cf-aig-metadata
33+
general_definition: |-
34+
Additional metadata associated with a request in the AI Gateway.
35+
36+
- term: cf-aig-cache-ttl
37+
general_definition: |-
38+
Specifies the cache time-to-live for AI Gateway responses.
39+
40+
- term: cf-aig-skip-cache
41+
general_definition: |-
42+
Header to bypass caching for a specific request in the AI Gateway.
43+
44+
# Deprecated headers
45+
- term: cf-cache-ttl
46+
general_definition: |-
47+
Deprecated: This header is replaced by `cf-aig-cache-ttl` in AI Gateway. It specifies cache time-to-live.
48+
49+
- term: cf-skip-cache
50+
general_definition: |-
51+
Deprecated: This header is replaced by `cf-aig-skip-cache` in AI Gateway. It bypasses caching for a specific request.

0 commit comments

Comments
 (0)