راهنمای سریع

راهنمای سریع

این راهنمای سریع به شما کمک می‌کند تا محیط توسعه لوکال خود را راه‌اندازی کنید و اولین درخواست API خود را ارسال کنید. اگر توسعه‌دهنده با تجربه‌ای هستید یا می‌خواهید فوراً از Gilas API استفاده کنید، راهنمای APIs را برای شروع مطالعه کنید. این راهنمای سریع به شما کمک می‌کند تا بتوانید:

  • محیط توسعه خود را راه‌اندازی کنید
  • برخی از مفاهیم اساسی Gilas API را یاد بگیرید
  • اولین درخواست API خود را ارسال کنید

اگر با چالشی روبرو شدید یا سوالی در مورد نحوه کار با Gilas API دارید، می‌توانید با پشتیبان تلگرامی ما تماس بگیرید.

ساخت حساب کاربری #

ابتدا، یک حساب کاربری جدید ایجاد کنید یا اگر صاحب حساب کاربری هستید وارد پنل کاربری خود شوید. سپس، به صفحه کلید API بروید و با کلیک روی دکمه “ساخت کلید API” یک کلید جدید برای دسترسی به Gilas API بسازید. مطمئن شوید که این کلید را در جای امنی ذخیره کرده و آن را با کسی به اشتراک نگذارید.

ارسال درخواست #

ابتدا کلید API ساخته شده را به محیط ترمینال یا محیط اجرای کد اضافه کنید.

1# MacOS | Linux
2export GILAS_API_KEY='your-api-key-here'
3# Windows
4setx GILAS_API_KEY "your-api-key-here"

حالا با استفاده از نمونه کدهای زیر اولین درخواست Chat Completions را ارسال کنید. چون کلید API در مرحله قبل تنظیم شده است، باید به صورت خودکار از طریق $GILAS_API_KEY به برنامه ارجاع داده شود. در غیر اینصورت می‌توانید به صورت دستی $GILAS_API_KEY را با کلید API خود جایگزین کنید.

 1curl https://api.gilas.io/v1/chat/completions  \
 2-H "Content-Type: application/json" \
 3-H "Authorization: Bearer $GILAS_API_KEY" \
 4-d '{
 5    "model": "gpt-3.5-turbo",
 6    "messages": [
 7      {
 8        "role": "system",
 9        "content": "You are an intelligent software developer. Please answer my questions."
10      },
11      {
12        "role": "user",
13        "content": "How to write a simple HTTP call via curl on the command line?"
14      }
15    ]
16  }'
 1package main
 2
 3import (
 4	"bytes"
 5	"encoding/json"
 6	"fmt"
 7	"io/ioutil"
 8	"net/http"
 9	"os"
10)
11
12func main() {
13	url := "https://api.gilas.io/v1/chat/completions"
14	payload := map[string]interface{}{
15		"model": "gpt-3.5-turbo",
16		"messages": []map[string]string{
17			{"role": "system", "content": "You are an intelligent software developer. Please answer my questions."},
18			{"role": "user", "content": "How to write a simple HTTP call via curl on the command line?"},
19		},
20	}
21
22	jsonPayload, _ := json.Marshal(payload)
23	req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonPayload))
24	req.Header.Set("Content-Type", "application/json")
25	req.Header.Set("Authorization", "Bearer "+os.Getenv("GILAS_API_KEY"))
26
27	client := &http.Client{}
28	resp, _ := client.Do(req)
29	defer resp.Body.Close()
30
31	body, _ := ioutil.ReadAll(resp.Body)
32	fmt.Println(string(body))
33}
 1const axios = require('axios');
 2
 3async function makeRequest() {
 4    const url = 'https://api.gilas.io/v1/chat/completions';
 5    const payload = {
 6        model: 'gpt-3.5-turbo',
 7        messages: [
 8            {
 9                role: 'system',
10                content: 'You are an intelligent software developer. Please answer my questions.'
11            },
12            {
13                role: 'user',
14                content: 'How to write a simple HTTP call via curl on the command line?'
15            }
16        ]
17    };
18
19    try {
20        const response = await axios.post(url, payload, {
21            headers: {
22                'Content-Type': 'application/json',
23                'Authorization': `Bearer ${process.env.GILAS_API_KEY}`
24            }
25        });
26        console.log(response.data);
27    } catch (error) {
28        console.error('Error making the request:', error);
29    }
30}
31
32makeRequest();
 1import requests
 2import os
 3
 4def make_request():
 5    url = 'https://api.gilas.io/v1/chat/completions'
 6    headers = {
 7        'Content-Type': 'application/json',
 8        'Authorization': f'Bearer {os.getenv("GILAS_API_KEY")}'
 9    }
10    payload = {
11        'model': 'gpt-3.5-turbo',
12        'messages': [
13            {'role': 'system', 'content': 'You are an intelligent software developer. Please answer my questions.'},
14            {'role': 'user', 'content': 'How to write a simple HTTP call via curl on the command line?'}
15        ]
16    }
17
18    response = requests.post(url, json=payload, headers=headers)
19    return response.json()
20
21if __name__ == "__main__":
22    result = make_request()
23    print(result)

استفاده از کتابخانه‌های OpenAI #

در صورتی که با کتابخانه‌های OpenAI در زبان‌های Python و Node.js آشنایی دارید می‌توانید با استفاده از این کتابخانه‌ها هم درخواست خود را به ‌GILAS API ارسال کنید.

ابتدا کلید API ساخته شده را به محیط ترمینال یا محیط اجرای کد اضافه کنید.

1# MacOS | Linux
2export GILAS_API_KEY='your-api-key-here'
3# Windows
4setx GILAS_API_KEY "your-api-key-here"

کتابخانه OpenAI را نصب کنید.

1npm install --save openai
2# or
3yarn add openai

حالا با استفاده از کتابخانه نصب شده درخواست Chat Completions خود را به Gilas ارسال کنید.

 1import OpenAI from 'openai';
 2
 3const openai = new OpenAI({
 4  apiKey: process.env['GILAS_API_KEY'],
 5  baseURL: 'https://api.gilas.io/v1/'
 6});
 7
 8async function main() {
 9  const chatCompletion = await openai.chat.completions.create({
10    messages: [{ role: 'user', content: 'Say this is a test' }],
11    model: 'gpt-3.5-turbo',
12  });
13
14  console.log(chatCompletion.choices[0]);
15}
16
17main();

کتابخانه OpenAI را نصب کنید.

1pip install --upgrade openai

حالا با استفاده از کتابخانه نصب شده درخواست Chat Completions خود را به Gilas ارسال کنید.

 1import os
 2from openai import OpenAI
 3
 4client = OpenAI(
 5    # This is the default and can be omitted
 6    api_key=os.environ.get("GILAS_API_KEY"),
 7    base_url="https://api.gilas.io/v1/"
 8)
 9
10chat_completion = client.chat.completions.create(
11    messages=[
12        {
13            "role": "user",
14            "content": "Say this is a test",
15        }
16    ],
17    model="gpt-3.5-turbo",
18)
19
20print(chat_completion.choices[0].message)