Logo
  • خانه
  • مستندات
  • بلاگ
  • تعرفه ها
  • ورود
Logo

راهنمای استفاده از API هوش سرویس

به مستندات هوش سرویس خوش آمدید! این راهنما به شما نشان می‌دهد که چگونه می‌توانید از قدرت هوش مصنوعی در پروژه‌ها و گردش‌های کاری خود استفاده کنید. خبر خوب این است که برای استفاده از هوش سرویس، نیازی به دانش برنامه‌نویسی ندارید. شما می‌توانید به سادگی و از طریق ابزارهای اتوماسیون مانند n8n، سرویس ما را به پلتفرم‌های مختلف متصل کنید.

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

اتصال به n8n: راهکار هوشمند بدون نیاز به کدنویسی

n8n یک ابزار قدرتمند و متن‌باز برای اتوماسیون گردش کار (Workflow Automation) است. با اتصال "هوش سرویس" به n8n، شما می‌توانید قابلیت‌های هوش مصنوعی را به صورت مستقیم و بدون نوشتن حتی یک خط کد، وارد گردش‌های کاری خود کنید.

چرا از n8n استفاده کنیم؟
  • تولید خودکار محتوا: برای وبلاگ، شبکه‌های اجتماعی یا توضیحات محصول.
  • خلاصه‌سازی هوشمند: خلاصه‌سازی مقالات از فیدهای RSS و ارسال آن‌ها به تلگرام یا ایمیل.
  • پاسخ‌های خودکار: ساخت پاسخ‌های هوشمند برای ایمیل‌ها، تیکت‌های پشتیبانی و موارد دیگر.
  • پردازش داده: تحلیل نظرات کاربران، دسته‌بندی داده‌ها و استخراج اطلاعات کلیدی از متون.

از آنجایی که "هوش سرویس" یک نقطه پایانی سازگار با OpenAI ارائه می‌دهد ، شما می‌توانید به سادگی از نود رسمی OpenAI در n8n استفاده کنید. این روش بسیار ساده‌تر و کارآمدتر از استفاده از نود عمومی HTTP Request است.

راهنمای گام به گام اتصال
  1. یک گردش کار جدید در n8n بسازید و نود OpenAI را از لیست نودها پیدا کرده و به آن اضافه کنید.
  2. در بخش "Authentication"، گزینه `API Key` را انتخاب کنید.
  3. در قسمت "Credentials"، روی "Create New" کلیک کنید تا یک حساب کاربری جدید برای اتصال به هوش سرویس بسازید.
  4. در پنجره باز شده برای ساخت حساب کاربری جدید:
    • Name: یک نام دلخواه وارد کنید (مثلاً Hoosh Service API).
    • API Key: کلید API اختصاصی که از پنل کاربری "هوش سرویس" دریافت کرده‌اید را در این قسمت وارد کنید.
    • گزینه "Use Custom Base URL" را حتماً فعال کنید. این مهم‌ترین بخش تنظیمات است.
    • Base URL: آدرس https://HOOSHSERVICE-API-URL/v1 را در این فیلد وارد کنید (آدرس پایه API خود را جایگزین `HOOSHSERVICE-API-URL` کنید).
  5. حساب کاربری را ذخیره کنید (Save).
  6. اکنون به تنظیمات اصلی نود OpenAI برگردید:
    • Resource: گزینه Chat را انتخاب کنید.
    • Operation: گزینه Create را انتخاب کنید.
    • Model: مدل مورد نظر خود را از لیست انتخاب کنید (مثلاً gpt-4 یا هر مدل دیگری که در سرویس شما فعال است).
    • Messages: پیام یا prompt خود را در این بخش وارد کنید. می‌توانید از Expressionهای n8n برای استفاده از داده‌های نودهای قبلی بهره ببرید. برای مثال، می‌توانید محتوای یک ایمیل یا یک آیتم RSS را به عنوان ورودی به این بخش بدهید.
  7. گردش کار خود را اجرا کنید و از نتیجه لذت ببرید!

راهنمای توسعه‌دهندگان

این بخش برای توسعه‌دهندگانی تهیه شده است که می‌خواهند API هوش سرویس را مستقیماً در برنامه‌ها و سرویس‌های خود فراخوانی کنند. این API از طریق متد POST داده‌ها را دریافت و خروجی را در قالب JSON ارائه می‌دهد.

احراز هویت

تمامی درخواست‌ها به API باید با استفاده از یک توکن اختصاصی (API Key) احراز هویت شوند. این توکن باید در هدر Authorization هر درخواست به صورت Bearer Token ارسال شود.

Authorization: Bearer YOUR_API_TOKEN

آدرس پایه (Base URL)

آدرس پایه برای تمام فراخوانی‌های API به شرح زیر است (این آدرس پس از ثبت‌نام در سایت به شما نمایش داده می‌شود):

https://HOOSHSERVICE-API-URL

اندپوینت‌های اصلی

POST/text

این نقطه پایانی یک متن ورودی (prompt) دریافت کرده و یک پاسخ متنی ساده تولید می‌کند.

پارامترهای بدنه درخواست (JSON)
کلید نوع توضیحات
prompt string الزامی. متن یا سوالی که می‌خواهید مدل به آن پاسخ دهد.
webhook string اختیاری. آدرس URL برای دریافت نتیجه به صورت غیرهمزمان.
requestid string اختیاری. یک شناسه یکتا برای درخواست شما که همراه با وب‌هوک استفاده می‌شود.
نمونه پاسخ موفق (کد 200)
{
  "status": "success",
  "result": "The capital of Iran is Tehran."
}
POST/html

این نقطه پایانی یک متن ورودی (prompt) دریافت کرده و یک پاسخ در قالب HTML تولید می‌کند.

پارامترهای بدنه درخواست (JSON)
کلید نوع توضیحات
prompt string الزامی. موضوعی که می‌خواهید مدل برای آن محتوای HTML تولید کند.
webhook string اختیاری. آدرس URL برای دریافت نتیجه به صورت غیرهمزمان.
requestid string اختیاری. یک شناسه یکتا برای درخواست شما که همراه با وب‌هوک استفاده می‌شود.
نمونه پاسخ موفق (کد 200)
{
  "status": "success",
  "result": "<ul>\\n  <li>Increased energy</li>\\n  <li>Improved mood</li>\\n  <li>Reduced risk of chronic diseases</li>\\n</ul>"
}
POST/image

این نقطه پایانی یک متن ورودی (prompt) برای توصیف یک تصویر دریافت کرده و پاسخی مرتبط با تصویر تولید می‌کند (مثلاً URL تصویر).

پارامترهای بدنه درخواست (JSON)
کلید نوع توضیحات
prompt string الزامی. توصیف کاملی از تصویری که می‌خواهید ساخته شود.
webhook string اختیاری. آدرس URL برای دریافت نتیجه به صورت غیرهمزمان.
requestid string اختیاری. یک شناسه یکتا برای درخواست شما که همراه با وب‌هوک استفاده می‌شود.
نمونه پاسخ موفق (کد 200)
{
  "status": "success",
  "result": "https://example.com/path/to/generated/image.jpg"
}

نمونه‌های کد

در این بخش، نمونه کدهایی برای فراخوانی API در زبان‌های برنامه‌نویسی مختلف ارائه شده است.

<?php
function callHooshService($token, $query, $action = "text")
{
    $url = 'https://HOOSHSERVICE-API-URL/' . $action;
    $postData = ['prompt' => $query];
    $jsonData = json_encode($postData);
    $headers = [
        'Authorization: Bearer ' . $token,
        'Content-Type: application/json',
        'Content-Length: ' . strlen($jsonData),
    ];
    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonData);
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_TIMEOUT, 300);
    $response = curl_exec($ch);
    curl_close($ch);
    return $response;
}
// --- Example Usage ---
$api_token = "YOUR_API_TOKEN";
$user_query = "Tell me five interesting facts about the Milky Way galaxy.";
$result_json = callHooshService($api_token, $user_query, "text");
$result_data = json_decode($result_json, true);
if (isset($result_data['status']) && $result_data['status'] === 'success') {
    echo "AI Response: " . $result_data['result'];
} else {
    echo "API Error: " . ($result_data['message'] ?? 'Unknown error');
}
?>
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Text.Json;
using System.Threading.Tasks;

public class HooshServiceClient
{
    private readonly HttpClient _httpClient;
    private const string ApiBaseUrl = "https://HOOSHSERVICE-API-URL/";
    public HooshServiceClient(string apiToken)
    {
        _httpClient = new HttpClient();
        _httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", apiToken);
    }
    public async Task<string> GetTextResponseAsync(string prompt)
    {
        var requestData = new { prompt };
        var jsonContent = new StringContent(JsonSerializer.Serialize(requestData), Encoding.UTF8, "application/json");
        HttpResponseMessage response = await _httpClient.PostAsync(ApiBaseUrl + "text", jsonContent);
        response.EnsureSuccessStatusCode();
        return await response.Content.ReadAsStringAsync();
    }
}
// --- Example Usage ---
public class Program
{
    public static async Task Main(string[] args)
    {
        var apiToken = "YOUR_API_TOKEN";
        var client = new HooshServiceClient(apiToken);
        string prompt = "Name three European capitals.";
        string jsonResponse = await client.GetTextResponseAsync(prompt);
        Console.WriteLine(jsonResponse);
    }
}
import requests
import json
def call_hoosh_service(token, query, action="text"):
    api_url = f"https://HOOSHSERVICE-API-URL/{action}"
    headers = {
        "Authorization": f"Bearer {token}",
        "Content-Type": "application/json"
    }
    payload = {"prompt": query}
    try:
        response = requests.post(api_url, headers=headers, json=payload, timeout=300)
        response.raise_for_status()
        return response.json()
    except requests.exceptions.RequestException as e:
        return {"status": "error", "message": str(e)}
# --- Example Usage ---
api_token = "YOUR_API_TOKEN"
user_query = "How can I become a better programmer?"
result = call_hoosh_service(api_token, user_query, "text")
if result.get("status") == "success":
    print(f"AI Response: {result.get('result')}")
else:
    print(f"API Error: {result.get('message', 'Unknown error')}")
async function callHooshService(token, query, action = 'text') {
    const apiUrl = `https://HOOSHSERVICE-API-URL/${action}`;
    const headers = {
        'Authorization': `Bearer ${token}`,
        'Content-Type': 'application/json'
    };
    const payload = {prompt: query};
    try {
        const response = await fetch(apiUrl, {
            method: 'POST',
            headers: headers,
            body: JSON.stringify(payload)
        });
        if (!response.ok) {
            const errorData = await response.json().catch(() => ({ message: response.statusText }));
            throw new Error(`API Error: ${response.status} - ${errorData.message}`);
        }
        return await response.json();
    } catch (error) {
        console.error('Request Failed:', error);
        return { status: 'error', message: error.message };
    }
}
// --- Example Usage ---
const apiToken = 'YOUR_API_TOKEN';
const userQuery = 'What is the difference between UI and UX?';
(async () => {
    const result = await callHooshService(apiToken, userQuery, 'text');
    if (result && result.status === 'success') {
        console.log('AI Response:', result.result);
    } else {
        console.error('Failed to get response:', result.message);
    }
})();

محصولات دیگر

سرزمین گرافیک
رومینو:سامانه برگزاری وبینار و کلاس آنلاین
واپیا:ربات ارسال انبوه واتساپ
سیم وب:سایت ساز آنلاین
easyfollower:افزایش فالوور واقعی اینستاگرام
سیمینCrm:سامانه مدیریت ارتباط با مشتری

هوش سرویس ؛ ارائه خدمات هوش مصنوعی

  • ما در هوش سرویس به عنوان یک ارائه‌دهنده پیشرو در خدمات API هوش مصنوعی، به شما کمک می‌کنیم تا توانایی‌های کسب‌وکار خود را با استفاده از فناوری‌های نوین به حداکثر برسانید. APIهای ما به شما این امکان را می‌دهند که به سادگی و با سرعت، قابلیت‌های هوش مصنوعی را در پروژه‌های خود پیاده‌سازی کنید

راه های ارتباطی

+(98) 917 319 8608 +(98) 921 585 585 2 +(98) 71 32 32 44 66

نیاز به راهنمایی دارید ؟

سوال خود را از پشتیبانی بپرسید

ارسال پیام

تمامی حقوق این سایت برای هوش سرویس محفوظ است