SearchIndexClient class

الحزمة:

@azure/search-documents

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

المنشئون

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

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

الخصائص

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

الأساليب

analyzeText(string, AnalyzeTextOptions)	استدعاء محلل أو رمز مميز يدويا على النص المقدم.
createIndex(SearchIndex, OperationOptions)	إنشاء فهرس جديد.
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)	إنشاء فهرس جديد أو تعديل فهرس موجود.
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)	إنشاء SynonymMap جديد أو تعديل مرادف موجود.
createSynonymMap(SynonymMap, OperationOptions)	إنشاء SynonymMap جديد في خدمة بحث.
deleteIndex(string | SearchIndex, DeleteIndexOptions)	حذف فهرس موجود.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	حذف SynonymMap موجود.
getIndex(string, OperationOptions)	استرداد معلومات حول فهرس.
getIndexStatistics(string, OperationOptions)	استرداد إحصائيات حول فهرس، مثل عدد المستندات وحجم تخزين الفهرس.
getSearchClient<TModel>(string, SearchClientOptions)	استرداد SearchClient المطابق لهذا SearchIndexClient
getServiceStatistics(OperationOptions)	استرداد إحصائيات حول الخدمة، مثل عدد المستندات والفهرس وما إلى ذلك.
getSynonymMap(string, OperationOptions)	استرداد معلومات حول SynonymMap.
listIndexes(OperationOptions)	استرداد قائمة الفهارس الموجودة في الخدمة.
listIndexesNames(OperationOptions)	استرداد قائمة بأسماء الفهارس الموجودة في الخدمة.
listSynonymMaps(OperationOptions)	استرداد قائمة ب SynonymMaps الموجودة في الخدمة.
listSynonymMapsNames(OperationOptions)	استرداد قائمة بأسماء SynonymMaps الموجودة في الخدمة.

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

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

إنشاء مثيل SearchIndexClient.

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

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

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

new SearchIndexClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexClientOptions)

المعلمات

endpoint

string

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

credential

KeyCredential | TokenCredential

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

options

SearchIndexClientOptions

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

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

apiVersion

تحذير

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

use {@Link serviceVersion} instead

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

apiVersion: string

قيمة الخاصية

string

endpoint

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

endpoint: string

قيمة الخاصية

string

serviceVersion

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

serviceVersion: string

قيمة الخاصية

string

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

analyzeText(string, AnalyzeTextOptions)

استدعاء محلل أو رمز مميز يدويا على النص المقدم.

function analyzeText(indexName: string, options: AnalyzeTextOptions): Promise<AnalyzeResult>

المعلمات

indexName

string

اسم الفهرس الذي يحتوي على الحقل المراد تحليله

options

AnalyzeTextOptions

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

المرتجعات

Promise<AnalyzeResult>

createIndex(SearchIndex, OperationOptions)

إنشاء فهرس جديد.

function createIndex(index: SearchIndex, options?: OperationOptions): Promise<SearchIndex>

المعلمات

index

SearchIndex

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

options

OperationOptions

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

المرتجعات

Promise<SearchIndex>

createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)

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

function createOrUpdateIndex(index: SearchIndex, options?: CreateOrUpdateIndexOptions): Promise<SearchIndex>

المعلمات

index

SearchIndex

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

options

CreateOrUpdateIndexOptions

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

المرتجعات

Promise<SearchIndex>

createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)

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

function createOrUpdateSynonymMap(synonymMap: SynonymMap, options?: CreateOrUpdateSynonymMapOptions): Promise<SynonymMap>

المعلمات

synonymMap

SynonymMap

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

options

CreateOrUpdateSynonymMapOptions

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

المرتجعات

Promise<SynonymMap>

createSynonymMap(SynonymMap, OperationOptions)

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

function createSynonymMap(synonymMap: SynonymMap, options?: OperationOptions): Promise<SynonymMap>

المعلمات

synonymMap

SynonymMap

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

options

OperationOptions

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

المرتجعات

Promise<SynonymMap>

deleteIndex(string | SearchIndex, DeleteIndexOptions)

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

function deleteIndex(index: string | SearchIndex, options?: DeleteIndexOptions): Promise<void>

المعلمات

index

string | SearchIndex

options

DeleteIndexOptions

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

المرتجعات

Promise<void>

deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)

حذف SynonymMap موجود.

function deleteSynonymMap(synonymMap: string | SynonymMap, options?: DeleteSynonymMapOptions): Promise<void>

المعلمات

synonymMap

string | SynonymMap

options

DeleteSynonymMapOptions

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

المرتجعات

Promise<void>

getIndex(string, OperationOptions)

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

function getIndex(indexName: string, options?: OperationOptions): Promise<SearchIndex>

المعلمات

indexName

string

اسم الفهرس.

options

OperationOptions

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

المرتجعات

Promise<SearchIndex>

getIndexStatistics(string, OperationOptions)

استرداد إحصائيات حول فهرس، مثل عدد المستندات وحجم تخزين الفهرس.

function getIndexStatistics(indexName: string, options?: OperationOptions): Promise<SearchIndexStatistics>

المعلمات

indexName

string

اسم الفهرس.

options

OperationOptions

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

المرتجعات

Promise<SearchIndexStatistics>

getSearchClient<TModel>(string, SearchClientOptions)

استرداد SearchClient المطابق لهذا SearchIndexClient

function getSearchClient<TModel>(indexName: string, options?: SearchClientOptions): SearchClient<TModel>

المعلمات

indexName

string

اسم الفهرس

options

SearchClientOptions

خيارات SearchClient

المرتجعات

SearchClient<TModel>

getServiceStatistics(OperationOptions)

استرداد إحصائيات حول الخدمة، مثل عدد المستندات والفهرس وما إلى ذلك.

function getServiceStatistics(options?: OperationOptions): Promise<SearchServiceStatistics>

المعلمات

options

OperationOptions

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

المرتجعات

Promise<SearchServiceStatistics>

getSynonymMap(string, OperationOptions)

استرداد معلومات حول SynonymMap.

function getSynonymMap(synonymMapName: string, options?: OperationOptions): Promise<SynonymMap>

المعلمات

synonymMapName

string

اسم SynonymMap.

options

OperationOptions

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

المرتجعات

Promise<SynonymMap>

listIndexes(OperationOptions)

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

function listIndexes(options?: OperationOptions): IndexIterator

المعلمات

options

OperationOptions

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

المرتجعات

IndexIterator

listIndexesNames(OperationOptions)

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

function listIndexesNames(options?: OperationOptions): IndexNameIterator

المعلمات

options

OperationOptions

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

المرتجعات

IndexNameIterator

listSynonymMaps(OperationOptions)

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

function listSynonymMaps(options?: OperationOptions): Promise<SynonymMap[]>

المعلمات

options

OperationOptions

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

المرتجعات

Promise<SynonymMap[]>

listSynonymMapsNames(OperationOptions)

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

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

المعلمات

options

OperationOptions

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

المرتجعات

Promise<string[]>