SearchIndexClient class
فئة لتنفيذ عمليات لإدارة (إنشاء، تحديث، قائمة/حذف) الفهارس، & المرادفات.
المنشئون
| Search |
إنشاء مثيل SearchIndexClient. مثال على الاستخدام: |
الخصائص
| api |
إصدار واجهة برمجة التطبيقات لاستخدامه عند الاتصال بالخدمة. |
| endpoint | نقطة نهاية خدمة البحث |
| pipeline | مرجع إلى مسار HTTP الداخلي للاستخدام مع الطلبات الأولية |
| service |
إصدار واجهة برمجة التطبيقات لاستخدامه عند الاتصال بالخدمة. |
الأساليب
تفاصيل المنشئ
SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)
إنشاء مثيل SearchIndexClient.
مثال على الاستخدام:
import { SearchIndexClient, AzureKeyCredential } from "@azure/search-documents";
const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));
new SearchIndexClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexClientOptions)المعلمات
- endpoint
-
string
نقطة نهاية خدمة البحث
- credential
يستخدم لمصادقة الطلبات إلى الخدمة.
- options
- SearchIndexClientOptions
يستخدم لتكوين عميل فهرس البحث.
تفاصيل الخاصية
apiVersion
تحذير
واجهة برمجة التطبيقات هذه مهملة الآن.
use {@Link serviceVersion} instead
إصدار واجهة برمجة التطبيقات لاستخدامه عند الاتصال بالخدمة.
apiVersion: stringقيمة الخاصية
string
endpoint
نقطة نهاية خدمة البحث
endpoint: stringقيمة الخاصية
string
pipeline
serviceVersion
إصدار واجهة برمجة التطبيقات لاستخدامه عند الاتصال بالخدمة.
serviceVersion: stringقيمة الخاصية
string
تفاصيل الأسلوب
analyzeText(string, AnalyzeTextOptions)
استدعاء محلل أو رمز مميز يدويا على النص المقدم.
function analyzeText(indexName: string, options: AnalyzeTextOptions): Promise<AnalyzeResult>المعلمات
- indexName
-
string
اسم الفهرس الذي يحتوي على الحقل المراد تحليله
- options
- AnalyzeTextOptions
وسيطات إضافية
المرتجعات
Promise<AnalyzeResult>
createAlias(SearchAlias, OperationOptions)
إنشاء اسم بحث بديل جديد.
function createAlias(alias: SearchAlias, options?: OperationOptions): Promise<SearchAlias>المعلمات
- alias
- SearchAlias
تعريف الاسم المستعار المراد إنشاؤه.
- options
- OperationOptions
معلمات الخيارات.
المرتجعات
Promise<SearchAlias>
createIndex(SearchIndex, OperationOptions)
إنشاء فهرس جديد.
function createIndex(index: SearchIndex, options?: OperationOptions): Promise<SearchIndex>المعلمات
- index
- SearchIndex
المعلومات التي تصف الفهرس الذي سيتم إنشاؤه.
- options
- OperationOptions
وسيطات اختيارية إضافية.
المرتجعات
Promise<SearchIndex>
createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)
يخلق قاعدة معرفية جديدة.
function createKnowledgeBase(knowledgeBase: KnowledgeBase, options?: CreateKnowledgeBaseOptions): Promise<KnowledgeBase>المعلمات
- knowledgeBase
- KnowledgeBase
تعريف قاعدة المعرفة التي يجب إنشاؤها.
- options
- CreateKnowledgeBaseOptions
معلمات الخيارات.
المرتجعات
Promise<KnowledgeBase>
createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)
إنشاء مصدر معرفة جديد.
function createKnowledgeSource(knowledgeSource: KnowledgeSource, options?: CreateKnowledgeSourceOptions): Promise<KnowledgeSource>المعلمات
- knowledgeSource
- KnowledgeSource
تعريف مصدر المعرفة المراد إنشاؤه.
- options
- CreateKnowledgeSourceOptions
معلمات الخيارات.
المرتجعات
Promise<KnowledgeSource>
createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)
إنشاء اسم مستعار جديد للبحث أو تحديث اسم مستعار إذا كان موجودا بالفعل.
function createOrUpdateAlias(alias: SearchAlias, options?: CreateOrUpdateAliasOptions): Promise<SearchAlias>المعلمات
- alias
- SearchAlias
تعريف الاسم المستعار المراد إنشاؤه أو تحديثه.
- options
- CreateOrUpdateAliasOptions
معلمات الخيارات.
المرتجعات
Promise<SearchAlias>
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)
إنشاء فهرس جديد أو تعديل فهرس موجود.
function createOrUpdateIndex(index: SearchIndex, options?: CreateOrUpdateIndexOptions): Promise<SearchIndex>المعلمات
- index
- SearchIndex
المعلومات التي تصف الفهرس الذي سيتم إنشاؤه.
- options
- CreateOrUpdateIndexOptions
وسيطات اختيارية إضافية.
المرتجعات
Promise<SearchIndex>
createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)
ينشئ قاعدة معرفة جديدة أو يحدث قاعدة معرفة إذا كانت موجودة بالفعل.
function createOrUpdateKnowledgeBase(knowledgeBaseName: string, knowledgeBase: KnowledgeBase, options?: CreateOrUpdateKnowledgeBaseOptions): Promise<KnowledgeBase>المعلمات
- knowledgeBaseName
-
string
اسم قاعدة المعرفة التي يجب إنشاؤها أو تحديثها.
- knowledgeBase
- KnowledgeBase
تعريف قاعدة المعرفة التي يجب إنشاؤها أو تحديثها.
معلمات الخيارات.
المرتجعات
Promise<KnowledgeBase>
createOrUpdateKnowledgeSource(KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)
function createOrUpdateKnowledgeSource(knowledgeSource: KnowledgeSource, options?: CreateOrUpdateKnowledgeSourceOptions): Promise<KnowledgeSource>المعلمات
- knowledgeSource
- KnowledgeSource
المرتجعات
Promise<KnowledgeSource>
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)
إنشاء خريطة مرادف جديدة أو تعديل مرادف موجود.
function createOrUpdateSynonymMap(synonymMap: SynonymMap, options?: CreateOrUpdateSynonymMapOptions): Promise<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>
deleteAlias(SearchAlias, DeleteAliasOptions)
حذف اسم مستعار للبحث والربط المرتبط به بفهرس. هذه العملية دائمة ، مع عدم وجود خيار استرداد. لم تمس هذه العملية الفهرس المعين.
function deleteAlias(alias: SearchAlias, options?: DeleteAliasOptions): Promise<void>المعلمات
- alias
- SearchAlias
الاسم المستعار المطلوب حذفه.
- options
- DeleteAliasOptions
وسيطات اختيارية إضافية.
المرتجعات
Promise<void>
deleteAlias(string, DeleteAliasOptions)
حذف اسم مستعار للبحث والربط المرتبط به بفهرس. هذه العملية دائمة ، مع عدم وجود خيار استرداد. لم تمس هذه العملية الفهرس المعين.
function deleteAlias(aliasName: string, options?: DeleteAliasOptions): Promise<void>المعلمات
- aliasName
-
string
اسم الاسم المستعار المراد حذفه.
- options
- DeleteAliasOptions
وسيطات اختيارية إضافية.
المرتجعات
Promise<void>
deleteIndex(SearchIndex, DeleteIndexOptions)
حذف فهرس موجود.
function deleteIndex(index: SearchIndex, options?: DeleteIndexOptions): Promise<void>المعلمات
- index
- SearchIndex
الفهرس المراد حذفه.
- options
- DeleteIndexOptions
وسيطات اختيارية إضافية.
المرتجعات
Promise<void>
deleteIndex(string, DeleteIndexOptions)
حذف فهرس موجود.
function deleteIndex(indexName: string, options?: DeleteIndexOptions): Promise<void>المعلمات
- indexName
-
string
اسم الفهرس المراد حذفه.
- options
- DeleteIndexOptions
وسيطات اختيارية إضافية.
المرتجعات
Promise<void>
deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)
يحذف قاعدة معرفة موجودة.
function deleteKnowledgeBase(knowledgeBase: KnowledgeBase, options?: DeleteKnowledgeBaseOptions): Promise<void>المعلمات
- knowledgeBase
- KnowledgeBase
قاعدة المعرفة التي يجب حذفها.
- options
- DeleteKnowledgeBaseOptions
معلمات الخيارات.
المرتجعات
Promise<void>
deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)
يحذف قاعدة معرفة موجودة.
function deleteKnowledgeBase(knowledgeBaseName: string, options?: DeleteKnowledgeBaseOptions): Promise<void>المعلمات
- knowledgeBaseName
-
string
اسم قاعدة المعرفة التي يجب حذفها.
- options
- DeleteKnowledgeBaseOptions
معلمات الخيارات.
المرتجعات
Promise<void>
deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)
حذف مصدر موجود.
function deleteKnowledgeSource(source: KnowledgeSource, options?: DeleteKnowledgeSourceOptions): Promise<void>المعلمات
- source
- KnowledgeSource
مصدر المعرفة المراد حذفه.
- options
- DeleteKnowledgeSourceOptions
معلمات الخيارات.
المرتجعات
Promise<void>
deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)
حذف مصدر موجود.
function deleteKnowledgeSource(sourceName: string, options?: DeleteKnowledgeSourceOptions): Promise<void>المعلمات
- sourceName
-
string
اسم مصدر المعرفة المراد حذفه.
- options
- DeleteKnowledgeSourceOptions
معلمات الخيارات.
المرتجعات
Promise<void>
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)
حذف خريطة مرادف موجودة.
function deleteSynonymMap(synonymMap: string | SynonymMap, options?: DeleteSynonymMapOptions): Promise<void>المعلمات
- synonymMap
-
string | SynonymMap
- options
- DeleteSynonymMapOptions
وسيطات اختيارية إضافية.
المرتجعات
Promise<void>
getAlias(string, OperationOptions)
يسترجع تعريف الاسم المستعار.
function getAlias(aliasName: string, options?: OperationOptions): Promise<SearchAlias>المعلمات
- aliasName
-
string
اسم الاسم المستعار المراد استرداده.
- options
- OperationOptions
معلمات الخيارات.
المرتجعات
Promise<SearchAlias>
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>
getKnowledgeBase(string, GetKnowledgeBaseOptions)
يسترجع تعريف قاعدة المعرفة.
function getKnowledgeBase(knowledgeBaseName: string, options?: GetKnowledgeBaseOptions): Promise<KnowledgeBase>المعلمات
- knowledgeBaseName
-
string
اسم قاعدة المعرفة التي يجب استرجاعها.
- options
- GetKnowledgeBaseOptions
معلمات الخيارات.
المرتجعات
Promise<KnowledgeBase>
getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)
استرداد KnowledgeRetrievalClient المقابل ل SearchIndexClient هذا
function getKnowledgeRetrievalClient(knowledgeBaseName: string, options?: KnowledgeRetrievalClientOptions): KnowledgeRetrievalClientالمعلمات
- knowledgeBaseName
-
string
اسم قاعدة المعرفة
- options
- KnowledgeRetrievalClientOptions
KnowledgeRetrievalخيارات العميل
المرتجعات
getKnowledgeSource(string, GetKnowledgeSourceOptions)
استرداد تعريف مصدر المعرفة.
function getKnowledgeSource(sourceName: string, options?: GetKnowledgeSourceOptions): Promise<KnowledgeSource>المعلمات
- sourceName
-
string
اسم مصدر المعرفة المراد استرداده.
- options
- GetKnowledgeSourceOptions
معلمات الخيارات.
المرتجعات
Promise<KnowledgeSource>
getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)
يعيد الحالة الحالية وتاريخ التزامن لمصدر معرفة.
function getKnowledgeSourceStatus(sourceName: string, options?: GetKnowledgeSourceStatusOptions): Promise<KnowledgeSourceStatus>المعلمات
- sourceName
-
string
اسم مصدر المعرفة الذي يجب استرجاع الحالة من أجله.
- options
- GetKnowledgeSourceStatusOptions
معلمات الخيارات.
المرتجعات
Promise<KnowledgeSourceStatus>
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>
listAliases(OperationOptions)
يسرد جميع الأسماء المستعارة المتاحة لخدمة البحث.
function listAliases(options?: OperationOptions): AliasIteratorالمعلمات
- options
- OperationOptions
معلمات الخيارات.
المرتجعات
listIndexes(OperationOptions)
استرداد قائمة الفهارس الموجودة في الخدمة.
function listIndexes(options?: OperationOptions): IndexIteratorالمعلمات
- options
- OperationOptions
خيارات لعملية فهرس القائمة.
المرتجعات
listIndexesNames(OperationOptions)
استرداد قائمة بأسماء الفهارس الموجودة في الخدمة.
function listIndexesNames(options?: OperationOptions): IndexNameIteratorالمعلمات
- options
- OperationOptions
خيارات لعملية فهرس القائمة.
المرتجعات
listKnowledgeBases(ListKnowledgeBasesOptions)
يسترجع قائمة بقواعد المعرفة الموجودة في الخدمة.
function listKnowledgeBases(options?: ListKnowledgeBasesOptions): KnowledgeBaseIteratorالمعلمات
- options
- ListKnowledgeBasesOptions
خيارات لتشغيل قواعد المعرفة القائمة.
المرتجعات
listKnowledgeSources(ListKnowledgeSourcesOptions)
استرداد قائمة بمصادر المعرفة الموجودة في الخدمة.
function listKnowledgeSources(options?: ListKnowledgeSourcesOptions): KnowledgeSourceIteratorالمعلمات
- options
- ListKnowledgeSourcesOptions
خيارات لعملية قائمة مصادر المعرفة.
المرتجعات
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[]>