Developer guide
API ಕೀಯೊಂದಿಗೆ ದೃಢೀಕರಿಸುವುದು
API ಕೀಯನ್ನು ಸೇರಿಸುವ ಹೆಡರ್ ಮತ್ತು SDK ನಲ್ಲಿ ಹೊಂದಿಸಬೇಕಾದ base URL
ಈ ಪುಟವು CLEVI ಗೇಟ್ವೇಗೆ API ಕೀಯೊಂದಿಗೆ ದೃಢೀಕರಿಸುವ ವಿಧಾನವನ್ನು ವಿವರಿಸುತ್ತದೆ.
OpenAI ಹೊಂದಾಣಿಕೆಯ ಮಾರ್ಗ ಮತ್ತು Anthropic ಹೊಂದಾಣಿಕೆಯ ಮಾರ್ಗ ಎರಡರಲ್ಲೂ ಒಂದೇ ಕೀಯೊಂದಿಗೆ ದೃಢೀಕರಿಸಲಾಗುತ್ತದೆ,
ಕೀಯನ್ನು ಸೇರಿಸುವ ಹೆಡರ್ನ ಅನುಮತಿಸಲಾದ ವ್ಯಾಪ್ತಿ ಮತ್ತು SDK ನಲ್ಲಿ ಹೊಂದಿಸಬೇಕಾದ base URL ಪ್ರತಿ ನಿರ್ದಿಷ್ಟತೆಯಲ್ಲೂ ಭಿನ್ನವಾಗಿರುತ್ತದೆ.
ದೃಢೀಕರಣ ಹೆಡರ್
ಎರಡೂ ಹೊಂದಾಣಿಕೆಯ ನಿರ್ದಿಷ್ಟತೆಗಳಲ್ಲಿ ಒಂದೇ API ಕೀಯೊಂದಿಗೆ ದೃಢೀಕರಿಸಲಾಗುತ್ತದೆ. ಕೀಯನ್ನು ಕನ್ಸೋಲ್ನ API ಕೀ ಪರದೆಯಿಂದ ನೀಡಲಾಗುತ್ತದೆ, ಮತ್ತು ಅದೇ ಪರದೆಯಲ್ಲಿ ರದ್ದುಗೊಳಿಸುವಿಕೆ ಮತ್ತು ಬಳಕೆಯ ವ್ಯಾಪ್ತಿಯನ್ನು ನಿರ್ವಹಿಸಲಾಗುತ್ತದೆ.
| ಹೆಡರ್ | OpenAI ಹೊಂದಾಣಿಕೆ | Anthropic ಹೊಂದಾಣಿಕೆ |
|---|---|---|
| X-API-Key: <키> | ಬಳಸಬಹುದು | ಬಳಸಬಹುದು |
| Authorization: Bearer <키> | ಬಳಸಬಹುದು | ಬಳಸಬಹುದು |
| Authorization: <키> (Bearer ಇಲ್ಲದೆ) | ತಿರಸ್ಕರಿಸಲಾಗುತ್ತದೆ | ಬಳಸಬಹುದು |
ಹೆಡರ್ ಹೆಸರುಗಳು ದೊಡ್ಡಕ್ಷರ ಮತ್ತು ಸಣ್ಣಕ್ಷರಗಳನ್ನು ಭೇದಿಸುವುದಿಲ್ಲ. Anthropic SDK ಕಳುಹಿಸುವ x-api-key ಸಹ ಹಾಗೆಯೇ ಕಾರ್ಯನಿರ್ವಹಿಸುತ್ತದೆ.
base URL
ನೀವು ಬಳಸುತ್ತಿದ್ದ SDK ಯಲ್ಲಿ base URL ಅನ್ನು ಕೆಳಗಿನ ವಿಳಾಸಕ್ಕೆ ಬದಲಾಯಿಸಿದರೆ ಸಾಕು. ಎರಡು ವಿಳಾಸಗಳು /v1 ಅನ್ನು ಒಳಗೊಂಡಿರುವುದರಲ್ಲಿ ಭಿನ್ನವಾಗಿವೆ.
| ನಿರ್ದಿಷ್ಟತೆ | base URL | ಮಾರ್ಗ ನಿಯಮ |
|---|---|---|
| OpenAI ಹೊಂದಾಣಿಕೆ | https://platform.clevi.net/api/v2/aiservice/openai/v1 | /v1 ವರೆಗೆ base URL ನಲ್ಲಿ ಸೇರಿಸಿ. |
| Anthropic ಹೊಂದಾಣಿಕೆ | https://platform.clevi.net/api/v2/aiservice/anthropic | Anthropic SDK ಮಾರ್ಗಕ್ಕೆ /v1 ಅನ್ನು ಸ್ವತಃ ಸೇರಿಸುವುದರಿಂದ /v1 ಕ್ಕಿಂತ ಮೊದಲು ಮುಗಿಯುತ್ತದೆ. |
ದೃಢೀಕರಣ ಪರಿಶೀಲನೆ
ಕೀ ಮತ್ತು base URL ಅನ್ನು ಸೇರಿಸಿ ಮಾದರಿಗಳ ಪಟ್ಟಿಯನ್ನು ಪಡೆಯುವುದರಿಂದ ದೃಢೀಕರಣವಾಗಿದೆಯೇ ಎಂಬುದನ್ನು ತಕ್ಷಣ ತಿಳಿಯಬಹುದು. ಕೆಳಗಿನ ಮೂರೂ ಒಂದೇ ಪಟ್ಟಿಯನ್ನು curl, OpenAI SDK ಮತ್ತು Anthropic SDK ಬಳಸಿ ಪಡೆಯುತ್ತವೆ.
curl https://platform.clevi.net/api/v2/aiservice/openai/v1/models \
-H "X-API-Key: sk-..."
curl https://platform.clevi.net/api/v2/aiservice/anthropic/v1/models \
-H "Authorization: Bearer sk-..." \
-H "anthropic-version: 2023-06-01"from openai import OpenAI
client = OpenAI(
api_key="sk-...",
base_url="https://platform.clevi.net/api/v2/aiservice/openai/v1",
)
for model in client.models.list():
print(model.id)from anthropic import Anthropic
client = Anthropic(
api_key="sk-...",
base_url="https://platform.clevi.net/api/v2/aiservice/anthropic",
)
for model in client.models.list(limit=20).data:
print(model.id)sk-... ಸ್ಥಾನದಲ್ಲಿ API ಕೀ ಪರದೆಯಿಂದ ನೀಡಲಾದ ಕೀಯನ್ನು ಸೇರಿಸಿ.
- ಪ್ರತಿಕ್ರಿಯೆ 200 ಆಗಿದ್ದರೆ ದೃಢೀಕರಣ ಯಶಸ್ವಿಯಾಗಿದೆ. data ಯಲ್ಲಿ ಈ ಕೀಯೊಂದಿಗೆ ಕರೆಯಬಹುದಾದ ಮಾದರಿಗಳ ಪಟ್ಟಿ ಒಳಗೊಂಡಿರುತ್ತದೆ.
- ಪ್ರತಿಕ್ರಿಯೆ 401 ಆಗಿದ್ದರೆ ಕೆಳಗಿನ ದೃಢೀಕರಣ ವಿಫಲವಾದ ವಿಭಾಗದಲ್ಲಿನ ಕ್ರಮದಂತೆ ಪರಿಶೀಲಿಸಿ.
ಒಟ್ಟಿಗೆ ಬಳಸುವ ಹೆಡರ್
ಎಲ್ಲವೂ ಐಚ್ಛಿಕವಾಗಿವೆ. ಸಮಸ್ಯೆಗಳನ್ನು ಟ್ರ್ಯಾಕ್ ಮಾಡಲು X-Request-Id ಅನ್ನು ಸೇರಿಸುವುದು ಉತ್ತಮ.
| ಹೆಡರ್ | ಬಳಕೆ | ಬಿಡಿಸಿದರೆ |
|---|---|---|
| X-Request-Id | ವಿನಂತಿ ಟ್ರ್ಯಾಕಿಂಗ್ಗಾಗಿ ಗುರುತಿಸುವಿಕೆ. Anthropic ಹೊಂದಾಣಿಕೆಯ ಪ್ರತಿಕ್ರಿಯೆಗಳಲ್ಲಿ request-id ಹೆಡರ್ ಆಗಿ ಹಿಂತಿರುಗುತ್ತದೆ. | ಸರ್ವರ್ ನೀಡುತ್ತದೆ. |
| X-Region-Code | ಕರೆ ಮಾಡುವ ಪ್ರದೇಶ | global ಆಗಿರುತ್ತದೆ. |
| X-Product-Sku (ಕ್ವೆರಿಯ product_sku ಆಗಿಯೂ ಬಳಸಬಹುದು) | ಬಿಲ್ಲಿಂಗ್ಗಾಗಿ ಬಳಸುವ Product SKU ಅನ್ನು ನೇರವಾಗಿ ನಿರ್ದಿಷ್ಟಪಡಿಸುತ್ತದೆ. ಹೆಡರ್ ಕ್ವೆರಿಗಿಂತ ಆದ್ಯತೆಯನ್ನು ಹೊಂದಿದ್ದು, ಇದನ್ನು ಮುಖ್ಯವಾಗಿ ಧ್ವನಿ·ವಾಯ್ಸ್ ಮಾರ್ಗಗಳಲ್ಲಿ ಬಳಸಲಾಗುತ್ತದೆ. | ವಾಯ್ಸ್ ಮಾರ್ಗಗಳಲ್ಲಿ ಅಗತ್ಯವಿದೆ. audio/speech ಮತ್ತು audio/transcriptions ಗಳು ವಿನಂತಿಯ body ಯಲ್ಲಿರುವ model ಮೂಲಕ Product ಅನ್ನು ಆಯ್ಕೆ ಮಾಡುತ್ತವೆ. |
| anthropic-version / anthropic-beta | Anthropic ಹೊಂದಾಣಿಕೆಯ ಮಾರ್ಗದಲ್ಲಿ ಹಾಗೆಯೇ ಫಾರ್ವರ್ಡ್ ಮಾಡಲಾಗುತ್ತದೆ. | ಆವೃತ್ತಿ 2023-06-01 ಆಗಿದೆ. |
ದೃಢೀಕರಣ ವಿಫಲವಾಗಿದೆ
ಕೀ ಇಲ್ಲದಿದ್ದರೆ ಅಥವಾ ಅವಧಿ ಮುಗಿದ·ರದ್ದಾದ ಕೀಯನ್ನು ಕಳುಹಿಸಿದರೆ 401 ಬರುತ್ತದೆ. OpenAI ಹೊಂದಾಣಿಕೆಯ ಮಾರ್ಗದಲ್ಲಿ ಕೀ ಇಲ್ಲದೆ ಕರೆ ಮಾಡಿದಾಗ ಕೆಳಗಿನ body ಬರುತ್ತದೆ, ಮತ್ತು Anthropic ಹೊಂದಾಣಿಕೆಯ ಮಾರ್ಗದ error.type authentication_error ಆಗಿರುತ್ತದೆ.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}- API ಕೀ ಪರದೆಯಲ್ಲಿ ಕೀಯ ಸ್ಥಿತಿಯನ್ನು ಪರಿಶೀಲಿಸಿ. ಅವಧಿ ಮುಗಿದ ಅಥವಾ ರದ್ದಾದ ಕೀಯಾಗಿದ್ದರೆ ಹೊಸದನ್ನು ರಚಿಸಿ.
- ಹೆಡರ್ ಹೆಸರು X-API-Key ಅಥವಾ Authorization ಆಗಿದೆಯೇ ಎಂದು ಪರಿಶೀಲಿಸಿ.
- OpenAI ಹೊಂದಾಣಿಕೆಯ ಮಾರ್ಗದಲ್ಲಿ Authorization ಬಳಸುತ್ತಿದ್ದರೆ Bearer ಪೂರ್ವಪ್ರತ್ಯಯವನ್ನು ಪರಿಶೀಲಿಸಿ.
