Completions
    • PDF

    Completions

    • PDF

    Article Summary

    Classic/VPC環境で利用できます。

    CLOVA Studio結果値(completion)を作成するための情報を CLOVA Studioに伝達することができます。プロンプトの内容と使用するモデル、その他の設定パラメータ値を指定して伝達すると、CLOVA Studioはこの内容に基づいて結果値を作成します。

    リクエスト

    リクエスト形式を説明します。リクエスト形式は次の通りです。

    メソッドURI
    POST/v1/completions/{model}

    ヘッダ

    ヘッダの説明は次の通りです。

    ヘッダ必須有無説明
    X-NCP-CLOVASTUDIO-API-KEYYテストアプリやサービスアプリを作成時に発行された API KEY
    X-NCP-APIGW-API-KEYYテストアプリやサービスアプリを作成時に発行された API Gateway KEY
    X-NCP-CLOVASTUDIO-REQUEST-IDN各リクエストのリクエスト ID
    Content-TypeYapplication/json

    パスパラメータ

    パラメータについての説明は、次の通りです。

    フィールドタイプ必須有無説明
    modelstringYモデル名: LK-D2

    ボディ

    ボディの説明は次の通りです。

    フィールドタイプ必須有無説明
    includeAiFiltersbooleanN作成されるテキストに対して悪口、卑下/差別/嫌悪、セクハラ/わいせつなどのカテゴリ別に該当する程度を表示する
  • true(基本値)
  • false
  • includeTokensbooleanNinput_tokensと output_tokensをレスポンスに含めるかどうか
  • true: 使用
  • false: 使用しない
  • maxTokensintN結果値を作成時に使用する最大トークンの数
  • 0 < maxTokens ≤ 2048(デフォルト値: 100)
  • repeatPenaltyfloatN同じ表現が繰り返されるトークンに付与するペナルティ値
  • 0.0 < repeatPenalty ≤ 10.0(デフォルト値: 5.0)
  • restartstringN出力値の後に付けるテキスト
    startstringNユーザー入力値の後に付けるテキスト
    stopBeforearrayNトークン作成停止文字
  • temperaturefloatN結果値のランダム。高いほどランダムな結果が作成される可能性が高くなる
  • 0.00 < temperature ≤ 1.00(デフォルト値: 0.50)
  • textstringYユーザーの入力値(プロンプト)で、このテキストに基づいて新しい文章を作成
    topKintNTop K値。トークンを確率の高い順に並べ、上位 Kの範囲内に入るトークンまで使用
  • 0 ≤ topk ≤ 128(デフォルト値: 0)
  • topPfloatNTop P値。Top Pが累積確率値範囲に含まれるトークンを候補として選択
  • 0.00 < topP ≤ 1.00(デフォルト値: 0.80)
  • 構文

    構文例は次の通りです。

    curl --location --request POST 'https://clovastudio.apigw.ntruss.com/testapp/v1/completions/LK-D2' \
    --header 'X-NCP-CLOVASTUDIO-API-KEY: <X-NCP-CLOVASTUDIO-API-KEY>' \
    --header 'X-NCP-APIGW-API-KEY: <X-NCP-APIGW-API-KEY>' \
    --header 'X-NCP-CLOVASTUDIO-REQUEST-ID: <X-NCP-CLOVASTUDIO-REQUEST-ID>' \
    --header 'Content-Type: application/json' \
    --data '{
     "start": "\n英語: ",
      "stopBefore": ["\n韓国語: "],
      "text": "韓国語: りんご\n英語: Apple\n韓国語: バナナ",
      "includeAiFilters": true
    }'
    

    レスポンス

    レスポンス形式を説明します。

    ヘッダ

    ヘッダの説明は次の通りです。

    ヘッダ必須有無説明
    Content-Type-application/json

    ボディ

    ボディの説明は次の通りです。

    フィールドタイプ必須有無説明
    aiFiltersobject array-AI Filter点数
    aiFilters[].groupNamestring-AI Filter分類参照
    aiFilters[].namestring-AI Filter分類参照
    aiFilters[].scorestring-テキストが aiFilters[].nameカテゴリに該当する程度
    • 0: 高い
    • 1: 中間
    • 2: 低い
    inputLengthinteger-入力されたトークン数
    inputTokensstring array-入力されたトークン情報
    outputLengthinteger-出力されたトークン数
    outputTokensstring array-出力されたトークン情報
    stopReasonstring-結果値の作成を中断した理由
    • length: 設定した最大の長さに到達
    • end_token: 使用できる最大トークン数に到達
    • stop_before: 設定した stop sequenceに到達
    textstring-作成されたトークン。プロンプトと結果値の両方を含む
    probsfloat-作成された各トークンが選択される確率

    AI Filter分類

    aiFilters[].groupNameaiFilters[].nameに含まれる内容は以下の表でご確認ください。

    groupNamename説明
    cursediscrimination卑下または差別または嫌悪
    curseinsult悪口
    unsafeContentssexualHarassmentセクハラまたはわいせつ

    構文

    構文例は次の通りです。

    {
      "status": {
        "code": "20000",
        "message": "OK"
      },
      "result": {
        "text": "...",
        "stopReason": "stop_before",
        "inputLength": 10,
        "outputLength": 20,
        "inputTokens" : ["who", " ", "are", " ", "you"],
        "outputTokens" : ["hello", " ", "world"],
        "aiFilters": [
          {
            "groupName": "curse",
            "name": "insult",
            "score": "0"
          },
          {
            "groupName": "curse",
            "name": "discrimination",
            "score": "1"
          },
          {
            "groupName": "unsafeContents",
            "name": "sexualHarassment",
            "score": "2"
          }
        ]
      }
    }
    

    この記事は役に立ちましたか?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.