التشغيل السريع: استخدام مكتبة العميل لـ Bing Autosuggest

  • مقالة
  • قراءة خلال 8 دقائق

تحذير

في 30 أكتوبر 2020، انتقلت واجهات برمجة تطبيقات البحث Bing من الخدمات المعرفية إلى خدمات البحث Bing. يتم توفير هذه الوثائق للرجوع إليها فقط. للحصول على الوثائق المحدثة، راجع وثائق واجهة برمجة تطبيقات البحث Bing. للحصول على إرشادات حول إنشاء موارد Azure جديدة للبحث Bing، راجع إنشاء مورد بحث Bing خلال Azure Marketplace.

البدء بمكتبة العميل Bing Autosuggest لـ .NET. اتبع هذه الخطوات لتثبيت الحزمة، وتجربة نموذج تعليمات البرمجة للمهام الأساسية.

استخدم مكتبة العميل "Bing Autosuggest" الخاصة بـ ".NET" للحصول على اقتراحات البحث استنادًا إلى سلاسل الاستعلام الجزئي.

⁧⁧⁩⁩الوثائق المرجعية⁧⁧⁩⁩⁧⁧ | ⁩⁩⁧⁧⁩⁩التعليمات البرمجية لمصدر المكتبة⁧⁧⁩⁩⁧⁧ | ⁩⁩⁧⁧⁩⁩حزمة (NuGet)⁧⁧⁩⁩⁧⁧ | ⁩⁩⁧⁧⁩⁩التعليمة البرمجية العينة⁧⁧⁩⁩

المتطلبات الأساسية

انشئ مورد Azure.

ابدأ في استخدام Bing Autosuggest API بإنشاء أحد موارد Azure التالية.

⁧⁩Bing Autosuggest resource⁧⁩

  • متوفر من خلال مدخل Microsoft Azure حتى وقت حذفك للمورد.
  • استخدم مستوى التسعير الحر لتجربة الخدمة، وترقيتها لاحقًا إلى مستوى مدفوع للإنتاج.
  • يتم تقديم Bing Autosuggest التلقائي أيضًا في المستويات المدفوعة لمورد ⁧⁩Bing Search v7 resource⁧⁩.

موارد متعددة الخدمات

  • متوفر من خلال مدخل Azure إلى أن تقوم بحذف المورد.
  • استخدم نفس المفتاح ونقطة النهاية للتطبيقات الخاصة بك، عبر الخدمات المعرفية المتعددة.

إنشاء متغيرات البيئة

ملاحظة

تستخدم نقاط انتهاء الموارد التي تم إنشاؤها بعد 1 يوليو 2019 تنسيق النطاق الفرعي المخصص الموضح أدناه. لمزيد من المعلومات وقائمة كاملة بنقاط الانتهاء الإقليمية، راجع أسماء النطاقات الفرعية المخصصة للخدمات المعرفية.

باستخدام المفتاح ونقطة الانتهاء من المورد الذي أنشأته، أنشئ متغيرين للبيئة من أجل المصادقة:

  • ⁧⁧AUTOSUGGEST_SUBSCRIPTION_KEY⁩⁩: مفتاح المورد للمصادقة على طلباتك.
  • ⁧⁧AUTOSUGGEST_ENDPOINT⁩⁩: نقطة انتهاء المورد لإرسال طلبات API. يجب أن يبدو هكذا عند التعديل: ⁧⁧https://<your-custom-subdomain>.api.cognitive.microsoft.com⁩⁩

استخدام إرشادات نظام تشغيلك.

setx AUTOSUGGEST_SUBSCRIPTION_KEY <replace-with-your-autosuggest-api-key>
setx AUTOSUGGEST_ENDPOINT <replace-with-your-autosuggest-api-endpoint>

بعد إضافة متغير البيئة، إعادة تشغيل إطار وحدة التحكم.

إنشاء تطبيق C# جديد

إنشاء تطبيق جديد.NET Core في المحرر المفضل لديك أو IDE.

في نافذة وحدة تحكم (مثل cmd أو PowerShell أو Bash)، استخدم الأمر ⁧dotnet new⁩ لإنشاء تطبيق وحدة تحكم جديد بالاسم ⁧bing-autosuggest-quickstart⁩. ينشئ هذا الأمر مشروع "مرحبًا بالعالم" بلغة C# بسيط مع ملف مصدر واحد: ⁧⁧⁩⁩program.cs⁧⁧⁩⁩.

dotnet new console -n bing-autosuggest-quickstart

غيّر دليلك إلى مجلد التطبيق المنشأ حديثًا. يمكنك إنشاء التطبيق باستخدام:

dotnet build

يجب ألا يحتوي إخراج البناء على تحذيرات أو أخطاء.

...
Build succeeded.
 0 Warning(s)
 0 Error(s)
...

من دليل المشروع، افتح الملف ⁧⁧⁩⁩Program.cs⁧⁧⁩⁩ في المحرر المفضل لديك أو IDE. أضِف توجيهات ⁧⁧using⁩⁩ التالية:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

في الفئة ⁧⁧Program⁩⁩، أنشئ متغيرات نقطة النهاية لموردك ومفتاح Azure . إذا قمت بإنشاء متغير البيئة بعد تشغيل التطبيق، فستحتاج إلى إغلاق، وإعادة فتح المحرر أو IDE أو shell، وتشغيله للوصول إلى المتغير.

private const string key_var = "AUTOSUGGEST_SUBSCRIPTION_KEY";
private static readonly string subscription_key = Environment.GetEnvironmentVariable(key_var);

// Note you must use the same region as you used to get your subscription key.
private const string endpoint_var = "AUTOSUGGEST_ENDPOINT";
private static readonly string endpoint = Environment.GetEnvironmentVariable(endpoint_var);

في الأسلوب ⁧⁧Main⁩⁩ الخاص بالتطبيق، أضف استدعاءات الأسلوب التالي، والتي ستحدده لاحقًا.

static void Main(string[] args)
{
    Task.WaitAll(RunQuickstart());
    Console.WriteLine("Press any key to exit.");
    Console.Read();
}

تثبيت مكتبة العميل

ضمن دليل التطبيق، قم بتثبيت مكتبة عميل Bing Autosuggest لـ .NET باستخدام الأمر التالي:

dotnet add package Microsoft.Azure.CognitiveServices.Search.AutoSuggest --version 2.0.0

إذا كنت تستخدم Visual Studio IDE، تتوفر مكتبة العميل كحزمة NuGet قابلة للتحميل.

أمثلة التعليمة البرمجية

توضح لك أجزاء التعليمات البرمجية التالية كيفية أداء المهام التالية باستخدام مكتبة عميل Bing Autosuggest لـ .NET:

مصادقة العميل

ملاحظة

تفترض هذه البداية السريعة ⁧⁧⁩⁩ أنك قمت بإنشاء متغير بيئة⁧⁧⁩⁩ لمفتاح Bing Autosuggest، المسمى ⁧⁧AUTOSUGGEST_SUBSCRIPTION_KEY⁩⁩، ومفتاح نقطة النهاية المسمى ⁧⁧AUTOSUGGEST_ENDPOINT⁩⁩.

في أسلوب جديد غير متزامن، قم بإنشاء مثيل للعميل بنقطة النهاية والمفتاح. إنشاء عنصر⁧⁧⁩⁩ApiKeyServiceClientCredentials⁧⁧⁩⁩ باستخدام مفتاح خاص بك، واستخدمه مع نقطة النهاية لإنشاء عنصر ⁧⁧⁩⁩AutosuggestClient⁧⁧⁩⁩.

async static Task RunQuickstart()
{
    // Generate the credentials and create the client.
    var credentials = new Microsoft.Azure.CognitiveServices.Search.AutoSuggest.ApiKeyServiceClientCredentials(subscription_key);
    var client = new AutoSuggestClient(credentials, new System.Net.Http.DelegatingHandler[] { })
    {
        Endpoint = endpoint
    };
}

إرسال طلب اقتراح تلقائي

في نفس الأسلوب، استخدم أسلوب العميل ⁧⁧⁩⁩AutoSuggestMethodAsync⁧⁧⁩⁩ لإرسال استعلام إلى Bing. ثم، التجاوب مع استجابة ⁧⁧⁩⁩الاقتراحات⁧⁧⁩⁩، ثم طباعة الاقتراح الأول.

var result = await client.AutoSuggestMethodAsync("xb");
var groups = result.SuggestionGroups;
if (groups.Count > 0) {
    var group = groups[0];
    Console.Write("First suggestion group: {0}\n", group.Name);
    var suggestions = group.SearchSuggestions;
    if (suggestions.Count > 0)
    {
        Console.WriteLine("First suggestion:");
        Console.WriteLine("Query: {0}", suggestions[0].Query);
        Console.WriteLine("Display text: {0}", suggestions[0].DisplayText);
    }
    else
    {
        Console.WriteLine("No suggestions found in this group.");
    }
}
else
{
    Console.WriteLine("No suggestions found.");
}

شغّل التطبيق

قم بتشغيل التطبيق من دليل التطبيق الخاص بك باستخدام الأمر dotnet run.

dotnet run

تنظيف الموارد

إذا كنت تريد تنظيف وإلغاء اشتراك الخدمات المعرفية، يمكنك حذف المورد أو مجموعة الموارد. يؤدي حذف مجموعة الموارد إلى حذف أية موارد أخرى مقترنة بها أيضًا.

الخطوات التالية

برنامج تعليمي عن Bing Autosuggest

راجع أيضًا

البدء بمكتبة العميل Bing Autosuggest لـ Go. اتبع هذه الخطوات لتثبيت الحزمة وتجربة نموذج تعليمات البرمجة للمهام الأساسية.

استخدم مكتبة العميل "Bing Autosuggest" الخاصة بـ "Go" للحصول على اقتراحات البحث استناداً إلى سلاسل الاستعلام الجزئي.

المرجع | كود مصدر المكتبة | حزمة (PyPi)عينات

المتطلبات الأساسية

ابدأ باستخدام مكتبة العميل Bing Autosuggest بإنشاء مورد Azure. اختر نوع المورد المناسب لك من أدناه:

انشئ مورد Azure.

ابدأ في استخدام Bing Autosuggest API بإنشاء أحد موارد Azure التالية.

⁧⁩Bing Autosuggest resource⁧⁩

  • متوفر من خلال مدخل Microsoft Azure حتى وقت حذفك للمورد.
  • استخدم مستوى التسعير الحر لتجربة الخدمة، وترقيتها لاحقًا إلى مستوى مدفوع للإنتاج.
  • يتم تقديم Bing Autosuggest التلقائي أيضًا في المستويات المدفوعة لمورد ⁧⁩Bing Search v7 resource⁧⁩.

موارد متعددة الخدمات

  • متوفر من خلال مدخل Azure إلى أن تقوم بحذف المورد.
  • استخدم نفس المفتاح ونقطة النهاية للتطبيقات الخاصة بك، عبر الخدمات المعرفية المتعددة.

إنشاء متغيرات البيئة

ملاحظة

تستخدم نقاط انتهاء الموارد التي تم إنشاؤها بعد 1 يوليو 2019 تنسيق النطاق الفرعي المخصص الموضح أدناه. لمزيد من المعلومات وقائمة كاملة بنقاط الانتهاء الإقليمية، راجع أسماء النطاقات الفرعية المخصصة للخدمات المعرفية.

باستخدام المفتاح ونقطة الانتهاء من المورد الذي أنشأته، أنشئ متغيرين للبيئة من أجل المصادقة:

  • ⁧⁧AUTOSUGGEST_SUBSCRIPTION_KEY⁩⁩: مفتاح المورد للمصادقة على طلباتك.
  • AUTOSUGGEST_ENDPOINTنقطة انتهاء المورد لإرسال طلبات API. يجب أن يبدو هكذا عند التعديل:https://<your-custom-subdomain>.api.cognitive.microsoft.com

استخدام إرشادات نظام تشغيلك.

setx BING_AUTOSUGGEST_SUBSCRIPTION_KEY <replace-with-your-autosuggest-api-key>
setx BING_AUTOSUGGEST_ENDPOINT <replace-with-your-autosuggest-api-endpoint>

بعد إضافة متغير البيئة، إعادة تشغيل إطار وحدة التحكم.

إنشاء مشروع Go جديد

في إطار وحدة تحكم (cmd، PowerShell، Terminal، Bash)، قم بإنشاء مساحة عمل جديدة لمشروع Go وانتقل إليه. ستحتوي مساحة العمل الخاصة بك على ثلاثة مُجلدات:

  • src- سيحتوي هذا الدليل على كود المصدر والحزم. أي حزم مثبتة مع الأمر go get ستبقى هنا.
  • pkg: يحتوي هذا الدليل على كائنات حزمة Go المبرمجة. كل هذه الملفات لها الامتدادات التالية .a.
  • bin- سيحتوي هذا الدليل على الملفات الثنائية القابلة للتنفيذ التي تم إنشاؤها عند التشغيل go install.

تلميح

تعرف على المزيد حول بنية مساحة عمل Go. يتضمن هذا الدليل معلومات حول الإعداد $GOPATH و$GOROOT.

لنقُم بإنشاء مساحة عمل تسمى my-app والدلائل الفرعية المطلوبة لـ src، وpkg،bin:

$ mkdir -p my-app/{src, bin, pkg}  
$ cd my-app

تثبيت مكتبة العميل لــ Go

بعد ذلك، تثبيت مكتبة العميل لـ Go:

$ go get -u <library-location-or-url>

أو إذا كنت تستخدم dep، في نطاق المستودع:

$ dep ensure -add <library-location-or-url>

قم بإنشاء تطبيق Go

إنشاء ملف يسمى src/sample-app.go:

$ cd src
$ touch sample-app.go

فتح sample-app.go، إضافة اسم الحزمة ثم استيراد المكتبات التالية:

package main

import (
    "context"
    "fmt"
    "github.com/Azure/azure-sdk-for-go/services/cognitiveservices/v1.0/autosuggest"
    "github.com/Azure/go-autorest/autorest"
    "log"
    "os"
)

إنشاء دالة باسم main. ثم إنشاء متغيرات بيئة لمفتاح Bing Autosuggest ونقطة الانتهاء:

func main() {
    // Add your Bing Autosuggest subscription key to your environment variables.
    if "" == os.Getenv("BING_AUTOSUGGEST_SUBSCRIPTION_KEY") {
        log.Fatal("Please set/export the environment variable BING_AUTOSUGGEST_SUBSCRIPTION_KEY.")
    }
    // Add your Bing Autosuggest endpoint to your environment variables.
    var subscription_key string = os.Getenv("BING_AUTOSUGGEST_ENDPOINT")
    if "" == os.Getenv("BING_AUTOSUGGEST_ENDPOINT") {
        log.Fatal("Please set/export the environment variable BING_AUTOSUGGEST_ENDPOINT.")
    }
    var endpoint string = os.Getenv("BING_AUTOSUGGEST_ENDPOINT")
}

أمثلة التعليمات البرمجية

تظهر نماذج التعليمات البرمجية هذه كيفية إكمال المهام الأساسية باستخدام مكتبة عميل "Bing Autosuggest" لــ Go:

مصادقة العميل

ملاحظة

يفترض هذا التشغيل السريع أنك قمت بإنشاء متغير بيئة لمفتاح الاقتراح التلقائي Bing ، المسمى BING_AUTOSUGGEST_SUBSCRIPTION_KEY، وواحد لنقطة النهاية المسماة BING_AUTOSUGGEST_ENDPOINT.

في الدالةmain() إنشاء مثيل عميل مع نقطة الانتهاء والمفتاح.

// Get the context, which is required by the SDK methods.
ctx := context.Background()

client := autosuggest.New()
// Set the subscription key on the client.
client.Authorizer = autorest.NewCognitiveServicesAuthorizer(subscription_key)
client.Endpoint = endpoint

إرسال طلب API

في نفس الأسلوب، استخدم أسلوب العميل AutoSuggestMethodAsync لإرسال استعلام إلى Bing. ثم، التجاوب مع استجابة ⁧⁧⁩⁩الاقتراحات⁧⁧⁩⁩، ثم طباعة الاقتراح الأول.

// This should return the query suggestion "xbox."
result, err := client.AutoSuggest (ctx, "xb", "", "", "", "", "", "", "", "", "", "", []autosuggest.ResponseFormat{"Json"})
if nil != err {
    log.Fatal(err)
}

groups := *result.SuggestionGroups
if len(groups) > 0 {
    group, _ := groups[0].AsSuggestionsSuggestionGroup()
    fmt.Printf ("First suggestion group: %s\n", (*group).Name)
    suggestions := *(*group).SearchSuggestions
    if len(suggestions) > 0 {
        fmt.Println("First suggestion:")
        fmt.Printf("Query: %s\n", *suggestions[0].Query)
        fmt.Printf("Display text: %s\n", *suggestions[0].DisplayText)
    } else {
        fmt.Println("No suggestions found in this group.")
    }
} else {
    fmt.Println("No suggestions found.")
}

شغّل التطبيق

تشغيل تطبيق Go مع go run [arguments] الأمر من دليل تطبيقك.

go run sample-app.go

تنظيف الموارد

إذا كنت تريد تنظيف وإلغاء اشتراك الخدمات المعرفية، يمكنك حذف المورد أو مجموعة الموارد. يؤدي حذف مجموعة الموارد إلى حذف أية موارد أخرى مقترنة بها أيضًا.

الخطوات التالية

برنامج تعليمي عن Bing Autosuggest

راجع أيضًا