Ընդհանուր ակնարկ

Endpoint-ներ

Յուրաքանչյուր endpoint գտնվում է մեկ base URL-ի տակ և սպասարկվում է HTTPS-ով։

https://api.shannon-ai.com

Տեքստ ստեղծող երեք endpoint-ները հասնում են նույն մոդելներին։ Ընտրեք այն, որի ձևաչափն արդեն օգտագործում է ձեր կոդը։

Հարցման հիմունքներ

• Յուրաքանչյուր POST-ի մարմինը մեկ JSON օբյեկտ է՝ մինչև 32 MiB։
• API-ին անհայտ դաշտը սխալ չի առաջացնում և ազդեցություն չունի։ Մեկ այլ provider-ի համար գրված հարցումը ավելորդ դաշտի պատճառով չի ձախողվում։
• Հայտնի դաշտը սխալ JSON տեսակով, կամ պարտադիր դաշտի բացակայությունը ստանում է 422 պատասխան։ Վավեր JSON չհանդիսացող մարմինը ստանում է 400։
• model-ը «Մոդելներ և գներ» էջի id-ներից մեկն է։ Մեծատառերն ու փոքրատառերը նշանակություն չունեն։

Պատասխանը JSON է, կամ server-sent events-ի հոսք, երբ հարցումը սահմանում է stream-ը true։ Յուրաքանչյուր endpoint պատասխանում է իր ձևաչափով։ Յուրաքանչյուր պատասխան ունի x-request-id header։

Ինչ է անցնում հարցումը

Հարցումը ստուգվում է ֆիքսված հերթականությամբ՝ մինչև մոդելի աշխատելը։ Առաջին չանցած ստուգումը պատասխանում է, ուստի 401-ը դեռ ոչինչ չի ասում մարմնի մասին։

Սխալի կառուցվածք

Սխալը JSON օբյեկտ է error-ով, որը պարունակում է type և message։ /v1/messages-ը փաթաթում է այն այնպես, ինչպես սպասում են Anthropic SDK-ները. մնացած բոլոր ուղիները օգտագործում են OpenAI ձևը։

{
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "message": "unknown model: gpt-4o"
  }
}

• Կարդացեք type-ը և message-ը։ code-ը և param-ը առկա են միայն որոշ սխալների վրա. համարեք դրանք ընտրովի։ param-ը միշտ null է։
• Հոսքի սկսվելուց հետո կարգավիճակն արդեն 200 է։ Ձախողումն այդ դեպքում գալիս է որպես սխալի շրջանակ հոսքի ներսում։
• Սխալի յուրաքանչյուր պատասխան կրում է x-request-id header-ը։

Սխալների մշակում

Վճարում և մնացորդ

• Յուրաքանչյուր հաշիվ ունի մեկ մնացորդ, և չատն ու API-ն կիսում են այն՝ նախ այսօրվա պլանի քվոտան, ապա գնված կրեդիտը։ API-ն սեփական քվոտա չունի։
• Հարցումը վերապահում է իր ելքի բյուջեն (max_tokens, լռելյայն 4,096), ապա գանձվում է իրականում օգտագործած թոքենների համար՝ մոդելի գնով։
• Յուրաքանչյուր պատասխան իր թոքենների քանակները նշում է usage-ում։ «Բանալիներ և օգտագործում» էջը ցույց է տալիս մնացորդը և այն, թե յուրաքանչյուր հարցում ինչ է արժեցել։
• Յուրաքանչյուր հարցում սպասարկվում է հավասարապես։ Հարցումների արագության միակ սահմանաչափը flood-պաշտպանությունն է՝ 120 հարցում րոպեում մեկ հաշվի համար։ Զուգահեռ ուղարկված հարցումները սպասում են հերթում։

Սահմանաչափեր և մնացորդ Մոդելներ և գներ Բանալիներ և օգտագործում

Մոդելից կախված դաշտեր

Յուրաքանչյուր մոդել ընդունում է նույն հարցումը։ Մի քանի դաշտ ազդեցություն ունի միայն որոշ մոդելների վրա. աղյուսակը նշում է, թե որտեղ։ Endpoint-ի էջերը թվարկում են յուրաքանչյուր դաշտ։

Chat Completions

Եթե գալիս եք OpenAI SDK-ից

• Սահմանեք base URL-ը https://api.shannon-ai.com/v1, իսկ բանալին՝ ձեր Shannon բանալին։ Chat Completions և Responses կանչերն այդ դեպքում SDK-ի հետ աշխատում են այնպես, ինչպես կան։
• model-ը պետք է լինի Shannon id։ Այլ provider-ի մոդելի անունը, ինչպես gpt-4o-ն, ստանում է 400 և unknown model։
• Reasoning-ը գալիս է առանձին դաշտում՝ reasoning_content content-ի կողքին, հաղորդագրության և հոսքի delta-ների մեջ։
• Հոսքը միշտ կրում է usage իր վերջին chunk-ում՝ finish_reason-ի հետ միասին։
• Հոսքում գործիքի կանչը գալիս է մեկ chunk-ով՝ arguments-ի ամբողջական տողով։
• Պատասխանն ունի մեկ choice։
• OpenAI API-ի այն ուղիները, որոնք վերևի աղյուսակում չկան, ինչպես /v1/embeddings-ը, ստանում են 404։

Եթե գալիս եք Anthropic SDK-ից

• Սահմանեք base URL-ը https://api.shannon-ai.com՝ առանց /v1-ի, իսկ բանալին՝ ձեր Shannon բանալին։ SDK-ն ուղարկում է այն որպես x-api-key։
• model-ը պետք է լինի Shannon id։
• max_tokens-ը այս API-ում պարտադիր չէ։ Լռելյայնը 4,096 է։
• Պատասխանը պարունակում է thinking, text և tool_use տեսակի բովանդակության բլոկներ։ Առաջին բլոկը միշտ տեքստը չէ. ընտրեք բլոկները ըստ type-ի։
• stop_reason-ը end_turn է կամ tool_use։ Shannon մոդելի հոսքը կարող է ավարտվել նաև max_tokens-ով։
• anthropic-version-ը և anthropic-beta-ն ընդունվում են, ուստի SDK-ն աշխատում է առանց փոփոխության։ Հարցմանը դրանք պետք չեն։
• /v1/messages-ի սխալներն ունեն Anthropic ձևը՝ {"type": "error", "error": {…}}։

Այս ձևաչափերով խոսող ծրագրավորման գործիքները կարգավորվում են նույն կերպ՝ base URL, բանալի և Shannon id որպես մոդել։ CLI գործիքներ ծրագրավորման համար