v1/files

اندپوینت فایل امکان بارگذاری و مدیریت فایل‌ها را به منظور fine-tuning کردن یک مدل به شما می‌دهد. اندازه هر فایل می‌تواند تا 25 مگابایت باشد و هر کاربر می‌تواند حداکثر ۱۰ فایل را بر روی سرور بارگذاری کند. در صورت نیاز به بارگذاری فایل‌های بیشتر می‌توانید فایل‌های قدیمی‌تر خود را حذف کنید.

آپلود فایل #

1POST https://api.gilas.io/v1/files

بارگذاری فایل با هدف استفاده برای fine-tuning کردن یک مدل.

اندپوینت Fine-tuning API تنها از فایل‌های .jsonl پشتیبانی می‌کند. ورودی این فایل‌ها باید فرمت‌های مشخصی برای آموزش مدل‌های گفتگو یا تکمیل‌ها داشته باشد. برای اطلاع بیشتر در مورد فرمت داده‌های آموزشی برای تنظیم دقیق یا fine-tuning کردن مدلها به /v1/fine_tuning/jobs مراجعه کنید.

curl

1curl https://api.gilas.io/v1/files \
2  -H "Authorization: Bearer $GILAS_API_KEY" \
3  -F purpose="fine-tune" \
4  -F file="@mydata.jsonl"

python

 1from openai import OpenAI
 2client = OpenAI(
 3    # This is the default and can be omitted
 4    api_key=os.environ.get("GILAS_API_KEY"),
 5    base_url="https://api.gilas.io/v1/"
 6)
 7
 8client.files.create(
 9  file=open("mydata.jsonl", "rb"),
10  purpose="fine-tune"
11)

خروجی:

1{
2  "id": "file-abc123",
3  "object": "file",
4  "bytes": 120000,
5  "created_at": 1677610602,
6  "filename": "mydata.jsonl",
7  "purpose": "fine-tune",
8}

بدنه درخواست (Request body) #

Required file file
فایل مورد نظر برای آپلود (نه نام فایل).

Required string purpose
رشته‌ای که هدف فایل آپلود شده را مشخص می‌کند. برای Fine-tuning از مقدار “fine-tune” استفاده کنید.

لیست فایل‌ها #

1GET https://api.gilas.io/v1/files

لیستی از فایل‌هایی که به کاربر تعلق دارند را برمی‌گرداند.

curl

1curl https://api.gilas.io/v1/files \
2  -H "Authorization: Bearer $GILAS_API_KEY"

python

1from openai import OpenAI
2client = OpenAI(
3    # This is the default and can be omitted
4    api_key=os.environ.get("GILAS_API_KEY"),
5    base_url="https://api.gilas.io/v1/"
6)
7
8client.files.list()

خروجی

 1{
 2  "data": [
 3    {
 4      "id": "file-abc123",
 5      "object": "file",
 6      "bytes": 175,
 7      "created_at": 1613677385,
 8      "filename": "my_dataset.jsonl",
 9      "purpose": "fine-tuning",
10    },
11    { ... }
12  ],
13  "object": "list"
14}

دریافت اطلاعات فایل #

1GET https://api.gilas.io/v1/files/{file_id}

اطلاعاتی در مورد فایل مشخص شده را برمی‌گرداند.

curl

1curl https://api.gilas.io/v1/files/file-abc123 \
2  -H "Authorization: Bearer $GILAS_API_KEY"

python

1from openai import OpenAI
2client = OpenAI(
3    # This is the default and can be omitted
4    api_key=os.environ.get("GILAS_API_KEY"),
5    base_url="https://api.gilas.io/v1/"
6)
7
8client.files.retrieve("file-abc123")

خروجی

1{
2  "id": "file-abc123",
3  "object": "file",
4  "bytes": 120000,
5  "created_at": 1677610602,
6  "filename": "mydata.jsonl",
7  "purpose": "fine-tune",
8}

پارامترهای مسیر (Path parameters) #

Required string file_id
شناسه فایل که برای این درخواست مورد استفاده قرار می‌گیرد (الزامی).

حذف فایل #

1DELETE https://api.gilas.io/v1/files/{file_id}

فایلی را حذف کنید.

curl

1curl https://api.gilas.io/v1/files/file-abc123 \
2  -X DELETE \
3  -H "Authorization: Bearer $GILAS_API_KEY"

python

1from openai import OpenAI
2client = OpenAI(
3    # This is the default and can be omitted
4    api_key=os.environ.get("GILAS_API_KEY"),
5    base_url="https://api.gilas.io/v1/"
6)
7
8client.files.delete("file-abc123")

خروجی

1{
2  "id": "file-abc123",
3  "object": "file",
4  "deleted": true
5}

پارامترهای مسیر (Path parameters) #

Required string file_id
شناسه فایل که برای این درخواست مورد استفاده قرار می‌گیرد (الزامی).

دریافت محتوای فایل #

1GET https://api.gilas.io/v1/files/{file_id}/content

محتوای فایل مشخص شده را برمی‌گرداند.

curl

1curl https://api.gilas.io/v1/files/file-abc123/content \
2  -H "Authorization: Bearer $GILAS_API_KEY" > file.jsonl

python

1from openai import OpenAI
2client = OpenAI(
3    # This is the default and can be omitted
4    api_key=os.environ.get("GILAS_API_KEY"),
5    base_url="https://api.gilas.io/v1/"
6)
7
8content = client.files.content("file-abc123")

پارامترهای مسیر (Path parameters) #

Required string file_id
شناسه فایل که برای این درخواست مورد استفاده قرار می‌گیرد (الزامی).

توجه
در نظر داشته باشید که Gilas APIs از لحاظ فنی و نحوه کارکرد و قابلیت‌ها کاملا شبیه OpenAI APIs هستند. به همین منظور پیشنهاد میکنیم که برای آگاهی از نحوه‌ی کارکرد API ها به مستندات OpenAI API Reference ارجاع کنید.