Плагин Endpoint

​

Определение группы

​

Структура

• settings (map[string] ProviderConfig): определение конфигурации эндпоинта.
• endpoints (list[string], обязательно): указывает на конкретные определения интерфейсов endpoint.

settings:
  api_key:
    type: secret-input
    required: true
    label:
      en_US: API key
      zh_Hans: API key
      ja_Jp: API key
      pt_BR: API key
    placeholder:
      en_US: Please input your API key
      zh_Hans: 请输入你的 API key
      ja_Jp: あなたの API key を入れてください
      pt_BR: Por favor, insira sua chave API
endpoints:
  - endpoints/duck.yaml
  - endpoints/neko.yaml

​

Определение интерфейса

• path (string): следует стандарту интерфейсов Werkzeug.
• method (string): метод интерфейса, поддерживаются только HEAD, GET, POST, PUT, DELETE, OPTIONS.
• extra (object): конфигурация помимо базовых сведений.
  • python (object)
    • source (string): исходный код, реализующий этот интерфейс.

path: "/duck/<app_id>"
method: "GET"
extra:
  python:
    source: "endpoints/duck.py"

​

Реализация интерфейса

• Входные параметры
  • r (Request): объект Request из werkzeug.
  • values (Mapping): параметры пути, разобранные из path.
  • settings (Mapping): конфигурация для данного Endpoint.
• Возвращаемое значение
  • Объект Response из werkzeug, поддерживает потоковые ответы.
  • Прямой возврат строки не поддерживается.

import json
from typing import Mapping
from werkzeug import Request, Response
from dify_plugin import Endpoint

class Duck(Endpoint):
    def _invoke(self, r: Request, values: Mapping, settings: Mapping) -> Response:
        """
        Invokes the endpoint with the given request.
        """
        app_id = values["app_id"]

        def generator():
            yield f"{app_id} <br>"

        return Response(generator(), status=200, content_type="text/html")

​

Примечания

• Эндпоинты создаются только при вызове плагина; это не постоянно работающие сервисы.
• При разработке эндпоинтов уделяйте внимание безопасности и избегайте выполнения опасных операций.
• Эндпоинты можно использовать для обработки вебхук-колбэков или для предоставления интерфейсов, к которым подключаются другие системы.

​

Дополнительные материалы

• Основные понятия разработки плагинов — общее представление об архитектуре разработки плагинов.
• Пример Neko Cat — пример разработки плагина-расширения.
• Определение общих спецификаций — общие структуры, такие как ProviderConfig.
• Пример разработки плагина Slack-бота — ещё один пример разработки плагина.
• Начало работы с разработкой плагинов — разработка плагина с нуля.
• Обратный вызов сервисов Интеллос — как использовать функцию обратного вызова.