KnowledgeRetrievalClientOptions interface

الحزمة:

@azure/search-documents

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

يمتد

ClientOptions

الخصائص

audience	الجمهور الذي يجب استخدامه للمصادقة مع Azure Active Directory (AAD). لا يتم اعتبار الجمهور عند استخدام مفتاح مشترك. يمكن استخدام KnownSearchAudience بالتبادل مع الجمهور
serviceVersion	إصدار الخدمة المراد استخدامه عند الاتصال بالخدمة.

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

additionalPolicies	نهج إضافية لتضمينها في البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.
agent	خيارات لتكوين مثيل العامل للطلبات الصادرة
allowInsecureConnection	خيار للسماح باستدعاء نقاط النهاية http (غير الآمنة)
apiVersion	خيارات لإعداد apiVersion مخصص.
baseUrl	عنوان URL الأساسي للعميل
credentials	معلومات بيانات الاعتماد
endpoint	نقطة النهاية للعميل
httpClient	حدد HttpClient مخصصا عند تقديم الطلبات.
loggingOptions	خيارات لتكوين تسجيل الطلب/الاستجابة.
pipeline	خط أنابيب لاستخدامه للعميل. إذا لم يتم توفيرها، سيتم إنشاء خط أنابيب افتراضي باستخدام الخيارات المتاحة. استخدم بحذر -- عند تعيين هذا الخيار، سيتم تجاهل جميع خيارات العميل المستخدمة في إنشاء خط الأنابيب الافتراضي.
proxyOptions	خيارات لتكوين وكيل للطلبات الصادرة.
redirectOptions	خيارات لكيفية معالجة استجابات إعادة التوجيه.
retryOptions	الخيارات التي تتحكم في كيفية إعادة محاولة الطلبات الفاشلة.
telemetryOptions	خيارات لإعداد معلومات تتبع الاستخدام والتتبع الشائعة للطلبات الصادرة.
tlsOptions	خيارات لتكوين مصادقة TLS
userAgentOptions	خيارات لإضافة تفاصيل عامل المستخدم إلى الطلبات الصادرة.

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

audience

الجمهور الذي يجب استخدامه للمصادقة مع Azure Active Directory (AAD). لا يتم اعتبار الجمهور عند استخدام مفتاح مشترك. يمكن استخدام KnownSearchAudience بالتبادل مع الجمهور

audience?: string

قيمة الخاصية

string

serviceVersion

إصدار الخدمة المراد استخدامه عند الاتصال بالخدمة.

serviceVersion?: string

قيمة الخاصية

string

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

additionalPolicies

نهج إضافية لتضمينها في البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

قيمة الخاصية

AdditionalPolicyConfig[]

موروث من ClientOptions.additionalPolicies

agent

خيارات لتكوين مثيل العامل للطلبات الصادرة

agent?: Agent

قيمة الخاصية

Agent

موروث من ClientOptions.agent

allowInsecureConnection

خيار للسماح باستدعاء نقاط النهاية http (غير الآمنة)

allowInsecureConnection?: boolean

قيمة الخاصية

boolean

موروث من ClientOptions.allowInsecureConnection

apiVersion

خيارات لإعداد apiVersion مخصص.

apiVersion?: string

قيمة الخاصية

string

موروث من ClientOptions.apiVersion

baseUrl

تحذير

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

This property is deprecated and will be removed soon, please use endpoint instead

عنوان URL الأساسي للعميل

baseUrl?: string

قيمة الخاصية

string

موروث من ClientOptions.baseUrl

credentials

معلومات بيانات الاعتماد

credentials?: { apiKeyHeaderName?: string, scopes?: string[] }

قيمة الخاصية

{ apiKeyHeaderName?: string, scopes?: string[] }

موروث من ClientOptions.credentials

endpoint

نقطة النهاية للعميل

endpoint?: string

قيمة الخاصية

string

موروث من ClientOptions.endpoint

httpClient

حدد HttpClient مخصصا عند تقديم الطلبات.

httpClient?: HttpClient

قيمة الخاصية

HttpClient

موروث من ClientOptions.httpClient

loggingOptions

خيارات لتكوين تسجيل الطلب/الاستجابة.

loggingOptions?: LogPolicyOptions

قيمة الخاصية

LogPolicyOptions

موروث من ClientOptions.loggingOptions

pipeline

خط أنابيب لاستخدامه للعميل. إذا لم يتم توفيرها، سيتم إنشاء خط أنابيب افتراضي باستخدام الخيارات المتاحة. استخدم بحذر -- عند تعيين هذا الخيار، سيتم تجاهل جميع خيارات العميل المستخدمة في إنشاء خط الأنابيب الافتراضي.

pipeline?: Pipeline

قيمة الخاصية

Pipeline

الموروث من ClientOptions.pipeline

proxyOptions

خيارات لتكوين وكيل للطلبات الصادرة.

proxyOptions?: ProxySettings

قيمة الخاصية

ProxySettings

موروث من ClientOptions.proxyOptions

redirectOptions

خيارات لكيفية معالجة استجابات إعادة التوجيه.

redirectOptions?: RedirectPolicyOptions

قيمة الخاصية

RedirectPolicyOptions

موروث من ClientOptions.redirectOptions

retryOptions

الخيارات التي تتحكم في كيفية إعادة محاولة الطلبات الفاشلة.

retryOptions?: PipelineRetryOptions

قيمة الخاصية

PipelineRetryOptions

موروث من ClientOptions.retryOptions

telemetryOptions

خيارات لإعداد معلومات تتبع الاستخدام والتتبع الشائعة للطلبات الصادرة.

telemetryOptions?: TelemetryOptions

قيمة الخاصية

TelemetryOptions

موروثة من ClientOptions.telemetryOptions

tlsOptions

خيارات لتكوين مصادقة TLS

tlsOptions?: TlsSettings

قيمة الخاصية

TlsSettings

موروث من ClientOptions.tlsOptions

userAgentOptions

خيارات لإضافة تفاصيل عامل المستخدم إلى الطلبات الصادرة.

userAgentOptions?: UserAgentPolicyOptions

قيمة الخاصية

UserAgentPolicyOptions

موروث من ClientOptions.userAgentOptions