Skip to content

Add status code to endpoint response #172

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jan 23, 2025
Merged

Add status code to endpoint response #172

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8ce529e
add status code
seanshi-scale Jan 23, 2025
e31552e
filter out extraneous fields explicitly
seanshi-scale Jan 23, 2025
6024b3d
black
seanshi-scale Jan 23, 2025
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
16 changes: 15 additions & 1 deletion launch/model_endpoint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@
TASK_SUCCESS_STATE = "SUCCESS"
TASK_FAILURE_STATE = "FAILURE"

# Echoes fields in EndpointResponse class
ALLOWED_ENDPOINT_RESPONSE_FIELDS = {"status", "result_url", "result", "traceback", "status_code"}


@dataclass_json(undefined=Undefined.EXCLUDE)
@dataclass
Expand Down Expand Up @@ -189,6 +192,7 @@ def __init__(
result_url: Optional[str] = None,
result: Optional[str] = None,
traceback: Optional[str] = None,
status_code: Optional[int] = None,
):
"""
Parameters:
Expand All @@ -210,12 +214,15 @@ def __init__(

traceback: The stack trace if the inference endpoint raised an error. Can be used for debugging

status_code: The underlying status code of the response, given from the inference endpoint itself.

"""
self.client = client
self.status = status
self.result_url = result_url
self.result = result
self.traceback = traceback
self.status_code = status_code

def __str__(self) -> str:
return (
Expand Down Expand Up @@ -271,6 +278,7 @@ def get(self, timeout: Optional[float] = None) -> EndpointResponse:
result_url=async_response.get("result", {}).get("result_url", None),
result=async_response.get("result", {}).get("result", None),
traceback=None,
status_code=async_response.get("status_code", None),
)
elif status == "FAILURE":
return EndpointResponse(
Expand All @@ -279,6 +287,7 @@ def get(self, timeout: Optional[float] = None) -> EndpointResponse:
result_url=None,
result=None,
traceback=async_response.get("traceback", None),
status_code=async_response.get("status_code", None),
)
else:
raise ValueError(f"Unrecognized status: {async_response['status']}")
Expand Down Expand Up @@ -312,6 +321,7 @@ def __next__(self):
result_url=result.get("result_url", None),
result=result.get("result", None),
traceback=data.get("traceback"),
status_code=data.get("status_code", None),
)


Expand Down Expand Up @@ -397,7 +407,10 @@ def predict(self, request: EndpointRequest) -> EndpointResponse:
args=request.args,
return_pickled=request.return_pickled,
)
raw_response = {k: v for k, v in raw_response.items() if v is not None}

raw_response = {
k: v for k, v in raw_response.items() if v is not None and k in ALLOWED_ENDPOINT_RESPONSE_FIELDS
}
return EndpointResponse(client=self.client, **raw_response)


Expand Down Expand Up @@ -632,6 +645,7 @@ def single_request(inner_url, inner_task_id):
result_url=raw_response.get("result_url", None),
result=raw_response.get("result", None),
traceback=raw_response.get("traceback", None),
status_code=raw_response.get("status_code", None),
)
self.responses[url] = response_object

Expand Down