Skip to content

added response format to model run #692

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 1 commit into from
Oct 7, 2025
Merged

added response format to model run #692

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions aixplain/modules/model/llm_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ def run(
parameters: Optional[Dict] = None,
wait_time: float = 0.5,
stream: bool = False,
response_format: Optional[Text] = None,
) -> Union[ModelResponse, ModelResponseStreamer]:
"""Run the LLM model synchronously to generate text.

Expand Down Expand Up @@ -150,6 +151,8 @@ def run(
Defaults to 0.5.
stream (bool, optional): Whether to stream the model's output tokens.
Defaults to False.
response_format (Optional[Union[str, dict, BaseModel]], optional):
Specifies the desired output structure or format of the model’s response.

Returns:
Union[ModelResponse, ModelResponseStreamer]: If stream=False, returns a ModelResponse
Expand All @@ -169,6 +172,7 @@ def run(
parameters.setdefault("temperature", temperature if temperature is not None else self.temperature)
parameters.setdefault("max_tokens", max_tokens)
parameters.setdefault("top_p", top_p)
parameters.setdefault("response_format", response_format)

if stream:
return self.run_stream(data=data, parameters=parameters)
Expand Down Expand Up @@ -213,6 +217,7 @@ def run_async(
top_p: float = 1.0,
name: Text = "model_process",
parameters: Optional[Dict] = None,
response_format: Optional[Text] = None,
) -> ModelResponse:
"""Run the LLM model asynchronously to generate text.

Expand Down Expand Up @@ -264,6 +269,7 @@ def run_async(
parameters.setdefault("temperature", temperature if temperature is not None else self.temperature)
parameters.setdefault("max_tokens", max_tokens)
parameters.setdefault("top_p", top_p)
parameters.setdefault("response_format", response_format)
payload = build_payload(data=data, parameters=parameters)
response = call_run_endpoint(payload=payload, url=url, api_key=self.api_key)
return ModelResponse(
Expand Down