เอกสาร

คู่มือ Token API

แนวทางตามแผนสำหรับการรับสิทธิ์ ส่งคำขอแรก และเชื่อมต่อบริการ

การเชื่อมต่อ Token API อยู่ระหว่างการเตรียมการ คู่มือนี้อธิบายขั้นตอนตามแผน ตัวอย่างโค้ดแสดงรูปแบบที่อาจใช้ได้ โดย TATC จะยืนยัน endpoint โปรโตคอล รหัสโมเดล คีย์ ข้อจำกัด และรายละเอียดการประมวลผลสำหรับบริการที่เลือกก่อนใช้งาน

1. การเข้าถึงและคีย์

ลำดับตามแผนตั้งแต่การสอบถามบริการจนถึงการรับข้อมูลเชื่อมต่อและการดูแลคีย์ API

1. หารือรูปแบบบริการ

แจ้ง TATC ถึงความสามารถของโมเดลและงานที่ต้องการ รูปแบบการใช้งานที่คาดหวัง รวมถึงข้อกำหนดด้านสถานที่ประมวลผลและการจัดการข้อมูล รูปแบบบริการที่เลือกจะกำหนดโมเดลที่เข้าถึงได้ ขอบเขตสิทธิ์ และเงื่อนไขทางการค้า

2. รับรายละเอียดการเชื่อมต่อ

เมื่อเตรียมสิทธิ์เข้าถึงตามข้อตกลงแล้ว TATC จะส่ง endpoint ที่ยืนยันแล้ว รหัสโมเดลที่ใช้ได้ ข้อมูลรับรองการเข้าถึง ข้อจำกัดที่เกี่ยวข้อง ข้อมูลการประมวลผล และช่องทางสนับสนุนผ่านวิธีที่ตกลงกัน การเปิดสิทธิ์เป็นไปตามข้อตกลงลูกค้าที่ได้รับการยืนยัน

3. ปกป้องคีย์ API

ช่องทางออกคีย์ ขอบเขต วันหมดอายุ ขั้นตอนเปลี่ยนคีย์ และอินเทอร์เฟซบัญชีที่เกี่ยวข้องจะระบุสำหรับบริการที่เลือก

เก็บคีย์ที่ได้รับในตัวแปรสภาพแวดล้อมฝั่งเซิร์ฟเวอร์หรือระบบจัดการความลับ
อย่าใส่คีย์ในโค้ดเบราว์เซอร์ แอปมือถือ ที่เก็บโค้ดสาธารณะ หรือภาพหน้าจอสำหรับขอความช่วยเหลือ
จำกัดผู้มีสิทธิ์เข้าถึง หากคีย์รั่วไหล ให้ติดต่อ TATC ผ่านช่องทางสนับสนุนที่ตกลงกันเพื่อพิจารณาเปลี่ยนคีย์

4. ก่อนส่งคำขอแรก

ยืนยัน endpoint และรหัสโมเดลตามที่ TATC ให้ไว้
ยืนยันรูปแบบคำขอ ข้อจำกัดการใช้งาน และสถานที่ประมวลผล
ให้เฉพาะแอปพลิเคชันฝั่งเซิร์ฟเวอร์ที่ส่งคำขอเข้าถึงคีย์

2. คำขอ API ครั้งแรก

ลำดับตามแผนสำหรับเชื่อมต่อแอปพลิเคชันฝั่งเซิร์ฟเวอร์หลังได้รับข้อมูลเข้าถึงจาก TATC

1. เตรียมข้อมูลเชื่อมต่อ

ใช้ endpoint คีย์ API และรหัสโมเดลที่ TATC ให้ไว้ ตั้งค่าเป็นตัวแปรสภาพแวดล้อมฝั่งเซิร์ฟเวอร์ ชื่อตัวแปรด้านล่างเป็นเพียงตัวอย่าง การส่งคีย์แบบ bearer จะใช้เมื่อรูปแบบการยืนยันตัวตนนี้ได้รับการยืนยันสำหรับบริการของคุณ

TATC_BASE_URL: URL ฐานของ API ที่ยืนยันแล้ว
TATC_API_KEY: คีย์เข้าถึงที่ได้รับ
TATC_MODEL_ID: รหัสโมเดลที่เปิดให้ใช้ตามข้อตกลง

2. ส่งคำขอทดสอบขนาดเล็ก

ตัวอย่าง cURL แสดงลำดับการทำงานตามแผน แทนค่าทุกตำแหน่งด้วยข้อมูลที่ยืนยันแล้ว เส้นทางคำขอและฟิลด์ JSON เป็นรูปแบบตัวอย่างของการเชื่อมต่อ

cURL · ตัวอย่าง

# Planned integration pattern. Use the details supplied by TATC.
export TATC_API_KEY="<issued-key>"
export TATC_BASE_URL="https://<confirmed-host>/v1"
export TATC_MODEL_ID="<confirmed-model-id>"

curl "$TATC_BASE_URL/chat/completions" \
  -H "Authorization: Bearer $TATC_API_KEY" \
  -H "Content-Type: application/json" \
  -d "$(printf '{"model":"%s","messages":[{"role":"user","content":"Hello"}]}' "$TATC_MODEL_ID")"

3. ใช้ไคลเอนต์ฝั่งเซิร์ฟเวอร์

หากบริการยืนยันว่ารองรับ OpenAI-compatible API คุณอาจกำหนดค่าไคลเอนต์ Python ด้วย URL ฐานและคีย์ตามที่ตกลง ติดตั้งและกำหนดค่าไคลเอนต์ให้ตรงกับเวอร์ชันของแอปพลิเคชัน

Python · ตัวอย่าง

# Planned OpenAI-compatible pattern, subject to interface confirmation.
import os
from openai import OpenAI

client = OpenAI(
    base_url=os.environ["TATC_BASE_URL"],
    api_key=os.environ["TATC_API_KEY"],
)
response = client.chat.completions.create(
    model=os.environ["TATC_MODEL_ID"],
    messages=[{"role": "user", "content": "Hello"}],
)
print(response.choices[0].message.content)

4. ตรวจสอบผลตอบกลับ

การสตรีม การเรียกใช้เครื่องมือ อินพุตภาพ และรูปแบบขั้นสูงอื่นขึ้นอยู่กับโมเดลและอินเทอร์เฟซที่ยืนยันแล้ว ค่อยเพิ่มหลังคำขอพื้นฐานทำงาน

ตรวจสอบผล HTTP และเนื้อหาที่ส่งกลับกับเอกสารอินเทอร์เฟซฉบับยืนยัน
บันทึกรหัสคำขอหากบริการมีให้เพื่อใช้แก้ปัญหา
ตรวจสอบบันทึกการใช้งานและหน่วยเรียกเก็บเงินกับเงื่อนไขบริการ

3. การเชื่อมต่อและแก้ปัญหา

แนวทางดูแลคีย์ การลองใหม่ การตรวจสอบการใช้งาน และข้อมูลสำหรับติดต่อฝ่ายสนับสนุน

การยืนยันตัวตนและการเปลี่ยนคีย์

ใช้ข้อมูลรับรองจากระบบฝั่งเซิร์ฟเวอร์ที่เชื่อถือได้เท่านั้น บันทึกว่าแอปพลิเคชันใดใช้คีย์แต่ละชุด เมื่อสิทธิ์เปลี่ยนหรือสงสัยว่าคีย์รั่วไหล ให้ติดต่อ TATC ผ่านช่องทางที่ตกลงกันเพื่อเปลี่ยนคีย์และเลิกใช้คีย์เดิมตามขั้นตอนที่ได้รับ

การจัดการคำขอที่ผิดพลาด

นี่เป็นรูปแบบการเชื่อมต่อทั่วไป รหัสสถานะ เนื้อหาข้อผิดพลาด และเวลาลองใหม่สำหรับบริการจะกำหนดในเอกสารทางเทคนิคฉบับสุดท้าย

หากได้รับผลตอบกลับเกี่ยวกับการยืนยันตัวตนหรือสิทธิ์ ให้ตรวจสอบคีย์ endpoint และสิทธิ์โมเดลก่อนลองใหม่
หากได้รับผลตอบกลับเกี่ยวกับข้อจำกัด ให้ทำตามแนวทางลองใหม่ที่ตกลงกันและหลีกเลี่ยงการส่งซ้ำอย่างถี่
เมื่อเกิดข้อผิดพลาดชั่วคราว ให้เก็บเวลา รหัสคำขอหากมี และสรุปคำขอที่ลบข้อมูลอ่อนไหวแล้วสำหรับฝ่ายสนับสนุน

การใช้งานและการจัดการข้อมูล

ตกลงวิธีวัดและรายงานการใช้งานก่อนใช้จริง สถานที่ประมวลผล การเก็บข้อมูล และการเกี่ยวข้องของผู้ให้บริการโมเดลต้นทางขึ้นอยู่กับโมเดลและข้อตกลงที่เลือก หลีกเลี่ยงการส่งข้อมูลที่ยังไม่ได้รับอนุมัติให้ประมวลผลภายใต้รูปแบบบริการนั้น

เมื่อติดต่อฝ่ายสนับสนุน

ระบุบริการ รหัสโมเดล เวลาโดยประมาณ และรหัสคำขอหากมี
อธิบายสถานะที่พบและปัญหาเกิดซ้ำได้หรือไม่
ลบคีย์ API ข้อมูลส่วนบุคคล และ prompt ที่เป็นความลับออกจากภาพหน้าจอหรือบันทึกก่อนส่ง

ติดต่อ TATC