(docs) input params

This commit is contained in:
ishaan-jaff 2023-12-26 14:36:19 +05:30
parent a463625452
commit b2e69cbc24

View file

@ -66,6 +66,7 @@ def completion(
model: str, model: str,
messages: List = [], messages: List = [],
# Optional OpenAI params # Optional OpenAI params
timeout: Optional[Union[float, int]] = None,
temperature: Optional[float] = None, temperature: Optional[float] = None,
top_p: Optional[float] = None, top_p: Optional[float] = None,
n: Optional[int] = None, n: Optional[int] = None,
@ -74,28 +75,27 @@ def completion(
max_tokens: Optional[float] = None, max_tokens: Optional[float] = None,
presence_penalty: Optional[float] = None, presence_penalty: Optional[float] = None,
frequency_penalty: Optional[float] = None, frequency_penalty: Optional[float] = None,
logit_bias: dict = {}, logit_bias: Optional[dict] = None,
user: str = "", user: Optional[str] = None,
deployment_id = None, # openai v1.0+ new params
request_timeout: Optional[int] = None,
response_format: Optional[dict] = None, response_format: Optional[dict] = None,
seed: Optional[int] = None, seed: Optional[int] = None,
tools: Optional[List] = None, tools: Optional[List] = None,
tool_choice: Optional[str] = None, tool_choice: Optional[str] = None,
functions: List = [], # soon to be deprecated logprobs: Optional[bool] = None,
function_call: str = "", # soon to be deprecated top_logprobs: Optional[int] = None,
deployment_id=None,
# Optional LiteLLM params # soon to be deprecated params by OpenAI
api_base: Optional[str] = None, functions: Optional[List] = None,
function_call: Optional[str] = None,
# set api_base, api_version, api_key
base_url: Optional[str] = None,
api_version: Optional[str] = None, api_version: Optional[str] = None,
api_key: Optional[str] = None, api_key: Optional[str] = None,
num_retries: Optional[int] = None, # set to retry a model if an APIError, TimeoutError, or ServiceUnavailableError occurs model_list: Optional[list] = None, # pass in a list of api_base,keys, etc.
context_window_fallback_dict: Optional[dict] = None, # mapping of model to use if call fails due to context window error # Optional liteLLM function params
fallbacks: Optional[list] = None, # pass in a list of api_base,keys, etc.
metadata: Optional[dict] = None # additional call metadata, passed to logging integrations / custom callbacks
**kwargs, **kwargs,
) -> ModelResponse: ) -> ModelResponse:
``` ```
### Required Fields ### Required Fields