WebApiSkill interface

الحزمة:

@azure/search-documents

مهارة يمكنها استدعاء نقطة نهاية واجهة برمجة تطبيقات الويب، ما يسمح لك بتوسيع مجموعة مهارات عن طريق استدعائه للتعليمات البرمجية المخصصة.

يمتد

BaseSearchIndexerSkill

الخصائص

authIdentity	الهوية المدارة المعينة من قبل المستخدم المستخدمة للاتصالات الصادرة. إذا تم توفير authResourceId ولم يتم تحديده، يتم استخدام الهوية المدارة المعينة من قبل النظام. في تحديثات المفهرس، إذا كانت الهوية غير محددة، تظل القيمة دون تغيير. إذا لم يتم تحديدها، يتم مسح قيمة هذه الخاصية.
authResourceId	ينطبق على المهارات المخصصة التي تتصل بالتعليمات البرمجية الخارجية في وظيفة Azure أو بعض التطبيقات الأخرى التي توفر التحويلات. يجب أن تكون هذه القيمة معرف التطبيق الذي تم إنشاؤه للوظيفة أو التطبيق عند تسجيله مع Azure Active Directory. عند تحديدها، تتصل المهارة المخصصة بالوظيفة أو التطبيق باستخدام معرف مدار (إما نظام أو تعيين من قبل المستخدم) لخدمة البحث ورمز الوصول للوظيفة أو التطبيق، باستخدام هذه القيمة كمعرف المورد لإنشاء نطاق الرمز المميز للوصول.
batchSize	حجم الدفعة المطلوب الذي يشير إلى عدد المستندات.
degreeOfParallelism	إذا تم تعيينه، عدد الاستدعاءات المتوازية التي يمكن إجراؤها على واجهة برمجة تطبيقات الويب.
httpHeaders	العناوين المطلوبة لإجراء طلب http.
httpMethod	أسلوب طلب http.
odatatype	تمييزي متعدد الأشكال، والذي يحدد الأنواع المختلفة التي يمكن أن يكون هذا الكائن
timeout	المهلة المطلوبة للطلب. الافتراضي هو 30 ثانية.
uri	عنوان URL لواجهة برمجة تطبيقات الويب.

الخصائص الموروثة

context	يمثل المستوى الذي تحدث فيه العمليات، مثل جذر المستند أو محتوى المستند (على سبيل المثال، /document أو /document/content). الإعداد الافتراضي هو /document.
description	وصف المهارة التي تصف مدخلات المهارة ومخرجاتها واستخدامها.
inputs	يمكن أن تكون مدخلات المهارات عمودا في مجموعة البيانات المصدر، أو إخراج مهارة المصدر.
name	اسم المهارة التي تحددها بشكل فريد داخل مجموعة المهارات. سيتم إعطاء مهارة بدون اسم معرف اسما افتراضيا لفهرسها المستند إلى 1 في صفيف المهارات، مسبوقا بالحرف '#'.
outputs	إخراج المهارة هو إما حقل في فهرس بحث، أو قيمة يمكن استهلاكها كمدخل من قبل مهارة أخرى.

تفاصيل الخاصية

authIdentity

الهوية المدارة المعينة من قبل المستخدم المستخدمة للاتصالات الصادرة. إذا تم توفير authResourceId ولم يتم تحديده، يتم استخدام الهوية المدارة المعينة من قبل النظام. في تحديثات المفهرس، إذا كانت الهوية غير محددة، تظل القيمة دون تغيير. إذا لم يتم تحديدها، يتم مسح قيمة هذه الخاصية.

authIdentity?: SearchIndexerDataIdentity

قيمة الخاصية

SearchIndexerDataIdentity

authResourceId

ينطبق على المهارات المخصصة التي تتصل بالتعليمات البرمجية الخارجية في وظيفة Azure أو بعض التطبيقات الأخرى التي توفر التحويلات. يجب أن تكون هذه القيمة معرف التطبيق الذي تم إنشاؤه للوظيفة أو التطبيق عند تسجيله مع Azure Active Directory. عند تحديدها، تتصل المهارة المخصصة بالوظيفة أو التطبيق باستخدام معرف مدار (إما نظام أو تعيين من قبل المستخدم) لخدمة البحث ورمز الوصول للوظيفة أو التطبيق، باستخدام هذه القيمة كمعرف المورد لإنشاء نطاق الرمز المميز للوصول.

authResourceId?: string

قيمة الخاصية

string

batchSize

حجم الدفعة المطلوب الذي يشير إلى عدد المستندات.

batchSize?: number

قيمة الخاصية

number

degreeOfParallelism

إذا تم تعيينه، عدد الاستدعاءات المتوازية التي يمكن إجراؤها على واجهة برمجة تطبيقات الويب.

degreeOfParallelism?: number

قيمة الخاصية

number

httpHeaders

العناوين المطلوبة لإجراء طلب http.

httpHeaders?: {[propertyName: string]: string}

قيمة الخاصية

{[propertyName: string]: string}

httpMethod

أسلوب طلب http.

httpMethod?: string

قيمة الخاصية

string

odatatype

تمييزي متعدد الأشكال، والذي يحدد الأنواع المختلفة التي يمكن أن يكون هذا الكائن

odatatype: "#Microsoft.Skills.Custom.WebApiSkill"

قيمة الخاصية

"#Microsoft.Skills.Custom.WebApiSkill"

timeout

المهلة المطلوبة للطلب. الافتراضي هو 30 ثانية.

timeout?: string

قيمة الخاصية

string

uri

عنوان URL لواجهة برمجة تطبيقات الويب.

uri: string

قيمة الخاصية

string

تفاصيل الخاصية الموروثة

context

يمثل المستوى الذي تحدث فيه العمليات، مثل جذر المستند أو محتوى المستند (على سبيل المثال، /document أو /document/content). الإعداد الافتراضي هو /document.

context?: string

قيمة الخاصية

string

موروثة منSearchIndexerSkill.context

description

وصف المهارة التي تصف مدخلات المهارة ومخرجاتها واستخدامها.

description?: string

قيمة الخاصية

string

موروثة منSearchIndexerSkill.description

inputs

يمكن أن تكون مدخلات المهارات عمودا في مجموعة البيانات المصدر، أو إخراج مهارة المصدر.

inputs: InputFieldMappingEntry[]

قيمة الخاصية

InputFieldMappingEntry[]

موروثة منSearchIndexerSkill.inputs

name

اسم المهارة التي تحددها بشكل فريد داخل مجموعة المهارات. سيتم إعطاء مهارة بدون اسم معرف اسما افتراضيا لفهرسها المستند إلى 1 في صفيف المهارات، مسبوقا بالحرف '#'.

name?: string

قيمة الخاصية

string

موروثة منSearchIndexerSkill.name

outputs

إخراج المهارة هو إما حقل في فهرس بحث، أو قيمة يمكن استهلاكها كمدخل من قبل مهارة أخرى.

outputs: OutputFieldMappingEntry[]

قيمة الخاصية

OutputFieldMappingEntry[]

موروثة منSearchIndexerSkill.outputs