OpenAICompatible with Milvus 2.6.x

استخدم نموذج تضمين OpenAI مع Milvus عن طريق اختيار نموذج وتكوين Milvus باستخدام مفتاح OpenAI API الخاص بك.

اختر نموذج تضمين

يدعم Milvus جميع نماذج التضمين التي يوفرها OpenAI. فيما يلي نماذج تضمين OpenAI المتوفرة حاليًا للرجوع إليها سريعًا:

اسم النموذج	الأبعاد	الحد الأقصى للرموز	الوصف
تضمين النص-تضمين النص-3-صغير	افتراضي: 1,536 (يمكن اختصاره إلى حجم بُعد أقل من 1,536)	8,191	مثالي للبحث الدلالي الحساس من حيث التكلفة والقابل للتطوير-يقدم أداءً قوياً بسعر أقل.
تضمين النص-تضمين النص-3-كبير	افتراضي: 3,072 (يمكن اختصاره إلى حجم بُعد أقل من 3,072)	8,191	الأفضل للتطبيقات التي تتطلب دقة استرجاع محسّنة وتمثيلات دلالية أكثر ثراءً.
تضمين النص-تضمين النص-ADA-002	ثابت: 1,536 (لا يمكن اختصاره)	8,191	نموذج الجيل السابق المناسب لخطوط الأنابيب القديمة أو السيناريوهات التي تتطلب التوافق مع الإصدارات السابقة.

تدعم نماذج التضمين من الجيل الثالث(تضمين النص-التضمين-3) تقليل حجم التضمين عبر معلمة dim. عادةً ما تكون التضمينات الأكبر حجمًا أكثر تكلفة من منظور الحوسبة والذاكرة والتخزين. تتيح القدرة على ضبط عدد الأبعاد مزيدًا من التحكم في التكلفة الإجمالية والأداء. للحصول على مزيد من التفاصيل حول كل نموذج، راجع مدونة نماذج التضمين ومنشور إعلان OpenAI.

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

يجب أن يعرف Milvus مفتاح OpenAI API الخاص بك قبل أن يتمكن من طلب التضمينات. يوفر Milvus طريقتين لتكوين بيانات الاعتماد:

• ملف التكوين (موصى به): قم بتخزين مفتاح واجهة برمجة التطبيقات في milvus.yaml بحيث تلتقطه كل إعادة تشغيل وعقدة تلقائيًا.

• متغيرات البيئة: أدخل المفتاح في وقت النشر - مثالي لـ Docker Compose.

اختر إحدى الطريقتين أدناه - من الأسهل الحفاظ على ملف التهيئة على الأجهزة العارية والأجهزة الافتراضية، بينما يناسب مسار env-var سير عمل الحاوية.

الخيار 1: ملف التكوين (موصى به وأولوية أعلى)

احتفظ بمفاتيح واجهة برمجة التطبيقات الخاصة بك في milvus.yaml ؛ يقرأها Milvus عند بدء التشغيل ويتجاوز أي متغير بيئة لنفس الموفر.

1. **أعلن مفاتيحك تحت credential:

   يمكنك إدراج مفتاح واحد أو أكثر من مفاتيح واجهة برمجة التطبيقات - أعطِ كل مفتاح تسمية تخترعها وستشير إليها لاحقًا.

   # milvus.yaml
   credential:
     apikey_dev:            # dev environment
       apikey: <YOUR_DEV_KEY>
     apikey_prod:           # production environment
       apikey: <YOUR_PROD_KEY>    
   

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

2. أخبر ميلفوس بالمفتاح الذي سيستخدمه لاستدعاءات OpenAI

   في نفس الملف، وجّه موفر OpenAI إلى التسمية التي تريده أن يستخدمها.

   function:
     textEmbedding:
       providers:
         openai:
           credential: apikey_dev      # ← choose any label you defined above
           # url: https://api.openai.com/v1/embeddings   # (optional) custom url
   

   هذا يربط مفتاحًا محددًا بكل طلب يرسله Milvus إلى نقطة نهاية تضمينات OpenAI.

الخيار 2: متغير البيئة

استخدم هذه الطريقة عندما تقوم بتشغيل Milvus مع Docker Compose وتفضل الاحتفاظ بالأسرار خارج الملفات والصور.

يعود Milvus إلى متغير البيئة فقط إذا لم يتم العثور على مفتاح للموفر في milvus.yaml.

المتغير	مطلوب	الوصف
MILVUSAI_OPENAI_API_KEY	نعم	يجعل مفتاح OpenAI متاحًا داخل كل حاوية Milvus (يتم تجاهله عند وجود مفتاح OpenAI في milvus.yaml )

في ملف docker-compose.yaml الخاص بك، قم بتعيين متغير البيئة MILVUSAI_OPENAI_API_KEY.

# docker-compose.yaml (standalone service section)
standalone:
  # ... other configurations ...
  environment:
    # ... other environment variables ...
    # Set the environment variable pointing to the OpenAI API key inside the container
    MILVUSAI_OPENAI_API_KEY: <MILVUSAI_OPENAI_API_KEY>

تقوم كتلة environment: بحقن المفتاح فقط في حاوية Milvus، تاركةً نظام التشغيل المضيف الخاص بك دون أن يمسه أحد. لمزيد من التفاصيل، راجع تكوين Milvus مع Docker Compose.

استخدام وظيفة التضمين

بمجرد تكوين بيانات الاعتماد، اتبع هذه الخطوات لتعريف دوال التضمين واستخدامها.

الخطوة 1: تحديد حقول المخطط

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

• الحقل الأساسي الذي يحدد بشكل فريد كل كيان في المجموعة.

• حقل قياسي يخزن البيانات الأولية المراد تضمينها.

• حقل متجه محجوز لتخزين التضمينات المتجهة التي ستقوم الدالة بإنشائها للحقل القياسي.

يحدد المثال التالي مخططًا يحتوي على حقل قياسي واحد "document" لتخزين البيانات النصية وحقل متجه واحد "dense" لتخزين التضمينات التي سيتم إنشاؤها بواسطة الوحدة النمطية للدالة. تذكر تعيين البعد المتجه (dim) لمطابقة مخرجات نموذج التضمين الذي اخترته.

from pymilvus import MilvusClient, DataType, Function, FunctionType

# Initialize Milvus client
client = MilvusClient(
    uri="http://localhost:19530",
)

# Create a new schema for the collection
schema = client.create_schema()

# Add primary field "id"
schema.add_field("id", DataType.INT64, is_primary=True, auto_id=False)

# Add scalar field "document" for storing textual data
schema.add_field("document", DataType.VARCHAR, max_length=9000)

# Add vector field "dense" for storing embeddings.
# IMPORTANT: Set dim to match the exact output dimension of the embedding model.
# For instance, OpenAI's text-embedding-3-small model outputs 1536-dimensional vectors.
schema.add_field("dense", DataType.FLOAT_VECTOR, dim=1536)

الخطوة 2: إضافة دالة التضمين إلى المخطط

تقوم الوحدة النمطية الدالة في ميلفوس تلقائيًا بتحويل البيانات الأولية المخزنة في حقل قياسي إلى تضمينات وتخزينها في حقل المتجه المحدد صراحة.

يضيف المثال أدناه وحدة الدالة (openai_embedding) التي تقوم بتحويل الحقل القياسي "document" إلى تضمينات، وتخزين المتجهات الناتجة في الحقل المتجه "dense" المحدد مسبقًا.

بمجرد تعريف دالة التضمين الخاصة بك، قم بإضافتها إلى مخطط مجموعتك. هذا يوجه ميلفوس لاستخدام دالة التضمين المحددة لمعالجة التضمينات وتخزينها من بياناتك النصية.

# Define embedding function (example: OpenAI provider)
text_embedding_function = Function(
    name="openai_embedding",                        # Unique identifier for this embedding function
    function_type=FunctionType.TEXTEMBEDDING,       # Type of embedding function
    input_field_names=["document"],                 # Scalar field to embed
    output_field_names=["dense"],                   # Vector field to store embeddings
    params={                                        # Provider-specific configuration (highest priority)
        "provider": "openai",                       # Embedding model provider
        "model_name": "text-embedding-3-small",     # Embedding model
        # Optional parameters:
        # "credential": "apikey_dev",               # Optional: Credential label specified in milvus.yaml
        # "dim": "1536",                            # Optional: Shorten the output vector dimension
        # "user": "user123"                         # Optional: identifier for API tracking
    }
)

# Add the embedding function to your schema
schema.add_function(text_embedding_function)

الخطوات التالية

بعد تكوين دالة التضمين، ارجع إلى نظرة عامة على الدالة للحصول على إرشادات إضافية حول تكوين الفهرس وأمثلة إدراج البيانات وعمليات البحث الدلالي.