openapi: 3.0.2
info:
  title: NLPCloud
  version: 1.0.0
  x-apisguru-categories:
    - text
  x-origin:
    - format: openapi
      url: https://nlpcloud.io/openapi.json
      version: "3.0"
  x-providerName: nlpcloud.io
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_apis.guru_assets_images_no-logo.svg
security:
  - bearerAuth: []
paths:
  /v1/en_core_web_sm/:
    get:
      operationId: read_root_v1_en_core_web_sm__get
      responses:
        "200":
          content:
            application/json:
              schema: {}
          description: Successful Response
      summary: Read Root
  /v1/en_core_web_sm/dependencies:
    post:
      operationId: read_dependencies_v1_en_core_web_sm_dependencies_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UserRequestIn"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DependenciesOut"
          description: Successful Response
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
          description: Validation Error
      summary: Read Dependencies
  /v1/en_core_web_sm/entities:
    post:
      operationId: read_entities_v1_en_core_web_sm_entities_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UserRequestIn"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EntitiesOut"
          description: Successful Response
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
          description: Validation Error
      summary: Read Entities
  /v1/en_core_web_sm/sentence-dependencies:
    post:
      operationId: read_sentence_dependencies_v1_en_core_web_sm_sentence_dependencies_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UserRequestIn"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SentenceDependenciesOut"
          description: Successful Response
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
          description: Validation Error
      summary: Read Sentence Dependencies
  /v1/en_core_web_sm/version:
    get:
      operationId: read_version_v1_en_core_web_sm_version_get
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/VersionOut"
          description: Successful Response
      summary: Read Version
components:
  schemas:
    Arc:
      properties:
        dir:
          title: Dir
          type: string
        end:
          title: End
          type: integer
        label:
          title: Label
          type: string
        start:
          title: Start
          type: integer
        text:
          title: Text
          type: string
      required:
        - start
        - end
        - label
        - text
        - dir
      title: Arc
      type: object
    DependenciesOut:
      properties:
        arcs:
          items:
            $ref: "#/components/schemas/Arc"
          title: Arcs
          type: array
        words:
          items:
            $ref: "#/components/schemas/Word"
          title: Words
          type: array
      required:
        - words
        - arcs
      title: DependenciesOut
      type: object
    EntitiesOut:
      properties:
        entities:
          items:
            $ref: "#/components/schemas/EntityOut"
          title: Entities
          type: array
      required:
        - entities
      title: EntitiesOut
      type: object
    EntityOut:
      properties:
        end:
          title: End
          type: integer
        start:
          title: Start
          type: integer
        text:
          title: Text
          type: string
        type:
          title: Type
          type: string
      required:
        - start
        - end
        - type
        - text
      title: EntityOut
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: "#/components/schemas/ValidationError"
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    SentenceDependenciesOut:
      properties:
        sentence_dependencies:
          items:
            $ref: "#/components/schemas/SentenceDependencyOut"
          title: Sentence Dependencies
          type: array
      required:
        - sentence_dependencies
      title: SentenceDependenciesOut
      type: object
    SentenceDependencyOut:
      properties:
        dependencies:
          $ref: "#/components/schemas/DependenciesOut"
        sentence:
          title: Sentence
          type: string
      required:
        - sentence
        - dependencies
      title: SentenceDependencyOut
      type: object
    UserRequestIn:
      properties:
        text:
          title: Text
          type: string
      required:
        - text
      title: UserRequestIn
      type: object
    ValidationError:
      properties:
        loc:
          items:
            type: string
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    VersionOut:
      properties:
        spacy:
          title: Spacy
          type: string
      required:
        - spacy
      title: VersionOut
      type: object
    Word:
      properties:
        tag:
          title: Tag
          type: string
        text:
          title: Text
          type: string
      required:
        - text
        - tag
      title: Word
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http
