SearchIndexerClient class

الحزمة:

@azure/search-documents

فئة لتنفيذ عمليات لإدارة (إنشاء وتحديث وقائمة/حذف) المفهرسات، مصادر البيانات & مجموعات المهارات.

المنشئون

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

إنشاء مثيل SearchIndexerClient. استخدام المثال: const { SearchIndexerClient, AzureKeyCredential } = require("@azure/search-documents"); const client = new SearchIndexerClient( "<endpoint>", new AzureKeyCredential("<Admin Key>"); );

الخصائص

apiVersion	إصدار واجهة برمجة التطبيقات لاستخدامه عند الاتصال بالخدمة.
endpoint	نقطة نهاية خدمة البحث
serviceVersion	إصدار واجهة برمجة التطبيقات لاستخدامه عند الاتصال بالخدمة.

الأساليب

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)	إنشاء مصدر بيانات جديد في خدمة بحث.
createIndexer(SearchIndexer, OperationOptions)	إنشاء مفهرس جديد في خدمة بحث.
createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)	إنشاء مصدر بيانات جديد أو تعديل مصدر بيانات موجود.
createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)	إنشاء مفهرس جديد أو تعديل مفهرس موجود.
createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)	إنشاء مجموعة مهارات جديدة أو تعديل مجموعة موجودة.
createSkillset(SearchIndexerSkillset, OperationOptions)	إنشاء مجموعة مهارات جديدة في خدمة بحث.
deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)	حذف مصدر بيانات موجود.
deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)	حذف مفهرس موجود.
deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)	حذف مجموعة مهارات موجودة.
getDataSourceConnection(string, OperationOptions)	استرداد معلومات حول مصدر البيانات
getIndexer(string, OperationOptions)	استرداد معلومات حول مفهرس.
getIndexerStatus(string, OperationOptions)	إرجاع الحالة الحالية ومحفوظات التنفيذ للمفهرس.
getSkillset(string, OperationOptions)	استرداد معلومات حول مجموعة المهارات.
listDataSourceConnections(OperationOptions)	استرداد قائمة بمصادر البيانات الموجودة في الخدمة.
listDataSourceConnectionsNames(OperationOptions)	استرداد قائمة بأسماء مصادر البيانات الموجودة في الخدمة.
listIndexers(OperationOptions)	استرداد قائمة المفهرسات الموجودة في الخدمة.
listIndexersNames(OperationOptions)	استرداد قائمة بأسماء المفهرسات الموجودة في الخدمة.
listSkillsets(OperationOptions)	استرداد قائمة ب Skillsets الموجودة في الخدمة.
listSkillsetsNames(OperationOptions)	استرداد قائمة بأسماء Skillsets الموجودة في الخدمة.
resetIndexer(string, OperationOptions)	إعادة تعيين حالة تعقب التغييرات المقترنة بمفهرس.
runIndexer(string, OperationOptions)	تشغيل مفهرس عند الطلب.

تفاصيل المنشئ

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

إنشاء مثيل SearchIndexerClient.

استخدام المثال:

const { SearchIndexerClient, AzureKeyCredential } = require("@azure/search-documents");

const client = new SearchIndexerClient(
  "<endpoint>",
  new AzureKeyCredential("<Admin Key>");
);

new SearchIndexerClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexerClientOptions)

المعلمات

endpoint

string

نقطة نهاية خدمة البحث

credential

KeyCredential | TokenCredential

يستخدم لمصادقة الطلبات إلى الخدمة.

options

SearchIndexerClientOptions

يستخدم لتكوين عميل البحث.

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

apiVersion

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

use {@Link serviceVersion} instead

إصدار واجهة برمجة التطبيقات لاستخدامه عند الاتصال بالخدمة.

apiVersion: string

قيمة الخاصية

string

endpoint

نقطة نهاية خدمة البحث

endpoint: string

قيمة الخاصية

string

serviceVersion

إصدار واجهة برمجة التطبيقات لاستخدامه عند الاتصال بالخدمة.

serviceVersion: string

قيمة الخاصية

string

تفاصيل الأسلوب

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)

إنشاء مصدر بيانات جديد في خدمة بحث.

function createDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>

المعلمات

dataSourceConnection

SearchIndexerDataSourceConnection

تعريف مصدر البيانات المراد إنشاؤه في خدمة بحث.

options

OperationOptions

وسيطات اختيارية إضافية.

المرتجعات

Promise<SearchIndexerDataSourceConnection>

createIndexer(SearchIndexer, OperationOptions)

إنشاء مفهرس جديد في خدمة بحث.

function createIndexer(indexer: SearchIndexer, options?: OperationOptions): Promise<SearchIndexer>

المعلمات

indexer

SearchIndexer

تعريف المفهرس المراد إنشاؤه في خدمة بحث.

options

OperationOptions

وسيطات اختيارية إضافية.

المرتجعات

Promise<SearchIndexer>

createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)

إنشاء مصدر بيانات جديد أو تعديل مصدر بيانات موجود.

function createOrUpdateDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: CreateorUpdateDataSourceConnectionOptions): Promise<SearchIndexerDataSourceConnection>

المعلمات

dataSourceConnection

SearchIndexerDataSourceConnection

المعلومات التي تصف مصدر البيانات المراد إنشاؤه/تحديثه.

options

CreateorUpdateDataSourceConnectionOptions

وسيطات اختيارية إضافية.

المرتجعات

Promise<SearchIndexerDataSourceConnection>

createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)

إنشاء مفهرس جديد أو تعديل مفهرس موجود.

function createOrUpdateIndexer(indexer: SearchIndexer, options?: CreateorUpdateIndexerOptions): Promise<SearchIndexer>

المعلمات

indexer

SearchIndexer

المعلومات التي تصف المفهرس المراد إنشاؤه/تحديثه.

options

CreateorUpdateIndexerOptions

وسيطات اختيارية إضافية.

المرتجعات

Promise<SearchIndexer>

createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)

إنشاء مجموعة مهارات جديدة أو تعديل مجموعة موجودة.

function createOrUpdateSkillset(skillset: SearchIndexerSkillset, options?: CreateOrUpdateSkillsetOptions): Promise<SearchIndexerSkillset>

المعلمات

skillset

SearchIndexerSkillset

المعلومات التي تصف الفهرس الذي سيتم إنشاؤه.

options

CreateOrUpdateSkillsetOptions

وسيطات اختيارية إضافية.

المرتجعات

Promise<SearchIndexerSkillset>

createSkillset(SearchIndexerSkillset, OperationOptions)

إنشاء مجموعة مهارات جديدة في خدمة بحث.

function createSkillset(skillset: SearchIndexerSkillset, options?: OperationOptions): Promise<SearchIndexerSkillset>

المعلمات

skillset

SearchIndexerSkillset

مجموعة المهارات التي تحتوي على مهارة واحدة أو أكثر لإنشائها في خدمة البحث.

options

OperationOptions

وسيطات اختيارية إضافية.

المرتجعات

Promise<SearchIndexerSkillset>

deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)

حذف مصدر بيانات موجود.

function deleteDataSourceConnection(dataSourceConnection: string | SearchIndexerDataSourceConnection, options?: DeleteDataSourceConnectionOptions): Promise<void>

المعلمات

dataSourceConnection

string | SearchIndexerDataSourceConnection

options

DeleteDataSourceConnectionOptions

وسيطات اختيارية إضافية.

المرتجعات

Promise<void>

deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)

حذف مفهرس موجود.

function deleteIndexer(indexer: string | SearchIndexer, options?: DeleteIndexerOptions): Promise<void>

المعلمات

indexer

string | SearchIndexer

المفهرس/اسم المفهرس المراد حذفه.

options

DeleteIndexerOptions

وسيطات اختيارية إضافية.

المرتجعات

Promise<void>

deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)

حذف مجموعة مهارات موجودة.

function deleteSkillset(skillset: string | SearchIndexerSkillset, options?: DeleteSkillsetOptions): Promise<void>

المعلمات

skillset

string | SearchIndexerSkillset

مجموعة المهارات/اسم مجموعة المهارات المراد حذفها.

options

DeleteSkillsetOptions

وسيطات اختيارية إضافية.

المرتجعات

Promise<void>

getDataSourceConnection(string, OperationOptions)

استرداد معلومات حول مصدر البيانات

function getDataSourceConnection(dataSourceConnectionName: string, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>

المعلمات

dataSourceConnectionName

string

options

OperationOptions

وسيطات اختيارية إضافية

المرتجعات

Promise<SearchIndexerDataSourceConnection>

getIndexer(string, OperationOptions)

استرداد معلومات حول مفهرس.

function getIndexer(indexerName: string, options?: OperationOptions): Promise<SearchIndexer>

المعلمات

indexerName

string

اسم المفهرس.

options

OperationOptions

وسيطات اختيارية إضافية.

المرتجعات

Promise<SearchIndexer>

getIndexerStatus(string, OperationOptions)

إرجاع الحالة الحالية ومحفوظات التنفيذ للمفهرس.

function getIndexerStatus(indexerName: string, options?: OperationOptions): Promise<SearchIndexerStatus>

المعلمات

indexerName

string

اسم المفهرس.

options

OperationOptions

وسيطات اختيارية إضافية.

المرتجعات

Promise<SearchIndexerStatus>

getSkillset(string, OperationOptions)

استرداد معلومات حول مجموعة المهارات.

function getSkillset(skillsetName: string, options?: OperationOptions): Promise<SearchIndexerSkillset>

المعلمات

skillsetName

string

options

OperationOptions

وسيطات اختيارية إضافية.

المرتجعات

Promise<SearchIndexerSkillset>

listDataSourceConnections(OperationOptions)

استرداد قائمة بمصادر البيانات الموجودة في الخدمة.

function listDataSourceConnections(options?: OperationOptions): Promise<SearchIndexerDataSourceConnection[]>

المعلمات

options

OperationOptions

خيارات لعملية مفهرسات القائمة.

المرتجعات

Promise<SearchIndexerDataSourceConnection[]>

listDataSourceConnectionsNames(OperationOptions)

استرداد قائمة بأسماء مصادر البيانات الموجودة في الخدمة.

function listDataSourceConnectionsNames(options?: OperationOptions): Promise<string[]>

المعلمات

options

OperationOptions

خيارات لعملية مفهرسات القائمة.

المرتجعات

Promise<string[]>

listIndexers(OperationOptions)

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

function listIndexers(options?: OperationOptions): Promise<SearchIndexer[]>

المعلمات

options

OperationOptions

خيارات لعملية مفهرسات القائمة.

المرتجعات

Promise<SearchIndexer[]>

listIndexersNames(OperationOptions)

استرداد قائمة بأسماء المفهرسات الموجودة في الخدمة.

function listIndexersNames(options?: OperationOptions): Promise<string[]>

المعلمات

options

OperationOptions

خيارات لعملية مفهرسات القائمة.

المرتجعات

Promise<string[]>

listSkillsets(OperationOptions)

استرداد قائمة ب Skillsets الموجودة في الخدمة.

function listSkillsets(options?: OperationOptions): Promise<SearchIndexerSkillset[]>

المعلمات

options

OperationOptions

خيارات لقائمة عملية Skillsets.

المرتجعات

Promise<SearchIndexerSkillset[]>

listSkillsetsNames(OperationOptions)

استرداد قائمة بأسماء Skillsets الموجودة في الخدمة.

function listSkillsetsNames(options?: OperationOptions): Promise<string[]>

المعلمات

options

OperationOptions

خيارات لقائمة عملية Skillsets.

المرتجعات

Promise<string[]>

resetIndexer(string, OperationOptions)

إعادة تعيين حالة تعقب التغييرات المقترنة بمفهرس.

function resetIndexer(indexerName: string, options?: OperationOptions): Promise<void>

المعلمات

indexerName

string

اسم المفهرس المراد إعادة تعيينه.

options

OperationOptions

وسيطات اختيارية إضافية.

المرتجعات

Promise<void>

runIndexer(string, OperationOptions)

تشغيل مفهرس عند الطلب.

function runIndexer(indexerName: string, options?: OperationOptions): Promise<void>

المعلمات

indexerName

string

اسم المفهرس المراد تشغيله.

options

OperationOptions

وسيطات اختيارية إضافية.

المرتجعات

Promise<void>