From af3b38a5b429d56b9abbdf03ca2bbf4a8898053d Mon Sep 17 00:00:00 2001 From: Adil Hafeez Date: Fri, 11 Jul 2025 11:27:13 -0700 Subject: [PATCH] update docs --- demos/use_cases/README.md | 12 +++------ docs/source/get_started/quickstart.rst | 18 +++++-------- docs/source/guides/llm_router.rst | 36 ++++++++++---------------- 3 files changed, 23 insertions(+), 43 deletions(-) diff --git a/demos/use_cases/README.md b/demos/use_cases/README.md index f0684e81..30cce822 100644 --- a/demos/use_cases/README.md +++ b/demos/use_cases/README.md @@ -13,16 +13,12 @@ listeners: timeout: 30s llm_providers: - - name: gpt-4o - access_key: $OPENAI_API_KEY - provider: openai - model: gpt-4o + - access_key: $OPENAI_API_KEY + model: openai/gpt-4o default: true - - name: ministral-3b - access_key: $MISTRAL_API_KEY - provider: openai - model: ministral-3b-latest + - access_key: $MISTRAL_API_KEY + model: mistral/ministral-3b-latest ``` ### Step 2. Start arch gateway diff --git a/docs/source/get_started/quickstart.rst b/docs/source/get_started/quickstart.rst index 9c3499ea..34dbf64c 100644 --- a/docs/source/get_started/quickstart.rst +++ b/docs/source/get_started/quickstart.rst @@ -50,10 +50,8 @@ Create ``arch_config.yaml`` file with the following content: timeout: 30s llm_providers: - - name: gpt-4o - access_key: $OPENAI_API_KEY - provider: openai - model: gpt-4o + - access_key: $OPENAI_API_KEY + model: openai/gpt-4o system_prompt: | You are a helpful assistant. @@ -153,16 +151,12 @@ Create ``arch_config.yaml`` file with the following content: timeout: 30s llm_providers: - - name: gpt-4o - access_key: $OPENAI_API_KEY - provider_interface: openai - model: gpt-4o + - access_key: $OPENAI_API_KEY + model: openai/gpt-4o default: true - - name: ministral-3b - access_key: $MISTRAL_API_KEY - provider_interface: openai - model: ministral-3b-latest + - access_key: $MISTRAL_API_KEY + model: mistralministral-3b-latest Step 2. Start arch gateway ~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/guides/llm_router.rst b/docs/source/guides/llm_router.rst index 0cde6ff8..f999860c 100644 --- a/docs/source/guides/llm_router.rst +++ b/docs/source/guides/llm_router.rst @@ -74,9 +74,6 @@ Below is an example to show how to set up a prompt target for the Arch Router: :caption: Route Config Example - routing: - model: archgw-v1-router-model - listeners: egress_traffic: address: 0.0.0.0 @@ -85,29 +82,22 @@ Below is an example to show how to set up a prompt target for the Arch Router: timeout: 30s llm_providers: - - name: archgw-v1-router-model - provider_interface: openai - model: katanemo/Arch-Router-1.5B - base_url: ... - - name: gpt-4o-mini - provider_interface: openai - access_key: $OPENAI_API_KEY - model: gpt-4o-mini - default: true + - model: openai/gpt-4o-mini + access_key: $OPENAI_API_KEY + default: true - - name: code_generation - provider_interface: openai - access_key: $OPENAI_API_KEY - model: gpt-4o - usage: Generating new code snippets, functions, or boilerplate based on user prompts or requirements - - - name: code_understanding - provider_interface: openai - access_key: $OPENAI_API_KEY - model: gpt-4.1 - usage: understand and explain existing code snippets, functions, or libraries + - model: openai/gpt-4o + access_key: $OPENAI_API_KEY + routing_preferences: + - name: code understanding + description: understand and explain existing code snippets, functions, or libraries + - model: openai/gpt-4.1 + access_key: $OPENAI_API_KEY + routing_preferences: + - name: code generation + description: generating new code snippets, functions, or boilerplate based on user prompts or requirements Example Use Cases -------------------------