test(instr-openai): refactor some test envvars and the Q used for tes…

…ting chat completion (#497)
elastic · Dec 26, 2024 · 731abfe · 731abfe
1 parent 8fddaf7
commit 731abfe
Show file tree

Hide file tree

Showing 28 changed files with 224 additions and 207 deletions.
diff --git a/.github/workflows/test-instrumentation-openai.yml b/.github/workflows/test-instrumentation-openai.yml
@@ -78,8 +78,8 @@ jobs:
     - name: Pull Ollama models
       run: |
         source packages/instrumentation-openai/ollama.env
-        curl -s http://localhost:11434/api/pull -d "{\"model\": \"$TEST_MODEL_TOOLS\"}"
-        curl -s http://localhost:11434/api/pull -d "{\"model\": \"$TEST_MODEL_EMBEDDINGS\"}"
+        curl -s http://localhost:11434/api/pull -d "{\"model\": \"$TEST_CHAT_MODEL\"}"
+        curl -s http://localhost:11434/api/pull -d "{\"model\": \"$TEST_EMBEDDINGS_MODEL\"}"
         curl -s http://localhost:11434/api/tags | jq
         # Dump Ollama container logs if it doesn't appear to be working.
         curl -fsS http://localhost:11434/ || docker logs $(docker ps -q)

diff --git a/packages/instrumentation-openai/CONTRIBUTING.md b/packages/instrumentation-openai/CONTRIBUTING.md
@@ -39,7 +39,7 @@ dev/debugging. For example:
 npx @elastic/mockotlpserver  # or whatever OTLP endpoint you like to use
 
 cd test/fixtures
-TEST_MODEL_TOOLS=gpt-4o-mini \
+TEST_CHAT_MODEL=gpt-4o-mini \
     node --env-file ../../openai.env -r ./telemetry.js chat-completion.js
 ```
 
diff --git a/packages/instrumentation-openai/TESTING.md b/packages/instrumentation-openai/TESTING.md
@@ -57,8 +57,8 @@ or a running Ollama. Which is used is determined by the environment variables.
     docker run -it --rm -p 11434:11434 -v ~/.ollama:/root/.ollama ghcr.io/elastic/ollama/ollama:testing serve
 
     set -a; source ./ollama.env
-    ollama pull $TEST_MODEL_TOOLS
-    ollama pull $TEST_MODEL_EMBEDDINGS
+    ollama pull $TEST_CHAT_MODEL
+    ollama pull $TEST_EMBEDDINGS_MODEL
 
     npm run test:integration
     ```

diff --git a/packages/instrumentation-openai/azure.env.template b/packages/instrumentation-openai/azure.env.template
@@ -28,10 +28,10 @@ OPENAI_API_VERSION=2024-10-01-preview
 
 # Set this to the *deployment name* in your Azure OpenAI endpoint that deployed
 # a model that supports OpenAI tool calling, such as "gpt-4o-mini".
-TEST_MODEL_TOOLS=YOUR_TOOL_COMPATIBLE_DEPLOYMENT_NAME
+TEST_CHAT_MODEL=YOUR_TOOL_COMPATIBLE_DEPLOYMENT_NAME
 
 # Set this to the *deployment name* in your Azure OpenAI endpoint that deployed
 # a model that supports OpenAI embeddings, such as "text-embedding-3-small".
-TEST_MODEL_EMBEDDINGS=YOUR_EMBEDDING_DEPLOYMENT_NAME
+TEST_EMBEDDINGS_MODEL=YOUR_EMBEDDING_DEPLOYMENT_NAME
 
 
diff --git a/packages/instrumentation-openai/examples/use-chat-esm.mjs b/packages/instrumentation-openai/examples/use-chat-esm.mjs
@@ -38,7 +38,7 @@ async function main() {
         {
           role: 'user',
           content:
-            'Answer in up to 3 words: Which ocean contains the falkland islands?',
+            'Answer in up to 3 words: Which ocean contains Bouvet Island?',
         },
       ],
     });

diff --git a/packages/instrumentation-openai/examples/use-chat.js b/packages/instrumentation-openai/examples/use-chat.js
@@ -40,7 +40,7 @@ async function main() {
         {
           role: 'user',
           content:
-            'Answer in up to 3 words: Which ocean contains the falkland islands?',
+            'Answer in up to 3 words: Which ocean contains Bouvet Island?',
         },
       ],
     });

diff --git a/packages/instrumentation-openai/ollama.env b/packages/instrumentation-openai/ollama.env
@@ -4,5 +4,5 @@ OPENAI_API_KEY=notused
 
 # These models may be substituted in the future with inexpensive to run, newer
 # variants.
-TEST_MODEL_TOOLS=qwen2.5:0.5b
-TEST_MODEL_EMBEDDINGS=all-minilm:33m
+TEST_CHAT_MODEL=qwen2.5:0.5b
+TEST_EMBEDDINGS_MODEL=all-minilm:33m
diff --git a/packages/instrumentation-openai/openai.env.template b/packages/instrumentation-openai/openai.env.template
@@ -20,5 +20,5 @@ OPENAI_API_KEY=sk-...
 # OPENAI_ORG_ID=org-...
 # OPENAI_PROJECT_ID=...
 
-TEST_MODEL_TOOLS=gpt-4o-mini
-TEST_MODEL_EMBEDDINGS=text-embedding-3-small
+TEST_CHAT_MODEL=gpt-4o-mini
+TEST_EMBEDDINGS_MODEL=text-embedding-3-small