# Search API این API برای **جستجوی معنایی (Semantic Search)** بین عبارات استفاده می‌شود. ## نحوه عملکرد این API از سه بخش اصلی تشکیل شده است: برای استفاده از هر بش از این API کافی است یک درخواست **GET** به Endpoint مربوطه ارسال کرده و توکن خود را در بخش **Authorization Header** قرار دهید. و پارامتر های اضافی مرتبط با بخش را در انتهای url و یا به صورت query string قرار دهید. --- ## 1. ایجاد دیتابیس جدید در این بخش می‌توانید یک دیتابیس جدید برای نگهداری مجموعه‌ای از عبارات ایجاد کنید. هر دیتابیس نماینده یک دسته‌بندی مستقل از عبارات است. ### Endpoint ```text newdb/ ``` ### پارامترهای ورودی | نام فیلد | توضیح | نوع فیلد | |-------------|---------------------------------------------|-------------------------------| | `dbname` | نام دیتابیسی که قصد ایجاد آن را دارید | در انتهای URL اضافه می‌شود | --- ## 2. اضافه کردن عبارت به دیتابیس در این بخش عباراتی که قصد دارید بین آن‌ها جستجوی معنایی انجام شود را به یکی از دیتابیس‌ها اضافه می‌کنید. ### Endpoint ```text addphrase/ ``` ### پارامترهای ورودی | نام فیلد | توضیح | نوع فیلد | |-------------|----------------------------------------|-------------------------------| | `dbname` | نام دیتابیس مقصد | در انتهای URL اضافه می‌شود | | `phrase` | عبارت مورد نظر برای ذخیره | Query String | --- ## 3. جستجوی معنایی در این بخش یک عبارت در دیتابیس مورد نظر جستجو شده و نزدیک‌ترین عبارات از نظر معنایی بازگردانده می‌شوند. نتایج به همراه میزان شباهت برای شما ارسال می‌شوند. هر چه عدد شباهت به 1 نزدیک‌تر باشد نتیجه نزدیک‌تر و هرچه به صفر نزدیک شود نتیجه دورتر است. ### Endpoint ```text search/ ``` ### پارامترهای ورودی | نام فیلد | توضیح | نوع فیلد | |-------------|----------------------------------------|-------------------------------| | `dbname` | نام دیتابیس | در انتهای URL اضافه می‌شود | | `phrase` | عبارت مورد جستجو | Query String | | `top` | تعداد نتایج درخواستی (`N`) | Query String | --- # آدرس‌ها تمامی Endpointهای ذکر شده در ادامه آدرس اصلی این API قرار می‌گیرند. به عنوان مثال: ```text /services/api/search/newdb/ /services/api/search/addphrase/ /services/api/search/search/ ```