Developer guide
API ಕೀ ಮೂಲಕ ದೃಢೀಕರಿಸುವುದು
API ಕೀ ಸೇರಿಸುವ ಹೆಡರ್ ಮತ್ತು SDK ನಲ್ಲಿ ಹೊಂದಿಸಬೇಕಾದ base URL
CLEVI ಗೇಟ್‌ವೇ OpenAI ಹೊಂದಾಣಿಕೆಯ ಮಾರ್ಗ ಮತ್ತು Anthropic ಹೊಂದಾಣಿಕೆಯ ಮಾರ್ಗವನ್ನು ಒಂದೇ API ಕೀ ಮೂಲಕ ದೃಢೀಕರಿಸುತ್ತದೆ.
ಕ್ಲೈಂಟ್‌ನಲ್ಲಿ ಹೊಂದಿಸಬೇಕಾದ ಮೌಲ್ಯಗಳು ಕೀ ಹೊಂದಿರುವ ದೃಢೀಕರಣ ಹೆಡರ್ ಮತ್ತು SDK ನ base URL ಎಂಬ ಎರಡು ಮಾತ್ರವಾಗಿವೆ; ಅನುಮತಿಸಲಾದ ಹೆಡರ್ ಸ್ವರೂಪ ಮತ್ತು base URL ಪ್ರತಿ ಸ್ಪೆಸಿಫಿಕೇಶನ್‌ಗೆ ಭಿನ್ನವಾಗಿರುತ್ತದೆ.
ಹೊಂದಿಸುವಿಕೆಯನ್ನು ಪೂರ್ಣಗೊಳಿಸಿದ ನಂತರ ಮಾದರಿಗಳ ಪಟ್ಟಿಯನ್ನು ಪಡೆಯುವುದರಿಂದ ದೃಢೀಕರಣವಾಗಿದೆಯೇ ಎಂಬುದನ್ನು ತಕ್ಷಣ ಪರಿಶೀಲಿಸಬಹುದು.
ದೃಢೀಕರಣ ವಿಫಲವಾದರೆ 401 ಅನ್ನು, ದೃಢೀಕರಣ ಯಶಸ್ವಿಯಾದ ನಂತರ ಅನುಮತಿ ಅಥವಾ ಮಿತಿ ಷರತ್ತುಗಳನ್ನು ಪೂರೈಸದಿದ್ದರೆ 403 ಅನ್ನು ಹಿಂತಿರುಗಿಸುತ್ತದೆ.
API ಕೀಯನ್ನು ಕನ್ಸೋಲ್‌ನ API ಕೀ ಪರದೆಯಿಂದ ವಿತರಿಸಿ. ಅದೇ ಪರದೆಯಲ್ಲಿ ಕೀಯನ್ನು ರದ್ದುಗೊಳಿಸುವುದು ಮತ್ತು ಅದರ ಬಳಕೆಯ ವ್ಯಾಪ್ತಿಯನ್ನು ನಿರ್ವಹಿಸಬಹುದು.
ದೃಢೀಕರಣ ಹೆಡರ್
ಎರಡೂ ಸ್ಪೆಸಿಫಿಕೇಶನ್‌ಗಳಲ್ಲಿ ಒಂದು ವಿನಂತಿ ಹೆಡರ್‌ನಲ್ಲಿ API ಕೀಯನ್ನು ಸೇರಿಸಲಾಗುತ್ತದೆ. X-API-Key ಹೆಡರ್ ಅಥವಾ Authorization ಹೆಡರ್‌ನಲ್ಲಿ ಒಂದನ್ನು ಬಳಸಲಾಗುತ್ತದೆ; ಅನುಮತಿಸಲಾದ ಸ್ವರೂಪವು ಸ್ಪೆಸಿಫಿಕೇಶನ್‌ಗೆ ಅನುಗುಣವಾಗಿ ಭಿನ್ನವಾಗಿರುತ್ತದೆ.
| ಹೆಡರ್ | OpenAI ಹೊಂದಾಣಿಕೆ | Anthropic ಹೊಂದಾಣಿಕೆ |
|---|---|---|
| X-API-Key: <키> | ಬಳಸಬಹುದು | ಬಳಸಬಹುದು |
| Authorization: Bearer <키> | ಬಳಸಬಹುದು | ಬಳಸಬಹುದು |
| Authorization: <키> (Bearer ಇಲ್ಲದೆ) | ನಿರಾಕರಿಸಲಾಗುತ್ತದೆ | ಬಳಸಬಹುದು |
OpenAI ಹೊಂದಾಣಿಕೆಯ ಮಾರ್ಗದಲ್ಲಿ Authorization ಹೆಡರ್ ಬಳಸುವಾಗ Bearer ಪೂರ್ವಪ್ರತ್ಯಯ ಅಗತ್ಯವಿದೆ. ಪೂರ್ವಪ್ರತ್ಯಯವಿಲ್ಲದೆ ಕೀಯನ್ನು ಮಾತ್ರ ಕಳುಹಿಸಿದರೆ ಗೇಟ್‌ವೇ ವಿನಂತಿಯನ್ನು ನಿರಾಕರಿಸುತ್ತದೆ.
ಹೆಡರ್ ಹೆಸರುಗಳು ದೊಡ್ಡಕ್ಷರ ಮತ್ತು ಸಣ್ಣಕ್ಷರಗಳನ್ನು ಬೇರ್ಪಡಿಸಿ ಪರಿಗಣಿಸುವುದಿಲ್ಲವಾದ್ದರಿಂದ Anthropic SDK ಕಳುಹಿಸುವ x-api-key ಹೆಡರ್ ಕೂಡ ಹಾಗೆಯೇ ಕಾರ್ಯನಿರ್ವಹಿಸುತ್ತದೆ. ಎರಡೂ ಹೆಡರ್‌ಗಳನ್ನು ನಿರ್ದಿಷ್ಟಪಡಿಸಿದರೆ 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 ಬಳಸಿ ಪಡೆಯುತ್ತವೆ. sk-... ಸ್ಥಾನದಲ್ಲಿ API ಕೀ ಪರದೆಯಿಂದ ವಿತರಿಸಿದ ಕೀಯನ್ನು ನಮೂದಿಸಿ.
curl ಬಳಸಿ ಪಟ್ಟಿಯನ್ನು ಪಡೆಯುವಾಗ, ಎರಡೂ ಸ್ಪೆಸಿಫಿಕೇಶನ್‌ಗಳಿಗೆ /v1/models ವರೆಗಿನ ಸಂಪೂರ್ಣ ಮಾರ್ಗವನ್ನು ನಿರ್ದಿಷ್ಟಪಡಿಸಿ. ಮೊದಲ ಆಜ್ಞೆಯು OpenAI ಹೊಂದಾಣಿಕೆಯ ಮಾರ್ಗದಲ್ಲಿ X-API-Key ಹೆಡರ್ ಅನ್ನು ಬಳಸುತ್ತದೆ, ಮತ್ತು ಎರಡನೇ ಆಜ್ಞೆಯು Anthropic ಹೊಂದಾಣಿಕೆಯ ಮಾರ್ಗದಲ್ಲಿ Authorization ಹೆಡರ್ ಅನ್ನು ಬಳಸುತ್ತದೆ.
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"OpenAI SDK ನಲ್ಲಿ base_url ಗೆ /v1 ಒಳಗೊಂಡಿರುವ ವಿಳಾಸವನ್ನು ನಿರ್ದಿಷ್ಟಪಡಿಸಿ.
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)Anthropic SDK ನಲ್ಲಿ base_url ಅನ್ನು /v1 ಕ್ಕಿಂತ ಮೊದಲು ಕೊನೆಗೊಳ್ಳುವ ವಿಳಾಸವಾಗಿ ನಿರ್ದಿಷ್ಟಪಡಿಸಿ.
ಪ್ರಮಾಣೀಕರಣಕ್ಕಾಗಿ SDK ಕಳುಹಿಸುವ x-api-key ಹೆಡರ್ ಅನ್ನು ಹಾಗೆಯೇ ಬಳಸಿ.
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)ಯಾವುದೇ ಉದಾಹರಣೆಯಲ್ಲಿ ಪ್ರತಿಕ್ರಿಯೆ 200 ಆಗಿದ್ದರೆ ಪ್ರಮಾಣೀಕರಣ ಯಶಸ್ವಿಯಾಗಿದೆ ಮತ್ತು ಪ್ರತಿಕ್ರಿಯೆಯ data ಯಲ್ಲಿ ಈ ಕೀಯಿಂದ ಕರೆ ಮಾಡಬಹುದಾದ ಮಾದರಿಗಳ ಪಟ್ಟಿ ಇರುತ್ತದೆ. 401 ಆಗಿದ್ದರೆ, ಕಾರಣವನ್ನು ಮುಂದಿನ ವಿಭಾಗದಲ್ಲಿರುವ ಕ್ರಮದ ಪ್ರಕಾರ ಪರಿಶೀಲಿಸಿ.
ಪ್ರಮಾಣೀಕರಣ ವಿಫಲವಾಗಿದೆ
ಕೀ ಇಲ್ಲದಿದ್ದರೆ ಅಥವಾ ಅವಧಿ ಮೀರಿದ·ರದ್ದುಗೊಂಡ ಕೀಯನ್ನು ಕಳುಹಿಸಿದರೆ 401 ಅನ್ನು ಹಿಂತಿರುಗಿಸಲಾಗುತ್ತದೆ. OpenAI ಹೊಂದಾಣಿಕೆಯ ಮಾರ್ಗದಲ್ಲಿ ಕೀ ಇಲ್ಲದೆ ಕರೆ ಮಾಡಿದರೆ ಕೆಳಗಿನ ಬಾಡಿಯನ್ನು ಹಿಂತಿರುಗಿಸಲಾಗುತ್ತದೆ, ಮತ್ತು Anthropic ಹೊಂದಾಣಿಕೆಯ ಮಾರ್ಗದಲ್ಲಿ error.type authentication_error ಆಗಿರುತ್ತದೆ.
{
"error": {
"message": "API key is required.",
"type": "invalid_request_error"
}
}401 ಪಡೆದರೆ, ಈ ಕೆಳಗಿನ ಕ್ರಮದಲ್ಲಿ ಪರಿಶೀಲಿಸಿ.
- API ಕೀ ಪರದೆಯಲ್ಲಿ ಕೀಯ ಸ್ಥಿತಿಯನ್ನು ಪರಿಶೀಲಿಸಿ. ಅದು ಅವಧಿ ಮೀರಿದ್ದರೆ ಅಥವಾ ರದ್ದುಗೊಂಡಿದ್ದರೆ, ಹೊಸದನ್ನು ವಿತರಿಸಿ.
- ಹೆಡರ್ ಹೆಸರು X-API-Key ಅಥವಾ Authorization ಆಗಿದೆಯೇ ಎಂಬುದನ್ನು ಪರಿಶೀಲಿಸಿ.
- OpenAI ಹೊಂದಾಣಿಕೆಯ ಮಾರ್ಗದಲ್ಲಿ Authorization ಹೆಡರ್ ಬಳಸುತ್ತಿದ್ದರೆ, Bearer ಪೂರ್ವಪ್ರತ್ಯಯವಿದೆಯೇ ಎಂಬುದನ್ನು ಪರಿಶೀಲಿಸಿ.
ತಿದ್ದುಪಡಿ ಮಾಡಿದ ನಂತರ, ಪ್ರಮಾಣೀಕರಣ ಪರಿಶೀಲನೆ ವಿಭಾಗದಲ್ಲಿನ ಮಾದರಿಗಳ ಪಟ್ಟಿಯನ್ನು ಪಡೆಯುವಿಕೆಯನ್ನು ಮತ್ತೊಮ್ಮೆ ಕಾರ್ಯಗತಗೊಳಿಸಿ ಮತ್ತು 200 ಬರುತ್ತದೆಯೇ ಎಂದು ಪರಿಶೀಲಿಸಿ.
ಒಟ್ಟಿಗೆ ಬಳಸುವ ಹೆಡರ್‌ಗಳು
ಕೆಳಗಿನ ಎಲ್ಲಾ ಹೆಡರ್‌ಗಳು ಐಚ್ಛಿಕವಾಗಿವೆ. ಸಮಸ್ಯೆಗಳನ್ನು ಪತ್ತೆಹಚ್ಚಲು 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 ಆಗಿದೆ. |
5xx ಪುನರಾವರ್ತಿತವಾದರೆ, X-Request-Id ಜೊತೆಗೆ ಸಹಾಯ ಮತ್ತು ವಿಚಾರಣೆ ವಿಭಾಗದ ಮೂಲಕ ನಮಗೆ ತಿಳಿಸಿ. ನೀವು ನೇರವಾಗಿ ನಿರ್ದಿಷ್ಟಪಡಿಸಿದ ಮೌಲ್ಯವಾಗಿದ್ದರೆ, ಅದನ್ನು ಕ್ಲೈಂಟ್‌ನ ದಾಖಲೆಗಳೊಂದಿಗೆ ತಕ್ಷಣ ಹೋಲಿಸಬಹುದು.