diff --git a/docs/input.md b/docs/input.md index 6ab42ab426..98b423c13c 100644 --- a/docs/input.md +++ b/docs/input.md @@ -1,5 +1,12 @@ # Completion Function - completion() +The Input params are **exactly the same** as the +OpenAI Create chat completion, and let you call **Azure OpenAI, Anthropic, Cohere, Replicate** models in the same format. + +In addition, liteLLM allows you to pass in the following **Optional** liteLLM args:
+`forceTimeout`, `azure`, `logger_fn`, `verbose` + ## Input - Request Body + **`model`** string Required
ID of the model to use. See the model endpoint compatibility @@ -12,6 +19,24 @@ ID of the model to use. See the Example Python Code +```python +from litellm import completion + +messages= + [ + {"role": "system", "content": "You are a helpful assistant."}, + {"role": "user", "content": "Knock knock."}, + {"role": "assistant", "content": "Who's there?"}, + {"role": "user", "content": "Orange."}, + ] + +# openai call +response = completion(model="gpt-3.5-turbo", messages=messages, temperature=0) + +# cohere call +response = completion(model="command-nightly", messages=messages, temperature=0) +``` + --- >> **`role`** @@ -64,8 +89,8 @@ A list of functions the model may generate JSON inputs for. >> **`parameters`** >> object Required
->> The parameters the functions accept, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format. ->> To describe a function that accepts no parameters, provide the value {"type": "object", "properties": {}}. +>> The parameters the functions accept, described as a JSON Schema object. +>> To describe a function that accepts no parameters, provide the value `{"type": "object", "properties": {}}`. >>
>> >> --- @@ -73,21 +98,21 @@ A list of functions the model may generate JSON inputs for. **`function_call`** string or object Optional
-Controls how the model responds to function calls. "none" means the model does not call a function, and responds to the end-user. "auto" means the model can pick between an end-user or calling a function. Specifying a particular function via {"name": "my_function"} forces the model to call that function. "none" is the default when no functions are present. "auto" is the default if functions are present. +Controls how the model responds to function calls. "none" means the model does not call a function, and responds to the end-user. "auto" means the model can pick between an end-user or calling a function. Specifying a particular function via `{"name": "my_function"}` forces the model to call that function. "none" is the default when no functions are present. "auto" is the default if functions are present.
--- **`temperature`** number Optional, Defaults to 1
-What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both. +What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both.
--- **`top_p`** number Optional, Defaults to 1
-An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both. +An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or 1temperature` but not both.
--- @@ -101,7 +126,7 @@ How many chat completion choices to generate for each input message. **`stream`** boolean Optional, Defaults to false
-If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Example Python code. +If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a `data: [DONE]` message.
--- @@ -115,21 +140,21 @@ Up to 4 sequences where the API will stop generating further tokens. **`max_tokens`** integer Optional, Defaults to inf
-The maximum number of tokens to generate in the chat completion. The total length of input tokens and generated tokens is limited by the model's context length. Example Python code for counting tokens. +The maximum number of tokens to generate in the chat completion. The total length of input tokens and generated tokens is limited by the model's context length
--- **`presence_penalty`** number Optional, Defaults to 0
-Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. See more information about frequency and presence penalties. +Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.
--- **`frequency_penalty`** number Optional, Defaults to 0
-Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. See more information about frequency and presence penalties. +Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
--- @@ -143,5 +168,5 @@ Modify the likelihood of specified tokens appearing in the completion. Accepts a **`user`** string Optional
-A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more. +A unique identifier representing your end-user, which can help liteLLM to monitor and detect abuse.