Actionpower NLP API

openapi: 3.2.0
info:
  title: Cloud API 문서 NLP API
  version: '1.0'
  description: 'API를 서비스를 사용하기 위해서는 JWT 토큰이 필요합니다.


    ## API Rate Limits


    각 API Endpoint 별 20 requests/sec 의 Rate Limit이 적용됩니다.


    이 허용치를 초과하는 요청량에 대해서는 HTTP 429 Too Many Request Error 응답이 나갈 수 있으며,


    반복, 지속적으로 요청량을 초과하게 되는 경우, 비정상적인 이용으로 간주되어 요청이 차단될 수 있습니다.'
  contact:
    name: Customer Service
    email: cs@daglo.ai
  termsOfService: https://daglo.ai/terms
  license:
    url: https://daglo.ai/license
    name: License
security:
- BearerAuth: []
tags:
- name: NLP
paths:
  /nlp/v1/sync/summaries:
    x-permission: nlp-sync-summary
    post:
      x-descriptors:
      - default: summary
      - default: dialogue
        at: /nlpConfig/summary/model
      x-features:
      - name: keywordExtraction
        at: /nlpConfig/keywordExtraction/enable
        regex: 'true'
      summary: Summarize short dialogue
      description: 대화 형태의 텍스트를 요약합니다. 동기화 방식이 사용됩니다.
      tags:
      - NLP
      operationId: post-nlp-v1-sync-summaries
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              x-tags:
              - NLP
              properties:
                text:
                  oneOf:
                  - type: array
                    description: DialogueUtterance 객체의 배열입니다.
                    items:
                      type: object
                      description: 발화 정보를 전달하기 위한 객체입니다. 화자 정보 및 화자의 발화 정보를 담고 있습니다.
                      properties:
                        speaker:
                          type: string
                          description: 화자의 이름 또는 ID 입니다.
                          example: 상담원
                        text:
                          type: string
                          description: 화자의 발화 내용입니다.
                          example: 안녕하세요. 상담원 ㅇㅇㅇ입니다. 무엇을 도와드릴까요?
                      x-tags:
                      - NLP
                    x-tags:
                    - NLP
                  - type: string
                    description: 문자열 형태의 텍스트입니다.
                    x-tags:
                    - Common
                nlpConfig:
                  type: object
                  description: 텍스트 요약 설정입니다.
                  properties:
                    summary:
                      type: object
                      description: '텍스트 요약 설정을 위한 객체입니다.


                        이 설정을 사용하면 텍스트를 요약한 결과를 반환합니다.'
                      properties:
                        enable:
                          type: boolean
                          description: 텍스트 요약을 활성화 하기 위해서는 반드시 `true`로 설정해야 합니다.
                        model:
                          type: string
                          enum:
                          - dialogue
                          description: '텍스트 요약을 위해 사용할 모델을 이름입니다.


                            명시하지 않을 경우 dialogue가 사용됩니다.


                            사용 가능한 모델은 다음과 같습니다.


                            |모델|설명|

                            |:---:|:---:|

                            |dialogue|대화를 요약하는 모델입니다.|'
                        outputSizeOption:
                          type: string
                          enum:
                          - small
                          - medium
                          - large
                          description: '요약 결과의 분량을 결정하는 설정입니다.


                            `small`, `medium`, `large` 중 하나를 사용 할 수 있습니다.


                            `maxCharsPerParagraph` 값이 주어질 경우 `outputSizeOption`은 무시됩니다.'
                        maxCharsPerParagraph:
                          type: integer
                          description: '한 문단을 구성 할 수 있는 최대 글자 개수 입니다. 이 값보다 적은 글자 수를 이용하여 하나의 문단을 구성합니다.


                            `maxCharsPerParagraph`의 값에 따라 결과 요약 문자의 수가 달라집니다.


                            `maxCharsPerParagraph` 값이 주어질 경우 `outputSizeOption`은 무시됩니다.'
                          example: 6000
                      x-tags:
                      - NLP
                    keywordExtraction:
                      type: object
                      description: '키워드 추출 설정을 위한 객체입니다.


                        이 설정을 사용하면 텍스트에서 키워드를 추룰합니다.'
                      x-tags:
                      - NLP
                      properties:
                        enable:
                          type: boolean
                          description: 키워드 추출을 활성화 하기 위해서는 반드시 `true`로 설정해야 합니다.
                        maxCount:
                          type: integer
                          description: "추출 할 키워드의 최대 개수 입니다. \n\n값이 클 경우 속도에 영향을 줄 수 있습니다.\n\n키워드가 많지 않을 경우 명시된 수 보다 적은 수의 키워드를 추출 할 수 있습니다."
                          minimum: 1
                          example: 10
                        extractAdjectives:
                          type: boolean
                          x-stoplight:
                            id: s6xtt4dnp0ksv
                          description: '형용사 키워드를 추출여부입니다.


                            true 일 경우 형용사 키워드를 추가로 추출합니다.

                            enable의 값이 true 일 경우에 활성화 됩니다.


                            추출 할 키워드의 수는 maxCount 값에 의해 결정됩니다.'
                  x-tags:
                  - NLP
                returnElapsedTime:
                  type: boolean
                  description: '계산 소요 시간 반환 여부입니다. `true` 일 경우 response body에 elapsedTime이 추가됩니다.

                    '
                  x-tags:
                  - Common
                  default: false
                custom:
                  type: object
                  description: '응답에 포함하여 받고 싶은 사용자 객체를 명시합니다.


                    사용자가 요청에 custom 객체를 명시한 경우 동일한 값이 응답에 명시되어 반환됩니다.


                    요청을 자동화 하여 보낼 때 유용합니다.'
                  example:
                    app_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                  x-tags:
                  - Common
              required:
              - text
      responses:
        '200':
          description: Example response
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    summaries:
                      type: array
                      description: '각 문단에 대한 요약을 문자열의 배열로 반환합니다.


                        설정은`NlpConfigSummary`를 참고하세요.'
                      items:
                        type: string
                  x-tags:
                  - NLP
                - type: object
                  x-tags:
                  - NLP
                  properties:
                    keywords:
                      type: array
                      description: '키워드 추출의 결과입니다.


                        추출한 키워드 들을 문자열의 배열 형태로 반환합니다.


                        설정은 `NlpConfigKeywordExtraction`을 참고하세요.'
                      items:
                        type: string
                    keywordsAdjectives:
                      type: array
                      x-stoplight:
                        id: 8ylmdlkpr8sra
                      description: 추출한 형용사 키워드 들을 문자열 배열로 반환합니다.
                      items:
                        x-stoplight:
                          id: zri0oiv2w203k
                        type: string
                x-tags:
                - NLP
        '204':
          description: No Content. 요청은 성공하였으나 반환한 결과가 없습니다. 받아쓰기의 경우 받아쓰기는 완료되었으나 결과가 비어있습니다.
        '400':
          description: Bad Request. 요청 형식이 잘못 되었습니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '403':
          description: Forbidden. 허용되지 않은 접근입니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '413':
          description: Payload Too Large. 요청이 너무 큽니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '415':
          description: Unsupported Media Type.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '429':
          description: Too Many Requests.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '500':
          description: Internal Server Error. 서버 오류입니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '503':
          description: Service Unavailable.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
  /nlp/v1/async/long-summaries:
    x-permission: nlp-async-long-summary
    post:
      x-descriptors:
      - default: long-summary
      summary: Request long summary
      description: TODO
      tags:
      - NLP
      operationId: post-nlp-v1-async-long-summary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                texts:
                  type: array
                  items:
                    type: object
                    properties:
                      text:
                        type: string
                        description: 요약할 문서 입니다.
                      metadata:
                        type: object
                    required:
                    - text
                callback:
                  type: object
                  description: '비동기 요청의 진행 상태 및 결과를 콜백으로 전달 받고 싶을 때 사용합니다. '
                  properties:
                    url:
                      type: string
                      description: '콜백을 전송받을 http(s) 를 포함한 URL 입니다.


                        처리 중에는 진행상태를, 처리가 완료 된 뒤에는 결과 혹은 오류 상태를 `POST` 방식으로 해당 URL에 전송합니다.'
                    headers:
                      type: object
                      description: 콜백 URL로 전송할 때, 헤더에 포함시켜야 하는 값이 있다면 명시해줍니다.
                  x-tags:
                  - Common
                custom:
                  type: object
                  description: '응답에 포함하여 받고 싶은 사용자 객체를 명시합니다.


                    사용자가 요청에 custom 객체를 명시한 경우 동일한 값이 응답에 명시되어 반환됩니다.


                    요청을 자동화 하여 보낼 때 유용합니다.'
                  example:
                    app_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                  x-tags:
                  - Common
              required:
              - texts
              x-tags:
              - NLP
      responses:
        '200':
          description: Example response
          content:
            application/json:
              schema:
                type: object
                properties:
                  rid:
                    type: string
                    description: 요청 ID 입니다.
                    example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                    x-tags:
                    - Common
                  custom:
                    type: object
                    description: '응답에 포함하여 받고 싶은 사용자 객체를 명시합니다.


                      사용자가 요청에 custom 객체를 명시한 경우 동일한 값이 응답에 명시되어 반환됩니다.


                      요청을 자동화 하여 보낼 때 유용합니다.'
                    example:
                      app_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                    x-tags:
                    - Common
                x-tags:
                - NLP
        '204':
          description: No Content. 요청은 성공하였으나 반환한 결과가 없습니다. 받아쓰기의 경우 받아쓰기는 완료되었으나 결과가 비어있습니다.
        '400':
          description: Bad Request. 요청 형식이 잘못 되었습니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '403':
          description: Forbidden. 허용되지 않은 접근입니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '413':
          description: Payload Too Large. 요청이 너무 큽니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '415':
          description: Unsupported Media Type.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '429':
          description: Too Many Requests.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '500':
          description: Internal Server Error. 서버 오류입니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '503':
          description: Service Unavailable.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
  /nlp/v1/async/long-summaries/{rid}:
    x-permission: nlp-async-long-summary
    parameters:
    - name: rid
      in: path
      required: true
      schema:
        type: string
        description: 요청 ID 입니다.
        example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
        x-tags:
        - Common
      description: Request ID.
    get:
      summary: Get long summary
      description: TODO
      tags:
      - NLP
      operationId: get-nlp-v1-async-long-summary-rid
      responses:
        '200':
          description: Example response
          content:
            application/json:
              schema:
                type: object
                properties:
                  rid:
                    type: string
                    description: 요청 ID 입니다.
                    example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                    x-tags:
                    - Common
                  status:
                    type: string
                    description: '요약 상태값 입니다.


                      `requested`: 요청이 시작되었습니다.


                      `processing`: 요약중 입니다.


                      `processed`: 요약 완료되었습니다.


                      `input_error`: 사용자 요청 값에 오류가 있습니다. 확인 후 다시 요청해 주세요.


                      `processing_error`: 요약중 오류가 발생하였습니다. 잠시 기다렸다가 다시 요청해 주세요.'
                    enum:
                    - requested
                    - processing
                    - processed
                    - input_error
                    - processing_error
                    example: processed
                    x-tags:
                    - NLP
                  progress:
                    type: integer
                    description: 받아쓰기 처리중인 경우 현재 진행률을 나타냅니다.
                    example: 100
                  summaries:
                    type: array
                    items:
                      type: object
                      properties:
                        title:
                          type: string
                          description: 원본 텍스트의 내용을 기반으로 생성된 제목입니다.
                        subtopics:
                          type: array
                          description: 주어진 문서를 세 부분으로 나눠 요약한 내용입니다.
                          items:
                            type: object
                            properties:
                              title:
                                type: string
                                description: 요약된 각 부분의 소제목입니다.
                              bullets:
                                type: array
                                description: 글머리 기호로 요약된 내용입니다. 최대 5개까지 요약이 생성됩니다.
                                items:
                                  type: object
                                  properties:
                                    text:
                                      type: string
                                      description: 요약 문장입니다.
                                    isImportant:
                                      type: boolean
                                      description: 요약 부분 중 해당 문장이 핵심적인 내용일 경우에 True로 표시됩니다. 기본값은 False입니다.
                                      default: false
                        startIndex:
                          type: integer
                          minimum: 0
                        endIndex:
                          type: integer
                          minimum: 0
                        metadata:
                          type: array
                          items:
                            type: object
                  message:
                    type: string
                    description: 오류 메시지 등의 추가정보를 표시합니다.
                  custom:
                    type: object
                    description: '응답에 포함하여 받고 싶은 사용자 객체를 명시합니다.


                      사용자가 요청에 custom 객체를 명시한 경우 동일한 값이 응답에 명시되어 반환됩니다.


                      요청을 자동화 하여 보낼 때 유용합니다.'
                    example:
                      app_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                    x-tags:
                    - Common
                x-tags:
                - NLP
        '204':
          description: No Content. 요청은 성공하였으나 반환한 결과가 없습니다. 받아쓰기의 경우 받아쓰기는 완료되었으나 결과가 비어있습니다.
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '403':
          description: Forbidden. 허용되지 않은 접근입니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '404':
          description: Not Found.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '429':
          description: Too Many Requests.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '500':
          description: Internal Server Error. 서버 오류입니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
  /nlp/v1/async/minutes:
    x-permission: nlp-async-minutes
    post:
      x-descriptors:
      - default: minutes
      summary: Request meeting minutes
      description: 텍스트를 회의록으로 변환합니다.
      tags:
      - NLP
      operationId: post-nlp-v1-async-minutes
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: 요약할 문서 입니다.
                callback:
                  type: object
                  description: '비동기 요청의 진행 상태 및 결과를 콜백으로 전달 받고 싶을 때 사용합니다. '
                  properties:
                    url:
                      type: string
                      description: '콜백을 전송받을 http(s) 를 포함한 URL 입니다.


                        처리 중에는 진행상태를, 처리가 완료 된 뒤에는 결과 혹은 오류 상태를 `POST` 방식으로 해당 URL에 전송합니다.'
                    headers:
                      type: object
                      description: 콜백 URL로 전송할 때, 헤더에 포함시켜야 하는 값이 있다면 명시해줍니다.
                  x-tags:
                  - Common
                custom:
                  type: object
                  description: '응답에 포함하여 받고 싶은 사용자 객체를 명시합니다.


                    사용자가 요청에 custom 객체를 명시한 경우 동일한 값이 응답에 명시되어 반환됩니다.


                    요청을 자동화 하여 보낼 때 유용합니다.'
                  example:
                    app_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                  x-tags:
                  - Common
              required:
              - text
              x-tags:
              - NLP
      responses:
        '200':
          description: Example response
          content:
            application/json:
              schema:
                type: object
                properties:
                  rid:
                    type: string
                    description: 요청 ID 입니다.
                    example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                    x-tags:
                    - Common
                  custom:
                    type: object
                    description: '응답에 포함하여 받고 싶은 사용자 객체를 명시합니다.


                      사용자가 요청에 custom 객체를 명시한 경우 동일한 값이 응답에 명시되어 반환됩니다.


                      요청을 자동화 하여 보낼 때 유용합니다.'
                    example:
                      app_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                    x-tags:
                    - Common
                x-tags:
                - NLP
        '204':
          description: No Content. 요청은 성공하였으나 반환한 결과가 없습니다. 받아쓰기의 경우 받아쓰기는 완료되었으나 결과가 비어있습니다.
        '400':
          description: Bad Request. 요청 형식이 잘못 되었습니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '403':
          description: Forbidden. 허용되지 않은 접근입니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '413':
          description: Payload Too Large. 요청이 너무 큽니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '415':
          description: Unsupported Media Type.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '429':
          description: Too Many Requests.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '500':
          description: Internal Server Error. 서버 오류입니다.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
        '503':
          description: Service Unavailable.
          content:
            application/json:
              schema:
                type: object
                description: 에러 발생 시 응답입니다.
                properties:
                  error:
                    type: string
                x-tags:
                - Common
  /nlp/v1/async/minutes/{rid}:
    x-permission: nlp-async-minutes
    parameters:
    - name: rid
      in: path
      required: true
      schema:
        type: string
        description: 요청 ID 입니다.
        example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
        x-tags:
        - Common
      description: Request ID.
    get:
      summary: Get meeting minutes
      description: 비동기화 방식으로 요청한 요약의 진행상황 및 결과를 확인합니다.
      tags:
      - NLP
      operationId: get-nlp-v1-async-minutes-rid
      responses:
        '200':
          description: Example response
          content:
            application/json:
              schema:
                type: object
                properties:
                  rid:
                    type: string
                    description: 요청 ID 입니다.
                    example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                    x-tags:
                    - Common
                  status:
                    type: string
                    description: '요약 상태값 입니다.


                      `requested`: 요청이 시작되었습니다.


                      `processing`: 요약중 입니다.


                      `processed

# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/actionpower/refs/heads/main/openapi/actionpower-nlp-api-openapi.yml