مستندات اتصال به API

لیست Endpoint ها

در این صفحه مشخصات API دسته‌گر واکاویک، Endpoint ها و نحوه اتصال به آنها تششریح شده است. در حال حاضر سه Endpoint ارائه شده است:

  • Classify یک متن دریافت می‌کند و بهترین برچسب را به همراه احتمال صحت آن برمیگرداند
  • getClassifications یک متن دریافت می کند و همه برچسب‌ها را به ترتیب احتمال صحت برمیگرداند
  • batchClassifications چند متن(تا ۱۰۰ عدد) دریافت می‌کند و برای هرکدام، همه برچسب‌ها را به ترتیب احتمال صحت آنها برمیگرداند



Classify

Descriptionاین Endpoint یک متن و کد یکتای ماژول را دریافت می کند و در خروجی برچسبی که بیشترین احتمال را دارد به همراه احتمال آن ارسال می کند.
URLhttps://api.vakavic.com/classifier/classify
MethodPOST
Content-Typeapplication/json
Authorization
  • در هر درخواستی که به API ارسال می شود، هدر Authorization باید به شکل زیر ارسال شود:
  • Authorization: Bearer YOUR_API_TOKEN
  • API Token: کلید دسترسی به API است که پس از ثبت نام در وبسایت از صفحه تنظیمات حساب کاربری قابل دسترسی است.
  • Data Params
    {
        referenceKey: [String],
        text: [String]
    }
  • referenceKey: کد یکتای ماژول مورد نظر است که از صفحه ماژول در تب تنظیمات صفحه هر ماژول قابل دسترسی است
  • text: متن مورد نظر برای دسته بندی
  • Success Response
    {
        Success: [boolean],
        remaningAPICalls: [Number],
        label: [String],
        probability: [Number]
    }                          
  • Success: مشخص می کند که پردازش با موفقیت انجام شده است یا نه.
  • remaningAPICalls: تعداد فراخوانی API باقیمانده در این ماه.
  • label: برچسبی (دسته بندی) که بیشترین احتمال را دارد.
  • probability: احتمال / میزان ارتباط متن ارسال شده با برچسب مشخص شده.
  • Error Response
    {
        Success: false,
        message: [String],
    }
  • message: توضیح مشکل پیش آمده


  • getClassifications

    Descriptionاین Endpoint یک متن و کد یکتای ماژول را دریافت می کند و در خروجی آرایه ای از همه برچسب ها و احتمال ارتباط این متن به هر یک از آنها را ارسال می کند. این آرایه براساس احتمال برچسب ها به صورت نزولی مرتب شده است.
    URLhttps://api.vakavic.com/classifier/getClassifications
    MethodPOST
    Content-Typeapplication/json
    Authorization
  • در هر درخواستی که به API ارسال می شود، هدر Authorization باید به شکل زیر ارسال شود:
  • Authorization: Bearer YOUR_API_TOKEN
  • API Token: کلید دسترسی به API است که پس از ثبت نام در وبسایت از صفحه تنظیمات حساب کاربری قابل دسترسی است.
  • Data Params
    {
        referenceKey: [String],
        text: [String]
    }
  • referenceKey: کد یکتای ماژول مورد نظر است که از صفحه ماژول در تب تنظیمات صفحه هر ماژول قابل دسترسی است
  • text: متن مورد نظر برای دسته بندی
  • Success Response
    {
        Success: [boolean],
        remaningAPICalls: [Number],
        result: [
            {
                label: [string],
                probability: [number]
            },
            {
                label: [string],
                probability: [number],
            },
            .
            .
            .
        ]
    } 
  • Success: مشخص می کند که پردازش با موفقیت انجام شده است یا نه.
  • remaningAPICalls: تعداد فراخوانی API باقیمانده در این ماه.
  • Result: آرایه ای که در آن برچسبها و احتمال مربوط به هر کدام وجود دارد
  • label: برچسبی (دسته بندی) که بیشترین احتمال را دارد.
  • probability: احتمال / میزان ارتباط متن ارسال شده با برچسب مشخص شده.
  • Error Response
    {
        Success: false,
        message: [String]
    }
  • message: توضیح مشکل پیش آمده


  • batchClassifications

    Descriptionاین Endpoint تعدادی متن (تا ۱۰۰ عدد) و کد یکتای ماژول را دریافت می کند و در خروجی آرایه ای بر می‌گرداند که برا هر متن، احتمال درست بودن هر برچسب مشخص شده است. برای هر متن، برچسب ها در یک آرایه که به ترتیب احتمالشان مرتب شده است قرار دارند.
    URLhttps://api.vakavic.com/classifier/batchClassification
    MethodPOST
    Content-Typeapplication/json
    Authorization
  • در هر درخواستی که به API ارسال می شود، هدر Authorization باید به شکل زیر ارسال شود:
  • Authorization: Bearer YOUR_API_TOKEN
  • API Token: کلید دسترسی به API است که پس از ثبت نام در وبسایت از صفحه تنظیمات حساب کاربری قابل دسترسی است.
  • Data Params
    {
        referenceKey: [String],
        data: [
             First text to classify,
             Second text to classify
             .
             .
             .
        ]
    }
  • referenceKey: کد یکتای ماژول مورد نظر است که از صفحه ماژول در تب تنظیمات صفحه هر ماژول قابل دسترسی است
  • data: آرایه ای از String است. هر String به صورت مجزا دسته بند یخواهد شد و به ازای هر کدام، یک فراخوانی API از حساب کاربری کاسته خواهد شد
  • Success Response
    {
        Success: [boolean],
        numberOfLabels: [Number],
        consumedAPICalls: [Number],
        remaningAPICalls: [Number],
        result: [
            {
                Success: [boolean], 
                labels: [
                    {
                        label: [string],
                        probability: [number]
                    },
                        label: [string],
                        probability: [number]
                    },
                    .
                    .
                    .
                ]
            },
            {
                Success: [boolean],
                message: [string] *در شرایطی که به دلیل مشکلی دسته بندی انجام نشده باشد
            },
            .
            .
            .
        ]
    }                          
  • Success: مشخص می کند که پردازش با موفقیت انجام شده است یا نه.
  • remaningAPICalls: تعداد فراخوانی API باقیمانده در این ماه.
  • consumedAPICalls: تعداد فراخوانی API که برای انجام این درخواست مصرف شده است.
  • result: آرایه ای قیقا هم اندازه آرایه ورودی که در آن برچسی که بیشتری احتما را برای متن متناظر کسب کرده است و اتمال صحت آن وجود دارد. در صورتی که متن فقط شامل لغات زائد باشد یا سطر متناظر در آرایه ورودی فرمت صحیحی نداشته باشد برچسب معادل "NOT_LABELED" و احتمال معادل صفر خواهد بود. در چنین حالتی فیلد message دلیل مشکل را نمایش خواهد داد
  • label: برچسبی (دسته بندی) که بیشترین احتمال را دارد.
  • probability: احتمال / میزان ارتباط متن ارسال شده با برچسب مشخص شده.
  • Error Response
    {
        Success: false,
        message: [String]
    }
  • message: توضیح مشکل پیش آمده