Skip to content

🪢 Open source agent evals & observability: Trace, evaluate, and improve LLM applications with one open platform.

feat: rename providedModelName to model in observation APIs (#16946)

Valery Meleshkinb8fab278f6be
diff --git a/fern/apis/server/definition/commons.yml b/fern/apis/server/definition/commons.yml
index 16e011d2ed..f5d8fc728e 100644
--- a/fern/apis/server/definition/commons.yml
+++ b/fern/apis/server/definition/commons.yml
@@ -313,7 +313,7 @@ types:
docs: Additional metadata of the observation
# Model fields (field group: model)
- providedModelName:
+ model:
type: optional<nullable<string>>
docs: The model name as provided by the user
internalModelId:
diff --git a/fern/apis/server/definition/observations.yml b/fern/apis/server/definition/observations.yml
index 4a80ff174e..2e3375a558 100644
--- a/fern/apis/server/definition/observations.yml
+++ b/fern/apis/server/definition/observations.yml
@@ -21,7 +21,7 @@ service:
- `time` - completionStartTime, createdAt, updatedAt
- `io` - input, output
- `metadata` - metadata (truncated to 200 chars by default, use `expandMetadata` to get full values)
- - `model` - providedModelName, internalModelId, modelParameters
+ - `model` - model, internalModelId, modelParameters
- `usage` - usageDetails, costDetails, totalCost, usagePricingTierName
- `prompt` - promptId, promptName, promptVersion
- `metrics` - latency, timeToFirstToken
diff --git a/packages/shared/src/domain/observation-field-groups.ts b/packages/shared/src/domain/observation-field-groups.ts
index 076ed91e41..7b4e5ecf44 100644
--- a/packages/shared/src/domain/observation-field-groups.ts
+++ b/packages/shared/src/domain/observation-field-groups.ts
@@ -37,7 +37,7 @@ export const OBSERVATION_FIELD_GROUPS_PUBLIC_API = [
"time", // completionStartTime, createdAt, updatedAt
"io", // input, output
"metadata", // metadata
- "model", // providedModelName, internalModelId, modelParameters
+ "model", // model (from providedModelName), internalModelId, modelParameters
"usage", // usageDetails, costDetails, totalCost, usagePricingTierName
"prompt", // promptId, promptName, promptVersion
"metrics", // latency, timeToFirstToken
diff --git a/web/public/generated/api/openapi.yml b/web/public/generated/api/openapi.yml
index b75abd3c89..a4534889ff 100644
--- a/web/public/generated/api/openapi.yml
+++ b/web/public/generated/api/openapi.yml
@@ -4285,7 +4285,7 @@ paths:
- `metadata` - metadata (truncated to 200 chars by default, use
`expandMetadata` to get full values)
- - `model` - providedModelName, internalModelId, modelParameters
+ - `model` - model, internalModelId, modelParameters
- `usage` - usageDetails, costDetails, totalCost, usagePricingTierName
@@ -10619,7 +10619,7 @@ components:
metadata:
nullable: true
description: Additional metadata of the observation
- providedModelName:
+ model:
type: string
nullable: true
description: The model name as provided by the user
diff --git a/web/src/features/public-api/types/observations.ts b/web/src/features/public-api/types/observations.ts
index 95f6f5fd17..120612bbe9 100644
--- a/web/src/features/public-api/types/observations.ts
+++ b/web/src/features/public-api/types/observations.ts
@@ -386,7 +386,7 @@ const APIObservationV2 = z
metadata: z.any().optional(),
// Model fields (field group: model)
- providedModelName: z.string().nullable().optional(),
+ model: z.string().nullable().optional(),
internalModelId: z.string().nullable().optional(),
modelParameters: z.any().optional(),