diff --git a/docs/deployment/bring-your-own-endpoint/testing-endpoint-oai-compatibility.md b/docs/deployment/bring-your-own-endpoint/testing-endpoint-oai-compatibility.md index f4cd305f..27aa856b 100644 --- a/docs/deployment/bring-your-own-endpoint/testing-endpoint-oai-compatibility.md +++ b/docs/deployment/bring-your-own-endpoint/testing-endpoint-oai-compatibility.md @@ -31,6 +31,7 @@ Your endpoint should support the following parameters: ```bash export FULL_ENDPOINT_URL="https://your-server.com/v1/chat/completions" export API_KEY="your-api-key-here" +export MODEL_NAME="your-model-name-here" curl -X POST ${FULL_ENDPOINT_URL} \ -H "Content-Type: application/json" \ @@ -42,7 +43,7 @@ curl -X POST ${FULL_ENDPOINT_URL} \ "content": "Write Python code that can add a list of numbers together." } ], - "model": "", + "model": "'"$MODEL_NAME"'", "temperature": 0.6, "top_p": 0.95, "max_tokens": 256, @@ -55,13 +56,14 @@ curl -X POST ${FULL_ENDPOINT_URL} \ ```bash export FULL_ENDPOINT_URL="https://your-server.com/v1/completions" export API_KEY="your-api-key-here" +export MODEL_NAME="your-model-name-here" curl -X POST ${FULL_ENDPOINT_URL} \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${API_KEY}" \ -d '{ "prompt": "Write Python code that can add a list of numbers together.", - "model": "", + "model": "'"$MODEL_NAME"'", "temperature": 0.6, "top_p": 0.95, "max_tokens": 256, @@ -79,6 +81,7 @@ NeMo Evaluator supports the **OpenAI Images API** ([docs](https://platform.opena ```bash export FULL_ENDPOINT_URL="https://your-server.com/v1/chat/completions" export API_KEY="your-api-key-here" +export MODEL_NAME="your-model-name-here" curl -X POST ${FULL_ENDPOINT_URL} \ -H "Content-Type: application/json" \ @@ -102,7 +105,7 @@ curl -X POST ${FULL_ENDPOINT_URL} \ ] } ], - "model": "", + "model": "'"$MODEL_NAME"'", "stream": false, "max_tokens": 16, "temperature": 0.0, @@ -119,13 +122,14 @@ Function calling request: ```bash export FULL_ENDPOINT_URL="https://your-server.com/v1/chat/completions" export API_KEY="your-api-key-here" +export MODEL_NAME="your-model-name-here" curl -X POST ${FULL_ENDPOINT_URL} \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${API_KEY}" \ -H "Accept: application/json" \ -d '{ - "model": "", + "model": "'"$MODEL_NAME"'", "stream": false, "max_tokens": 16, "temperature": 0.0, @@ -181,6 +185,7 @@ Example: ``` bash export FULL_ENDPOINT_URL="https://your-server.com/v1/chat/completions" export API_KEY="your-api-key-here" +export MODEL_NAME="your-model-name-here" curl -X POST ${FULL_ENDPOINT_URL} \ -H "Content-Type: application/json" \ @@ -188,7 +193,7 @@ curl -X POST ${FULL_ENDPOINT_URL} \ -H "Accept: application/json" \ -d '{ "max_tokens": 256, - "model": "", + "model": "'"$MODEL_NAME"'", "messages": [ { "content": [