সব ভাষাতেই command ও code ইংরেজিতে থাকবে। বড় হাতের অক্ষরে লেখা placeholder নিজের account ও paid job-এর মান দিয়ে বদলান; shared notebook বা log-এ আসল key দেবেন না।
API রিসোর্সের জীবনচক্র
- কোটেশন কনফিগারেশন ও বর্তমান দাম যাচাই
- কাজ তৈরি করুন ও অনুমোদিত অর্থপ্রদান সম্পন্ন করুন
- সেশন রানটাইম ও অন্তর্ভুক্ত রেফারেন্স বাছাই
- প্রস্তুতি যাচাইকৃত ডেটাসেট বিবরণী তৈরি
- প্রতিবেদন প্রকৃত প্রশিক্ষণ ও আর্টিফ্যাক্টের মেটাডেটা নথিবদ্ধ
কোটেশন: কনফিগারেশন ও বর্তমান দাম যাচাই. কাজ: তৈরি করুন ও অনুমোদিত অর্থপ্রদান সম্পন্ন করুন. সেশন: রানটাইম ও অন্তর্ভুক্ত রেফারেন্স বাছাই. প্রস্তুতি: যাচাইকৃত ডেটাসেট বিবরণী তৈরি. প্রতিবেদন: প্রকৃত প্রশিক্ষণ ও আর্টিফ্যাক্টের মেটাডেটা নথিবদ্ধ
Authentication ও request-এর নিয়ম
HTTPS-এ Authorization: Bearer এবং ai:training-সহ account API key ব্যবহার করুন। Accept: application/json পাঠান; JSON body হলে Content-Type: application/json যোগ করুন। সব resource account-মালিকানাধীন। Route group-এ প্রতি মিনিটে 30 request-এর throttle, এবং কনফিগার করা অতিরিক্ত নিয়ন্ত্রণ আছে। উদাহরণের ID placeholder, shared resource নয়।
- Quote ID, job UUID, session ID, model ID ও artifact ID ভিন্ন identifier।
- Network বিঘ্নের পর write আবার দেওয়ার আগে বর্তমান state পড়ুন।
- API request-এ public-page ভাষা বা pricing query parameter ব্যবহার করবেন না।
export TRAINING_API='https://fusionpointai.com/api/v1/training'
# Set the key securely as shown in Quickstart.
export JOB_UUID='REPLACE_WITH_YOUR_JOB_UUID'
export SESSION_ID='REPLACE_WITH_YOUR_SESSION_ID'
curl --fail-with-body --silent --show-error "$TRAINING_API/jobs" \
-H "Authorization: Bearer $FUSIONPOINTAI_API_KEY" -H 'Accept: application/json'
Request, response ও state
যোগ্য configuration থেকে quote তৈরি করুন, quote দিয়ে native job তৈরি করুন এবং session খোলার আগে অনুমোদিত payment workflow সম্পন্ন করুন। Project endpoint বিদ্যমান paid reference access অনুমোদন করে এবং invoice তৈরি বা দাম না বদলে curriculum বা lesson চায়। Session response-এ configuration, নির্বাচিত reference, dataset manifest, জানানো step ও report থাকে। Preparation এবং reporting আলাদা request; job ও session-এর state আলাদা।
- Project authorization-এ provider ও reference_model_id লাগে; teacher request-এ action ও objective-ও লাগে।
- Teacher example শুধু অনুমোদিত training material থেকে; validation ও final-test row স্থানীয় থাকে।
- Legacy completion report প্রকৃত স্থানীয় artifact বর্ণনা করে এবং integrity ও evaluation check পাস করতে হবে।
POST /api/v1/training/quotes
reference_model_id required eligible integer model ID
training_plan_id required public provider-plan integer ID
mode automatic | advanced
objective required string, 10..4000 characters
language required string, at most 120 characters
performance_criteria required string, 10..2000 characters
student_release_slug optional eligible slug, at most 190 characters
method optional eligible method, at most 80 characters
dataset_megabytes optional integer, 1..1000000
gpu_count optional integer, 1..128
delivery optional: artifact | hosted
execution_target optional: fusionpointai_hosting | customer_datacenter | colab
Availability and approved plan policies can impose narrower constraints.
Do not submit price, fixed_total, currency, price_version_id or model_training.
{
"reference_model_id": 123,
"training_plan_id": "<INTEGER_FROM_YOUR_PROVIDER_PLAN>",
"mode": "advanced",
"objective": "Train a German support-message classifier.",
"language": "German",
"performance_criteria": "Evaluate per-class precision and recall on held-out data.",
"student_release_slug": "<ELIGIBLE_STUDENT_RELEASE_SLUG>",
"method": "LoRA",
"dataset_megabytes": 8,
"gpu_count": 1,
"delivery": "artifact"
}
# Save the body as quote.json; replace ID placeholders with integers.
# Automatic mode omits student_release_slug and method.
curl --fail-with-body --silent --show-error "$TRAINING_API/quotes" \
-H "Authorization: Bearer $FUSIONPOINTAI_API_KEY" \
-H 'Accept: application/json' -H 'Content-Type: application/json' \
--data-binary @quote.json
# Save {"quote":"YOUR_QUOTE_UUID"} as job.json.
# Creates a native job/invoice; this is not payment confirmation.
curl --fail-with-body --silent --show-error "$TRAINING_API/jobs" \
-H "Authorization: Bearer $FUSIONPOINTAI_API_KEY" \
-H 'Accept: application/json' -H 'Content-Type: application/json' \
--data-binary @job.json
curl --fail-with-body --silent --show-error "$TRAINING_API/jobs/$JOB_UUID" \
-H "Authorization: Bearer $FUSIONPOINTAI_API_KEY" -H 'Accept: application/json'
POST /api/v1/training/quotes: 201
{quote: UUID, currency: ISO_CODE, fixed_total: DECIMAL_STRING, expires_at: ISO_8601}
POST /api/v1/training/jobs: {"quote":"OWNED_QUOTE_UUID"}
201 for a newly created job; 200 when an accepted quote reuses its job.
Job fields:
id job UUID
status native job state, such as awaiting_payment
progress_percent recorded progress, not an independent quality score
invoice_id owned native invoice ID or null
created_at ISO 8601 timestamp
completed_at ISO 8601 timestamp or null
training_session null or {id, status, step, delivery, verification}
GET /api/v1/training/jobs:
{data: JOB_ARRAY, current_page: INTEGER, last_page: INTEGER, per_page: 50, total: INTEGER}
This is a response-shape reference, not a fabricated live response.
# Save as session.json, using your paid job UUID and optional reference ID:
# {"job":"YOUR_PAID_JOB_UUID","runtime":"customer_datacenter","reference_model_id":123}
curl --fail-with-body --silent --show-error "$TRAINING_API/sessions" \
-H "Authorization: Bearer $FUSIONPOINTAI_API_KEY" \
-H 'Accept: application/json' -H 'Content-Type: application/json' \
--data-binary @session.json
curl --fail-with-body --silent --show-error "$TRAINING_API/sessions/$SESSION_ID" \
-H "Authorization: Bearer $FUSIONPOINTAI_API_KEY" -H 'Accept: application/json'
# One preparation batch; inspect progress before another request.
curl --fail-with-body --silent --show-error "$TRAINING_API/sessions/$SESSION_ID/prepare" \
-H "Authorization: Bearer $FUSIONPOINTAI_API_KEY" \
-H 'Accept: application/json' -H 'Content-Type: application/json' --data '{}'
Session response fields (shape reference, not a fabricated live result):
id session UUID
job owned job UUID
status preparing | ready | running | evaluating | completed | failed | cancelled
configuration approved method, student_checkpoint, sdk_training and selected reference
reference_model_id selected integer reference ID
expires_at ISO 8601 access expiry
step last reported integer step
datasets[] {split, rows, bytes, sha256}
report current report object; event metrics live under report.last_event.metrics
delivery runtime_local
verification runtime_reported
curl --fail-with-body --silent --show-error \
"$TRAINING_API/sessions/$SESSION_ID/datasets/train" \
-H "Authorization: Bearer $FUSIONPOINTAI_API_KEY" \
-H 'Accept: application/x-ndjson' --output train.jsonl
# Use /datasets/validation for the other supported split.
sha256sum train.jsonl
# Compare bytes, rows and SHA-256 with the session manifest.
# For published server-side artifacts only, not the local SDK ZIP:
# GET /api/v1/training/jobs/{job}/artifacts/{file}
POST /api/v1/training/sessions/{session}/events
Content-Type: application/json
state required: running | evaluating | failed
step required integer: 0..2000
total_steps required integer: 1..2000
metrics optional; only loss and eval_loss, each 0..1000000
error_code optional: training_failed | evaluation_failed | runtime_unavailable |
dataset_invalid | report_failed
Send actual trainer observations, never sample or invented metrics.
# Build the body from a REAL SDK report; requires jq.
jq '{artifact_name:"model-package.zip",report:.completion_report}' \
customer-model-run-001/training-report.json > completion.json
curl --fail-with-body --silent --show-error "$TRAINING_API/sessions/$SESSION_ID/complete" \
-H "Authorization: Bearer $FUSIONPOINTAI_API_KEY" \
-H 'Accept: application/json' -H 'Content-Type: application/json' \
--data-binary @completion.json
# Cancel eligible service state, not the operating-system process:
curl --fail-with-body --silent --show-error "$TRAINING_API/sessions/$SESSION_ID/cancel" \
-H "Authorization: Bearer $FUSIONPOINTAI_API_KEY" \
-H 'Accept: application/json' -H 'Content-Type: application/json' --data '{}'
curl --fail-with-body --silent --show-error \
'https://fusionpointai.com/api/v1/training/projects/authorize' \
-H "Authorization: Bearer $FUSIONPOINTAI_API_KEY" \
-H 'Accept: application/json' -H 'Content-Type: application/json' \
--data '{"provider":"openai","reference_model_id":123}'
# The response identifies the owned paid job/grant and access expiry.
curl --fail-with-body --silent --show-error \
'https://fusionpointai.com/api/v1/training/projects/teacher' \
-H "Authorization: Bearer $FUSIONPOINTAI_API_KEY" \
-H 'Accept: application/json' -H 'Content-Type: application/json' \
--data '{"provider":"openai","reference_model_id":123,"action":"lessons","objective":"Classify support messages into agreed categories.","topic":"ambiguous_requests","count":2,"approved_examples":["A reviewed support training example."]}'
# Send only explicitly approved training examples. Never send held-out rows.
# Curriculum action returns topics; lessons action returns text/topic examples.
import os
from fusionpointai_training import TrainingClient
client = TrainingClient(api_key=os.environ["FUSIONPOINTAI_API_KEY"])
session = client.get_session(os.environ["FUSIONPOINTAI_SESSION_ID"])
print("Session:", session["id"])
print("Status:", session["status"])
print("Last reported step:", session["step"])
# Inspection is read-only; status and step are server-reported state.
import os
from fusionpointai_training import TrainingClient
client = TrainingClient(api_key=os.environ["FUSIONPOINTAI_API_KEY"])
session = client.get_session(os.environ["FUSIONPOINTAI_SESSION_ID"])
for manifest in session["datasets"]:
print(
manifest["split"],
"rows:", manifest["rows"],
"bytes:", manifest["bytes"],
"sha256:", manifest["sha256"],
)
# These are server-provided manifest values, not a local integrity pass.
import os
from fusionpointai_training import TrainingClient
client = TrainingClient(api_key=os.environ["FUSIONPOINTAI_API_KEY"])
session = client.get_session(os.environ["FUSIONPOINTAI_SESSION_ID"])
server_report = session.get("report")
runtime_report = server_report.get("runtime") if isinstance(server_report, dict) else None
if (
session.get("status") == "completed"
and isinstance(runtime_report, dict)
and runtime_report.get("artifact_sha256") == os.environ["LOCAL_ARTIFACT_SHA256"]
and server_report.get("delivery") == "runtime_local"
and server_report.get("verification") == "runtime_reported"
):
print("Server report matches the local artifact digest.")
else:
print("Completion is not confirmed for this local artifact.")
# Reconcile by reading state; do not repeat training or invent a result.
Error ও নিরাপদ integration
প্রতিটি error ক্ষণস্থায়ী ধরে না নিয়ে HTTP status ও ফেরত validation বিবরণ দেখুন। Unauthenticated request-এ 401, access অস্বীকৃত হলে 403, resource নেই বা নিজের নয় হলে 404, state অসামঞ্জস্যপূর্ণ হলে 409, input অবৈধ হলে 422 এবং throttling হলে 429 আশা করুন। Provider বা runtime ব্যর্থতায় অন্য error-ও হতে পারে। SDK কাঁচা secret-যুক্ত upstream output ফেরত না দিয়ে APIError দেয়।
- Event-এ running, evaluating অথবা failed চলে; metrics key হলো loss ও eval_loss।
- step এবং total_steps সর্বোচ্চ 2000; total_steps ধনাত্মক হতে হবে।
- সম্পূর্ণ body-তে artifact_name এবং উদাহরণে দেখানো প্রতিটি report field লাগবে।
401 Authentication missing or invalid
403 Account/key scope or access denied
404 Resource missing, non-owned or intentionally hidden
409 Invalid session transition, runtime, paid-access or model configuration
410 Writable session expired
422 Invalid request fields or completion criteria not met
429 Request rate limited
502 Upstream reference data malformed or preparation failed
Do not retry a write blindly. Read session state and inspect the response.
Keep error_code distinct from the HTTP status. Never log authorization.
POST /api/v1/training/sessions/{session}/complete
artifact_name safe filename ending in .zip, max 160 characters
report.training_steps integer 1..2000
report.weights_before_sha256 lowercase SHA-256 of actual pre-training weights
report.weights_after_sha256 lowercase SHA-256 of actual changed weights
report.artifact_sha256 lowercase SHA-256 of the real local ZIP
report.artifact_bytes integer 1..107374182400
report.eval_loss_before finite number >0 and <=1000000
report.eval_loss_after finite number >=0 and <=1000000
report.base_repository pinned student repository, max 255 characters
report.base_revision lowercase immutable 40-character revision
report.method SFT | LoRA | QLoRA
Values must match the approved session and actual local training.
Additional report keys are rejected. This body does not upload the ZIP.
import os
from fusionpointai_training import TrainingClient
from fusionpointai_training.errors import APIError
client = TrainingClient(
api_key=os.environ["FUSIONPOINTAI_API_KEY"],
timeout=30.0,
max_get_retries=2,
)
try:
session = client.get_session(os.environ["FUSIONPOINTAI_SESSION_ID"])
except APIError:
# GET retries are bounded. Do not blindly retry a write after an error.
print("Session inspection failed; check access and current server state.")
else:
print("Status:", session["status"])
# Never print the API key, authorization headers, or response secrets.
API তথ্যসূত্র
| Endpoint | উদ্দেশ্য ও আচরণ |
|---|---|
POST /api/v1/training/quotes
Authorization: Bearer ai:training |
যোগ্য reference, plan ও configuration যাচাই করে quote UUID, currency, fixed_total ও expires_at ফেরায়। Arbitrary client price নয়; approved plan ও যোগ্য student setting ব্যবহার করুন।
|
GET /api/v1/training/jobs
Authorization: Bearer ai:training |
Authenticated customer-এর job-গুলো তালিকাভুক্ত করে। Numeric identifier অনুমান না করে ফেরত collection ও resource ID দেখুন। |
POST /api/v1/training/jobs
Authorization: Bearer ai:training |
বৈধ quote UUID থেকে account-মালিকানাধীন job তৈরি করে। Response-এ job ID, status, invoice ID ও timestamp থাকে; job তৈরি হওয়া payment-এর প্রমাণ নয়। |
GET /api/v1/training/jobs/{job}
Authorization: Bearer ai:training |
Job UUID দিয়ে নিজের একটি job পড়ুন; এতে live progress ও delivery status থাকে। |
GET /api/v1/training/jobs/{job}/artifacts/{file}
Authorization: Bearer ai:training |
নিজের job-এর প্রকাশিত file ডাউনলোড করে। স্থানীয় SDK ZIP স্বয়ংক্রিয়ভাবে upload হয় না বা এই route-এ পাওয়া যায় না। |
POST /api/v1/training/sessions
Authorization: Bearer ai:training |
Body: job UUID, runtime এবং ঐচ্ছিক ধনাত্মক reference_model_id। নতুন বা পুনর্ব্যবহৃত session ফেরায়; preparation শুরু হওয়ার আগে কেবল reference বদলানো যায়।
|
GET /api/v1/training/sessions/{session}
Authorization: Bearer ai:training |
নিজের session, configuration, dataset, report ও state পড়ুন। State পড়লে training শুরু হয় না। |
POST /api/v1/training/sessions/{session}/prepare
Authorization: Bearer ai:training |
সীমিত preparation batch চাইতে খালি JSON object পাঠান। Request budget মেনে অগ্রগতি থাকলে ready না হওয়া পর্যন্ত পুনরায় দিন। |
GET /api/v1/training/sessions/{session}/datasets/{split}
Authorization: Bearer ai:training |
application/x-ndjson হিসেবে train বা validation ডাউনলোড করুন। ওই session-এর manifest-এর সঙ্গে byte, SHA-256 ও row মিলিয়ে দেখুন।
|
POST /api/v1/training/sessions/{session}/events
Authorization: Bearer ai:training |
প্রকৃত state, step, total_steps এবং ঐচ্ছিক loss/eval_loss metric জানান। শুধু সমর্থিত state ও error-code মান দিন।
|
POST /api/v1/training/sessions/{session}/complete
Authorization: Bearer ai:training |
artifact_name ও প্রকৃত training report-এর সব field জমা দিন। Service method, base revision, weight পরিবর্তন, artifact digest ও evaluation criterion যাচাই করে।
|
POST /api/v1/training/sessions/{session}/cancel
Authorization: Bearer ai:training |
যোগ্য service state বাতিল করতে খালি JSON object পাঠান। দরকার হলে আলাদা GPU process নিজে থামান; এটি pause/resume নয়। |
POST /api/v1/training/projects/authorize
Authorization: Bearer ai:training |
provider ও ধনাত্মক reference_model_id দিয়ে POST /api/v1/training/projects/authorize করুন। Authenticated account-এর paid training reference access আবার যাচাই করে নিজের job, grant, provider, reference model ও মেয়াদ ফেরায়। Invoice তৈরি বা payment বদলায় না।
|
POST /api/v1/training/projects/teacher
Authorization: Bearer ai:training |
provider, reference_model_id, action (curriculum অথবা lessons), objective, ঐচ্ছিক topic, count (১–৪) এবং সর্বোচ্চ আটটি approved_examples (প্রতিটি সর্বোচ্চ ২,০০০ অক্ষর) দিয়ে POST /api/v1/training/projects/teacher করুন। Topic অথবা lesson text/topic row ফেরত দেয়। শুধু অনুমোদিত training material পাঠান; validation বা final-test data নয়।
|