Keural API

Keural இல் பதிவு செய்யப்பட்ட மாதிரிகளை OpenAI Chat Completions வடிவில் அழையுங்கள்.

Base URL இன் வடிவம் https://<சூழலுக்கான பொது API டொமைன்>/llm/v1. பொது API டொமைன் சூழலுக்கு ஏற்ப வேறுபடும், எனவே நிர்வாகியிடம் சரிபார்க்கவும்.

Embedding, படம் உருவாக்கம், குரல், Responses API பாதைகள் ஆதரிக்கப்படாது; இவற்றுக்கு அனுப்பினால் 404 திருப்பி அனுப்பப்படும்.

பயன்பாட்டு வரிசைஇணைப்பை நகலெடு

தொடங்குவதற்கு முன்இணைப்பை நகலெடு

API விசையை வழங்குதல்இணைப்பை நகலெடு

1. கணக்கு மெனுவில் அமைப்புகள் → API ஐத் திறக்கவும். டெஸ்க்டாப் மற்றும் மொபைல் செயலிகளில் இது கருவிகள் பிரிவில் இருக்கும்.
2. API keys தாவலில், விசைக்குரிய பணியிடத்தை (தனிப்பட்ட அல்லது நிறுவனம்) மற்றும் Model ID ஐத் தேர்ந்தெடுக்கவும்.
3. தேவைப்பட்டால் புதிய விசையின் காலாவதி தேதி ஐக் குறிப்பிடவும். காலியாக விட்டால், திரும்பப் பெறும் வரை விசை செல்லுபடியாகும்.
4. Issue key ஐ அழுத்தி Copy key மூலம் விசையை நகலெடுத்து பாதுகாப்பான இடத்தில் சேமிக்கவும். விசையின் முழு உள்ளடக்கம் இந்தக் கட்டத்தில் ஒருமுறை மட்டுமே காட்டப்படும்; திரையை மூடிய பின் மீண்டும் பார்க்க முடியாது.

• விசை தேர்ந்தெடுத்த பணியிடம் மற்றும் ஒரு மாதிரி ஆகியவற்றுடன் இணைக்கப்படும். பயன்பாடு விசையை வழங்கியவருக்குக் கணக்கிடப்படும்.
• ஒரு பணியிடம் மற்றும் மாதிரி இணைக்கு ஒரு விசை மட்டுமே இருக்கலாம். புதிய விசை வேண்டுமெனில், இருக்கும் விசையை மீண்டும் வழங்கவும் அல்லது திரும்பப் பெறவும்.
• விசையை மீண்டும் வழங்கினால், பழைய விசை உடனடியாகப் பயன்படுத்த முடியாததாகிவிடும்.
• வழங்கக்கூடிய மாதிரி எதுவும் இல்லை என்ற செய்தி வந்தால், மாதிரி காட்சி அமைப்புகள், திட்டம் மற்றும் நிறுவன API அனுமதியை நிர்வாகியிடம் சரிபார்க்கவும்.

நிறுவன உறுப்பினரின் API அனுமதிஇணைப்பை நகலெடு

நிறுவன உரிமையாளர் மற்றும் நிர்வாகிகளுக்கு மட்டுமே இது. நிறுவனப் பணியிடத்தில் உறுப்பினர் விசையைப் பெற வேண்டுமெனில் நிர்வாகி முதலில் அனுமதிக்க வேண்டும். அனைத்து உறுப்பினர்களுக்கும் இயல்புநிலை தடை.

நிறுவன நிர்வாகம் → Organization API பின்வரும் மூன்று பகுதிகளைக் கொண்டுள்ளது. இந்த மெனு இல்லையெனில், API அம்சம் முடக்கப்பட்டுள்ளது அல்லது உங்கள் கணக்கில் நிறுவன நிர்வாக அனுமதி இல்லை.

உறுப்பினர் நிறுவனத்திலிருந்து விலகினாலோ நீக்கப்பட்டாலோ, நிறுவனத்தின் மூலம் அவர் பெற்ற விசைகள் தானாகத் திரும்பப் பெறப்படும்.

கிளையண்டுடன் இணைத்தல்இணைப்பை நகலெடு

OpenAI API உடன் இணக்கமான செயலிகளில் (அரட்டைக் கிளையண்ட், IDE நீட்சி, தானியங்கி கருவிகள் போன்றவை) கீழ்க்கண்ட மூன்று மதிப்புகளை உள்ளிடுங்கள்.

1. செயலி அமைப்புகளில் OpenAI இணக்க இணைப்பு (Connection) ஐச் சேர்க்கவும்.
2. Base URL மற்றும் API Key ஐ உள்ளிட்டுச் சேமிக்கவும்.
3. மாதிரிகள் பட்டியலில் இருந்து மாதிரியைத் தேர்ந்தெடுக்கவும். பட்டியலில் விசையுடன் இணைக்கப்பட்ட ஒரே ஒரு மாதிரி மட்டுமே இருக்கும்.
4. ஒரு சிறிய செய்தியை அனுப்பி பதிலைச் சரிபார்க்கவும்.

கோரிக்கை வடிவம் பின்வருமாறு.

முதல் கோரிக்கைஇணைப்பை நகலெடு

export KEURAL_API_KEY='வழங்கப்பட்ட_விசை'
export KEURAL_BASE_URL='https://<சூழலுக்கான_பொது_API_டொமைன்>/llm/v1'
export MODEL_ID='வழங்கல் திரையில் உள்ள மாதிரி ID'

curl "$KEURAL_BASE_URL/chat/completions" \
  -H "Authorization: Bearer $KEURAL_API_KEY" \
  -H 'Content-Type: application/json' \
  -d "{\"model\":\"$MODEL_ID\",\"messages\":[{\"role\":\"user\",\"content\":\"வணக்கம்.\"}]}"

கோரிக்கை உடலில் உள்ள model விசையுடன் இணைக்கப்பட்ட மாதிரி ID உடன் சரியாகப் பொருந்த வேண்டும். provider/மாதிரி ID போன்ற முன்னொட்டு பாதை இருந்தால், கடைசி / க்குப் பிறகு உள்ள பகுதி பொருந்துகிறதா எனப் பாருங்கள். இல்லையெனில் API 403 ஐத் திருப்பி அனுப்பும். பதிலில் உள்ள model எப்போதும் விசையின் மாதிரி ID ஐக் கொண்டிருக்கும்.

from openai import OpenAI
import os

client = OpenAI(
    api_key=os.environ["KEURAL_API_KEY"],
    base_url=os.environ["KEURAL_BASE_URL"],
)
res = client.chat.completions.create(
    model=os.environ["MODEL_ID"],
    messages=[{"role": "user", "content": "வணக்கம்."}],
)
print(res.choices[0].message.content)

ஆதரிக்கப்படும் கோரிக்கை புலங்கள்இணைப்பை நகலெடு

ஏற்கப்படும் மேல்நிலைப் புலங்கள் கீழே உள்ள 18 மட்டுமே. மற்ற புலங்களை அனுப்பினால் 400 திருப்பி அனுப்பப்படும். மதிப்பு null ஆக உள்ள விருப்பப் புலங்கள் அனுப்பப்படவில்லை எனக் கருதப்படும்.

செய்திகள்இணைப்பை நகலெடு

• tool செய்தி, முந்தைய tool_calls இல் உள்ள ஒவ்வொரு id க்கும் ஒருமுறை மட்டுமே பதிலளிக்கும்.
• படப் பகுதி (image_url) படங்களை ஏற்கும் மாதிரியின் user செய்திகளில் மட்டுமே சேர்க்கலாம். http அல்லது https முகவரி, அல்லது PNG, JPEG, GIF, WebP வடிவ base64 data URI ஐப் பயன்படுத்தவும். detail auto · low · high ஆக இருக்கலாம்.

உடல்இணைப்பை நகலெடு

உடல் விதிகளை மீறினால் 400 கிடைக்கும், param body ஆக இருக்கும்.

ஸ்ட்ரீமிங்இணைப்பை நகலெடு

கோரிக்கையில் "stream": true எனச் சேர்த்தால் SSE வழியாகப் பதில் அனுப்பப்படும். ஒவ்வொரு துண்டும் data: ... நிகழ்வாக அனுப்பப்படும்; முடிவில் data: [DONE] அனுப்பப்படும். "stream_options": {"include_usage": true} ஐச் சேர்த்தால், [DONE] க்கு முன் டோக்கன் பயன்பாட்டுத் துண்டு ஒன்று கூடுதலாக அனுப்பப்படும்.

include_usage ஐச் சேர்த்தால் ஒவ்வொரு துண்டிலும் usage: null இருக்கும்; கடைசிப் பயன்பாட்டுத் துண்டில் choices வெற்று வரிசையாக இருக்கும். ஸ்ட்ரீம் அல்லாத பதில்களில் உள்ளீடு மற்றும் வெளியீட்டு டோக்கன்கள் இரண்டும் உறுதிசெய்யப்பட்டால் மட்டுமே usage இருக்கும்.

பதிவு id வடிவம் chatcmpl-<x-request-id>. ஒவ்வொரு பதிலிலும் x-request-id தலைப்பு இருக்கும்.

ஸ்ட்ரீமிங்கின் போது பிழை ஏற்பட்டால், பிழை JSON உள்ள data: நிகழ்வு அனுப்பப்படும்; அதன் பிறகு [DONE] இல்லாமல் இணைப்பு முடியும். ஒரு துண்டு 1 MiB ஐத் தாண்டினாலோ பதில் 16 MiB ஐத் தாண்டினாலோ, ஸ்ட்ரீம் 503 உடன் முடியும்.

curl -N "$KEURAL_BASE_URL/chat/completions" \
  -H "Authorization: Bearer $KEURAL_API_KEY" \
  -H 'Content-Type: application/json' \
  -d "{\"model\":\"$MODEL_ID\",\"messages\":[{\"role\":\"user\",\"content\":\"வணக்கம்.\"}],\"stream\":true,\"stream_options\":{\"include_usage\":true}}"

பயன்பாட்டு வரம்புஇணைப்பை நகலெடு

பயனர், நிறுவனம், மாதிரி ஆகியவற்றின் அடிப்படையில் ஒரே நேரக் கோரிக்கைகளின் எண்ணிக்கை, நிமிடத்துக்கான கோரிக்கைகள் (RPM), நிமிடத்துக்கான டோக்கன்கள் (TPM) ஆகியவற்றுக்கு வரம்பு உண்டு. உண்மையான மதிப்புகள் ஒவ்வொரு சூழலுக்கும் வேறுபடும்.

நிமிடத்துக்கான டோக்கன்கள் கோரிக்கை வரும்போதே முன்கூட்டியே கழிக்கப்படும். உள்ளீடு ஆங்கில 4 எழுத்துகளுக்கு 1 டோக்கன், பிற எழுத்துகளுக்கு ஒரு எழுத்துக்கு 1 டோக்கன் எனக் கணக்கிடப்படும். ஒரு படம் 2,000 டோக்கன்களாகக் கணக்கிடப்படும். வெளியீடு max_tokens (அதிகபட்சம் 4,096) அளவுக்குக் கழிக்கப்படும், எனவே தேவையான அளவுக்கு மட்டும் வெளியீட்டு வரம்பை அமைத்தால் வரம்பில் அதிக இடம் மிஞ்சும்.

விசை நிர்வாகம்இணைப்பை நகலெடு

அமைப்புகள் → API → API keys தாவலில் விசையின் நிலையை (செல்லுபடியாகும் · காலாவதியானது · திரும்பப் பெறப்பட்டது) சரிபார்த்து, மீண்டும் வழங்கலாம் அல்லது திரும்பப் பெறலாம்.

விசை krl_llm_ இல் தொடங்கும் 51 எழுத்துச் சரம். ஒரு பணியிடத்துக்கு ஒரு விசை மட்டுமே இருக்கலாம்; ஏற்கனவே இருந்தால் புதிதாக வழங்காமல் மீண்டும் வழங்கவும். காலாவதித் தேதியை இன்றுக்குப் பிறகு மட்டுமே அமைக்க முடியும்.

பயன்பாட்டைச் சரிபார்த்தல்இணைப்பை நகலெடு

API வழியாக அனுப்பிய கோரிக்கைகளையும் டோக்கன் பயன்பாட்டையும் பின்வரும் இரண்டு இடங்களில் சரிபார்க்கலாம்.

தேடல் நிபந்தனைகள்இணைப்பை நகலெடு

நிபந்தனைகளை அமைத்து தேடு ஐ அழுத்தவும். சமீபத்திய கோரிக்கைகளைப் பார்க்க புதுப்பி ஐ அழுத்தவும்.

திரையில் காட்டப்படும் மதிப்புகள்இணைப்பை நகலெடு

• பயன்படுத்தப்பட்ட தேதி வரம்பு: உண்மையில் தேடப்பட்ட கால வரம்பு. தொடக்க·முடிவு நேரத்தைக் காலியாக விட்டாலோ 90 நாட்களைத் தாண்டினாலோ, சேவையகம் சரிசெய்த கால வரம்பு காட்டப்படும்.
• கோரிக்கை எண்ணிக்கை மற்றும் உள்ளீட்டு டோக்கன் · வெளியீட்டு டோக்கன் · மொத்த டோக்கன்: உறுதிசெய்யப்பட்ட மதிப்புகள் மட்டுமே கூட்டப்படும். உறுதிசெய்யப்படாத டோக்கன்கள் 0 ஆகக் கருதப்படாமல் உறுதிசெய்யப்படவில்லை எனக் காட்டப்படும்.
• கோரிக்கைப் பட்டியல்: ஒவ்வொரு கோரிக்கையும் கோரிக்கை நேரம், Model ID, கோரிக்கை நிலை, உள்ளீடு, வெளியீடு, மொத்த டோக்கன்களுடன் ஒரு வரியில் காட்டப்படும். ஒரு பக்கத்தில் 20 கோரிக்கைகள் தெரியும். முந்தையது · அடுத்தது மூலம் பக்கங்களை மாற்றலாம்.

வரியில் உள்ள கோரிக்கை விவரங்கள் ஐ அழுத்தினால் பின்வரும் மதிப்புகள் காட்டப்படும்.

stream_options.include_usage இல்லாமலும் ஸ்ட்ரீமிங் கோரிக்கைகளின் பயன்பாடு பதிவு செய்யப்படும். கோரிக்கை நடுவில் துண்டிக்கப்பட்டால் நிலை பகுதி உறுதி அல்லது உறுதிசெய்யப்படவில்லை ஆக இருக்கலாம்.

பிழை வடிவம்இணைப்பை நகலெடு

பிழைகள் OpenAI இணக்க வடிவத்தில் திருப்பி அனுப்பப்படும்.

{
  "error": {
    "message": "மனிதர் படிக்கக்கூடிய பிழை விளக்கம்",
    "type": "authentication_error",
    "code": "invalid_api_key",
    "param": null
  }
}

type நிலைக் குறியீட்டால் தீர்மானிக்கப்படும்; code காரணத்தை வேறுபடுத்தும்.

சிக்கல் தீர்வுஇணைப்பை நகலெடு

தீர்வு கிடைக்கவில்லை என்றால், பின்வரும் தகவல்களுடன் நிர்வாகியிடம் கேளுங்கள். விசையின் முழு உள்ளடக்கத்தையும் prompt உள்ளடக்கத்தையும் அனுப்ப வேண்டாம்.

• நிகழ்ந்த நேரம்
• பயன்படுத்திய Model ID
• கிளையண்ட் செயலியின் பெயர் மற்றும் பதிப்பு
• பதில் தலைப்பில் உள்ள x-request-id
• திரையில் தோன்றிய பிழைச் செய்தி