Skip to content

Commit 1dcc6ec

Browse files
authored
[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).
1 parent e0ca21a commit 1dcc6ec

1 file changed

Lines changed: 9 additions & 14 deletions

File tree

openai/README.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44

55
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.
66

7-
[LLM Obs tracing view video][16]
8-
97
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.
108

119
## Setup
@@ -21,22 +19,20 @@ Get cost estimation, prompt and completion sampling, error tracking, performance
2119

2220
### Installation
2321

24-
# Configuring OpenAI Integration for Datadog
25-
26-
## Overview
22+
#### Overview
2723

2824
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.
2925

30-
## Prerequisites
26+
#### Prerequisites
3127

3228
- An **OpenAI account** with admin write permissions
3329
- A **valid OpenAI API key**:
3430
- **For Cloud Cost Management (CCM) and usage metrics**: An **admin-scoped API key is mandatory**. Project-scoped keys cannot collect this data.
3531
- **For LLM Observability only**: A standard API key with write permissions for model capabilities is sufficient.
3632

37-
## Setup
33+
#### Setup
3834

39-
### 1. Generate an OpenAI API key
35+
##### 1. Generate an OpenAI API key
4036

4137
**For Cloud Cost Management and usage metrics**, you must create an **admin-scoped API key**:
4238

@@ -53,7 +49,7 @@ Datadog's OpenAI integration allows you to collect usage metrics, cost data, and
5349
- Ensure that the API key has **write** permission for **model capabilities** to invoke models in your LLM account.
5450
4. Copy the created API Key to your clipboard.
5551

56-
### 2. Configure Datadog's OpenAI integration
52+
##### 2. Configure Datadog's OpenAI integration
5753

5854
1. Navigate to Datadog's [OpenAI integration tile][11] and open the **Configuration** tab.
5955
2. Click **Add Account**.
@@ -62,14 +58,14 @@ Datadog's OpenAI integration allows you to collect usage metrics, cost data, and
6258
- **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].
6359
- **Use this API key to evaluate your LLM applications**: If enabled, evaluations are run through this API key in LLM Observability.
6460

65-
### Additional Notes
61+
##### Additional Notes
6662

6763
- **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.
6864
- If you enable Cloud Cost Management for OpenAI without an admin-scoped API key, cost metrics are not available.
6965

70-
## Additional Resources
66+
#### Additional Resources
7167

72-
- [OpenAI API Documentation][17]
68+
- [OpenAI API Documentation][21]
7369
- [Generating an API Token][18]
7470

7571

@@ -532,8 +528,7 @@ Additional helpful documentation, links, and articles:
532528
[13]: https://docs.datadoghq.com/getting_started/site/#access-the-datadog-site
533529
[14]: /cost
534530
[15]: https://docs.datadoghq.com/cloud_cost_management/saas_costs/?tab=openai#data-collected
535-
[16]: https://imgix.datadoghq.com/video/products/llm-observability/expedite-troubleshooting.mp4?fm=webm&fit=max
536-
[17]: https://platform.openai.com/docs/
537531
[18]: https://platform.openai.com/
532+
[21]: https://platform.openai.com/docs/
538533
[19]: https://www.datadoghq.com/product/llm-observability/
539534
[20]: https://platform.openai.com/settings/organization/admin-keys

0 commit comments

Comments
 (0)