apidoc.aidev.koapp.com Open in urlscan Pro
14.129.64.176 Public Scan

Back to summary
Submitted URL:
https://apidoc.aidev.koapp.com/
Effective URL:
https://apidoc.aidev.koapp.com/redoc
Submission: On June 08 via api (June 8th 2024, 12:04:26 pm UTC) from US — Scanned from DE
Form analysis
0 forms found in the DOM

Text Content

ReDoc requires Javascript to function. Please enable it to browse the
documentation.
 * 인증 Flow
 * API Flow
 * getCreate Token
 * getRefresh Token
 * postSummary
 * postTag
 * postTopic
 * postCompletions

API docs by Redocly





CONNECTWAVE AI API (1.0.0)

Download OpenAPI specification:Download




커넥트웨이브 AI API 사용에 대한 문서입니다.

API 사용문의 : https://labs.cowave.kr/ai-tf/ask-anything/-/issues


인증 FLOW




API FLOW




CREATE TOKEN


인증 토큰 생성 요청

--------------------------------------------------------------------------------


인증관리자에서 발급받은 키로 인증토큰을 생성합니다.

인증관리자 주소 : https://auth.ai.cowave.kr/admin/

인증관리자 사이트 접속 -> 앱 목록 -> 추가


승인후 클라이언트키, 비밀키를 사용하시면 됩니다.


HOST : AUTH.AI.COWAVE.KR

Header : Authentication : Basic Base64(client_key:secert_key)
JWT 방식의 토큰을 생성합니다.

AUTHORIZATIONS:

HTTPBasic

REQUEST BODY SCHEMA: APPLICATION/JSON


object (CreateTokenRequest)

요청 내용은 빈값입니다.


RESPONSES

200

Successful Response

400

인증 헤더 누락

401

인증 실패

422

Validation Error

get/api/create_token

API

https://문서HOST정보/api/create_token


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
{ }


RESPONSE SAMPLES

 * 200
 * 400
 * 401
 * 422

Content type
application/json
Copy
{
 * "token":
   "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJjb25uZWN0d2F2ZSIsImF1ZCI6ImFpIiwiZXhwIjoxNzQwNjM3ODE3LCJpYXQiOjE3MDkxMDE4MTcsInNlcnZpY2UiOiJyZXZpZXciLCJjbGllbnRfa2V5IjoiYU9LU1hBdUZJY0lLWUZlTCJ9.aabbccsdf",
 * "refresh_token":
   "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJjb25uZWN0d2F2ZSIsImF1ZCI6ImFpIiwiZXhwIjoxNzQwNjM3ODE3LCJpYXQiOjE3MDkxMDE4MTcsInNlcnZpY2UiOiJyZXZpZXciLCJjbGllbnRfa2V5IjoiYU9LU1hBdUZJY0lLWUZlTCJ9.aabbccsdf"

}





REFRESH TOKEN


갱신 토큰 생성 요청

--------------------------------------------------------------------------------


갱신 토큰으로 새 인증토큰을 생성합니다.


HOST : AUTH.AI.COWAVE.KR

Header : Authentication : Bearer refresh_token

AUTHORIZATIONS:

HTTPBearer

REQUEST BODY SCHEMA: APPLICATION/JSON


object (RefreshTokenRequest)

요청 내용은 빈값입니다.


RESPONSES

200

Successful Response

400

인증 헤더 누락

401

인증 실패

422

Validation Error

get/api/refresh_token

API

https://문서HOST정보/api/refresh_token


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
{ }


RESPONSE SAMPLES

 * 200
 * 400
 * 401
 * 422

Content type
application/json
Copy
{
 * "token":
   "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJjb25uZWN0d2F2ZSIsImF1ZCI6ImFpIiwiZXhwIjoxNzQwNjM3ODE3LCJpYXQiOjE3MDkxMDE4MTcsInNlcnZpY2UiOiJyZXZpZXciLCJjbGllbnRfa2V5IjoiYU9LU1hBdUZJY0lLWUZlTCJ9.aabbccsdf",
 * "refresh_token":
   "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJjb25uZWN0d2F2ZSIsImF1ZCI6ImFpIiwiZXhwIjoxNzQwNjM3ODE3LCJpYXQiOjE3MDkxMDE4MTcsInNlcnZpY2UiOiJyZXZpZXciLCJjbGllbnRfa2V5IjoiYU9LU1hBdUZJY0lLWUZlTCJ9.aabbccsdf"

}





SUMMARY


리뷰 요약 생성

--------------------------------------------------------------------------------


리뷰 요약문장을 생성합니다.


HOST : REVIEW.AI.COWAVE.KR

Header : Authentication : Bearer token

AUTHORIZATIONS:

HTTPBearer

REQUEST BODY SCHEMA: APPLICATION/JSON



category_code1
required
string (Category Code1)

카테고리 대분류 코드

category_code2
required
string (Category Code2)

카테고리 중분류 코드

category_code3
Category Code3 (string) or Category Code3 (null) (Category Code3)

카테고리 소분류 코드

category_code4
Category Code4 (string) or Category Code4 (null) (Category Code4)

카테고리 상세분류 코드

goods_name
required
string (Goods Name)

상품명

contents
required
Array of strings (Contents)


리뷰 내용

리뷰의 내용을 배열로 넣어 하나의 값으로 받습니다.

하나의 리뷰의 값만 얻으려면 1개의 배열로 전송해주세요.

callback_data
Callback Data (string) or Callback Data (null) (Callback Data)


응답 데이타

callback_data에 넣은 키값이나 데이타값을 다시 전달해줍니다.

 * 최대 길이 500자 제한

use_async
boolean (Use Async)
Default: false


비동기 방식 사용여부

동기 방식의 경우 응답 요청에 결과는 제공하지 않습니다.

이 경우는 응답값의 id를 활용해 kafka event에서 해당 값을 얻을 수 있습니다.

많은 데이터 요청에는 비동기로 사용해 주세요

summary_type
string (SummeryTypeEnum)
Default: "normal"
Enum: "normal" "short" "long"

응답 길이 타입

use_helpfullness
boolean (Use Helpfullness)
Default: false

구매 도움 사용 여부. 리뷰가 구매에 도움이 되는 정도를 표시합니다.


RESPONSES

200

Successful Response

400

인증 헤더 누락

401

인증 실패

422

Validation Error

post/api/summary

API

https://문서HOST정보/api/summary


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
Expand all Collapse all
{
 * "category_code1": "03",
 * "category_code2": "04",
 * "category_code3": "05",
 * "category_code4": "12",
 * "goods_name": "ASUS TUF Gaming 노트북",
 * "contents": [
    * "빠르게 받아봤어요. 포장도 컨셉있고 정갈하게 포장되었네요.무게는 2.2kg 이다보니 조금 무게는 나가지만, 남자아이가 가지고
      다닐거라 큰문제는 없습니다. 파워도 240w 짜리라 꽤커서 놀랬어요. 전원버튼을 누르니 조용하게 동작되어서 켜진지도 몰랐어요.
      키보드의 led 도 잘전환되고 이제 마음껏 사용하기만 하면 됩니다. 잘사용하고 이가격에 사게되서 마음에 듭니다.",
    * "게이밍 노트북 추천합니다 처음 설정에 버벅이긴 했는데 다른분 리뷰 보고 제대로 설정하니 너무 부드럽게 돌아가더라구요 게임돌릴땐
      배터리 순삭인데 그냥 일상 사무업무만 하는 건 괜찮고 배터리팩 제외하고는 가벼워서 좋았어요"
   
   ],
 * "callback_data": "{\"cataglog_id\":1234}",
 * "use_async": false,
 * "summary_type": "short",
 * "use_helpfullness": false

}


RESPONSE SAMPLES

 * 200
 * 400
 * 401
 * 422

Content type
application/json
Copy
{
 * "message": "success",
 * "error_code": null,
 * "id": 123456,
 * "callback_data": "{\"cataglog_id\":1234}",
 * "summery": "게이밍 노트북이 빠르고 좋습니다.",
 * "purchase_helpfulness": "high"

}





TAG


리뷰 긍정, 부정 테그 생성

--------------------------------------------------------------------------------


리뷰의 긍정, 부정 테그들을 생성합니다.


HOST : REVIEW.AI.COWAVE.KR

Header : Authentication : Bearer token

AUTHORIZATIONS:

HTTPBearer

REQUEST BODY SCHEMA: APPLICATION/JSON



category_code1
required
string (Category Code1)

카테고리 대분류 코드

category_code2
required
string (Category Code2)

카테고리 중분류 코드

category_code3
Category Code3 (string) or Category Code3 (null) (Category Code3)

카테고리 소분류 코드

category_code4
Category Code4 (string) or Category Code4 (null) (Category Code4)

카테고리 상세분류 코드

goods_name
required
string (Goods Name)

상품명

contents
required
Array of strings (Contents)


리뷰 내용

리뷰의 내용을 배열로 넣어 하나의 값으로 받습니다.

하나의 리뷰의 값만 얻으려면 1개의 배열로 전송해주세요.

callback_data
Callback Data (string) or Callback Data (null) (Callback Data)


응답 데이타

callback_data에 넣은 키값이나 데이타값을 다시 전달해줍니다.

 * 최대 길이 500자 제한

use_async
boolean (Use Async)
Default: false


비동기 방식 사용여부

동기 방식의 경우 응답 요청에 결과는 제공하지 않습니다.

이 경우는 응답값의 id를 활용해 kafka event에서 해당 값을 얻을 수 있습니다.

많은 데이터 요청에는 비동기로 사용해 주세요


RESPONSES

200

Successful Response

400

인증 헤더 누락

401

인증 실패

422

Validation Error

post/api/tag

API

https://문서HOST정보/api/tag


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
Expand all Collapse all
{
 * "category_code1": "03",
 * "category_code2": "04",
 * "category_code3": "05",
 * "category_code4": "12",
 * "goods_name": "ASUS TUF Gaming 노트북",
 * "contents": [
    * "빠르게 받아봤어요. 포장도 컨셉있고 정갈하게 포장되었네요.무게는 2.2kg 이다보니 조금 무게는 나가지만, 남자아이가 가지고
      다닐거라 큰문제는 없습니다. 파워도 240w 짜리라 꽤커서 놀랬어요. 전원버튼을 누르니 조용하게 동작되어서 켜진지도 몰랐어요.
      키보드의 led 도 잘전환되고 이제 마음껏 사용하기만 하면 됩니다. 잘사용하고 이가격에 사게되서 마음에 듭니다.",
    * "게이밍 노트북 추천합니다 처음 설정에 버벅이긴 했는데 다른분 리뷰 보고 제대로 설정하니 너무 부드럽게 돌아가더라구요 게임돌릴땐
      배터리 순삭인데 그냥 일상 사무업무만 하는 건 괜찮고 배터리팩 제외하고는 가벼워서 좋았어요"
   
   ],
 * "callback_data": "{\"cataglog_id\":1234}",
 * "use_async": false

}


RESPONSE SAMPLES

 * 200
 * 400
 * 401
 * 422

Content type
application/json
Copy
Expand all Collapse all
{
 * "message": "success",
 * "error_code": null,
 * "id": 123456,
 * "callback_data": "{\"cataglog_id\":1234}",
 * "positive": [
    * {
       * "related_review": "[배송이 빨랐어요.]",
       * "tag": "빠름"
      
      }
   
   ],
 * "negative": [
    * {
       * "related_review": "[상품이 너무 무거웠습니다.]",
       * "tag": "무게"
      
      }
   
   ]

}





TOPIC


리뷰 주제어 생성

--------------------------------------------------------------------------------


리뷰 속성값을 생성합니다.


HOST : REVIEW.AI.COWAVE.KR

Header : Authentication : Bearer token

AUTHORIZATIONS:

HTTPBearer

REQUEST BODY SCHEMA: APPLICATION/JSON



category_code1
required
string (Category Code1)

카테고리 대분류 코드

category_code2
required
string (Category Code2)

카테고리 중분류 코드

category_code3
Category Code3 (string) or Category Code3 (null) (Category Code3)

카테고리 소분류 코드

category_code4
Category Code4 (string) or Category Code4 (null) (Category Code4)

카테고리 상세분류 코드

goods_name
required
string (Goods Name)

상품명

contents
required
Array of strings (Contents)


리뷰 내용

리뷰의 내용을 배열로 넣어 하나의 값으로 받습니다.

하나의 리뷰의 값만 얻으려면 1개의 배열로 전송해주세요.

callback_data
Callback Data (string) or Callback Data (null) (Callback Data)


응답 데이타

callback_data에 넣은 키값이나 데이타값을 다시 전달해줍니다.

 * 최대 길이 500자 제한

use_async
boolean (Use Async)
Default: false


비동기 방식 사용여부

동기 방식의 경우 응답 요청에 결과는 제공하지 않습니다.

이 경우는 응답값의 id를 활용해 kafka event에서 해당 값을 얻을 수 있습니다.

많은 데이터 요청에는 비동기로 사용해 주세요


RESPONSES

200

Successful Response

400

인증 헤더 누락

401

인증 실패

422

Validation Error

post/api/topic

API

https://문서HOST정보/api/topic


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
Expand all Collapse all
{
 * "category_code1": "03",
 * "category_code2": "04",
 * "category_code3": "05",
 * "category_code4": "12",
 * "goods_name": "ASUS TUF Gaming 노트북",
 * "contents": [
    * "빠르게 받아봤어요. 포장도 컨셉있고 정갈하게 포장되었네요.무게는 2.2kg 이다보니 조금 무게는 나가지만, 남자아이가 가지고
      다닐거라 큰문제는 없습니다. 파워도 240w 짜리라 꽤커서 놀랬어요. 전원버튼을 누르니 조용하게 동작되어서 켜진지도 몰랐어요.
      키보드의 led 도 잘전환되고 이제 마음껏 사용하기만 하면 됩니다. 잘사용하고 이가격에 사게되서 마음에 듭니다.",
    * "게이밍 노트북 추천합니다 처음 설정에 버벅이긴 했는데 다른분 리뷰 보고 제대로 설정하니 너무 부드럽게 돌아가더라구요 게임돌릴땐
      배터리 순삭인데 그냥 일상 사무업무만 하는 건 괜찮고 배터리팩 제외하고는 가벼워서 좋았어요"
   
   ],
 * "callback_data": "{\"cataglog_id\":1234}",
 * "use_async": false

}


RESPONSE SAMPLES

 * 200
 * 400
 * 401
 * 422

Content type
application/json
Copy
Expand all Collapse all
{
 * "message": "success",
 * "error_code": null,
 * "id": 123456,
 * "callback_data": "{\"cataglog_id\":1234}",
 * "topic": {
    * "성능": [
       * "빠름",
       * "램이 충분"
      
      ],
    * "화면": [
       * "반사",
       * "터치"
      
      ]
   
   }

}





COMPLETIONS


채팅(OPENAI API STYLE)

--------------------------------------------------------------------------------


주어진 채팅 대화에 대한 응답을 만듭니다.


OPENAI API의 라이브러리 및 호출 방식을 지원합니다.

OpenAI API 문서

https://platform.openai.com/docs/api-reference/chat/create


PYTHON 호출예시

from openai import OpenAI

auth = "aaa.bbb.ccc" # Create Token 호출결과의 토큰
server_url = "https://plaigpt.ai.cowave.kr/v1/"
client = OpenAI(api_key=auth, base_url=server_url)
completion = client.chat.completions.create(
    model="plai",
    messages=[
        {
            "role": "user",
            "content": "Say this is a test",
        },
    ],
)



JSON 응답방식 사용 예시

completion = client.chat.completions.create(
    messages=[
        {
            "role": "user",
            "content": "Can you generate an example json object describing a fruit?",
        }
    ],
    model="plai",
    response_format={"type": "json_object"},
)



비동기 응답방식 CALLBACK URL 사용

# callback에 콜백받을 URL 설정 및 callbackdata로 원하는 변수 설정
client.default_headers = {"callback": "https://abc.com/get_result", "callbackdata": "myreviewid_44"}

completion = client.chat.completions.create(
    messages=[
        {
            "role": "user",
            "content": "Can you generate an example json object describing a fruit?",
        }
    ],
    model="plai_async", #모델을 변경해야합니다.
)



CALLBACK URL 응답

Header
  USER-AGENT : PlaiGPT
  CLIENT-ID : 요청클라이언트키
  CALLBACKDATA : 콜백데이타 값
Body
  {"id": "cmpl-4330ec1654c64c1aa60b63b09b55b754", "choices": [{"finish_reason": "stop", "index": 0, "logprobs": null, "message": {"content": " hello", "role": "assistant", "function_call": null, "tool_calls": null}, "stop_reason": null}], "created": 1717464877, "model": "plai", "object": "chat.completion", "system_fingerprint": null, "usage": {"completion_tokens": 10, "prompt_tokens": 10, "total_tokens": 20}}



비동기 응답방식 카프카 사용

client.default_headers = {"callback": "kafka", "callbackdata": "myreviewid_44"}

completion = client.chat.completions.create(
    messages=[
        {
            "role": "user",
            "content": "Can you generate an example json object describing a fruit?",
        }
    ],
    model="plai_async", #모델을 변경해야합니다.
)



비동기 요청에 대한 응답(CALLBACK URL, KAFKA 동일)

{
    "id": "d119a0e877602a7b2de50b17397191a6s794",
    "object": "chat.completion",
    "created": 1716778812,
    "model": "plai",
    "system_fingerprint": "d119a0e877602a7b2de50b17397191a6s794",
    "choices": [
        {
            "index": 0,
            "message": {
                "role": "assistant",
                "content": "aync msg"
            },
            "logprobs": null,
            "finish_reason": "stop"
        }
    ],
    "usage": {
        "prompt_tokens": 1,
        "completion_tokens": 1,
        "total_tokens": 2
    }
}



HOST : PLAIGPT.AI.COWAVE.KR

Header : Authentication : Bearer token

AUTHORIZATIONS:

HTTPBearer

REQUEST BODY SCHEMA: APPLICATION/JSON



model
string (ChatModels)
Default: "plai"
Enum: "plai" "plai_async"

모델 선택. 실시간 : plai, 비동기요청 : plai_async

messages
required
Array of strings (Messages)

채팅 내용.


RESPONSES

200

Successful Response

400

JSON 생성 실패

401

인증 실패

422

Validation Error

post/v1/chat/completions

API

https://문서HOST정보/v1/chat/completions


REQUEST SAMPLES

 * Payload

Content type
application/json
Copy
Expand all Collapse all
{
 * "model": "plai",
 * "messages": [
    * {
       * "content": "You are a helpful assistant.",
       * "role": "system"
      
      },
    * {
       * "content": "Hello!",
       * "role": "user"
      
      }
   
   ]

}


RESPONSE SAMPLES

 * 200
 * 400
 * 401
 * 422

Content type
application/json
Copy
Expand all Collapse all
{
 * "id": "string",
 * "object": "string",
 * "created": 0,
 * "model": "string",
 * "system_fingerprint": "string",
 * "choices": [
    * {
       * "index": 0,
       * "message": {
          * "role": "string",
          * "content": "string"
         
         },
       * "logprobs": { },
       * "finish_reason": "string"
      
      }
   
   ],
 * "usage": {
    * "prompt_tokens": 0,
    * "completion_tokens": 0,
    * "total_tokens": 0
   
   }

}
apidoc.aidev.koapp.com Open in urlscan Pro 14.129.64.176 Public Scan

Form analysis 0 forms found in the DOM

Text Content

apidoc.aidev.koapp.com Open in urlscan Pro
14.129.64.176 Public Scan

Form analysis
0 forms found in the DOM
