@azure/openai package
الفصول
AzureKeyCredential |
بيانات اعتماد مستندة إلى مفتاح ثابت تدعم تحديث قيمة المفتاح الأساسي. |
OpenAIClient |
عميل للتفاعل مع Azure OpenAI. يحتاج العميل إلى نقطة نهاية مورد OpenAI وطريقة مصادقة مثل مفتاح واجهة برمجة التطبيقات أو الرمز المميز. يمكن العثور على مفتاح واجهة برمجة التطبيقات ونقطة النهاية في صفحة مورد OpenAI. سيتم تحديد موقعها في صفحة المفاتيح ونقطة النهاية الخاصة بالمورد. أمثلة للمصادقة:مفتاح API
Azure Active Directory
|
OpenAIKeyCredential |
تمثل فئة OpenAIKeyCredential مفتاح OpenAI API وتستخدم للمصادقة في عميل OpenAI لنقطة نهاية OpenAI. |
الواجهات
AudioResultSimpleJson |
استجابة بسيطة لكتابة الحديث |
AudioResultVerboseJson |
استجابة النسخ. |
AudioSegment |
مقطع كتابة الحديث. |
AzureChatEnhancementConfiguration |
تمثيل لتكوينات تحسين Azure OpenAI المتوفرة. |
AzureChatEnhancements |
يمثل نتائج إخراج تحسينات Azure لإكمال الدردشة، كما تم تكوينها عبر الإدخال المطابق المقدم في الطلب. |
AzureChatExtensionConfiguration |
تمثيل لبيانات التكوين لملحق دردشة Azure OpenAI واحد. سيتم استخدام هذا بواسطة طلب إكمال الدردشة الذي يجب أن يستخدم ملحقات دردشة Azure OpenAI لزيادة سلوك الاستجابة. استخدام هذا التكوين متوافق فقط مع Azure OpenAI. |
AzureChatExtensionDataSourceResponseCitation |
مثيل واحد لمعلومات السياق الإضافية المتوفرة عند مشاركة ملحقات دردشة Azure OpenAI في إنشاء استجابة إكمال دردشة مقابلة. يتم ملء معلومات السياق هذه فقط عند استخدام طلب Azure OpenAI الذي تم تكوينه لاستخدام ملحق مطابق. |
AzureChatExtensionsMessageContext |
تمثيل لمعلومات السياق الإضافية المتوفرة عند مشاركة ملحقات دردشة Azure OpenAI في إنشاء استجابة إكمال دردشة مقابلة. يتم ملء معلومات السياق هذه فقط عند استخدام طلب Azure OpenAI الذي تم تكوينه لاستخدام ملحق مطابق. |
AzureChatGroundingEnhancementConfiguration |
تمثيل للخيارات المتاحة لتحسين أساس Azure OpenAI. |
AzureChatOCREnhancementConfiguration |
تمثيل للخيارات المتوفرة لتحسين التعرف البصري على الحروف (OCR) في Azure OpenAI. |
AzureCosmosDBChatExtensionConfiguration |
تمثيل محدد للخيارات القابلة للتكوين ل Azure Cosmos DB عند استخدامه كملحق دردشة Azure OpenAI. |
AzureCosmosDBFieldMappingOptions |
إعدادات اختيارية للتحكم في كيفية معالجة الحقول عند استخدام مورد Azure Cosmos DB مكون. |
AzureExtensionsOptions |
خيارات ملحقات دردشة Azure OpenAI. |
AzureGroundingEnhancement |
تحسين الأساس الذي يرجع المربع المحيط للعناصر المكتشفة في الصورة. |
AzureGroundingEnhancementCoordinatePoint |
تمثيل نقطة مضلع واحد كما هو مستخدم من قبل تحسين أساس Azure. |
AzureGroundingEnhancementLine |
عنصر سطر محتوى يتكون من تسلسل متجاورة من عناصر المحتوى، مثل الكلمات وعلامات التحديد. |
AzureGroundingEnhancementLineSpan |
كائن امتداد يمثل كائنا تم اكتشافه ومعلومات المربع المحيط به. |
AzureMachineLearningIndexChatExtensionConfiguration |
تمثيل محدد للخيارات القابلة للتكوين لفهرس متجه التعلم الآلي من Microsoft Azure عند استخدامه كملحق دردشة Azure OpenAI. |
AzureSearchChatExtensionConfiguration |
تمثيل محدد للخيارات القابلة للتكوين ل Azure البحث عند استخدامه كملحق دردشة Azure OpenAI. |
AzureSearchIndexFieldMappingOptions |
إعدادات اختيارية للتحكم في كيفية معالجة الحقول عند استخدام مورد Azure البحث تم تكوينه. |
ChatChoice |
تمثيل إكمال مطالبة واحدة كجزء من طلب إكمال الدردشة الشامل.
بشكل عام، |
ChatChoiceLogProbabilityInfo |
معلومات احتمال السجل للاختيار، كما هو مطلوب عبر "logprobs" و"top_logprobs". |
ChatCompletions |
تمثيل بيانات الاستجابة من طلب إكمال الدردشة. تدعم عمليات الإكمال مجموعة متنوعة من المهام وتنشئ نصا يستمر من بيانات المطالبة المقدمة أو "يكملها". |
ChatCompletionsFunctionToolCall |
استدعاء أداة إلى أداة دالة، صادرة عن النموذج في تقييم أداة دالة مكونة، والتي تمثل استدعاء دالة مطلوب لطلب إكمال الدردشة اللاحق لحله. |
ChatCompletionsFunctionToolDefinition |
معلومات التعريف لأداة دالة إكمال الدردشة التي يمكنها استدعاء دالة استجابة لاستدعاء أداة. |
ChatCompletionsFunctionToolSelection |
تحديد أداة لأداة دالة محددة مسماة ستحد من إكمال الدردشة لاستخدام الدالة المسماة. |
ChatCompletionsJsonResponseFormat |
تنسيق استجابة لإكمالات الدردشة يقيد الاستجابات لانبعاث كائنات JSON صالحة. |
ChatCompletionsNamedFunctionToolSelection |
تحديد أداة لأداة دالة محددة مسماة ستحد من إكمال الدردشة لاستخدام الدالة المسماة. |
ChatCompletionsNamedToolSelection |
تمثيل مجرد لاختيار أداة مسماة صريحة لاستخدامها لطلب إكمال الدردشة. |
ChatCompletionsResponseFormat |
تمثيل مجرد لتكوين تنسيق استجابة قابل للاستخدام بواسطة إكمال الدردشة. يمكن استخدامها لتمكين وضع JSON. |
ChatCompletionsTextResponseFormat |
تنسيق استجابة إكمال الدردشة القياسي الذي يمكنه إنشاء نص بحرية وغير مضمون لإنتاج محتوى استجابة يلتزم بمخطط معين. |
ChatCompletionsToolCall |
تمثيل مجرد لاستدعاء أداة يجب حله في طلب لاحق لتنفيذ إكمال الدردشة المطلوبة. |
ChatCompletionsToolDefinition |
تمثيل مجرد لأداة يمكن استخدامها من قبل النموذج لتحسين استجابة إكمال الدردشة. |
ChatFinishDetails |
تمثيل مجرد للمعلومات المنظمة حول سبب إنهاء استجابة إكمال الدردشة. |
ChatMessageContentItem |
تمثيل مجرد لعنصر محتوى منظم داخل رسالة دردشة. |
ChatMessageImageContentItem |
عنصر محتوى دردشة منظم يحتوي على مرجع صورة. |
ChatMessageImageUrl |
موقع إنترنت يمكن للنموذج استرداد صورة منه. |
ChatMessageTextContentItem |
عنصر محتوى دردشة منظم يحتوي على نص عادي. |
ChatRequestAssistantMessage |
رسالة دردشة طلب تمثل استجابة أو إجراء من المساعد. |
ChatRequestFunctionMessage |
رسالة دردشة طلب تمثل الإخراج المطلوب من دالة تم تكوينها. |
ChatRequestMessage |
تمثيل مجرد لرسالة دردشة كما هو متوفر في الطلب. |
ChatRequestSystemMessage |
رسالة دردشة طلب تحتوي على إرشادات النظام التي تؤثر على كيفية إنشاء النموذج استجابة إكمال الدردشة. |
ChatRequestToolMessage |
رسالة دردشة طلب تمثل الإخراج المطلوب من أداة تم تكوينها. |
ChatRequestUserMessage |
رسالة دردشة طلب تمثل إدخال المستخدم إلى المساعد. |
ChatResponseMessage |
تمثيل لرسالة دردشة كما تم تلقيها في استجابة. |
ChatTokenLogProbabilityInfo |
تمثيل لمعلومات احتمال السجل الرموز المميزة لمحتوى رسالة واحدة. |
ChatTokenLogProbabilityResult |
تمثيل لمعلومات احتمال السجل رمز مميز واحد للمحتوى، بما في ذلك قائمة بالرموز المميزة الأكثر احتمالا إذا تم طلب "top_logprobs". |
Choice |
تمثيل إكمال موجه واحد كجزء من طلب إكمال شامل.
بشكل عام، |
Completions |
تمثيل بيانات الاستجابة من طلب الإكمال. تدعم عمليات الإكمال مجموعة متنوعة من المهام وتنشئ نصا يستمر من بيانات المطالبة المقدمة أو "يكملها". |
CompletionsLogProbabilityModel |
تمثيل نموذج احتمالات السجل لإنشاء عمليات إكمال. |
CompletionsUsage |
تمثيل عدد الرموز المميزة التي تمت معالجتها لطلب الإكمال. تأخذ العد في الاعتبار جميع الرموز المميزة عبر المطالبات والخيارات والخيارات البديلة والأجيال best_of والمستهلكين الآخرين. |
ContentFilterBlocklistIdResult |
يمثل نتيجة التقييم مقابل قائمة حظر مخصصة كما يتم تنفيذها بواسطة تصفية المحتوى. |
ContentFilterCitedDetectionResult |
يمثل نتيجة عملية الكشف ضد الموارد المحمية كما يتم تنفيذها بواسطة تصفية المحتوى. |
ContentFilterDetectionResult |
يمثل نتيجة عملية الكشف التي يتم إجراؤها بواسطة تصفية المحتوى. |
ContentFilterErrorResults |
معلومات حول نتيجة خطأ تصفية المحتوى. |
ContentFilterResult |
معلومات حول مستوى خطورة المحتوى الذي تمت تصفيته وما إذا تمت تصفيته أم لا. |
ContentFilterResultsForPrompt |
نتائج تصفية المحتوى لمطالبة واحدة في الطلب. |
ContentFilterSuccessResultDetailsForPrompt |
معلومات حول نتيجة نجاح تصفية المحتوى. |
ContentFilterSuccessResultsForChoice |
معلومات حول تصفية المحتوى التي تم تقييمها مقابل إخراج النموذج الذي تم إنشاؤه. |
ElasticsearchChatExtensionConfiguration |
تمثيل محدد للخيارات القابلة للتكوين ل Elasticsearch عند استخدامه كملحق دردشة Azure OpenAI. |
ElasticsearchIndexFieldMappingOptions |
إعدادات اختيارية للتحكم في كيفية معالجة الحقول عند استخدام مورد Elasticsearch® مكون. |
EmbeddingItem |
تمثيل مقارنة مرتبطة بتضمين واحد. |
Embeddings |
تمثيل بيانات الاستجابة من طلب تضمين. تقيس التضمينات مدى ارتباط السلاسل النصية وتستخدم عادة للبحث والتكتلة والتوصيات والسيناريوهات المماثلة الأخرى. |
EmbeddingsUsage |
قياس كمية الرموز المميزة المستخدمة في هذا الطلب والاستجابة. |
EventStream |
دفق قابل للقراءة قابل للتكارات وقابل للتخلص منه. |
FunctionCall |
اسم ووسيطات الدالة التي يجب استدعاؤها، كما تم إنشاؤها بواسطة النموذج. |
FunctionDefinition |
تعريف دالة محددة من قبل المتصل قد تستدعيها إكمالات الدردشة استجابة لإدخال المستخدم المطابق. |
FunctionName |
بنية تحدد الاسم الدقيق لوظيفة معينة يوفرها الطلب لاستخدامها عند معالجة عملية إكمال الدردشة. |
GetAudioTranscriptionOptions |
خيارات طلب كتابة الصوت |
GetAudioTranslationOptions |
خيارات طلب ترجمة صوتية |
GetChatCompletionsOptions |
تحتوي هذه الوحدة النمطية على نماذج نريد أن نعيش جنبا إلى جنب مع النماذج التي تم إنشاؤها المقابلة. هذا مفيد لتوفير نماذج مواجهة للعملاء لها أسماء/أنواع مختلفة عن النماذج التي تم إنشاؤها. |
GetCompletionsOptions |
معلومات التكوين لطلب الإكمال. تدعم عمليات الإكمال مجموعة متنوعة من المهام وتنشئ نصا يستمر من بيانات المطالبة المقدمة أو "يكملها". |
GetEmbeddingsOptions |
خيارات لطلب التضمينات المخصصة |
GetImagesOptions |
يمثل بيانات الطلب المستخدمة لإنشاء الصور. |
ImageGenerationContentFilterResults |
يصف نتيجة تصفية المحتوى لطلب إنشاء الصور. |
ImageGenerationData |
تمثيل لصورة واحدة تم إنشاؤها، يتم توفيرها إما كبيانات مشفرة ب base64 أو كعنون URL يمكن استرداد الصورة منه. |
ImageGenerationPromptFilterResults |
يصف نتائج تصفية المحتوى لمطالبة طلب إنشاء صورة. |
ImageGenerations |
نتيجة عملية إنشاء صور ناجحة. |
MaxTokensFinishDetails |
تم الوصول إلى تمثيل منظم لسبب توقف يشير إلى حد الرمز المميز قبل أن يكتمل النموذج بشكل طبيعي. |
OnYourDataAccessTokenAuthenticationOptions |
خيارات المصادقة ل Azure OpenAI على بياناتك عند استخدام الرمز المميز للوصول. |
OnYourDataApiKeyAuthenticationOptions |
خيارات المصادقة ل Azure OpenAI على بياناتك عند استخدام مفتاح API. |
OnYourDataAuthenticationOptions |
خيارات المصادقة ل Azure OpenAI على بياناتك. |
OnYourDataConnectionStringAuthenticationOptions |
خيارات المصادقة ل Azure OpenAI على بياناتك عند استخدام سلسلة الاتصال. |
OnYourDataDeploymentNameVectorizationSource |
تفاصيل مصدر متجه، يستخدمه Azure OpenAI على بياناتك عند تطبيق بحث المتجهات، الذي يستند إلى اسم توزيع نموذج تضمين داخلي في نفس مورد Azure OpenAI. |
OnYourDataEncodedApiKeyAuthenticationOptions |
خيارات المصادقة ل Azure OpenAI على بياناتك عند استخدام مفتاح واجهة برمجة تطبيقات مرمز Elasticsearch. |
OnYourDataEndpointVectorizationSource |
تفاصيل مصدر متجه، يستخدمه Azure OpenAI على بياناتك عند تطبيق بحث المتجهات، الذي يستند إلى استدعاء نقطة نهاية Azure OpenAI عام للتضمينات. |
OnYourDataKeyAndKeyIdAuthenticationOptions |
خيارات المصادقة ل Azure OpenAI على بياناتك عند استخدام مفتاح Elasticsearch وزوج معرف المفتاح. |
OnYourDataModelIdVectorizationSource |
تفاصيل مصدر متجه، يستخدمه Azure OpenAI على بياناتك عند تطبيق بحث المتجهات، الذي يستند إلى معرف نموذج خدمة البحث. حاليا يدعمه Elasticsearch® فقط. |
OnYourDataSystemAssignedManagedIdentityAuthenticationOptions |
خيارات المصادقة ل Azure OpenAI على بياناتك عند استخدام هوية مدارة معينة من قبل النظام. |
OnYourDataUserAssignedManagedIdentityAuthenticationOptions |
خيارات المصادقة ل Azure OpenAI على بياناتك عند استخدام هوية مدارة معينة من قبل المستخدم. |
OnYourDataVectorizationSource |
تمثيل مجرد لمصدر متجهات ل Azure OpenAI على بياناتك مع البحث عن المتجهات. |
OpenAIClientOptions | |
PineconeChatExtensionConfiguration |
تمثيل محدد للخيارات القابلة للتكوين ل Pinecone عند استخدامه كملحق دردشة Azure OpenAI. |
PineconeFieldMappingOptions |
إعدادات اختيارية للتحكم في كيفية معالجة الحقول عند استخدام مورد Pinecone مكون. |
StopFinishDetails |
تمثيل منظم لسبب التوقف الذي يشير إلى الإنهاء الطبيعي من قبل النموذج. |
النوع أسماء مستعارة
AudioResult |
نوع نتيجة كتابة الحديث استنادا إلى تنسيق الاستجابة المطلوب |
AudioResultFormat |
تنسيق نتيجة مهمة صوتية |
AudioTranscriptionTask |
"نسخ"، "ترجمة" |
AzureChatExtensionConfigurationUnion |
الاسم المستعار ل AzureChatExtensionConfigurationUnion |
AzureChatExtensionType |
"azure_search"، "azure_ml_index"، "azure_cosmos_db"، "elasticsearch"، "pinecone" |
AzureSearchQueryType |
"بسيط" و"دلالي" و"متجه" و"vector_simple_hybrid" و"vector_semantic_hybrid" |
ChatCompletionsNamedToolSelectionUnion |
الاسم المستعار ل ChatCompletionsNamedToolSelectionUnion |
ChatCompletionsResponseFormatUnion |
الاسم المستعار ل ChatCompletionsResponseFormatUnion |
ChatCompletionsToolCallUnion |
الاسم المستعار ل ChatCompletionsToolCallUnion |
ChatCompletionsToolDefinitionUnion |
الاسم المستعار ل ChatCompletionsToolDefinitionUnion |
ChatCompletionsToolSelectionPreset |
"تلقائي"، "لا شيء" |
ChatFinishDetailsUnion |
الاسم المستعار ل ChatFinishDetailsUnion |
ChatMessageContentItemUnion |
الاسم المستعار ل ChatMessageContentItemUnion |
ChatMessageImageDetailLevel |
"auto", "low", "high" |
ChatRequestMessageUnion |
الاسم المستعار ل ChatRequestMessageUnion |
ChatRole |
"النظام" و"المساعد" و"المستخدم" و"الوظيفة" و"الأداة" |
CompletionsFinishReason |
"stop" و"length" و"content_filter" و"function_call" و"tool_calls" |
ContentFilterResultDetailsForPrompt |
معلومات حول فئة تصفية المحتوى، إذا تم اكتشافها. |
ContentFilterResultsForChoice |
معلومات حول نتائج تصفية المحتوى، إذا تم اكتشافها. |
ContentFilterSeverity |
"آمن"، "منخفض"، "متوسط"، "مرتفع" |
ElasticsearchQueryType |
"بسيط"، "متجه" |
FunctionCallPreset |
"تلقائي"، "لا شيء" |
ImageGenerationQuality |
"قياسي"، "hd" |
ImageGenerationResponseFormat |
"url"، "b64_json" |
ImageGenerationStyle |
"طبيعي"، "حي" |
ImageSize |
"256x256"، "512x512"، "1024x1024"، "1792x1024"، "1024x1792" |
OnYourDataAuthenticationOptionsUnion |
الاسم المستعار ل OnYourDataAuthenticationOptionsUnion |
OnYourDataAuthenticationType |
"api_key" و"connection_string" و"key_and_key_id" و"encoded_api_key" و"access_token" و"system_assigned_managed_identity" و"user_assigned_managed_identity" |
OnYourDataVectorizationSourceType |
"نقطة النهاية"، "deployment_name"، "model_id" |
OnYourDataVectorizationSourceUnion |
الاسم المستعار ل OnYourDataVectorizationSourceUnion |
Azure SDK for JavaScript
الملاحظات
https://aka.ms/ContentUserFeedback.
قريبًا: خلال عام 2024، سنتخلص تدريجيًا من GitHub Issues بوصفها آلية إرسال ملاحظات للمحتوى ونستبدلها بنظام ملاحظات جديد. لمزيد من المعلومات، راجعإرسال الملاحظات وعرضها المتعلقة بـ