morpheus.llm.services.openai_chat_service.OpenAIChatClient

(Latest Version)
class OpenAIChatClient(parent, *, model_name, set_assistant=False, max_retries=10, **model_kwargs)[source]

Bases: morpheus.llm.services.llm_service.LLMClient

Client for interacting with a specific OpenAI chat model. This class should be constructed with the OpenAIChatService.get_client method.

Parameters
model_name

The name of the model to interact with.

set_assistant: bool, optional default=False

When True, a second input field named assistant will be used to proide additional context to the model.

max_retries: int, optional default=10

The maximum number of retries to attempt when making a request to the OpenAI API.

model_kwargs

Additional keyword arguments to pass to the model when generating text.

Methods

generate(**input_dict) Issue a request to generate a response based on a given prompt.
generate_async(**input_dict) Issue an asynchronous request to generate a response based on a given prompt.
generate_batch() Issue a request to generate a list of responses based on a list of prompts.
generate_batch_async() Issue an asynchronous request to generate a list of responses based on a list of prompts.
get_input_names() Returns the names of the inputs to the model.
generate(**input_dict)[source]

Issue a request to generate a response based on a given prompt.

Parameters
input_dict

Input containing prompt data.

async generate_async(**input_dict)[source]

Issue an asynchronous request to generate a response based on a given prompt.

Parameters
input_dict

Input containing prompt data.

generate_batch(inputs: dict[str, list], return_exceptions: Literal[True] = True)list[str | BaseException][source]
generate_batch(inputs: dict[str, list], return_exceptions: Literal[False] = False)list[str]

Issue a request to generate a list of responses based on a list of prompts.

Parameters
inputs

Inputs containing prompt data.

return_exceptions

Whether to return exceptions in the output list or raise them immediately.

async generate_batch_async(inputs: dict[str, list], return_exceptions: Literal[True] = True)list[str | BaseException][source]
async generate_batch_async(inputs: dict[str, list], return_exceptions: Literal[False] = False)list[str]

Issue an asynchronous request to generate a list of responses based on a list of prompts.

Parameters
inputs

Inputs containing prompt data.

return_exceptions

Whether to return exceptions in the output list or raise them immediately.

get_input_names()[source]

Returns the names of the inputs to the model.

Previous morpheus.llm.services.openai_chat_service
Next morpheus.llm.services.openai_chat_service.OpenAIChatService
© Copyright 2024, NVIDIA. Last updated on Apr 25, 2024.