AI Gateway

Author: kodster28

src/content/docs/ai-gateway/evaluations/add-human-feedback-api.mdx

@@ -5,6 +5,8 @@ sidebar:
   order: 4
 ---
 
+import { APIRequest } from "~/components";
+
 This guide will walk you through the steps of adding human feedback to an AI Gateway request using the Cloudflare API. You will learn how to retrieve the relevant request logs, and submit feedback using the API.
 
 If you prefer to add human feedback via the dashboard, refer to [Add Human Feedback](/ai-gateway/evaluations/add-human-feedback/).
@@ -19,21 +21,7 @@ If you prefer to add human feedback via the dashboard, refer to [Add Human Feedb
 2. Get your [Account ID](/fundamentals/account/find-account-and-zone-ids/).
 3. Using that API token and Account ID, send a [`POST` request](/api/resources/ai_gateway/methods/create/) to the Cloudflare API.
 
-## 2. Using the API Token
-
-Once you have the token, you can use it in API requests by adding it to the authorization header as a bearer token. Here is an example of how to use it in a request:
-
-```bash
-curl "https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs" \
---header "Authorization: Bearer {your_api_token}"
-```
-
-In the request above:
-
-- Replace `{account_id}` and `{gateway_id}` with your specific Cloudflare account and gateway details.
-- Replace `{your_api_token}` with the API token you just created.
-
-## 3. Retrieve the `cf-aig-log-id`
+## 2. Retrieve the `cf-aig-log-id`
 
 The `cf-aig-log-id` is a unique identifier for the specific log entry to which you want to add feedback. Below are two methods to obtain this identifier.
 
@@ -64,22 +52,14 @@ In the example below, the `cf-aig-log-id` is `01JADMCQQQBWH3NXZ5GCRN98DP`.
 
 If you do not have the `cf-aig-log-id` in the response body or you need to access it after the fact, you are able to retrieve it by querying the logs using the [Cloudflare API](/api/resources/ai_gateway/subresources/logs/methods/list/).
 
-The steps below outline how to do this.
-
-1. **Send a GET Request to Retrieve Logs**: You can query the AI Gateway logs for a specific time frame or for a specific request. The request will return a list of logs, each containing its own `id`.
-   Here is an example request:
-
-```bash
-GET https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs
-```
+Send a `GET` request to get a list of logs and then find a specific ID
 
-Replace `{account_id}` and `{gateway_id}` with your specific account and gateway details.
+<APIRequest
+	path="/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs"
+	method="GET"
+/>
 
-2. **Search for the Relevant Log**: In the response from the GET request, locate the specific log entry for which you would like to submit feedback. Each log entry will include the `id`.
-
-In the example below, the `id` is `01JADMCQQQBWH3NXZ5GCRN98DP`.
-
-```json
+```json output
 {
 	"result": [
 		{
@@ -103,24 +83,7 @@ In the example below, the `id` is `01JADMCQQQBWH3NXZ5GCRN98DP`.
 			"tokens_in": 0,
 			"tokens_out": 0
 		}
-	],
-	"result_info": {
-		"count": 0,
-		"max_cost": 0,
-		"max_duration": 0,
-		"max_tokens_in": 0,
-		"max_tokens_out": 0,
-		"max_total_tokens": 0,
-		"min_cost": 0,
-		"min_duration": 0,
-		"min_tokens_in": 0,
-		"min_tokens_out": 0,
-		"min_total_tokens": 0,
-		"page": 0,
-		"per_page": 0,
-		"total_count": 0
-	},
-	"success": true
+	]
 }
 ```
 
@@ -129,42 +92,40 @@ In the example below, the `id` is `01JADMCQQQBWH3NXZ5GCRN98DP`.
 You can also retrieve the `cf-aig-log-id` using a binding, which streamlines the process. Here's how to retrieve the log ID directly:
 
 ```js
-const resp = await env.AI.run('@cf/meta/llama-3-8b-instruct', {
-		prompt: 'tell me a joke'
-}, {
+const resp = await env.AI.run(
+	"@cf/meta/llama-3-8b-instruct",
+	{
+		prompt: "tell me a joke",
+	},
+	{
 		gateway: {
-				id: 'my_gateway_id'
-		}
-})
+			id: "my_gateway_id",
+		},
+	},
+);
 
-const myLogId = env.AI.aiGatewayLogId
+const myLogId = env.AI.aiGatewayLogId;
 ```
 
 :::note[Note:]
 
-
 The `aiGatewayLogId` property, will only hold the last inference call log id.
 
-
 :::
 
-## 4. Submit feedback via PATCH request
+## 3. Submit feedback via PATCH request
 
-Once you have both the API token and the `cf-aig-log-id`, you can send a PATCH request to submit feedback. Use the following URL format, replacing the `{account_id}`, `{gateway_id}`, and `{log_id}` with your specific details:
+Once you have both the API token and the `cf-aig-log-id`, you can send a PATCH request to submit feedback.
 
-```bash
-PATCH https://api.cloudflare.com/client/v4/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{log_id}
-```
-
-Add the following in the request body to submit positive feedback:
-
-```json
-{
-	"feedback": 1
-}
-```
+<APIRequest
+	path="/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/logs/{id}"
+	method="PATCH"
+	json={{
+		feedback: 1,
+	}}
+/>
 
-Add the following in the request body to submit negative feedback:
+If you had negative feedback, adjust the body of the request to be `-1`.
 
 ```json
 {