SearchIndexClient الفصل
عميل للتفاعل مع فهرس خدمة بحث Azure.
- توريث
-
azure.search.documents._headers_mixin.HeadersMixinSearchIndexClient
الدالمنشئ
SearchIndexClient(endpoint: str, credential: AzureKeyCredential | TokenCredential, **kwargs: Any)
المعلمات
- api_version
- str
إصدار Search API لاستخدامه للطلبات.
- audience
- str
تعيين الجمهور لاستخدامه للمصادقة مع Azure Active Directory (AAD). لا يتم اعتبار الجمهور عند استخدام مفتاح مشترك. إذا لم يتم توفير الجمهور، فسيتم افتراض جمهور السحابة العامة.
الأساليب
analyze_text |
يوضح كيفية تقسيم المحلل النص إلى رموز مميزة. |
close |
SearchIndexClient أغلق جلسة العمل. |
create_index |
إنشاء فهرس بحث جديد. |
create_or_update_index |
إنشاء فهرس بحث جديد أو تحديث فهرس إذا كان موجودا بالفعل. |
create_or_update_synonym_map |
إنشاء خريطة مرادف جديدة في خدمة البحث Azure، أو تحديث مخطط موجود. |
create_synonym_map |
إنشاء خريطة مرادف جديدة في Azure خدمة البحث |
delete_index |
حذف فهرس بحث وجميع المستندات التي يحتوي عليها. يجب توفير النموذج بدلا من الاسم لاستخدام شروط الوصول. |
delete_synonym_map |
حذف خريطة مرادف مسماة في خدمة البحث Azure. لاستخدام شروط الوصول، يجب توفير نموذج SynonymMap بدلا من الاسم. يكفي توفير اسم خريطة المرادفات للحذف دون قيد أو شرط. |
get_index | |
get_index_statistics |
إرجاع إحصائيات الفهرس المحدد، بما في ذلك عدد المستندات واستخدام التخزين. |
get_search_client |
إرجاع عميل لإجراء عمليات على البحث |
get_service_statistics |
احصل على إحصائيات مستوى الخدمة لخدمة البحث. |
get_synonym_map |
استرداد خريطة مرادف مسماة في Azure خدمة البحث |
get_synonym_map_names |
سرد أسماء خريطة المرادفات في خدمة البحث Azure. |
get_synonym_maps |
سرد خرائط المرادفات في خدمة البحث Azure. |
list_index_names |
سرد أسماء الفهرس في خدمة البحث Azure. |
list_indexes |
سرد الفهارس في خدمة البحث Azure. |
analyze_text
يوضح كيفية تقسيم المحلل النص إلى رموز مميزة.
analyze_text(index_name: str, analyze_request: AnalyzeTextOptions, **kwargs: Any) -> AnalyzeResult
المعلمات
المرتجعات
AnalyzeResult
نوع الإرجاع
استثناءات
أمثلة
تحليل النص
from azure.core.credentials import AzureKeyCredential
from azure.search.documents.indexes import SearchIndexClient
from azure.search.documents.indexes.models import AnalyzeTextOptions
client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
analyze_request = AnalyzeTextOptions(text="One's <two/>", analyzer_name="standard.lucene")
result = client.analyze_text(index_name, analyze_request)
print(result.as_dict())
close
create_index
إنشاء فهرس بحث جديد.
create_index(index: SearchIndex, **kwargs: Any) -> SearchIndex
المعلمات
المرتجعات
الفهرس الذي تم إنشاؤه
نوع الإرجاع
استثناءات
أمثلة
إنشاء فهرس جديد.
client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
name = "hotels"
fields = [
SimpleField(name="hotelId", type=SearchFieldDataType.String, key=True),
SimpleField(name="baseRate", type=SearchFieldDataType.Double),
SearchableField(name="description", type=SearchFieldDataType.String, collection=True),
ComplexField(
name="address",
fields=[
SimpleField(name="streetAddress", type=SearchFieldDataType.String),
SimpleField(name="city", type=SearchFieldDataType.String),
],
collection=True,
),
]
cors_options = CorsOptions(allowed_origins=["*"], max_age_in_seconds=60)
scoring_profiles: List[ScoringProfile] = []
index = SearchIndex(name=name, fields=fields, scoring_profiles=scoring_profiles, cors_options=cors_options)
result = client.create_index(index)
create_or_update_index
إنشاء فهرس بحث جديد أو تحديث فهرس إذا كان موجودا بالفعل.
create_or_update_index(index: SearchIndex, allow_index_downtime: bool | None = None, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndex
المعلمات
- allow_index_downtime
- bool
يسمح بإضافة المحللات الجديدة أو الرموز المميزة أو عوامل تصفية الرمز المميز أو عوامل تصفية الأحرف إلى فهرس عن طريق أخذ الفهرس دون اتصال لبضع ثوان على الأقل. يؤدي هذا مؤقتا إلى فشل طلبات الفهرسة والاستعلام. يمكن أن يضعف أداء الفهرس وكتابته لعدة دقائق بعد تحديث الفهرس، أو أطول للفهارس الكبيرة جدا.
- match_condition
- MatchConditions
شرط المطابقة لاستخدامه على etag
المرتجعات
الفهرس الذي تم إنشاؤه أو تحديثه
نوع الإرجاع
استثناءات
أمثلة
تحديث فهرس.
client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
name = "hotels"
fields = [
SimpleField(name="hotelId", type=SearchFieldDataType.String, key=True),
SimpleField(name="baseRate", type=SearchFieldDataType.Double),
SearchableField(name="description", type=SearchFieldDataType.String, collection=True),
SearchableField(name="hotelName", type=SearchFieldDataType.String),
ComplexField(
name="address",
fields=[
SimpleField(name="streetAddress", type=SearchFieldDataType.String),
SimpleField(name="city", type=SearchFieldDataType.String),
SimpleField(name="state", type=SearchFieldDataType.String),
],
collection=True,
),
]
cors_options = CorsOptions(allowed_origins=["*"], max_age_in_seconds=60)
scoring_profile = ScoringProfile(name="MyProfile")
scoring_profiles = []
scoring_profiles.append(scoring_profile)
index = SearchIndex(name=name, fields=fields, scoring_profiles=scoring_profiles, cors_options=cors_options)
result = client.create_or_update_index(index=index)
create_or_update_synonym_map
إنشاء خريطة مرادف جديدة في خدمة البحث Azure، أو تحديث مخطط موجود.
create_or_update_synonym_map(synonym_map: SynonymMap, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SynonymMap
المعلمات
- match_condition
- MatchConditions
شرط المطابقة لاستخدامه على etag
المرتجعات
خريطة المرادف التي تم إنشاؤها أو تحديثها
نوع الإرجاع
استثناءات
create_synonym_map
إنشاء خريطة مرادف جديدة في Azure خدمة البحث
create_synonym_map(synonym_map: SynonymMap, **kwargs: Any) -> SynonymMap
المعلمات
المرتجعات
خريطة المرادفات التي تم إنشاؤها
نوع الإرجاع
استثناءات
أمثلة
إنشاء خريطة مرادف
synonyms = [
"USA, United States, United States of America",
"Washington, Wash. => WA",
]
synonym_map = SynonymMap(name="test-syn-map", synonyms=synonyms)
result = client.create_synonym_map(synonym_map)
print("Create new Synonym Map 'test-syn-map succeeded")
delete_index
حذف فهرس بحث وجميع المستندات التي يحتوي عليها. يجب توفير النموذج بدلا من الاسم لاستخدام شروط الوصول.
delete_index(index: str | SearchIndex, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None
المعلمات
- match_condition
- MatchConditions
شرط المطابقة لاستخدامه على etag
استثناءات
أمثلة
حذف فهرس.
client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
name = "hotels"
client.delete_index(name)
delete_synonym_map
حذف خريطة مرادف مسماة في خدمة البحث Azure. لاستخدام شروط الوصول، يجب توفير نموذج SynonymMap بدلا من الاسم. يكفي توفير اسم خريطة المرادفات للحذف دون قيد أو شرط.
delete_synonym_map(synonym_map: str | SynonymMap, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None
المعلمات
- match_condition
- MatchConditions
شرط المطابقة لاستخدامه على etag
المرتجعات
بلا
نوع الإرجاع
استثناءات
أمثلة
حذف خريطة مرادف
client.delete_synonym_map("test-syn-map")
print("Synonym Map 'test-syn-map' deleted")
get_index
get_index(name: str, **kwargs: Any) -> SearchIndex
المعلمات
المرتجعات
كائن SearchIndex
نوع الإرجاع
استثناءات
أمثلة
الحصول على فهرس.
client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
name = "hotels"
result = client.get_index(name)
get_index_statistics
إرجاع إحصائيات الفهرس المحدد، بما في ذلك عدد المستندات واستخدام التخزين.
get_index_statistics(index_name: str, **kwargs: Any) -> MutableMapping[str, Any]
المعلمات
المرتجعات
إحصائيات الفهرس المحدد، بما في ذلك عدد المستندات واستخدام التخزين.
نوع الإرجاع
استثناءات
get_search_client
إرجاع عميل لإجراء عمليات على البحث
get_search_client(index_name: str, **kwargs: Any) -> SearchClient
المعلمات
المرتجعات
كائن SearchClient
نوع الإرجاع
استثناءات
get_service_statistics
احصل على إحصائيات مستوى الخدمة لخدمة البحث.
get_service_statistics(**kwargs: Any) -> MutableMapping[str, Any]
المرتجعات
نتيجة إحصائيات الخدمة.
نوع الإرجاع
استثناءات
get_synonym_map
استرداد خريطة مرادف مسماة في Azure خدمة البحث
get_synonym_map(name: str, **kwargs: Any) -> SynonymMap
المعلمات
المرتجعات
خريطة المرادفات المستردة
نوع الإرجاع
استثناءات
أمثلة
الحصول على خريطة المرادفات
result = client.get_synonym_map("test-syn-map")
print("Retrived Synonym Map 'test-syn-map' with synonyms")
for syn in result.synonyms:
print(" {}".format(syn))
get_synonym_map_names
سرد أسماء خريطة المرادفات في خدمة البحث Azure.
get_synonym_map_names(**kwargs: Any) -> List[str]
المرتجعات
قائمة خرائط المرادفات
نوع الإرجاع
استثناءات
get_synonym_maps
سرد خرائط المرادفات في خدمة البحث Azure.
get_synonym_maps(*, select: List[str] | None = None, **kwargs) -> List[SynonymMap]
المعلمات
تحديد خصائص المستوى الأعلى لمستوى مجموعات المهارات المراد استردادها. تم تحديده كقوائم بأسماء خصائص JSON، أو '*' لجميع الخصائص. الافتراضي هو كافة الخصائص.
المرتجعات
قائمة خرائط المرادفات
نوع الإرجاع
استثناءات
أمثلة
قائمة خرائط المرادفات
result = client.get_synonym_maps()
names = [x.name for x in result]
print("Found {} Synonym Maps in the service: {}".format(len(result), ", ".join(names)))
list_index_names
سرد أسماء الفهرس في خدمة البحث Azure.
list_index_names(**kwargs: Any) -> ItemPaged[str]
المرتجعات
قائمة بأسماء الفهرس
نوع الإرجاع
استثناءات
list_indexes
سرد الفهارس في خدمة البحث Azure.
list_indexes(*, select: List[str] | None = None, **kwargs: Any) -> ItemPaged[SearchIndex]
المعلمات
تحديد خصائص المستوى الأعلى لمستوى مجموعات المهارات المراد استردادها. تم تحديده كقوائم بأسماء خصائص JSON، أو '*' لجميع الخصائص. الافتراضي هو كافة الخصائص.
المرتجعات
قائمة الفهارس
نوع الإرجاع
استثناءات
Azure SDK for Python