Skip to content

feat: support custom tool upload file #10796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 20, 2024
Merged

Conversation

hjlarry
Copy link
Contributor

@hjlarry hjlarry commented Nov 18, 2024

Summary

Tip

Close issue syntax: Fixes #<issue number> or Resolves #<issue number>, see documentation for more details.

as OPENAPI doc, https://swagger.io/docs/specification/v3_0/describing-request-body/file-upload/
we can support file upload in custom tools.
some people require this feature: #9322

Screenshots

Before: After:

Example YAML Schema:

openapi: 3.0.0
info:
  title: File Upload API
  version: 1.0.1
  description: API for uploading audio files for processing

servers:
  - url: https://ai.gitee.com/api/serverless

paths:
  /whisper-base/speech-to-text:
    post:
      summary: Upload and process file
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          audio/flac:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  description: The audio file to be processed
              required:
                - file
      responses:
        '200':
          description: Successful response

Example JSON Schema:

{
  "openapi": "3.0.0",
  "info": {
    "title": "File Upload API",
    "version": "1.0.0",
    "description": "An API for uploading files with metadata"
  },
  "servers": [
    {
      "url": "https://httpbin.org"
    }
  ],
  "paths": {
    "/post": {
      "post": {
        "summary": "Upload a file",
        "description": "Upload a file with associated metadata",
        "operationId": "uploadFile",
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "file": {
                    "type": "string",
                    "format": "binary",
                    "description": "The file to upload"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response"
          }
        }
      }
    }
  }
}

Checklist

Important

Please review the checklist below before submitting your pull request.

  • This change requires a documentation update, included: Dify Document
  • I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
  • I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
  • I've updated the documentation accordingly.
  • I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods

Sorry, something went wrong.

@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. 🔨 feat:tools Tools for agent, function call related stuff. labels Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔨 feat:tools Tools for agent, function call related stuff. lgtm This PR has been approved by a maintainer size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants