FilePulse المحلي HTTP واجهة برمجة التطبيقات

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

يسمح للذكاء الاصطناعي والبرامج النصية والمشغلات والأدوات الداخلية باستدعاء إمكانات البحث والمعاينة الخاصة بـ FilePulse من خلال واجهة الويب HTTP API المحلية التي تستخدمها واجهة الويب FilePulse.

مثال لقاعدة URLhttp://127.0.0.1:80

يستخدم المثال المنفذ الافتراضي HTTP رقم 80 في config_default.json. أثناء النشر الفعلي، يرجى الرجوع إلى المنفذ في ملف config.json المحلي الخاص بالمستخدم.

ابدأ هنا

عملية المصادقة

استكشف أولاً، ثم قم بتسجيل الدخول للحصول على الرمز المميز، ثم ضع الرمز المميز الذي تم إرجاعه مباشرةً في رأس التفويض. لا تقم بإضافة البادئة Bearer.

01
GET/api/ver

اكتشاف الإصدار وقراءته

إصدار الإرجاع والخطة. قد تعرض الإصدارات المتوفرة عبر الإنترنت أيضًا المعرف الفريد (uid) والرخصة_المتبقية_الساعات. هذه الواجهة لا تتطلب رمزًا مميزًا.

مثال على الطلب: /api/ver
curl http://127.0.0.1:80/api/ver
02
POST/api/login

إنشاء رمز وصول

أرسل اسم المستخدم وكلمة المرور باستخدام JSON. تحتوي الاستجابة على اسم الخادم ورمز الوصول.

مثال على الطلب: /api/login
curl -X POST http://127.0.0.1:80/api/login \
  -H "Content-Type: application/json" \
  -d '{"username":"root","password":"root"}'
03
HEADERAuthorization: <access_token>

استدعاء واجهة برمجة التطبيقات المحمية

تضع الطلبات اللاحقة الرمز المميز مباشرة في رأس التفويض، أو في معلمة استعلام التفويض.

مثال على الطلب: Authorization: <access_token>
curl http://127.0.0.1:80/api/search_scope_targets \
  -H "Authorization: $FILEPULSE_TOKEN"

الواجهات الأساسية

نقاط النهاية العامة المشتركة

تلائم هذه الواجهات سير العمل المدعوم بالذكاء الاصطناعي: اكتشاف النطاق والبحث والمعاينة والتنزيل، مع فتح الملفات فقط بعد تأكيد المستخدم.

GET/api/search_scope_targets
Token

الأقراص والنطاقات القابلة للبحث

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

الحقول الرئيسية

  • يمكن تمرير رقم القرص الذي تم إرجاعه إلى drive_scope.drive_indices.
  • سير عمل الذكاء الاصطناعي إذا كنت تريد تجنب أهداف التثبيت عن بعد، فيمكنك استخدام drive_scope.local_only.
مثال على الطلب: /api/search_scope_targets
curl http://127.0.0.1:80/api/search_scope_targets \
  -H "Authorization: $FILEPULSE_TOKEN"
POST/api/search
Token

اسم الملف والبحث عن المسار

البحث حسب البيانات التعريفية للملف/المجلد، ودعم أحرف البدل أو الأنماط العادية، والتصفية والفرز والترحيل.

الحقول الرئيسية

  • الوضع: regex أو حرف البدل
  • search_by: الاسم أو مسار_كامل
  • الفرز_حسب: الاسم أو المسار الكامل أو الحجم أو التعديل أو التحويل
  • النوع: 0 يعني الملفات والمجلدات، 1 يعني المجلدات، 2 يعني الملفات
  • تتحكم pin_priority/use_groups في أولوية الدبوس وسلوك التجميع
  • ترجع واجهة طلب inline_icon.size بيانات الأيقونة المضمنة
  • البداية/النهاية هي النتيجة المنخفضة بما في ذلك الحدود
مثال للبحث عن الملفات
curl -X POST 'http://127.0.0.1:80/api/search' \
  -H 'Content-Type: application/json' \
  -H "Authorization: $FILEPULSE_TOKEN" \
  --data-raw '{
    "search_content": "a",
    "mode": "wildcard",
    "case_sensitive": false,
    "search_by": "name",
    "sort_by": "modified",
    "sort_asc": false,
    "content_plugin": [""],
    "kind": 0,
    "pin_priority": false,
    "use_groups": false,
    "start": 0,
    "end": 13,
    "inline_icon": {
      "size": 32
    }
  }'
POST/api/content_search
Token

البحث عن محتوى النص الكامل

نص مستند البحث، ونص OCR، والمحتوى المفهرس لمعالجات المحتوى التي تم تكوينها. يوصى بتشغيل المقتطف عندما يحتاج الذكاء الاصطناعي إلى الوصول إلى السياق.

الحقول الرئيسية

  • عندما يكون الخطي خاطئًا، يتم دعم العادي والتعبير العادي والبادئة والغامض
  • عندما يكون الخطي صحيحًا، يتم دعم أوضاع اجتياز أحرف البدل والتعبير العادي
  • sort_by: لا شيء، ملف أو نتيجة
  • يمكن لملف_search_condition إعادة استخدام شروط التصفية لـ /api/search
  • يتحكم المقتطف في ما إذا كان سيتم إرجاع سياق النتيجة
  • تتحكم pin_priority/use_groups في أولوية الدبوس وسلوك التجميع
  • ترجع واجهة طلب inline_icon.size بيانات الأيقونة المضمنة
مثال على الطلب: /api/content_search
curl -X POST 'http://127.0.0.1:80/api/content_search' \
  -H 'Content-Type: application/json' \
  -H "Authorization: $FILEPULSE_TOKEN" \
  --data-raw '{
    "linear": false,
    "search_content": "a",
    "mode": "regular",
    "fuzzy_distance": 2,
    "score_top_k": 100,
    "sort_by": "score",
    "sort_asc": false,
    "snippet": false,
    "snippet_radius": 100,
    "pin_priority": false,
    "use_groups": false,
    "start": 0,
    "end": 13,
    "inline_icon": {
      "size": 32
    }
  }'
GET/api/visual_status
Token

حالة البحث المرئي

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

الحقول الرئيسية

  • تحقق من الملفات الممكّنة والجاهزة قبل إرسال استعلامات الصور أو الفيديو.
  • يمكنك استخدام Indexing/current_file_count/total_file_count لتحديد ما إذا كنت بحاجة إلى الانتظار حتى يكتمل الفهرس.
مثال على الطلب: /api/visual_status
curl http://127.0.0.1:80/api/visual_status \
  -H "Authorization: $FILEPULSE_TOKEN"
POST/api/visual_search
Token

البحث المشابه عن الصور والفيديو

استخدم بيانات النماذج متعددة الأجزاء لإرسال الصور أو لقطات الشاشة أو مقاطع الفيديو، أو FilePulse مسار الاستعلام المطلق على المضيف.

الحقول الرئيسية

  • يجب تقديم ملف أو query_path
  • يتلقى محرك_المؤشرات سلسلة مصفوفة JSON
  • يحدد top_k عدد المرتجعات
  • يقوم الوضع fast_mode بتداول الدقة من أجل السرعة
  • search_detail وmin_match_count قابلان للتعديل مطابقة الفيديو
مثال على الطلب: /api/visual_search
curl -X POST 'http://127.0.0.1:80/api/visual_search' \
  -H "Authorization: $FILEPULSE_TOKEN" \
  -F 'file=@query.jpg' \
  -F 'top_k=20' \
  -F 'drive_indices=[0]' \
  -F 'fast_mode=true'
GET/api/download/{encodedPath}
Token

تنزيل الملفات أو معاينتها

يُرجع البث مسارات الملفات الأصلية أو الوكيل. برجاء وضع المسار الكامل في المسار بعد تشفير URL وحمل التفويض. تدعم خدمة الملفات الأساسية طلبات النطاق.

الحقول الرئيسية

  • يتم استخدام x-proxy فقط مع اسم_الخادم البعيد المسجل.
  • يقبل مسارات الملفات فقط؛ سترجع المجلدات خطأ.
مثال على الطلب: /api/download/{encodedPath}
curl 'http://127.0.0.1:80/api/download/D%3A%5Cdocs%5Creport.pdf' \
  -H "Authorization: $FILEPULSE_TOKEN" \
  --output report.pdf
POST/api/folder_preview
Token

معاينة المجلدات الفرعية

إرجاع قائمة صغيرة ومرتبة من المجلدات لتجنب سحب جميع المجلدات الفرعية مرة واحدة.

الحقول الرئيسية

  • المسار مطلوب
  • الحد الافتراضي 80، الحد الأقصى 200
  • تحتوي الاستجابة على إجمالي_الأطفال ومقتطعة
مثال على الطلب: /api/folder_preview
curl -X POST http://127.0.0.1:80/api/folder_preview \
  -H "Content-Type: application/json" \
  -H "Authorization: $FILEPULSE_TOKEN" \
  -d '{"path":"D:\\docs","limit":50}'
POST/api/content_match_preview
Token

معاينة سياق نتيجة المحتوى

احصل على سياق HTML/نص لنتيجة بحث محتوى معينة، حتى يتمكن الذكاء الاصطناعي من التحقق من موقع النتيجة قبل طلب ذلك افتح الملف.

الحقول الرئيسية

  • المسار، المعدل، search_content، الوضع المطلوب
  • يجب أن تكون المسافة الخطية والمسافة الغامضة متوافقة مع طلب البحث عن المحتوى الأصلي
مثال على الطلب: /api/content_match_preview
curl -X POST http://127.0.0.1:80/api/content_match_preview \
  -H "Content-Type: application/json" \
  -H "Authorization: $FILEPULSE_TOKEN" \
  -d '{
    "path": "D:\\docs\\report.pdf",
    "modified": 1717113600,
    "search_content": "invoice",
    "mode": "regular",
    "linear": false,
    "fuzzy_distance": 2
  }'
POST/api/openfile
Token

افتح الملف على المضيف

قم بتشغيل الملف أو البرنامج القابل للتنفيذ على الجهاز الذي يوجد به FilePulse. هذه العملية لها آثار جانبية، ويجب أن تطلب أدوات الذكاء الاصطناعي من المستخدمين التأكيد بشكل صريح أولاً.

الحقول الرئيسية

  • المسار مطلوب
  • يمكن ترك مجلد العمل فارغًا وسيتم استنتاج الدليل الأصلي تلقائيًا
  • admin يعني محاولة البدء بحقوق المسؤول على الأنظمة الأساسية المدعومة
مثال على الطلب: /api/openfile
curl -X POST http://127.0.0.1:80/api/openfile \
  -H "Content-Type: application/json" \
  -H "Authorization: $FILEPULSE_TOKEN" \
  -d '{"path":"D:\\docs\\report.pdf","work_folder":"","admin":false}'
POST/api/quick_launcher
Token

بحث سريع عن المشغل

البحث عن التطبيقات والمجلدات والاختصارات القابلة للتشغيل، ويتبع نص الطلب بشكل أساسي بنية /api/search.

الحقول الرئيسية

  • يتبع نص الطلب SearchReqJson
  • مناسب للذكاء الاصطناعي لتحديد موقع التطبيقات أو الأدلة شائعة الاستخدام أولاً، ثم مطالبة المستخدم بتأكيد ما إذا كان سيبدأ أم لا.
مثال على الطلب: /api/quick_launcher
curl -X POST http://127.0.0.1:80/api/quick_launcher \
  -H "Content-Type: application/json" \
  -H "Authorization: $FILEPULSE_TOKEN" \
  -d '{
    "search_content": "chrome",
    "mode": "wildcard",
    "case_sensitive": false,
    "search_by": "full_path",
    "sort_by": "modified",
    "sort_asc": false,
    "content_plugin": [""],
    "kind": 0,
    "start": 0,
    "end": 9
  }'

توصيات استدعاء الذكاء الاصطناعي

سير عمل الذكاء الاصطناعي الموصى به

احتفظ بالنموذج في مسار ضيق: المصادقة والبحث والفحص ثم طلب تأكيد المستخدم قبل فتح الملف أو تغييره.

ver
login
search / content_search / visual_search
preview / download
user-confirmed openfile

لا تعطي كلمة المرور للنموذج لفترة طويلة

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

يجب تأكيد الملف المفتوح أولاً

قد يؤدي فتح ملف إلى بدء تشغيل برنامج أو كشف البيانات المحلية. يجب أن يُظهر الذكاء الاصطناعي المسار الدقيق وينتظر موافقة المستخدم.

اطلب ترحيل صفحات صغير أولاً

يوصى باستخدام الطرف 9 أو الطرف 19 أولاً، والتحقق من اسم الملف والملخص، ثم طلب المزيد من النتائج حسب الحاجة.

لا تغطي هذه الصفحة

واجهة برمجة التطبيقات (API) المتقدمة والداخلية

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

sync/**_internalكتابة التكوينمشاركة التكوينتكوين LLMتنظيف الملفات المكررةupload