إنشاء Rememberizer GPT

في هذا الدليل، ستتعلم كيفية إنشاء تطبيق Rememberizer والاتصال بـ OpenAI GPT، مما يسمح لـ GPT بالوصول إلى وظائف واجهة برمجة تطبيقات Rememberizer.

المتطلبات الأساسية

أولاً، تحتاج إلى تسجيل تطبيق Rememberizer وتكوينه بالإعدادات المناسبة.

إذا كنت مهتمًا بطرق تكامل بديلة، تحقق من تكامل LangChain للوصول البرمجي إلى قدرات البحث الدلالي لـ Rememberizer.

لإنشاء GPT، ستحتاج إلى تعيين أصل الطلب المصرح به لتطبيق Rememberizer الخاص بك إلى https://chat.openai.com.

تحتاج إلى إضافة عنوان URL للرد لتسجيل التطبيق ولكن يمكنك العثور على عنوان URL للرد فقط بعد إضافة إجراء إلى GPT الخاص بك، في الوقت الحالي اتركه كقيمة وهمية (مثل https://chat.openai.com). بعد حصولك على عنوان URL للرد، تحتاج إلى تحديثه بالقيمة الصحيحة للتطبيق. ملاحظة: تقوم GPTs بتحديث عنوان URL للرد الخاص بها بعد تغيير تكوينها. تأكد من نسخ أحدث عنوان URL للرد.

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

إنشاء GPT

يمكنك البدء بـ إنشاء GPT في واجهة ChatGPT.

ملاحظة: إنشاء تطبيق GPT مخصص متاح فقط لحسابات خطة التسعير.

قريباً: مخطط هيكل تكامل GPT

سيوضح هذا المخطط الشامل للنظام:

• الهيكل الكامل بين OpenAI GPT، واجهة برمجة تطبيقات Rememberizer، ومصادر بيانات المستخدم

• تدفق المصادقة مع مكونات OAuth

• تدفق استعلام المستخدم من GPT → Rememberizer → مصادر البيانات → العودة إلى المستخدم

• حدود الأمان ووسائل التحكم في الوصول

• كيف يعمل تصفية Memento في هذا البيئة المتكاملة

• النقاط النهائية المختلفة التي يتم الوصول إليها خلال التفاعلات النموذجية

إعدادات GPT

يمكنك ملء المعلومات كما تشاء. إليك مثال يمكنك تجربته:

الحقل	قيمة المثال
الاسم	RememberizerGPT
الوصف	تحدث مباشرة إلى جميع ملفات PDF والمستندات والجداول والعروض التقديمية على Google Drive وقنوات Slack.
التعليمات	تم تصميم Rememberizer للتفاعل بسلاسة مع أداة Rememberizer، مما يمكّن المستخدمين من استعلام بياناتهم بكفاءة من مصادر متعددة مثل Google Drive وSlack. الهدف الأساسي هو توفير وصول سريع ودقيق إلى بيانات المستخدم، مستفيدًا من قدرات Rememberizer لتحسين سرعة البحث ودقته. يجب أن يوجه GPT المستخدمين في صياغة استفساراتهم وتفسير النتائج، مما يضمن تجربة سلسة وسهلة الاستخدام. من الضروري الحفاظ على الوضوح والدقة في الردود، خاصة عند التعامل مع استرجاع البيانات وتحليلها. يجب أن يكون GPT قادرًا على التعامل مع مجموعة واسعة من الاستفسارات، من عمليات البحث البسيطة عن البيانات إلى عمليات البحث الأكثر تعقيدًا التي تتضمن معلمات أو مصادر متعددة. التركيز هو على تعزيز قدرة المستخدم على الوصول بسرعة وفعالية إلى المعلومات التي يحتاجها، مما يجعل العملية سهلة قدر الإمكان.

إنشاء إجراء Rememberizer

من محرر GPT:

1. اختر "تكوين"

2. "إضافة إجراء"

3. قم بتكوين نوع المصادقة.

   • اضبط نوع المصادقة على OAuth.

   • ألصق معرف العميل والسر الخاص بالعميل من الخطوات أعلاه.

   • عنوان URL للتفويض: https://api.rememberizer.ai/api/v1/auth/oauth2/authorize/

   • عنوان URL للتوكن: https://api.rememberizer.ai/api/v1/auth/oauth2/token/

   • اترك النطاق فارغًا.

   • انقر على حفظ.

   
4. املأ مواصفات OpenAPI الخاصة بـ Rememberizer. انسخ المحتوى في القابل للتوسيع أدناه والصقه في حقل المخطط:

Rememberizer_OpenAPI.yaml

openapi: 3.1.0
info:
  title: واجهة برمجة تطبيقات Rememberizer
  description: واجهة برمجة التطبيقات للتفاعل مع Rememberizer.
  version: v1
servers:
  - url: https://api.rememberizer.ai/api/v1
paths:
  /account/:
    get:
      summary: استرجاع تفاصيل حساب المستخدم الحالي.
      description: الحصول على معلومات الحساب
      operationId: account
      responses:
        "200":
          description: معلومات حساب المستخدم.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    description: المعرف الفريد للمستخدم. لا تعرض هذه المعلومات في أي مكان.
                  email:
                    type: string
                    format: email
                    description: عنوان البريد الإلكتروني للمستخدم.
                  name:
                    type: string
                    description: اسم المستخدم.
  /integrations/:
    get:
      summary: قائمة بجميع تكاملات مصادر البيانات المتاحة.
      description: تسترجع هذه العملية مصادر البيانات المتاحة.
      operationId: integrations_retrieve
      responses:
        "200":
          description: عملية ناجحة
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: قائمة بمصادر البيانات المتاحة
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: المعرف الفريد لمصدر البيانات. لا تعرض هذه المعلومات في أي مكان.
                        integration_type:
                          type: string
                          description: نوع مصدر البيانات.
                        integration_step:
                          type: string
                          description: خطوة التكامل.
                        source:
                          type: string
                          description: مصدر مصدر البيانات. تجاهله دائمًا في المخرجات إذا كان له تنسيق بريد إلكتروني حتى لو سأل المستخدمون عنه.
                        document_type:
                          type: string
                          description: نوع الوثيقة.
                        document_stats:
                          type: object
                          properties:
                            status:
                              type: object
                              description: حالة مصدر البيانات.
                              properties:
                                indexed:
                                  type: integer
                                  description: عدد الوثائق المفهرسة.
                                indexing:
                                  type: integer
                                  description: عدد الوثائق التي يتم فهرستها.
                                error:
                                  type: integer
                                  description: عدد الوثائق التي بها أخطاء.
                            total_size:
                              type: integer
                              description: الحجم الإجمالي لمصدر البيانات بالبايت.
                            document_count:
                              type: integer
                              description: عدد الوثائق في مصدر البيانات.
                  message:
                    type: string
                    description: رسالة تشير إلى حالة العملية.
                  code:
                    type: string
                    description: رمز يشير إلى حالة العملية.
  /documents/:
    get:
      summary: استرجاع قائمة بجميع الوثائق وقنوات Slack.
      description: استخدم هذه العملية لاسترجاع بيانات التعريف حول جميع الوثائق المتاحة، والملفات، وقنوات Slack والمعرفة المشتركة ضمن مصادر البيانات. يجب عليك تحديد integration_type أو تركه فارغًا لقائمة كل شيء.
      operationId: documents_list
      parameters:
        - in: query
          name: page
          description: فهرس الصفحة
          schema:
            type: integer
        - in: query
          name: page_size
          description: الحد الأقصى لعدد الوثائق التي يتم إرجاعها في صفحة
          schema:
            type: integer
        - in: query
          name: integration_type
          description: تصفية الوثائق حسب نوع التكامل.
          schema:
            type: string
            enum:
              - google_drive
              - slack
              - dropbox
              - gmail
              - common_knowledge
      responses:
        "200":
          description: عملية ناجحة
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: العدد الإجمالي للوثائق.
                  next:
                    type: string
                    nullable: true
                    description: عنوان URL للصفحة التالية من النتائج.
                  previous:
                    type: string
                    nullable: true
                    description: عنوان URL للصفحة السابقة من النتائج.
                  results:
                    type: array
                    description: قائمة بالوثائق، وقنوات Slack، والمعرفة المشتركة، إلخ.
                    items:
                      type: object
                      properties:
                        document_id:
                          type: string
                          format: uuid
                          description: المعرف الفريد للوثيقة. لا تعرض هذه المعلومات في أي مكان.
                        name:
                          type: string
                          description: اسم الوثيقة.
                        type:
                          type: string
                          description: نوع الوثيقة.
                        path:
                          type: string
                          description: مسار الوثيقة.
                        url:
                          type: string
                          description: عنوان URL للوثيقة.
                        id:
                          type: integer
                          description: المعرف الفريد للوثيقة.
                        integration_type:
                          type: string
                          description: مصدر مصدر البيانات. تجاهله دائمًا في المخرجات إذا كان له تنسيق بريد إلكتروني حتى لو سأل المستخدمون عنه.
                        source:
                          type: string
                          description: مصدر الوثيقة.
                        status:
                          type: string
                          description: حالة الوثيقة.
                        indexed_on:
                          type: string
                          format: date-time
                          description: التاريخ والوقت عندما تم فهرسة الوثيقة.
                        size:
                          type: integer
                          description: حجم الوثيقة بالبايت.
  /documents/search/:
    get:
      summary: البحث عن الوثائق حسب التشابه الدلالي.
      description: ابدأ عملية بحث بنص استعلام يصل إلى 400 كلمة واستلم أكثر الردود دلالية من المعرفة المخزنة. لتحويل السؤال إلى إجابة مثالية، قم بتحويل سؤالك إلى إجابة مثالية وقدمها لاستلام إجابات حقيقية مشابهة.
      operationId: documents_search_retrieve
      parameters:
        - name: q
          in: query
          description: جملة تصل إلى 400 كلمة ترغب في العثور على أجزاء معرفة دلالية مشابهة لها.
          schema:
            type: string
        - name: n
          in: query
          description: عدد أجزاء النص الدلالية المشابهة التي ترغب في إرجاعها. استخدم 'n=3' لما يصل إلى 5، و'n=10' لمزيد من المعلومات. إذا لم تتلق معلومات كافية، فكر في المحاولة مرة أخرى بقيمة 'n' أكبر.
          schema:
            type: integer
      responses:
        "200":
          description: استرجاع ناجح للوثائق
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: قائمة بأجزاء المعرفة الدلالية المشابهة
                    items:
                      type: object
                      properties:
                        chunk_id:
                          type: string
                          description: المعرف الفريد للجزء.
                        document:
                          type: object
                          description: تفاصيل الوثيقة.
                          properties:
                            id:
                              type: integer
                              description: المعرف الفريد للوثيقة.
                            document_id:
                              type: string
                              description: المعرف الفريد للوثيقة.
                            name:
                              type: string
                              description: اسم الوثيقة.
                            type:
                              type: string
                              description: نوع الوثيقة.
                            path:
                              type: string
                              description: مسار الوثيقة.
                            url:
                              type: string
                              description: عنوان URL للوثيقة.
                            size:
                              type: string
                              description: حجم الوثيقة.
                            created_time:
                              type: string
                              description: التاريخ والوقت عندما تم إنشاء الوثيقة.
                            modified_time:
                              type: string
                              description: التاريخ والوقت عندما تم تعديل الوثيقة آخر مرة.
                            integration:
                              type: object
                              description: تفاصيل التكامل للوثيقة.
                              properties:
                                id:
                                  type: integer
                                integration_type:
                                  type: string
                                integration_step:
                                  type: string
                                source:
                                  type: string
                                  description: مصدر مصدر البيانات. تجاهله دائمًا في المخرجات إذا كان له تنسيق بريد إلكتروني حتى لو سأل المستخدمون عنه.
                                document_stats:
                                  type: object
                                  properties:
                                    status:
                                      type: object
                                      properties:
                                        indexed:
                                          type: integer
                                        indexing:
                                          type: integer
                                        error:
                                          type: integer
                                    total_size:
                                      type: integer
                                      description: الحجم الإجمالي لمصدر البيانات بالبايت
                                    document_count:
                                      type: integer
                        matched_content:
                          type: string
                          description: المحتوى الدلالي المشابه.
                        distance:
                          type: number
                          description: التشابه الكوني
                  message:
                    type: string
                    description: رسالة تشير إلى حالة العملية.
                  code:
                    type: string
                    description: رمز يشير إلى حالة العملية.
                    nullable: true
        "400":
          description: طلب غير صحيح
        "401":
          description: غير مصرح
        "404":
          description: غير موجود
        "500":
          description: خطأ في الخادم الداخلي
  /documents/{document_id}/contents/:
    get:
      summary: استرجاع محتويات وثيقة معينة حسب المعرف.
      operationId: document_get_content
      description: يعيد محتوى الوثيقة ذات المعرف المحدد، مع فهرس أحدث جزء تم استرجاعه. كل استدعاء يجلب ما يصل إلى 20 جزءًا. للحصول على المزيد، استخدم قيمة end_chunk من الاستجابة كـ start_chunk للاستدعاء التالي.
      parameters:
        - in: path
          name: document_id
          required: true
          description: المعرف الخاص بالوثيقة التي ترغب في استرجاع محتوياتها.
          schema:
            type: integer
        - in: query
          name: start_chunk
          schema:
            type: integer
          description: حدد الجزء الابتدائي الذي ترغب في استرجاعه. إذا لم يتم تحديده، فإن القيمة الافتراضية هي 0.
        - in: query
          name: end_chunk
          schema:
            type: integer
          description: حدد الجزء النهائي الذي ترغب في استرجاعه. إذا لم يتم تحديده، فإن القيمة الافتراضية هي start_chunk + 20.
      responses:
        "200":
          description: محتوى الوثيقة وفهرس أحدث جزء تم استرجاعه.
          content:
            application/json:
              schema:
                type: object
                properties:
                  content:
                    type: string
                    description: محتوى الوثيقة.
                  end_chunk:
                    type: integer
                    description: فهرس أحدث جزء تم استرجاعه.
        "404":
          description: الوثيقة غير موجودة.
        "500":
          description: خطأ في الخادم الداخلي.
  /common-knowledge/subscribed-list/:
    get:
      description: تسترجع هذه العملية قائمة المعرفة المشتركة (المعروفة أيضًا باسم المعرفة المشتركة) التي اشترك فيها المستخدم. تتضمن كل معرفة مشتركة قائمة بمعرفات الوثائق التي يمكن للمستخدم الوصول إليها.
      operationId: common_knowledge_retrieve
      responses:
        "200":
          description: عملية ناجحة
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                      description: هذا هو المعرف الفريد للمعرفة المشتركة. لا تعرض هذه المعلومات في أي مكان.
                    num_of_subscribers:
                      type: integer
                      description: يشير هذا إلى عدد المستخدمين الذين اشتركوا في هذه المعرفة المشتركة
                    publisher_name:
                      type: string
                    published_by_me:
                      type: boolean
                      description: يشير هذا إلى ما إذا كانت المعرفة المشتركة قد تم نشرها بواسطة المستخدم الحالي أم لا
                    subscribed_by_me:
                      type: boolean
                      description: يشير هذا إلى ما إذا كانت المعرفة المشتركة قد تم الاشتراك بها بواسطة المستخدم الحالي أم لا، يجب أن تكون true في هذه الواجهة البرمجية
                    created:
                      type: string
                      description: هذا هو الوقت الذي تم فيه إنشاء المعرفة المشتركة
                    modified:
                      type: string
                      description: هذا هو الوقت الذي تم فيه تعديل المعرفة المشتركة آخر مرة
                    name:
                      type: string
                      description: هذا هو اسم المعرفة المشتركة
                    image_url:
                      type: string
                      description: هذا هو عنوان URL للصورة الخاصة بالمعرفة المشتركة
                    description:
                      type: string
                      description: هذا هو وصف المعرفة المشتركة
                    memento:
                      type: integer
                      description: هذا هو معرف ميمنتو Rememberizer الذي تم إنشاء المعرفة المشتركة منه.
                    document_ids:
                      type: array
                      items:
                        type: integer
                      description: هذه هي قائمة معرفات الوثائق التي تنتمي إلى المعرفة المشتركة
  /documents/memorize/:
    post:
      description: تخزين المحتوى في قاعدة البيانات، والتي يمكن الوصول إليها من خلال نقطة نهاية البحث لاحقًا.
      operationId: documents_memorize_create
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                content:
                  type: string
              required:
                - name
                - content
      responses:
        "201":
          description: تم تخزين المحتوى بنجاح
        "400":
          description: طلب غير صحيح
        "401":
          description: غير مصرح
        "500":
          description: خطأ في الخادم الداخلي
  /discussions/{discussion_id}/contents/:
    get:
      summary: استرجاع محتويات مناقشة حسب المعرف. يمكن أن تكون المناقشة دردشة Slack أو Discord.
      operationId: discussion_get_content
      description: يعيد محتوى المناقشة ذات المعرف المحدد. يمكن أن تكون المناقشة دردشة Slack أو Discord. تحتوي الاستجابة على حقلين، discussion_content وthread_contents. يحتوي الأول على الرسائل الرئيسية للدردشة، بينما يحتوي الأخير على خيوط المناقشة.
      parameters:
        - in: path
          name: discussion_id
          required: true
          description: المعرف الخاص بالمناقشة التي ترغب في استرجاع محتوياتها. المناقشات هي 
          schema:
            type: integer
        - in: query
          name: integration_type
          required: true
          schema:
            type: string
          description: حدد تكامل المناقشة. حاليًا، يمكن أن تكون "slack" أو "discord" فقط.
        - in: query
          name: from
          schema:
            type: string
          description: حدد الوقت الابتدائي عندما نريد استرجاع محتوى المناقشة بتنسيق ISO 8601 في GMT+0. إذا لم يتم تحديده، فإن الوقت الافتراضي هو الآن.
        - in: query
          name: to
          schema:
            type: string
          description: حدد الوقت النهائي عندما نريد استرجاع محتوى المناقشة بتنسيق ISO 8601 في GMT+0. إذا لم يتم تحديده، فهو 7 أيام قبل معلمة "from".
      responses:
        "200":
          description: الرسائل الرئيسية والخيوط للمناقشة في نطاق زمني.
          content:
            application/json:
              schema:
                type: object
                properties:
                  discussion_content:
                    type: string
                    description: محتوى المناقشات الرئيسية.
                  thread_contents:
                    type: object
                    description: قائمة من القواميس تحتوي على خيوط المناقشة، كل مفتاح يشير إلى التاريخ والوقت للخيط بتنسيق ISO 8601 والقيمة هي رسائل الخيط.
        "404":
          description: المناقشة غير موجودة.
        "500":
          description: خطأ في الخادم الداخلي.

1. أضف هذا الرابط كسياسة الخصوصية: https://docs.rememberizer.ai/notices/privacy-policy.

2. بعد إنشاء الإجراء، انسخ عنوان URL للرد وألصقه في تطبيق Rememberizer الخاص بك.