Skip to content

Commit afbea27

Browse files
Add GenAI Gateway and APISIX Gateway configuration documentation
1 parent cd8f7b4 commit afbea27

2 files changed

Lines changed: 33 additions & 9 deletions

File tree

CodeTranslation/.env.example

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
# Backend API Configuration
22
BACKEND_PORT=5001
33

4-
# Keycloak Authentication
5-
BASE_URL=https://your-enterprise-api.com
6-
KEYCLOAK_CLIENT_ID=api
7-
KEYCLOAK_CLIENT_SECRET=your-client-secret
8-
9-
# Model Configuration - CodeLlama-34b-instruct
10-
INFERENCE_MODEL_ENDPOINT=CodeLlama-34b-Instruct-hf
4+
# Inference API Configuration
5+
# INFERENCE_API_ENDPOINT: URL to your inference service (without /v1 suffix)
6+
# - For GenAI Gateway: https://genai-gateway.example.com
7+
# - For APISIX Gateway: https://apisix-gateway.example.com/inference
8+
#
9+
# INFERENCE_API_TOKEN: Authentication token/API key for the inference service
10+
# - For GenAI Gateway: Your GenAI Gateway API key
11+
# - For APISIX Gateway: Your APISIX authentication token
12+
INFERENCE_API_ENDPOINT=https://your-api-endpoint.com/deployment
13+
INFERENCE_API_TOKEN=your-pre-generated-token-here
1114
INFERENCE_MODEL_NAME=codellama/CodeLlama-34b-Instruct-hf
1215

1316
# LLM Settings

CodeTranslation/README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,15 @@ Before you begin, ensure you have the following installed:
119119
### Required API Configuration
120120

121121
**For Inference Service (Code Translation):**
122-
- INFERENCE_API_ENDPOINT: URL of the deployed model inference service
123-
- INFERENCE_API_TOKEN: API key / bearer token used to authenticate requests
122+
123+
This application supports multiple inference deployment patterns:
124+
125+
- **GenAI Gateway**: Intel's centralized gateway for multi-model access
126+
- **APISIX Gateway**: API gateway with routing and authentication
127+
128+
Configuration requirements:
129+
- INFERENCE_API_ENDPOINT: URL to your inference service (GenAI Gateway, APISIX Gateway, etc.)
130+
- INFERENCE_API_TOKEN: Authentication token/API key for your chosen service
124131

125132
### Verify Docker Installation
126133

@@ -156,6 +163,13 @@ cat > .env << EOF
156163
BACKEND_PORT=5001
157164
158165
# Inference API Configuration
166+
# INFERENCE_API_ENDPOINT: URL to your inference service (without /v1 suffix)
167+
# - For GenAI Gateway: https://genai-gateway.example.com
168+
# - For APISIX Gateway: https://apisix-gateway.example.com/inference
169+
#
170+
# INFERENCE_API_TOKEN: Authentication token/API key for the inference service
171+
# - For GenAI Gateway: Your GenAI Gateway API key
172+
# - For APISIX Gateway: Your APISIX authentication token
159173
INFERENCE_API_ENDPOINT=https://your-api-endpoint.com/deployment
160174
INFERENCE_API_TOKEN=your-pre-generated-token-here
161175
INFERENCE_MODEL_NAME=codellama/CodeLlama-34b-Instruct-hf
@@ -180,6 +194,13 @@ Or manually create `.env` with:
180194
BACKEND_PORT=5001
181195

182196
# Inference API Configuration
197+
# INFERENCE_API_ENDPOINT: URL to your inference service (without /v1 suffix)
198+
# - For GenAI Gateway: https://genai-gateway.example.com
199+
# - For APISIX Gateway: https://apisix-gateway.example.com/inference
200+
#
201+
# INFERENCE_API_TOKEN: Authentication token/API key for the inference service
202+
# - For GenAI Gateway: Your GenAI Gateway API key
203+
# - For APISIX Gateway: Your APISIX authentication token
183204
INFERENCE_API_ENDPOINT=https://your-api-endpoint.com/deployment
184205
INFERENCE_API_TOKEN=your-pre-generated-token-here
185206
INFERENCE_MODEL_NAME=codellama/CodeLlama-34b-Instruct-hf

0 commit comments

Comments
 (0)