از API های جستجوی SharePoint نهایت استفاده را ببرید

یکشنبه 4 اردیبهشت 1401

API های جستجوی SharePoint دارای ویژگی ها و کاربردهای بسیار زیادی هستند، در این مطلب بیشتر درباره API های جستجوی SharePoint صحبت می کنیم.

 از API های جستجوی SharePoint نهایت استفاده را ببرید

پیش از صحبت درباره API های جستجوی SharePoint اجازه دهید تا درباره اهمیت محتوا در کسب و کارها صحبت کنیم. امروزه بسیاری از سازمان ها از نظر محتوا پیشرفت زیادی را تجربه کرده اند و به همین علت است که داکیومنت ها هنوز در قلب گردش کاری بسیاری از سازمان ها و شرکت ها فعالیت دارند. زمانی که این داکیومنت ها به هدف اولیه خود دست پیدا می کنند همچنان اهمیت خود را حفظ می کنند. این فرم ها، مقالات و گزارش ها همگی دارای دانشی هستند که برای کسب و کارها لازم و ضروری است. اگرچه سازمان ها و شرکت ها می توانند این محتواها را دور بیندازند ولی با این حال بهتر است که از ذخیره سازی کم هزینه در فضای ابری یا به صورت محلی برای ایجاد انبارهای دیجیتالی از دانشی که به دست آورده ایم استفاده کنیم چرا که این اطلاعات ممکن است روزی بسیار مفید و کاربردی باشند. با استفاده از API های جستجوی SharePoint می توان اطلاعات بسیار خوبی را از این داده ها به دست آورد. 

انبار دیجیتالی از دانش

نکته ای که در این جا باید به آن دقت داشته باشید این است که این گنجینه ها و انبارهای دیجیتالی در واقع مانند بایگانی های کاغذی قدیمی نیستند. هرچه شما اطلاعات بیشتری را ذخیره کنید می توانند مفیدتر واقع شوند و مجموعه ای از دانش را برای شما فراهم کنند که به نرم افزار اجازه می دهد تا لینک ها و پیوندهای موجود در دانش شرکت های ما را کشف کند و بینش هایی را درباره آنچه که می دانیم به ما ارائه دهد. با این حال نباید فراموش کنید که بدون داشتن فروشگاه های هوشمند و ابزارهای جستجوی موثر مانند API های جستجوی SharePoint نمی توانیم این کار را به خوبی انجام دهیم. به همین علت است که امروزه کسب و کارها به دنبال ابزارهایی مانند API های جستجوی SharePoint هستند. 

ابزارهای مدیریتی محتوا و API های جستجوی SharePoint

ابزارهای مدیریت محتوای سازمانی مانند API های جستجوی SharePoint که توسط مایکروسافت طراحی و ساخته شده است هیچ شباهتی به پلتفرم های مدیریت محتوا ندارند. اگرچه API های جستجوی SharePoint می توانند چارچوب هایی را برای نمایش و مدیریت محتوا ایجاد کنند اما بهتر است که به عنوان یک انبار دیجیتال در نظر گرفته شوند چرا که می توانند ابزارهایی را برای فهرست نویسی و جستجوی فایل ها در اختیار شما قرار می دهند. در واقع شما می توانید این ابزار را به عنوان پایگاه های اطلاعاتی تخصصی مانند پایگاه داده های داکیومنت NoSQL امروزی در نظر بگیرید که با فایل های متنی بزرگ کار می کنند و می توانند مدیریت محتوای بی ساختار را برای شما ساده تر کنند. به جای این که شما تنها با جیسون کار کنید می توانید از API های جستجوی SharePoint استفاده کرده و از مزایای آن نهایت بهره را ببرید. فراموش نکنید که این ابزارها برای انجام طیف گسترده ای از وظایف بهینه سازی شده اند.

نکاتی درباره API های جستجوی SharePoint

زمانی که شرکت مایکروسافت در حال توسعه ابزار آفیس 365 بود مشخص بود که می خواهد از API های جستجوی SharePoint نیز به عنوان سرور آن استفاده کند. این ابزار در واقع رقیبی برای ابزارهای ذخیره سازی ویندوز در سرور بود. فراموش نکنید که امروزه این ابزار به عنوان یکی از قطب های مایکروسافت 365 شناخته می شود که زیربنای لیست ها و همینطور بخش هایی از تیم ها و OneDrive سازمانی را تشکیل می دهند. علاوه بر این باید توجه کنید که این ابزار یک پلتفرم توسعه است که به شما اجازه می دهد تا با استفاده از ابزارهای توسعه خود و ابزار مایکروسافت گراف برنامه ها و اپلیکیشن های اینترانت را ایجاد کنید و اقدام به مستقر کردن آنها کنید.

جستجو در SharePoint

شاید مهمترین ابزار برای ساخت هر اپلیکیشن SharePoint پس از جریان کاری، جستجو در آن باشد. به این ترتیب کاربران شما می توانند داکیومنت ها و مستندات را به راحتی پیدا کرده و نتایج مرتبط با جستجوی خود را دریافت کنند. جستجو از طریق API های جستجوی SharePoint صورت می گیرد که بر روی دو فناوری جستجوی مختلف طراحی و ساخته شده است. هر دو این فناوری ها دارای یک فهرست مشترک و خزنده محتوا هستند که می تواند روی تمام محتواها و انبارهای محتوای شما کار کند. کوئری ها در این جستجو با استفاده از KQL صورت می گیرد که یک زبان کوئری کلید واژه است. البته شما برای این کار می توانید از FQL نیز استفاده کنید که یک زبان کوئری سریع برای پلتفرم جستجوی سازمانی FAST که توسط مایکروسافت در سال 2008 خریداری شد می باشد.

نکاتی درباره API های جستجوی SharePoint

جستجوها را می توان در محتوای وب یا از طریق یک REST API که به سرویس جستجوی SharePoint متصل است انجام داد. با این کار شما می توانید درخواست های POST و GET را دریافت کنید و روند توسعه نرم افزار خود را به میزان زیادی ساده سازی کنید. این کار به اندازه کافی ساده است که از آن برای ارسال اپلیکیشن کوئری ها به SharePoint استفاده کنید. این کار با استفاده از URL ها از طریق GET یا به عنوان پارامترهای جیسون از طریق دستور POST صورت می گیرد.

در عمل بهتر است که شما از جیسون و POST استفاده کنید چرا که می تواند محدودیت های مربوط به طول URL را به میزان زیادی کاهش دهد و از انواع کوئری های پیچیده نیز پشتیبانی می کند. دقت داشته باشید که هم Get و هم Post به صورت پیش فرض پاسخ های خود را در قالب XML برمی گردانند گرچه شما در صورت تمایل می توانید مستندات را به صورت جیسون نیز دریافت کنید.

از آنجایی که SharePoint و API های جستجوی SharePoint یک انبار مستندات و داکیومنت است کوئری ها بسیار ساده خواهند بود. دقت داشته باشید که ما در این جا به دنبال بازگشت یک ورودی خاص نیستیم و در عوض ما فهرستی از مستندات و داکیومنت ها را بر می گردانیم که کاربر می تواند روی آنها کلیک کرده و در آنها کاوش کند.

ساخت API های جستجوی SharePoint

API های جستجوی SharePoint دارای شکلی آشنا هستند. در واقع آنها شبیه به آنچه هستند که شما می توانید در اکثر API های Microsoft Graph مشاهده کنید. اگرچه باید دقت داشته باشید که در این جا نمونه های سرور SharePoint شما را هدف قرار می دهند. با شروع از نام دامنه سروری که انتخاب کرده اید ساختار نسبتا ساده ای را پیش رو خواهید داشت:

GET http://server/_api/search/query?query_parameter

در این مثال شما باید سرور را با نام دامنه کاملا واجد شرایط سرور SharePoint خود تعویض کنید که این کار با استفاده از عبارات جستجو و هر تغییر دهنده ای که به عنوان پارامترهای کوئری ارائه می شود قابل انجام خواهد بود. این کار باعث می شود تا یک کوئری مناسب در زبان برنامه نویسی دلخواه شما ایجاد شود. درخواست های GET نیز دقیقا به همین وضوح هستند که می توانند برای درخواست های ساده تر گزینه بسیار بهتری باشند. درخواست های پیچیده تر را می توان به عنوان داکیومنت جیسون که شامل جفت های کلید-مقدار مناسب برای هر عنصر از درخواست است ایجاد کرد.

پاسخ درخواست ها

پاسخ درخواست ها در API های جستجوی SharePoint نیز از اهمیت بالایی برخوردار است. پاسخ های درخواست ها را می توان به مجموعه ای از داکیومنت ها محدود کرد یا این که شما می توانید انتخاب کنید که داده های پاسخ صفحه بندی شوند و بلوک های نتایج را در زمان جا به جایی کاربران از صفحه ای به صفحه دیگر بارگذاری کنید. راهکار دیگری که برای انجام این کار در API های جستجوی SharePoint وجود دارد این است که در زمان جا به جایی و حرکت در یک برنامه و اپلیکیشن وب تک صفحه ای نتایج جدیدی را اضافه کنید. این نتایج می توانند اطلاعات بسیار خوبی را در اختیار کاربران قرار دهند.

سینتکس مربوط به API های جستجوی SharePoint

اگرچه API های جستجوی SharePoint دارای سینتکس مخصوص به خود هستند اما شما هنوز هم باید درباره استفاده از KQL و FQL در زمان ساخت عبارت های مرتبط با کوئری ها فکر کنید. اگر قصد دارید پاسخ درخواست ها را اصلاح کنید نیازمند استفاده از فیلترهای مخصوص FQL خواهید بود. این ها به شما اجازه می دهند تا داکیومنت هایی را که در مجموعه نتایج برگردانده اید را انتخاب کنید. دقت داشته باشید که استفاده از GET API می تواند شما را تنها به یک فیلتر محدود کند و به همین علت بهتر است که از API های جستجوی SharePoint استفاده کنید. 

شخصی سازی نتایج

برخلاف اکثر محیط های جستجو، API های جستجوی SharePoint گزینه های زیادی برای سفارشی کردن نتایج در اختیار شما قرار می دهند. دقت داشته باشید که این ابزار یک ابزار جستجوی همه جانبه نیست و به همین علت نیازمند کنترل بیشتری است. به عنوان مثال اطمینان از اعمال نقش ها و سایر مکانیزم های کنترل دسترسی و همچنین مدیریت SharePoint به شما اجازه می دهد تا سطحی از کنترل را روی نتایج اعمال کنند. به این ترتیب نحوه ترتیب و نمایش نتایج نیز قابل تنظیم خواهد بود. کوئری های SharePoint به طور پیش فرض تنها برای کاربران مجاز در دسترس خواهند بود ولی شما می توانید مجموعه ای محدود از نتایج را برای کاربران ناشناس نیز مجاز کنید. این یک ویژگی بسیار مفید در API های جستجوی SharePoint است که ذخیره داکیومنت های عمومی را از سرورهای مبتنی بر وب ساده تر می کند.

سایر ابزارهای مایکروسافت در این زمینه

شرکت مایکروسافت علاوه بر REST API مجموعه ای از ابزارهای دات نت SharePoint را نیز به شما ارائه می دهد که از قابلیت های جستجو و یک کتابخانه جاوا اسکریپت مرتبط نیز پشتیبانی می کند. این قابلیت به شما اجازه دسترسی به مجموعه ای از قابلیت ها را می دهد و در عین حال کار کردن با اشیا مربوط به پاسخ به صورت نیتیو را به جای جیسون یا XML ساده تر می کند. شما می توانید از هر دو عملگر FML و KML برای اصلاح کوئری های خود استفاده کنید چرا که SQL در آنها پشتیبانی نمی شود. ویژگی هایی مانند NEAR در API های جستجوی SharePoint به شما کمک می کند تا محتوای مرتبط را پیدا کنید و ویژگی XRANK نیز به مدیریت رتبه پاسخ ها کمک می کند.

کوئری های پیشنهادی در API های جستجوی SharePoint

یک ویژگی مفید گزینه ای است که کوئری های پیشنهادی را بر اساس آنچه که سایر کاربران جستجو کرده اند بر می گرداند. API های جستجوی SharePoint یک endpoint پیشنهادی ساده را برای انجام این کار پیشنهاد می دهند که از پارامترهای مخصوصی برای ارائه عبارت های جستجوی ممکن که می توانند این پیشنهاد را فعال کنند استفاده می کند. این عبارت ها را می توان به عنوان عبارت های جستجوی فعلی کاربران شما در نظر گرفت تا به آنها کمک کرد که بتوانند به سرعت و پیش از این که یک جستجو را اجرا کنند کوئری های خود را تعریف کنند. درخواست شما می تواند شامل تعداد پیشنهادات برای اضافه کردن یا فرمت کردن قوانین نیز باشد تا اطمینان حاصل کند که پاسخ ها همگی با حروف بزرگ نوشته شده اند.

شما می توانید از این رویکرد با یک ورودی متنی آزاد برای ساخت موتور جستجوی مخصوص به خود استفاده کنید که این کار از طریق سازنده های کوئری داینامیک صورت می گیرد که در آنها هر بار که کاربر متنی را در کادر مربوطه وارد می کند پیشنهاداتی را دریافت خواهد کرد. با این حال در عمل این کار می تواند پیچیدگی های زیادی را به همراه داشته باشد و این کار راحت تر است که مجموعه ای از پیشنهاداتی که سایر کاربران به دنبال آن بوده اند را به کاربران فعلی ارائه دهیم.

گزینه های دیگری که در این جا وجود دارند به پاسخ های پیشنهادی شما اجازه می دهند تا نام هایی را به آنها اضافه کنید که از طریق آنها می توانید افراد مرتبط با عبارات جستجو را مشخص کنید. این ویژگی می تواند به نشان دادن کارشناس مربوطه یا تیم های مرتبط با موضوع جستجو نیز بسیار کمک کند و مزایای زیادی را برای کسب و کارها و شرکت ها به همراه داشته باشد. 


 

برنامه نویسان

نویسنده 3346 مقاله در برنامه نویسان

کاربرانی که از نویسنده این مقاله تشکر کرده اند

در صورتی که در رابطه با این مقاله سوالی دارید، در تاپیک های انجمن مطرح کنید