You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[DOCS-13084] Fix wrong links and heading levels in OpenAI integration doc (DataDog#23296)
Two link reference bugs caused by duplicate reference numbers:
- [16] was defined twice: once for the PHP library install URL and once
for a video URL. The video placeholder line in the Overview was a
leftover that served no purpose as a text link, so it was removed
along with its duplicate [16] definition.
- [17] was defined twice: once in the PHP tab for the PHP library config
URL and once at the bottom for the OpenAI API docs URL. The "OpenAI
API Documentation" link in the API Key tab was incorrectly resolving
to the PHP library docs. Fixed by assigning the OpenAI API docs URL
to a new reference [21].
Also demoted heading levels in the API Key tab from h1/h2/h3 to
h4/h4/h5 to match the existing heading hierarchy (Installation is h3).
Copy file name to clipboardExpand all lines: openai/README.md
+9-14Lines changed: 9 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,8 +4,6 @@
4
4
5
5
Monitor, troubleshoot, and evaluate your LLM-powered applications, such as chatbots or data extraction tools, using [OpenAI][1]. With LLM Observability, you can investigate the root cause of issues, monitor operational performance, and evaluate the quality, privacy, and safety of your LLM applications.
6
6
7
-
[LLM Obs tracing view video][16]
8
-
9
7
Get cost estimation, prompt and completion sampling, error tracking, performance metrics, and more out of [OpenAI][1] account-level, Python, Node.js, and PHP library requests using Datadog metrics and APM.
10
8
11
9
## Setup
@@ -21,22 +19,20 @@ Get cost estimation, prompt and completion sampling, error tracking, performance
21
19
22
20
### Installation
23
21
24
-
# Configuring OpenAI Integration for Datadog
25
-
26
-
## Overview
22
+
#### Overview
27
23
28
24
Datadog's OpenAI integration allows you to collect usage metrics, cost data, and enables [LLM Observability][19] to monitor your OpenAI models. Follow the steps below to generate an OpenAI API key and configure the integration.
29
25
30
-
## Prerequisites
26
+
####Prerequisites
31
27
32
28
- An **OpenAI account** with admin write permissions
33
29
- A **valid OpenAI API key**:
34
30
-**For Cloud Cost Management (CCM) and usage metrics**: An **admin-scoped API key is mandatory**. Project-scoped keys cannot collect this data.
35
31
-**For LLM Observability only**: A standard API key with write permissions for model capabilities is sufficient.
36
32
37
-
## Setup
33
+
####Setup
38
34
39
-
### 1. Generate an OpenAI API key
35
+
#####1. Generate an OpenAI API key
40
36
41
37
**For Cloud Cost Management and usage metrics**, you must create an **admin-scoped API key**:
42
38
@@ -53,7 +49,7 @@ Datadog's OpenAI integration allows you to collect usage metrics, cost data, and
53
49
- Ensure that the API key has **write** permission for **model capabilities** to invoke models in your LLM account.
54
50
4. Copy the created API Key to your clipboard.
55
51
56
-
### 2. Configure Datadog's OpenAI integration
52
+
#####2. Configure Datadog's OpenAI integration
57
53
58
54
1. Navigate to Datadog's [OpenAI integration tile][11] and open the **Configuration** tab.
59
55
2. Click **Add Account**.
@@ -62,14 +58,14 @@ Datadog's OpenAI integration allows you to collect usage metrics, cost data, and
62
58
-**Collect Cost Data**: If enabled, cost data is visible in [Cloud Cost Management][14] within 24 hours. **Requires an admin-scoped API key.** See [collected data][15].
63
59
-**Use this API key to evaluate your LLM applications**: If enabled, evaluations are run through this API key in LLM Observability.
64
60
65
-
### Additional Notes
61
+
#####Additional Notes
66
62
67
63
-**Admin-scoped API key requirement**: An admin-scoped API key is **mandatory** for collecting usage metrics and Cloud Cost Management data. This integration only collects `audio_speeches`, `audio_transcriptions`, `code_interpreter_sessions`, `completions`, `embeddings`, `images`, `moderations`, and `vector_stores` metrics when an admin-scoped API key is provided.
68
64
- If you enable Cloud Cost Management for OpenAI without an admin-scoped API key, cost metrics are not available.
69
65
70
-
## Additional Resources
66
+
####Additional Resources
71
67
72
-
-[OpenAI API Documentation][17]
68
+
-[OpenAI API Documentation][21]
73
69
-[Generating an API Token][18]
74
70
75
71
@@ -532,8 +528,7 @@ Additional helpful documentation, links, and articles:
0 commit comments