beta chat completions are gone in recent openai versions

Author: xrmx

instrumentation/elastic-opentelemetry-instrumentation-openai/src/opentelemetry/instrumentation/openai/__init__.py

@@ -117,7 +117,7 @@ def _instrument(self, **kwargs):
 
     def _patch(self, module):
         version = tuple([int(x) for x in getattr(getattr(module, "version"), "VERSION").split(".")])
-        self.beta_chat_available = version >= (1, 40, 0)
+        self.beta_chat_available = version >= (1, 40, 0) and version < (1, 93, 0)
         wrap_function_wrapper(
             "openai.resources.chat.completions",
             "Completions.create",

instrumentation/elastic-opentelemetry-instrumentation-openai/tests/test_beta_chat_completions.py

@@ -66,9 +66,10 @@
 TEST_CHAT_MODEL = "gpt-4o-mini"
 TEST_CHAT_RESPONSE_MODEL = "gpt-4o-mini-2024-07-18"
 TEST_CHAT_INPUT = "Answer in up to 3 words: Which ocean contains Bouvet Island?"
+HAS_BETA_CHAT_COMPLETIONS = (1, 40, 0) <= OPENAI_VERSION < (1, 93, 0)
 
 
-@pytest.mark.skipif(OPENAI_VERSION < (1, 40, 0), reason="beta completions added in 1.40.0")
+@pytest.mark.skipif(not HAS_BETA_CHAT_COMPLETIONS, reason="beta completions added in 1.40.0, removed in 1.93.0")
 @pytest.mark.vcr()
 def test_chat(default_openai_env, trace_exporter, metrics_reader, logs_exporter):
     client = openai.OpenAI()
@@ -133,7 +134,7 @@ def test_chat(default_openai_env, trace_exporter, metrics_reader, logs_exporter)
     )
 
 
-@pytest.mark.skipif(OPENAI_VERSION < (1, 40, 0), reason="beta completions added in 1.40.0")
+@pytest.mark.skipif(not HAS_BETA_CHAT_COMPLETIONS, reason="beta completions added in 1.40.0, removed in 1.93.0")
 @pytest.mark.vcr()
 def test_chat_with_developer_role_message(default_openai_env, trace_exporter, metrics_reader, logs_exporter):
     client = openai.OpenAI()
@@ -206,7 +207,7 @@ def test_chat_with_developer_role_message(default_openai_env, trace_exporter, me
     )
 
 
-@pytest.mark.skipif(OPENAI_VERSION < (1, 40, 0), reason="beta completions added in 1.40.0")
+@pytest.mark.skipif(not HAS_BETA_CHAT_COMPLETIONS, reason="beta completions added in 1.40.0, removed in 1.93.0")
 @pytest.mark.vcr()
 def test_chat_all_the_client_options(default_openai_env, trace_exporter, metrics_reader, logs_exporter):
     client = openai.OpenAI()
@@ -295,7 +296,7 @@ def test_chat_all_the_client_options(default_openai_env, trace_exporter, metrics
     )
 
 
-@pytest.mark.skipif(OPENAI_VERSION < (1, 40, 0), reason="beta completions added in 1.40.0")
+@pytest.mark.skipif(not HAS_BETA_CHAT_COMPLETIONS, reason="beta completions added in 1.40.0, removed in 1.93.0")
 @pytest.mark.vcr()
 def test_chat_multiple_choices_with_capture_message_content(
     default_openai_env, trace_exporter, metrics_reader, logs_exporter
@@ -370,7 +371,7 @@ def test_chat_multiple_choices_with_capture_message_content(
     )
 
 
-@pytest.mark.skipif(OPENAI_VERSION < (1, 40, 0), reason="beta completions added in 1.40.0")
+@pytest.mark.skipif(not HAS_BETA_CHAT_COMPLETIONS, reason="beta completions added in 1.40.0, removed in 1.93.0")
 @pytest.mark.vcr()
 def test_chat_function_calling_with_tools(default_openai_env, trace_exporter, metrics_reader, logs_exporter):
     client = openai.OpenAI()
@@ -473,7 +474,7 @@ def test_chat_function_calling_with_tools(default_openai_env, trace_exporter, me
     )
 
 
-@pytest.mark.skipif(OPENAI_VERSION < (1, 40, 0), reason="beta completions added in 1.40.0")
+@pytest.mark.skipif(not HAS_BETA_CHAT_COMPLETIONS, reason="beta completions added in 1.40.0, removed in 1.93.0")
 @pytest.mark.vcr()
 def test_chat_tools_with_capture_message_content(default_openai_env, trace_exporter, logs_exporter, metrics_reader):
     # Redo the instrumentation dance to be affected by the environment variable
@@ -584,7 +585,7 @@ def test_chat_tools_with_capture_message_content(default_openai_env, trace_expor
     )
 
 
-@pytest.mark.skipif(OPENAI_VERSION < (1, 40, 0), reason="beta completions added in 1.40.0")
+@pytest.mark.skipif(not HAS_BETA_CHAT_COMPLETIONS, reason="beta completions added in 1.40.0, removed in 1.93.0")
 @pytest.mark.integration
 def test_chat_tools_with_capture_message_content_integration(trace_exporter, logs_exporter, metrics_reader):
     client = get_integration_client()
@@ -695,7 +696,7 @@ def test_chat_tools_with_capture_message_content_integration(trace_exporter, log
     )
 
 
-@pytest.mark.skipif(OPENAI_VERSION < (1, 40, 0), reason="beta completions added in 1.40.0")
+@pytest.mark.skipif(not HAS_BETA_CHAT_COMPLETIONS, reason="beta completions added in 1.40.0, removed in 1.93.0")
 def test_chat_connection_error(default_openai_env, trace_exporter, metrics_reader, logs_exporter):
     client = openai.Client(base_url="http://localhost:9999/v5", api_key="not-read", max_retries=1)
     messages = [
@@ -746,7 +747,7 @@ def test_chat_connection_error(default_openai_env, trace_exporter, metrics_reade
     )
 
 
-@pytest.mark.skipif(OPENAI_VERSION < (1, 40, 0), reason="beta completions added in 1.40.0")
+@pytest.mark.skipif(not HAS_BETA_CHAT_COMPLETIONS, reason="beta completions added in 1.40.0, removed in 1.93.0")
 @pytest.mark.integration
 def test_chat_with_capture_message_content_integration(trace_exporter, logs_exporter, metrics_reader):
     model = os.getenv("TEST_CHAT_MODEL", TEST_CHAT_MODEL)
@@ -822,7 +823,7 @@ def test_chat_with_capture_message_content_integration(trace_exporter, logs_expo
     )
 
 
-@pytest.mark.skipif(OPENAI_VERSION < (1, 40, 0), reason="beta completions added in 1.40.0")
+@pytest.mark.skipif(not HAS_BETA_CHAT_COMPLETIONS, reason="beta completions added in 1.40.0, removed in 1.93.0")
 @pytest.mark.vcr()
 def test_chat_with_capture_message_content(default_openai_env, trace_exporter, logs_exporter, metrics_reader):
     client = openai.OpenAI()
@@ -893,7 +894,7 @@ def test_chat_with_capture_message_content(default_openai_env, trace_exporter, l
     )
 
 
-@pytest.mark.skipif(OPENAI_VERSION < (1, 40, 0), reason="beta completions added in 1.40.0")
+@pytest.mark.skipif(not HAS_BETA_CHAT_COMPLETIONS, reason="beta completions added in 1.40.0, removed in 1.93.0")
 @pytest.mark.vcr()
 def test_chat_tools_with_followup_and_capture_message_content(
     default_openai_env, trace_exporter, metrics_reader, logs_exporter
@@ -1065,7 +1066,7 @@ def test_chat_tools_with_followup_and_capture_message_content(
     )
 
 
-@pytest.mark.skipif(OPENAI_VERSION < (1, 40, 0), reason="beta completions added in 1.40.0")
+@pytest.mark.skipif(not HAS_BETA_CHAT_COMPLETIONS, reason="beta completions added in 1.40.0, removed in 1.93.0")
 @pytest.mark.asyncio
 @pytest.mark.vcr()
 async def test_chat_async(default_openai_env, trace_exporter, metrics_reader, logs_exporter):
@@ -1131,7 +1132,7 @@ async def test_chat_async(default_openai_env, trace_exporter, metrics_reader, lo
     )
 
 
-@pytest.mark.skipif(OPENAI_VERSION < (1, 40, 0), reason="beta completions added in 1.40.0")
+@pytest.mark.skipif(not HAS_BETA_CHAT_COMPLETIONS, reason="beta completions added in 1.40.0, removed in 1.93.0")
 @pytest.mark.asyncio
 @pytest.mark.vcr()
 async def test_chat_async_with_capture_message_content(
@@ -1205,7 +1206,7 @@ async def test_chat_async_with_capture_message_content(
     )
 
 
-@pytest.mark.skipif(OPENAI_VERSION < (1, 40, 0), reason="beta completions added in 1.40.0")
+@pytest.mark.skipif(not HAS_BETA_CHAT_COMPLETIONS, reason="beta completions added in 1.40.0, removed in 1.93.0")
 @pytest.mark.integration
 @pytest.mark.asyncio
 async def test_chat_async_with_capture_message_content_integration(trace_exporter, logs_exporter, metrics_reader):
@@ -1279,7 +1280,7 @@ async def test_chat_async_with_capture_message_content_integration(trace_exporte
     )
 
 
-@pytest.mark.skipif(OPENAI_VERSION < (1, 40, 0), reason="beta completions added in 1.40.0")
+@pytest.mark.skipif(not HAS_BETA_CHAT_COMPLETIONS, reason="beta completions added in 1.40.0, removed in 1.93.0")
 @pytest.mark.vcr()
 @pytest.mark.asyncio
 async def test_chat_async_tools_with_capture_message_content(
@@ -1393,7 +1394,7 @@ async def test_chat_async_tools_with_capture_message_content(
     )
 
 
-@pytest.mark.skipif(OPENAI_VERSION < (1, 40, 0), reason="beta completions added in 1.40.0")
+@pytest.mark.skipif(not HAS_BETA_CHAT_COMPLETIONS, reason="beta completions added in 1.40.0, removed in 1.93.0")
 @pytest.mark.vcr()
 def test_chat_without_model_parameter(default_openai_env, trace_exporter, metrics_reader):
     client = openai.OpenAI()
@@ -1439,7 +1440,7 @@ def test_chat_without_model_parameter(default_openai_env, trace_exporter, metric
     )
 
 
-@pytest.mark.skipif(OPENAI_VERSION < (1, 40, 0), reason="beta completions added in 1.40.0")
+@pytest.mark.skipif(not HAS_BETA_CHAT_COMPLETIONS, reason="beta completions added in 1.40.0, removed in 1.93.0")
 @pytest.mark.vcr()
 def test_chat_with_model_not_found(default_openai_env, trace_exporter, metrics_reader):
     client = openai.OpenAI()
@@ -1485,7 +1486,7 @@ def test_chat_with_model_not_found(default_openai_env, trace_exporter, metrics_r
     )
 
 
-@pytest.mark.skipif(OPENAI_VERSION < (1, 40, 0), reason="beta completions added in 1.40.0")
+@pytest.mark.skipif(not HAS_BETA_CHAT_COMPLETIONS, reason="beta completions added in 1.40.0, removed in 1.93.0")
 @pytest.mark.vcr()
 def test_chat_exported_schema_version(default_openai_env, trace_exporter, metrics_reader):
     client = openai.OpenAI()
@@ -1511,7 +1512,7 @@ def test_chat_exported_schema_version(default_openai_env, trace_exporter, metric
             assert scope_metrics.schema_url == "https://opentelemetry.io/schemas/1.31.0"
 
 
-@pytest.mark.skipif(OPENAI_VERSION < (1, 40, 0), reason="beta completions added in 1.40.0")
+@pytest.mark.skipif(not HAS_BETA_CHAT_COMPLETIONS, reason="beta completions added in 1.40.0, removed in 1.93.0")
 @pytest.mark.vcr()
 def test_parse_response_format_json_object_with_capture_message_content(
     default_openai_env, trace_exporter, metrics_reader, logs_exporter
@@ -1588,7 +1589,7 @@ class Reason(BaseModel):
     reason: str
 
 
-@pytest.mark.skipif(OPENAI_VERSION < (1, 40, 0), reason="beta completions added in 1.40.0")
+@pytest.mark.skipif(not HAS_BETA_CHAT_COMPLETIONS, reason="beta completions added in 1.40.0, removed in 1.93.0")
 @pytest.mark.vcr()
 def test_parse_response_format_structured_output_with_capture_message_content(
     default_openai_env, trace_exporter, metrics_reader, logs_exporter