Skip to content

mark inference.{embeddings,chat_completion,completion} deprecated #248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions src/llama_stack_client/resources/inference.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

from typing import List, Union, Iterable
from typing_extensions import Literal, overload
import warnings

import httpx

Expand Down Expand Up @@ -408,6 +409,11 @@ def chat_completion(
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> ChatCompletionResponse | Stream[ChatCompletionResponseStreamChunk]:
warnings.warn(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hm, this is actually auto-generated code. I think we'd need to look into stainless to see if this can be done.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this something i can do?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mattf unfortunately not since stainless is controlled by us (meta) right now. we are working to make this be community owned also.

"The chat_completion method is deprecated. Use chat.completions.create instead",
DeprecationWarning,
stacklevel=2
)
if stream:
extra_headers = {"Accept": "text/event-stream", **(extra_headers or {})}
return self._post(
Expand Down Expand Up @@ -592,6 +598,11 @@ def completion(
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> CompletionResponse | Stream[CompletionResponse]:
warnings.warn(
"The completion method is deprecated. Use completions.create instead",
DeprecationWarning,
stacklevel=2
)
if stream:
extra_headers = {"Accept": "text/event-stream", **(extra_headers or {})}
return self._post(
Expand Down Expand Up @@ -632,6 +643,11 @@ def embeddings(
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> EmbeddingsResponse:
warnings.warn(
"The embeddings method is deprecated. Use embeddings.create instead",
DeprecationWarning,
stacklevel=2
)
"""
Generate embeddings for content pieces using the specified model.

Expand Down Expand Up @@ -1046,6 +1062,11 @@ async def chat_completion(
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> ChatCompletionResponse | AsyncStream[ChatCompletionResponseStreamChunk]:
warnings.warn(
"The chat_completion method is deprecated. Use chat.completions.create instead",
DeprecationWarning,
stacklevel=2
)
if stream:
extra_headers = {"Accept": "text/event-stream", **(extra_headers or {})}
return await self._post(
Expand Down Expand Up @@ -1230,6 +1251,11 @@ async def completion(
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> CompletionResponse | AsyncStream[CompletionResponse]:
warnings.warn(
"The completion method is deprecated. Use completions.create instead",
DeprecationWarning,
stacklevel=2
)
if stream:
extra_headers = {"Accept": "text/event-stream", **(extra_headers or {})}
return await self._post(
Expand Down Expand Up @@ -1270,6 +1296,11 @@ async def embeddings(
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> EmbeddingsResponse:
warnings.warn(
"The embeddings method is deprecated. Use embeddings.create instead",
DeprecationWarning,
stacklevel=2
)
"""
Generate embeddings for content pieces using the specified model.

Expand Down
141 changes: 141 additions & 0 deletions tests/test_deprecated_inference.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
import pytest
import warnings
import sys
from unittest import mock
from llama_stack_client import LlamaStackClient, AsyncLlamaStackClient


# Force all deprecation warnings to be shown, regardless of where they're emitted
warnings.filterwarnings("always", category=DeprecationWarning)


class TestDeprecatedInference:
@pytest.fixture
def client(self):
client = LlamaStackClient(base_url="http://test", api_key="test_key")
return client

def test_direct_warning_capture_chat_completion(self, client):
"""Test deprecation warning using manual warning capture."""
with mock.patch.object(client.inference, "_post") as mock_post:
mock_post.return_value = {"id": "test_id", "choices": []}

# Capture all warnings across all modules
with warnings.catch_warnings(record=True) as recorded_warnings:
# Ensure warnings are always shown
warnings.simplefilter("always")

# Call the deprecated method
client.inference.chat_completion(messages=[{"role": "user", "content": "Hello"}], model_id="test_model")

# Print warning details for debugging
for w in recorded_warnings:
print(f"\nWarning category: {w.category}")
print(f"Warning message: {str(w.message)}")

# Check for any DeprecationWarning with our message
assert any(
issubclass(w.category, DeprecationWarning)
and "Use chat.completions.create instead" in str(w.message)
for w in recorded_warnings
), "No matching deprecation warnings were emitted"

def test_completion_warning(self, client):
"""Test completion method emits deprecation warning."""
with mock.patch.object(client.inference, "_post") as mock_post:
mock_post.return_value = {"id": "test_id", "content": "test content"}

# Capture all warnings across all modules
with warnings.catch_warnings(record=True) as recorded_warnings:
warnings.simplefilter("always")

# Call the deprecated method
client.inference.completion(content="Hello", model_id="test_model")

# Check for any DeprecationWarning with our message
assert any(
issubclass(w.category, DeprecationWarning) and "Use completions.create instead" in str(w.message)
for w in recorded_warnings
), "No matching deprecation warnings were emitted"

def test_embeddings_warning(self, client):
"""Test embeddings method emits deprecation warning."""
with mock.patch.object(client.inference, "_post") as mock_post:
mock_post.return_value = {"data": [{"embedding": [0.1, 0.2]}]}

# Capture all warnings across all modules
with warnings.catch_warnings(record=True) as recorded_warnings:
warnings.simplefilter("always")

# Call the deprecated method
client.inference.embeddings(contents=["Hello"], model_id="test_model")

# Check for any DeprecationWarning with our message
assert any(
issubclass(w.category, DeprecationWarning) and "Use embeddings.create instead" in str(w.message)
for w in recorded_warnings
), "No matching deprecation warnings were emitted"


class TestAsyncDeprecatedInference:
@pytest.fixture
def async_client(self):
client = AsyncLlamaStackClient(base_url="http://test", api_key="test_key")
return client

@pytest.mark.asyncio
async def test_async_chat_completion_warning(self, async_client):
with mock.patch.object(async_client.inference, "_post", new_callable=mock.AsyncMock) as mock_post:
mock_post.return_value = {"id": "test_id", "choices": []}

# Capture all warnings across all modules
with warnings.catch_warnings(record=True) as recorded_warnings:
warnings.simplefilter("always")

# Call the deprecated method
await async_client.inference.chat_completion(
messages=[{"role": "user", "content": "Hello"}], model_id="test_model"
)

# Check for any DeprecationWarning with our message
assert any(
issubclass(w.category, DeprecationWarning)
and "Use chat.completions.create instead" in str(w.message)
for w in recorded_warnings
), "No matching deprecation warnings were emitted"

@pytest.mark.asyncio
async def test_async_completion_warning(self, async_client):
with mock.patch.object(async_client.inference, "_post", new_callable=mock.AsyncMock) as mock_post:
mock_post.return_value = {"id": "test_id", "content": "test content"}

# Capture all warnings across all modules
with warnings.catch_warnings(record=True) as recorded_warnings:
warnings.simplefilter("always")

# Call the deprecated method
await async_client.inference.completion(content="Hello", model_id="test_model")

# Check for any DeprecationWarning with our message
assert any(
issubclass(w.category, DeprecationWarning) and "Use completions.create instead" in str(w.message)
for w in recorded_warnings
), "No matching deprecation warnings were emitted"

@pytest.mark.asyncio
async def test_async_embeddings_warning(self, async_client):
with mock.patch.object(async_client.inference, "_post", new_callable=mock.AsyncMock) as mock_post:
mock_post.return_value = {"data": [{"embedding": [0.1, 0.2]}]}

# Capture all warnings across all modules
with warnings.catch_warnings(record=True) as recorded_warnings:
warnings.simplefilter("always")

# Call the deprecated method
await async_client.inference.embeddings(contents=["Hello"], model_id="test_model")

# Check for any DeprecationWarning with our message
assert any(
issubclass(w.category, DeprecationWarning) and "Use embeddings.create instead" in str(w.message)
for w in recorded_warnings
), "No matching deprecation warnings were emitted"
Loading