Skip to content
TheChatArchiveThe Chat Archive
gpt-4o-2024-05-13· OpenAIAi2 WildChat-4.8M (AI2)

перепиши код в соответствии с примером из https://github.com/flasgger/flasgger, сам код:…

  1. User

    перепиши код в соответствии с примером из https://github.com/flasgger/flasgger, сам код: from flask import Flask, request, jsonify, make_response from flasgger import Swagger, swag_from from freeGPT import Client import os

    Создаем приложение Flask

    app = Flask(name, static_url_path='/Static', static_folder='Static')

    swagger_template = { "swagger": "2.0", "info": { "title": "GPT-3 API", "description": "API for generating text completions using GPT-3", "version": "1.0.0" } }

    swagger_config = { "headers": [], "specs": [ { "endpoint": 'apispec_1', "route": '/apispec_1.json', # Путь к спецификации JSON "rule_filter": lambda rule: True, # Все эндпоинты включены "model_filter": lambda tag: True # Все модели включены } ], "swagger_ui": True, "specs_route": "/apidocs/" }

    swagger = Swagger(app, config=swagger_config, template=swagger_template)

    def create_completion(prompt, model='gpt3'): # Используем библиотеку freeGPT для генерации текста return Client.create_completion(model, prompt)

    @app.route('/generate', methods=['POST']) @swag_from('swagger.yaml', validation=True) def generate(): try: data = request.json prompt = data.get('prompt', '') model = data.get('model', 'gpt3') prompt = f"Ответь по-русски: {prompt}"

        response_text = create_completion(prompt, model)
    
        decoded_response = response_text.encode('latin1').decode('utf-8')
    
        # Создаем response с добавлением заголовков кеширования
        response = make_response(jsonify({'response': decoded_response.strip()}))
        response.headers['Cache-Control'] = 'no-store'
        response.headers['Pragma'] = 'no-cache'
        response.headers['Expires'] = '0'
        return response
    except Exception as e:
        return jsonify({'error': str(e)}), 500
    

    if name == "main": # Проверяем, что файл swagger.yaml существует и читается swagger_file_path = 'swagger.yaml' if os.path.exists(swagger_file_path): with open(swagger_file_path, 'r') as f: try: import yaml swagger_data = yaml.safe_load(f) print("Swagger YAML файл загружен успешно:") print(swagger_data) except yaml.YAMLError as exc: print("Ошибка при чтении YAML файла:", exc) else: print("Swagger YAML файл не найден по пути:", swagger_file_path)

    os.makedirs('Static', exist_ok=True)  # Убедитесь, что директория Static существует
    app.run(host='0.0.0.0', port=5000)
    
  2. Assistant

    Чтобы адаптировать ваш код с использованием библиотеки Flasgger по примеру из официального репозитория https://github.com/flasgger/flasgger, мы можем внести некоторые изменения. Основные шаги включают объявление и настройку Swagger, а также модификацию маршрута для генерации текста.

    Вот пример кода, переписанного с учетом данного примера:

    from flask import Flask, request, jsonify, make_response
    from flasgger import Swagger, swag_from
    from freeGPT import Client
    import os
    
    # Создаем приложение Flask
    app = Flask(__name__, static_url_path='/Static', static_folder='Static')
    
    swagger_template = {
        "swagger": "2.0",
        "info": {
            "title": "GPT-3 API",
            "description": "API for generating text completions using GPT-3",
            "version": "1.0.0"
        },
        "host": "localhost:5000",
        "basePath": "/",
        "schemes": ["http"],
        "operationId": "getmyData",
        "produces": ["application/json"],
        "consumes": ["application/json"],
    }
    
    swagger_config = {
        "headers": [],
        "specs": [
            {
                "endpoint": 'apispec_1',
                "route": '/apispec_1.json',  # Путь к спецификации JSON
                "rule_filter": lambda rule: True,  # Все эндпоинты включены
                "model_filter": lambda tag: True  # Все модели включены
            }
        ],
        "static_url_path": "/flasgger_static",
        "swagger_ui": True,
        "specs_route": "/apidocs/"
    }
    
    # Инициализация Swagger
    swagger = Swagger(app, config=swagger_config, template=swagger_template)
    
    
    def create_completion(prompt, model='gpt3'):
        # Используем библиотеку freeGPT для генерации текста
        return Client.create_completion(model, prompt)
    
    
    @app.route('/generate', methods=['POST'])
    @swag_from('swagger.yaml', validation=True)
    def generate():
        """
        This is the text generation endpoint.
        Call this API passing a JSON body with 'prompt' and 'model' fields.
        ---
        tags:
          - Text Generation
        parameters:
          - in: body
            name: body
            description: JSON object containing the prompt and model
            schema:
              type: object
              required:
                - prompt
              properties:
                prompt:
                  type: string
                  description: The text prompt to complete.
                model:
                  type: string
                  default: "gpt3"
                  description: The model to use, default is gpt3.
        responses:
          200:
            description: Text generated successfully
            schema:
              type: object
              properties:
                response:
                  type: string
                  description: The generated text.
          500:
            description: Internal server error
        """
        try:
            data = request.json
            prompt = data.get('prompt', '')
            model = data.get('model', 'gpt3')
            prompt = f"Ответь по-русски: {prompt}"
    
            response_text = create_completion(prompt, model)
    
            decoded_response = response_text.encode('latin1').decode('utf-8')
    
            # Создаем response с добавлением заголовков кеширования
            response = make_response(jsonify({'response': decoded_response.strip()}))
            response.headers['Cache-Control'] = 'no-store'
            response.headers['Pragma'] = 'no-cache'
            response.headers['Expires'] = '0'
            return response
        except Exception as e:
            return jsonify({'error': str(e)}), 500
    
    
    if __name__ == "__main__":
        # Проверяем, что файл swagger.yaml существует и читается
        swagger_file_path = 'swagger.yaml'
        if os.path.exists(swagger_file_path):
            with open(swagger_file_path, 'r') as f:
                try:
                    import yaml
                    swagger_data = yaml.safe_load(f)
                    print("Swagger YAML файл загружен успешно:")
                    print(swagger_data)
                except yaml.YAMLError as exc:
                    print("Ошибка при чтении YAML файла:", exc)
        else:
            print("Swagger YAML файл не найден по пути:", swagger_file_path)
    
        os.makedirs('Static', exist_ok=True)  # Убедитесь, что директория Static существует
        app.run(host='0.0.0.0', port=5000)
    

    Основные изменения включают настройку Swagger и добавление раздела документации для маршрута /generate. Код предполагает, что вы имеете корректный 'swagger.yaml' файл для определения деталей маршрута.

    Тестирование и отладка Flask приложения важны, убедитесь, что все установленные зависимости корректны, и путь к 'swagger.yaml' актуален.

  3. User

    добавь содержимое YAML в код напрямую: from flask import Flask, request, jsonify, make_response from flasgger import Swagger, swag_from from freeGPT import Client import os

    Создаем приложение Flask

    app = Flask(name, static_url_path='/Static', static_folder='Static')

    swagger_template = { "swagger": "2.0", "info": { "title": "GPT-3 API", "description": "API for generating text completions using GPT-3", "version": "1.0.0" }, "host": "localhost:5000", "basePath": "/", "schemes": ["http"], "operationId": "getmyData", "produces": ["application/json"], "consumes": ["application/json"], }

    swagger_config = { "headers": [], "specs": [ { "endpoint": 'apispec_1', "route": '/apispec_1.json', # Путь к спецификации JSON "rule_filter": lambda rule: True, # Все эндпоинты включены "model_filter": lambda tag: True # Все модели включены } ], "static_url_path": "/flasgger_static", "swagger_ui": True, "specs_route": "/apidocs/" }

    Инициализация Swagger

    swagger = Swagger(app, config=swagger_config, template=swagger_template)

    def create_completion(prompt, model='gpt3'): # Используем библиотеку freeGPT для генерации текста return Client.create_completion(model, prompt)

    @app.route('/generate', methods=['POST']) @swag_from('swagger.yaml', validation=True) def generate(): """ This is the text generation endpoint. Call this API passing a JSON body with 'prompt' and 'model' fields. — tags: - Text Generation parameters: - in: body name: body description: JSON object containing the prompt and model schema: type: object required: - prompt properties: prompt: type: string description: The text prompt to complete. model: type: string default: "gpt3" description: The model to use, default is gpt3. responses: 200: description: Text generated successfully schema: type: object properties: response: type: string description: The generated text. 500: description: Internal server error """ try: data = request.json prompt = data.get('prompt', '') model = data.get('model', 'gpt3') prompt = f"Ответь по-русски: {prompt}"

        response_text = create_completion(prompt, model)
    
        decoded_response = response_text.encode('latin1').decode('utf-8')
    
        # Создаем response с добавлением заголовков кеширования
        response = make_response(jsonify({'response': decoded_response.strip()}))
        response.headers['Cache-Control'] = 'no-store'
        response.headers['Pragma'] = 'no-cache'
        response.headers['Expires'] = '0'
        return response
    except Exception as e:
        return jsonify({'error': str(e)}), 500
    

    if name == "main": # Проверяем, что файл swagger.yaml существует и читается swagger_file_path = 'swagger.yaml' if os.path.exists(swagger_file_path): with open(swagger_file_path, 'r') as f: try: import yaml swagger_data = yaml.safe_load(f) print("Swagger YAML файл загружен успешно:") print(swagger_data) except yaml.YAMLError as exc: print("Ошибка при чтении YAML файла:", exc) else: print("Swagger YAML файл не найден по пути:", swagger_file_path)

    os.makedirs('Static', exist_ok=True)  # Убедитесь, что директория Static существует
    app.run(host='0.0.0.0', port=5000)
    
  4. Assistant

    Для включения содержимого YAML файла непосредственно в код, необходимо перенести аннотации API из YAML в строку документации вашего маршрута. Это позволит вам избавиться от внешнего файла swagger.yaml.

    Вот ваше обновленное приложение Flask с Flasgger, где анотации находятся непосредственно в коде:

    from flask import Flask, request, jsonify, make_response
    from flasgger import Swagger
    from freeGPT import Client
    import os
    
    # Создаем приложение Flask
    app = Flask(__name__, static_url_path='/Static', static_folder='Static')
    
    swagger_template = {
        "swagger": "2.0",
        "info": {
            "title": "GPT-3 API",
            "description": "API for generating text completions using GPT-3",
            "version": "1.0.0"
        },
        "host": "localhost:5000",
        "basePath": "/",
        "schemes": ["http"],
        "operationId": "getmyData",
        "produces": ["application/json"],
        "consumes": ["application/json"],
    }
    
    swagger_config = {
        "headers": [],
        "specs": [
            {
                "endpoint": 'apispec_1',
                "route": '/apispec_1.json',  # Путь к спецификации JSON
                "rule_filter": lambda rule: True,  # Все эндпоинты включены
                "model_filter": lambda tag: True  # Все модели включены
            }
        ],
        "static_url_path": "/flasgger_static",
        "swagger_ui": True,
        "specs_route": "/apidocs/"
    }
    
    # Инициализация Swagger
    swagger = Swagger(app, config=swagger_config, template=swagger_template)
    
    
    def create_completion(prompt, model='gpt3'):
        # Используем библиотеку freeGPT для генерации текста
        return Client.create_completion(model, prompt)
    
    
    @app.route('/generate', methods=['POST'])
    def generate():
        """
        This is the text generation endpoint.
        Call this API passing a JSON body with 'prompt' and 'model' fields.
        ---
        tags:
          - Text Generation
        parameters:
          - in: body
            name: body
            description: JSON object containing the prompt and model
            schema:
              type: object
              required:
                - prompt
              properties:
                prompt:
                  type: string
                  description: The text prompt to complete.
                model:
                  type: string
                  default: "gpt3"
                  description: The model to use, default is gpt3.
        responses:
          200:
            description: Text generated successfully
            schema:
              type: object
              properties:
                response:
                  type: string
                  description: The generated text.
          500:
            description: Internal server error
        """
        try:
            data = request.json
            prompt = data.get('prompt', '')
            model = data.get('model', 'gpt3')
            prompt = f"Ответь по-русски: {prompt}"
    
            response_text = create_completion(prompt, model)
    
            decoded_response = response_text.encode('latin1').decode('utf-8')
    
            # Создаем response с добавлением заголовков кеширования
            response = make_response(jsonify({'response': decoded_response.strip()}))
            response.headers['Cache-Control'] = 'no-store'
            response.headers['Pragma'] = 'no-cache'
            response.headers['Expires'] = '0'
            return response
        except Exception as e:
            return jsonify({'error': str(e)}), 500
    
    
    if __name__ == "__main__":
        os.makedirs('Static', exist_ok=True)  # Убедитесь, что директория Static существует
        app.run(host='0.0.0.0', port=5000)
    

    Основные изменения:

    1. Убраны ссылки на внешний файл swagger.yaml.
    2. Добавлена документация Swagger непосредственно внутри строки документации функции generate().

    Теперь эта конфигурация будет работать без зависимости от внешнего YAML файла, все аннотации Swagger находятся прямо в коде.

  5. User

    No operations defined in spec!

  6. Assistant

    Сообщение "No operations defined in spec!" возникает, когда Swagger не находит определений операций для ваших маршрутов в спецификации. Это может произойти по нескольким причинам, таким как ошибки в разметке или отсутствие аннотаций.

    В данном случае, чтобы устранить эту ошибку, нужно проверить несколько моментов:

    1. Корректность разметки YAML в строке документации функции (docstring).
    2. Отсутствие синтаксических и прочих ошибок в Swagger конфигурации.
    3. Убедиться, что Flasgger правильно инициализирован.

    Давайте попробуем немного реорганизовать наш код и убедиться, что все правильно прописано. Также добавим отладочную информацию.

    Вот обновленный пример:

    from flask import Flask, request, jsonify, make_response
    from flasgger import Swagger
    from freeGPT import Client
    
    # Создаем приложение Flask
    app = Flask(__name__, static_url_path='/Static', static_folder='Static')
    
    swagger_template = {
        "swagger": "2.0",
        "info": {
            "title": "GPT-3 API",
            "description": "API for generating text completions using GPT-3",
            "version": "1.0.0"
        },
        "host": "localhost:5000",
        "basePath": "/",
        "schemes": ["http"],
        "produces": ["application/json"],
        "consumes": ["application/json"],
    }
    
    swagger_config = {
        "headers": [],
        "specs": [
            {
                "endpoint": 'apispec_1',
                "route": '/apispec_1.json',  # Путь к спецификации JSON
                "rule_filter": lambda rule: True,  # Все эндпоинты включены
                "model_filter": lambda tag: True  # Все модели включены
            }
        ],
        "static_url_path": "/flasgger_static",
        "swagger_ui": True,
        "specs_route": "/apidocs/"
    }
    
    # Инициализация Swagger
    swagger = Swagger(app, config=swagger_config, template=swagger_template)
    
    
    def create_completion(prompt, model='gpt3'):
        # Используем библиотеку freeGPT для генерации текста
        return Client.create_completion(model, prompt)
    
    
    @app.route('/generate', methods=['POST'])
    def generate():
        """
        This is the text generation endpoint.
        Call this API passing a JSON body with 'prompt' and 'model' fields.
        ---
        tags:
          - Text Generation
        parameters:
          - in: body
            name: body
            description: JSON object containing the prompt and model.
            required: true
            schema:
              type: object
              required:
                - prompt
              properties:
                prompt:
                  type: string
                  description: The text prompt to complete.
                  example: "Пример текста"
                model:
                  type: string
                  description: The model to use, default is gpt3.
                  default: "gpt3"
                  example: "gpt3"
        responses:
          200:
            description: Text generated successfully
            schema:
              type: object
              properties:
                response:
                  type: string
                  description: The generated text.
          500:
            description: Internal server error
        """
        try:
            data = request.json
            prompt = data.get('prompt', '')
            model = data.get('model', 'gpt3')
            prompt = f"Ответь по-русски: {prompt}"
    
            response_text = create_completion(prompt, model)
    
            decoded_response = response_text.encode('latin1').decode('utf-8')
    
            # Создаем response с добавлением заголовков кеширования
            response = make_response(jsonify({'response': decoded_response.strip()}))
            response.headers['Cache-Control'] = 'no-store'
            response.headers['Pragma'] = 'no-cache'
            response.headers['Expires'] = '0'
            return response
        except Exception as e:
            return jsonify({'error': str(e)}), 500
    
    
    if __name__ == "__main__":
        app.run(host='0.0.0.0', port=5000)
    

    Изменения и оптимизации:

    1. Убедились, что отступы в строке документации соблюдены правильно.
    2. Добавили "required": true для параметров, чтобы Swagger корректно интерпретировал параметры тела запроса.
    3. Перенесли пример для prompt и model прямо в описание параметров, чтобы упростить восприятие Swagger UI.
    4. Убрал проверку существования swagger.yaml, так как она больше не требуется.

    Запустите приложение и перейдите на /apidocs/, чтобы убедиться, что маршруты корректно появляются в документации Swagger.