From 4a568a073ecc33df570a82d2f6cd4480edcd94ad Mon Sep 17 00:00:00 2001
From: Rohit Kadhe <rohit@scale3labs.com>
Date: Fri, 7 Jun 2024 14:50:27 -0400
Subject: [PATCH] export attribute names as keys

---
 scripts/generate_typescript.ts                |   1 +
 src/typescript/constants.ts                   |   8 +
 src/typescript/index.ts                       |   6 +
 src/typescript/package-lock.json              |   4 +-
 src/typescript/package.json                   |   2 +-
 .../schemas/database_span_attributes.json     |  65 +++++++
 .../schemas/framework_span_attributes.json    |  65 +++++++
 .../schemas/llm_span_attributes.json          | 159 ++++++++++++++++++
 src/typescript/tsconfig.build.json            |   2 +-
 9 files changed, 308 insertions(+), 4 deletions(-)
 create mode 100644 src/typescript/constants.ts
 create mode 100644 src/typescript/schemas/database_span_attributes.json
 create mode 100644 src/typescript/schemas/framework_span_attributes.json
 create mode 100644 src/typescript/schemas/llm_span_attributes.json

diff --git a/scripts/generate_typescript.ts b/scripts/generate_typescript.ts
index 233efd5..a2c4b12 100644
--- a/scripts/generate_typescript.ts
+++ b/scripts/generate_typescript.ts
@@ -35,6 +35,7 @@ TJS.compile(schema, schemaBaseName)
       fs.mkdirSync(dirname, { recursive: true })
     }
     fs.writeFileSync(outputFilePath, ts);
+    fs.cpSync("schemas", "src/typescript/schemas", {recursive: true})
   })
   .catch((error) => console.error(error));
 
diff --git a/src/typescript/constants.ts b/src/typescript/constants.ts
new file mode 100644
index 0000000..c9503f2
--- /dev/null
+++ b/src/typescript/constants.ts
@@ -0,0 +1,8 @@
+import { properties as LLMSpanAttributesObj  } from './schemas/llm_span_attributes.json'
+import { properties as DatabaseSpanAttributesObj } from  './schemas/database_span_attributes.json'
+import { properties as FrameworkSpanAttributesObj } from './schemas/framework_span_attributes.json'
+
+
+export const LLMSpanAttributeNames: Array<keyof typeof LLMSpanAttributesObj> = Object.keys(LLMSpanAttributesObj) as Array<keyof typeof LLMSpanAttributesObj>
+export const DatabaseSpanAttributeNames: Array<keyof typeof DatabaseSpanAttributesObj> = Object.keys(DatabaseSpanAttributesObj) as Array<keyof typeof DatabaseSpanAttributesObj>
+export const FrameworkSpanAttributeNames: Array<keyof typeof FrameworkSpanAttributesObj> = Object.keys(FrameworkSpanAttributesObj) as Array<keyof typeof FrameworkSpanAttributesObj>
\ No newline at end of file
diff --git a/src/typescript/index.ts b/src/typescript/index.ts
index d53223f..7e95c5a 100644
--- a/src/typescript/index.ts
+++ b/src/typescript/index.ts
@@ -1,6 +1,7 @@
 import {LLMSpanAttributes as LLMSpanAttributesInternal} from "./models/llm_span_attributes";
 import {DatabaseSpanAttributes as DatabaseSpanAttributesInternal} from "./models/database_span_attributes";
 import {FrameworkSpanAttributes as FrameworkSpanAttributesInternal} from "./models/framework_span_attributes";
+import { LLMSpanAttributeNames, DatabaseSpanAttributeNames, FrameworkSpanAttributeNames } from "./constants";
 /** Opentelemetry span attributes */
 
 /**
@@ -21,3 +22,8 @@ export declare type AttributeValue = string | number | boolean | Array<null | un
 export type LLMSpanAttributes = Attributes & ( LLMSpanAttributesInternal);
 export type DatabaseSpanAttributes = Attributes & ( DatabaseSpanAttributesInternal);
 export type FrameworkSpanAttributes = Attributes & ( FrameworkSpanAttributesInternal);
+export {
+  LLMSpanAttributeNames,
+  DatabaseSpanAttributeNames,
+  FrameworkSpanAttributeNames
+}
diff --git a/src/typescript/package-lock.json b/src/typescript/package-lock.json
index deafb73..dc030e3 100644
--- a/src/typescript/package-lock.json
+++ b/src/typescript/package-lock.json
@@ -1,12 +1,12 @@
 {
     "name": "@langtrase/trace-attributes",
-    "version": "5.0.0",
+    "version": "5.0.1",
     "lockfileVersion": 3,
     "requires": true,
     "packages": {
         "": {
             "name": "@langtrase/trace-attributes",
-            "version": "5.0.0",
+            "version": "5.0.1",
             "license": "MIT",
             "dependencies": {
                 "ncp": "^2.0.0"
diff --git a/src/typescript/package.json b/src/typescript/package.json
index c6a03f9..1f36d0c 100644
--- a/src/typescript/package.json
+++ b/src/typescript/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@langtrase/trace-attributes",
-    "version": "5.0.0",
+    "version": "5.0.1",
     "description": "LangTrace - Trace Attributes",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
diff --git a/src/typescript/schemas/database_span_attributes.json b/src/typescript/schemas/database_span_attributes.json
new file mode 100644
index 0000000..a2f7f9b
--- /dev/null
+++ b/src/typescript/schemas/database_span_attributes.json
@@ -0,0 +1,65 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "DatabaseSpanAttributes",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "langtrace.service.name": {
+      "type": "string"
+    },
+    "langtrace.service.type": {
+      "type": "string"
+    },
+    "langtrace.service.version": {
+      "type": "string"
+    },
+    "langtrace.sdk.name": {
+      "type": "string"
+    },
+    "langtrace.version": {
+      "type": "string"
+    },
+    "server.address": {
+      "type": "string"
+    },
+    "db.query": {
+      "type": "string"
+    },
+    "db.response": {
+      "type": "string"
+    },
+    "db.operation": {
+      "type": "string"
+    },
+    "db.system": {
+      "type": "string"
+    },
+    "db.namespace": {
+      "type": "string"
+    },
+    "db.index": {
+      "type": "string"
+    },
+    "db.collection.name": {
+      "type": "string"
+    },
+    "db.top_k": {
+      "type": "number",
+      "format": "float"
+    },
+    "db.embedding_model": {
+      "type": "string"
+    },
+    "langtrace.testId": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "langtrace.service.name",
+    "langtrace.service.type",
+    "langtrace.sdk.name",
+    "db.query",
+    "langtrace.version",
+    "db.system"
+  ]
+}
\ No newline at end of file
diff --git a/src/typescript/schemas/framework_span_attributes.json b/src/typescript/schemas/framework_span_attributes.json
new file mode 100644
index 0000000..42075aa
--- /dev/null
+++ b/src/typescript/schemas/framework_span_attributes.json
@@ -0,0 +1,65 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "FrameworkSpanAttributes",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "langtrace.service.name": {
+      "type": "string"
+    },
+    "langtrace.service.type": {
+      "type": "string"
+    },
+    "langtrace.service.version": {
+      "type": "string"
+    },
+    "langtrace.sdk.name": {
+      "type": "string"
+    },
+    "langtrace.version": {
+      "type": "string"
+    },
+    "langchain.task.name": {
+      "type": "string"
+    },
+    "langchain.inputs": {
+      "type": "string"
+    },
+    "langchain.outputs": {
+      "type": "string"
+    },
+    "langgraph.entrypoint": {
+      "type": "string"
+    },
+    "langgraph.node": {
+      "type": "string"
+    },
+    "langgraph.edge": {
+      "type": "string"
+    },
+    "langgraph.finishpoint": {
+      "type": "string"
+    },
+    "langgraph.task.name": {
+      "type": "string"
+    },
+    "llamaindex.task.name": {
+      "type": "string"
+    },
+    "llamaindex.inputs": {
+      "type": "string"
+    },
+    "llamaindex.outputs": {
+      "type": "string"
+    },
+    "langtrace.testId": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "langtrace.service.name",
+    "langtrace.service.type",
+    "langtrace.sdk.name",
+    "langtrace.version"
+  ]
+}
\ No newline at end of file
diff --git a/src/typescript/schemas/llm_span_attributes.json b/src/typescript/schemas/llm_span_attributes.json
new file mode 100644
index 0000000..2cce4d9
--- /dev/null
+++ b/src/typescript/schemas/llm_span_attributes.json
@@ -0,0 +1,159 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "LLMSpanAttributes",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "langtrace.service.name": {
+      "type": "string"
+    },
+    "langtrace.service.type": {
+      "type": "string"
+    },
+    "langtrace.service.version": {
+      "type": "string"
+    },
+    "langtrace.version": {
+      "type": "string"
+    },
+    "langtrace.sdk.name": {
+      "type": "string"
+    },
+    "url.full": {
+      "type": "string"
+    },
+    "llm.api": {
+      "type": "string"
+    },
+    "llm.model": {
+      "type": "string"
+    },
+    "llm.temperature": {
+      "type": "number",
+      "format": "float"
+    },
+    "llm.top_p": {
+      "type": "number",
+      "format": "float"
+    },
+    "llm.top_k": {
+      "type": "number",
+      "format": "float"
+    },
+    "llm.user": {
+      "type": "string"
+    },
+    "llm.system.fingerprint": {
+      "type": "string"
+    },
+    "llm.prompts": {
+      "type": "string"
+    },
+    "llm.responses": {
+      "type": "string"
+    },
+    "llm.token.counts": {
+      "type": "string"
+    },
+    "llm.stream": {
+      "type": "boolean"
+    },
+    "llm.encoding.formats": {
+      "type": "string"
+    },
+    "llm.dimensions": {
+      "type": "string"
+    },
+    "llm.generation_id": {
+      "type": "string"
+    },
+    "llm.response_id": {
+      "type": "string"
+    },
+    "llm.citations": {
+      "type": "string"
+    },
+    "llm.documents": {
+      "type": "string"
+    },
+    "llm.is_search_required": {
+      "type": "boolean"
+    },
+    "llm.search_results": {
+      "type": "string"
+    },
+    "llm.tool_calls": {
+      "type": "string"
+    },
+    "llm.max_tokens": {
+      "type": "string"
+    },
+    "llm.max_input_tokens": {
+      "type": "string"
+    },
+    "llm.conversation_id": {
+      "type": "string"
+    },
+    "llm.seed": {
+      "type": "string"
+    },
+    "llm.frequency_penalty": {
+      "type": "string"
+    },
+    "llm.presence_penalty": {
+      "type": "string"
+    },
+    "llm.connectors": {
+      "type": "string"
+    },
+    "llm.tools": {
+      "type": "string"
+    },
+    "llm.tool_results": {
+      "type": "string"
+    },
+    "llm.embedding_inputs": {
+      "type": "string"
+    },
+    "llm.embedding_dataset_id": {
+      "type": "string"
+    },
+    "llm.embedding_input_type": {
+      "type": "string"
+    },
+    "llm.embedding_job_name": {
+      "type": "string"
+    },
+    "llm.retrieval.query": {
+      "type": "string"
+    },
+    "llm.retrieval.results": {
+      "type": "string"
+    },
+    "llm.image.size": {
+      "type": "string"
+    },
+    "llm.response_format": {
+      "type": "string"
+    },
+    "http.max.retries": {
+      "type": "integer",
+      "format": "int32"
+    },
+    "http.timeout": {
+      "type": "integer",
+      "format": "int64"
+    },
+    "langtrace.testId": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "langtrace.service.name",
+    "langtrace.service.type",
+    "langtrace.sdk.name",
+    "langtrace.version",
+    "url.full",
+    "llm.api"
+  ]
+}
diff --git a/src/typescript/tsconfig.build.json b/src/typescript/tsconfig.build.json
index fcfdfe0..cb4ddcb 100644
--- a/src/typescript/tsconfig.build.json
+++ b/src/typescript/tsconfig.build.json
@@ -1,8 +1,8 @@
 {
     "compilerOptions": {
         "outDir": "./dist",
-        "rootDir": "./",
         "module": "commonjs",
+        "resolveJsonModule": true,
         "target": "es5",
         "declaration": true,
         "sourceMap": true,