From 3e29a233019b34ade2a966347244cc4542adbd8b Mon Sep 17 00:00:00 2001 From: vedpatwardhan Date: Tue, 3 Sep 2024 05:11:14 +0000 Subject: [PATCH] updated docs --- .../llm_queries/chat_completions.mdx | 9 +++-- api-reference/openapi.json | 7 ++++ mint.json | 36 +++++++++---------- python/evaluator.mdx | 5 --- python/queries.mdx | 5 --- python/{queries.chat.mdx => queries/chat.mdx} | 2 +- .../clients.mdx} | 2 +- .../multi_llm.mdx} | 2 +- python/utils.custom_api_keys.mdx | 5 --- python/utils.custom_endpoints.mdx | 5 --- python/utils.efficiency_benchmarks.mdx | 5 --- python/utils.evaluators.mdx | 5 --- python/utils.helpers.mdx | 5 --- python/utils.logging.mdx | 5 --- python/utils.mdx | 5 --- python/utils.router_configurations.mdx | 5 --- python/utils.router_deployment.mdx | 5 --- python/utils.router_training.mdx | 5 --- .../{utils.credits.mdx => utils/credits.mdx} | 2 +- .../datasets.mdx} | 2 +- .../evaluations.mdx} | 2 +- .../supported_endpoints.mdx} | 2 +- 22 files changed, 38 insertions(+), 88 deletions(-) delete mode 100644 python/evaluator.mdx delete mode 100644 python/queries.mdx rename python/{queries.chat.mdx => queries/chat.mdx} (99%) rename python/{queries.clients.mdx => queries/clients.mdx} (99%) rename python/{queries.multi_llm.mdx => queries/multi_llm.mdx} (99%) delete mode 100644 python/utils.custom_api_keys.mdx delete mode 100644 python/utils.custom_endpoints.mdx delete mode 100644 python/utils.efficiency_benchmarks.mdx delete mode 100644 python/utils.evaluators.mdx delete mode 100644 python/utils.helpers.mdx delete mode 100644 python/utils.logging.mdx delete mode 100644 python/utils.mdx delete mode 100644 python/utils.router_configurations.mdx delete mode 100644 python/utils.router_deployment.mdx delete mode 100644 python/utils.router_training.mdx rename python/{utils.credits.mdx => utils/credits.mdx} (95%) rename python/{utils.datasets.mdx => utils/datasets.mdx} (99%) rename python/{utils.evaluations.mdx => utils/evaluations.mdx} (98%) rename python/{utils.supported_endpoints.mdx => utils/supported_endpoints.mdx} (98%) diff --git a/api-reference/llm_queries/chat_completions.mdx b/api-reference/llm_queries/chat_completions.mdx index 99512bc..7aa8d9e 100644 --- a/api-reference/llm_queries/chat_completions.mdx +++ b/api-reference/llm_queries/chat_completions.mdx @@ -143,6 +143,10 @@ Whether or not to use custom API keys with the specified provider, meaning that Comma-separated list of tags to associate with the corresponding prompt. + +Whether or not to drop unsupported OpenAI params by the provider you're using + + ```bash cURL @@ -187,7 +191,8 @@ curl --request POST \ "user": "some_user", "signature": "python", "use_custom_keys": true, - "tags": true + "tags": true, + "drop_params": true }' ``` @@ -198,7 +203,7 @@ url = "https://api.unify.ai/v0/chat/completions" headers = {"Authorization": "Bearer "} -json_input = {"messages": [{"content": "Tell me a joke", "role": "user"}], "model": "gpt-4o-mini@openai", "max_tokens": 1024, "stop": ["The End.", " is the answer."], "stream": False, "temperature": 0.9, "frequency_penalty": 1.5, "logit_bias": {"0": 10, "1": -75, "2": 90}, "logprobs": False, "top_logprobs": 15, "n": 15, "presence_penalty": -1.1, "response_format": "{ "type": "json_mode"}", "seed": 11, "stream_options": [True, "include_usage"], "top_p": 0.5, "tool_choice": "{"type": "function", "function": {"name": "my_function"}}", "parallel_tool_calls": True, "user": "some_user", "signature": "python", "use_custom_keys": True, "tags": True} +json_input = {"messages": [{"content": "Tell me a joke", "role": "user"}], "model": "gpt-4o-mini@openai", "max_tokens": 1024, "stop": ["The End.", " is the answer."], "stream": False, "temperature": 0.9, "frequency_penalty": 1.5, "logit_bias": {"0": 10, "1": -75, "2": 90}, "logprobs": False, "top_logprobs": 15, "n": 15, "presence_penalty": -1.1, "response_format": "{ "type": "json_mode"}", "seed": 11, "stream_options": [True, "include_usage"], "top_p": 0.5, "tool_choice": "{"type": "function", "function": {"name": "my_function"}}", "parallel_tool_calls": True, "user": "some_user", "signature": "python", "use_custom_keys": True, "tags": True, "drop_params": True} response = requests.request("POST", url, json=json_input, headers=headers) diff --git a/api-reference/openapi.json b/api-reference/openapi.json index 08b01d8..e2fe110 100644 --- a/api-reference/openapi.json +++ b/api-reference/openapi.json @@ -3393,6 +3393,13 @@ "title": "Tags", "description": "Comma-separated list of tags to associate with the corresponding prompt.", "example": true + }, + "drop_params": { + "type": "boolean", + "title": "Drop Params", + "description": "Whether or not to drop unsupported OpenAI params by the provider you're using", + "default": true, + "example": true } }, "additionalProperties": true, diff --git a/mint.json b/mint.json index ed060d1..e874cf4 100644 --- a/mint.json +++ b/mint.json @@ -100,26 +100,24 @@ "pages": [ "python/dataset", "python/evaluation", - "python/evaluator", "python/exceptions", - "python/queries", - "python/queries.chat", - "python/queries.clients", - "python/queries.multi_llm", - "python/utils", - "python/utils.credits", - "python/utils.custom_api_keys", - "python/utils.custom_endpoints", - "python/utils.datasets", - "python/utils.efficiency_benchmarks", - "python/utils.evaluations", - "python/utils.evaluators", - "python/utils.helpers", - "python/utils.logging", - "python/utils.router_configurations", - "python/utils.router_deployment", - "python/utils.router_training", - "python/utils.supported_endpoints" + { + "group": "queries", + "pages": [ + "python/queries/chat", + "python/queries/clients", + "python/queries/multi_llm" + ] + }, + { + "group": "utils", + "pages": [ + "python/utils/credits", + "python/utils/datasets", + "python/utils/evaluations", + "python/utils/supported_endpoints" + ] + } ] }, { diff --git a/python/evaluator.mdx b/python/evaluator.mdx deleted file mode 100644 index fbd1822..0000000 --- a/python/evaluator.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'evaluator' ---- - - diff --git a/python/queries.mdx b/python/queries.mdx deleted file mode 100644 index 92af730..0000000 --- a/python/queries.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'queries' ---- - - diff --git a/python/queries.chat.mdx b/python/queries/chat.mdx similarity index 99% rename from python/queries.chat.mdx rename to python/queries/chat.mdx index 540fa30..bb384b5 100644 --- a/python/queries.chat.mdx +++ b/python/queries/chat.mdx @@ -1,5 +1,5 @@ --- -title: 'queries.chat' +title: 'chat' --- diff --git a/python/queries.clients.mdx b/python/queries/clients.mdx similarity index 99% rename from python/queries.clients.mdx rename to python/queries/clients.mdx index 7096c9c..54252ad 100644 --- a/python/queries.clients.mdx +++ b/python/queries/clients.mdx @@ -1,5 +1,5 @@ --- -title: 'queries.clients' +title: 'clients' --- diff --git a/python/queries.multi_llm.mdx b/python/queries/multi_llm.mdx similarity index 99% rename from python/queries.multi_llm.mdx rename to python/queries/multi_llm.mdx index 839d419..78979f2 100644 --- a/python/queries.multi_llm.mdx +++ b/python/queries/multi_llm.mdx @@ -1,5 +1,5 @@ --- -title: 'queries.multi_llm' +title: 'multi_llm' --- diff --git a/python/utils.custom_api_keys.mdx b/python/utils.custom_api_keys.mdx deleted file mode 100644 index f1ee4dd..0000000 --- a/python/utils.custom_api_keys.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'utils.custom_api_keys' ---- - - diff --git a/python/utils.custom_endpoints.mdx b/python/utils.custom_endpoints.mdx deleted file mode 100644 index fd4f823..0000000 --- a/python/utils.custom_endpoints.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'utils.custom_endpoints' ---- - - diff --git a/python/utils.efficiency_benchmarks.mdx b/python/utils.efficiency_benchmarks.mdx deleted file mode 100644 index f2bfbf4..0000000 --- a/python/utils.efficiency_benchmarks.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'utils.efficiency_benchmarks' ---- - - diff --git a/python/utils.evaluators.mdx b/python/utils.evaluators.mdx deleted file mode 100644 index 004a79c..0000000 --- a/python/utils.evaluators.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'utils.evaluators' ---- - - diff --git a/python/utils.helpers.mdx b/python/utils.helpers.mdx deleted file mode 100644 index 1296dd4..0000000 --- a/python/utils.helpers.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'utils.helpers' ---- - - diff --git a/python/utils.logging.mdx b/python/utils.logging.mdx deleted file mode 100644 index c225e4b..0000000 --- a/python/utils.logging.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'utils.logging' ---- - - diff --git a/python/utils.mdx b/python/utils.mdx deleted file mode 100644 index aaf5def..0000000 --- a/python/utils.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'utils' ---- - - diff --git a/python/utils.router_configurations.mdx b/python/utils.router_configurations.mdx deleted file mode 100644 index 4796c1a..0000000 --- a/python/utils.router_configurations.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'utils.router_configurations' ---- - - diff --git a/python/utils.router_deployment.mdx b/python/utils.router_deployment.mdx deleted file mode 100644 index 6772c04..0000000 --- a/python/utils.router_deployment.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'utils.router_deployment' ---- - - diff --git a/python/utils.router_training.mdx b/python/utils.router_training.mdx deleted file mode 100644 index 3eaa04e..0000000 --- a/python/utils.router_training.mdx +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'utils.router_training' ---- - - diff --git a/python/utils.credits.mdx b/python/utils/credits.mdx similarity index 95% rename from python/utils.credits.mdx rename to python/utils/credits.mdx index 4f53c60..4dee674 100644 --- a/python/utils.credits.mdx +++ b/python/utils/credits.mdx @@ -1,5 +1,5 @@ --- -title: 'utils.credits' +title: 'credits' --- diff --git a/python/utils.datasets.mdx b/python/utils/datasets.mdx similarity index 99% rename from python/utils.datasets.mdx rename to python/utils/datasets.mdx index 351b3bb..316a824 100644 --- a/python/utils.datasets.mdx +++ b/python/utils/datasets.mdx @@ -1,5 +1,5 @@ --- -title: 'utils.datasets' +title: 'datasets' --- diff --git a/python/utils.evaluations.mdx b/python/utils/evaluations.mdx similarity index 98% rename from python/utils.evaluations.mdx rename to python/utils/evaluations.mdx index 29f2027..686b916 100644 --- a/python/utils.evaluations.mdx +++ b/python/utils/evaluations.mdx @@ -1,5 +1,5 @@ --- -title: 'utils.evaluations' +title: 'evaluations' --- diff --git a/python/utils.supported_endpoints.mdx b/python/utils/supported_endpoints.mdx similarity index 98% rename from python/utils.supported_endpoints.mdx rename to python/utils/supported_endpoints.mdx index 14c4343..4abc607 100644 --- a/python/utils.supported_endpoints.mdx +++ b/python/utils/supported_endpoints.mdx @@ -1,5 +1,5 @@ --- -title: 'utils.supported_endpoints' +title: 'supported_endpoints' ---