Alibaba Cloud Model Studio:構造化出力

from openai import OpenAI
import os

client = OpenAI(
    # API キーはリージョンによって異なります。API キーの取得方法：https://www.alibabacloud.com/help/zh/model-studio/get-api-key
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    # 北京リージョンのモデルを使用する場合は、base_url を https://dashscope.aliyuncs.com/compatible-mode/v1 に置き換えます。
    base_url="https://dashscope-intl.aliyuncs.com/compatible-mode/v1",
)

completion = client.chat.completions.create(
    model="qwen-flash",
    messages=[
        {
            "role": "system",
            "content": "ユーザーの名前と年齢を抽出し、JSON 形式で返します"
        },
        {
            "role": "user",
            "content": "こんにちは、私の名前は田中一郎、34 歳です。メールアドレスは tanakaichiro@example.com で、バスケットボールと旅行が趣味です。", 
        },
    ],
    response_format={"type": "json_object"}
)

json_string = completion.choices[0].message.content
print(json_string)

応答

{
  "Name": "田中一郎",
  "Age": 34
}

import OpenAI from "openai";

const openai = new OpenAI({
    // API キーはリージョンによって異なります。API キーの取得方法：https://www.alibabacloud.com/help/zh/model-studio/get-api-key
    // 環境変数を設定していない場合は、次の行を apiKey: "sk-xxx" に置き換えます。
    apiKey: process.env.DASHSCOPE_API_KEY,
    // 北京リージョンのモデルを使用する場合は、baseURL を https://dashscope.aliyuncs.com/compatible-mode/v1 に置き換えます。
    baseURL: "https://dashscope-intl.aliyuncs.com/compatible-mode/v1"
});

const completion = await openai.chat.completions.create({
    model: "qwen-flash",
    messages: [
        {
            role: "system",
            content: "ユーザーの名前と年齢を抽出し、JSON 形式で返します"
        },
        {
            role: "user",
            content: "こんにちは、私の名前は田中一郎、34 歳です。メールアドレスは tanakaichiro@example.com で、バスケットボールと旅行が趣味です。"
        }
    ],
    response_format: {
        type: "json_object"
    }
});

const jsonString = completion.choices[0].message.content;
console.log(jsonString);

応答

{
  "name": "Alex Brown",
  "age": 34
}

# ======= 重要事項 =======
# API キーはリージョンによって異なります。API キーの取得方法：https://www.alibabacloud.com/help/en/model-studio/get-api-key
# 北京リージョンのモデルを使用する場合は、URL を https://dashscope.aliyuncs.com/compatible-mode/v1/chat/completions に置き換えます。
# === 実行前にこのコメントを削除してください ===
curl -X POST https://dashscope-intl.aliyuncs.com/compatible-mode/v1/chat/completions \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "qwen-plus",
    "messages": [
        {
            "role": "system",
            "content": "名前（文字列）、年齢（文字列）、メールアドレス（文字列）を抽出してください。結果を JSON 文字列として出力します。その他の関係のない内容は含めないでください。\n例：\nQ: 私の名前は張三、25 歳で、メールアドレスは zhangsan@example.com です。\nA: {\"name\":\"張三\",\"age\":\"25 歳\",\"email\":\"zhangsan@example.com\"}\nQ: 私の名前は李四、30 歳で、メールアドレスは lisi@example.com です。\nA: {\"name\":\"李四\",\"age\":\"30 歳\",\"email\":\"lisi@example.com\"}\nQ: 私の名前は王五、メールアドレスは wangwu@example.com、40 歳です。\nA: {\"name\":\"王五\",\"age\":\"40 歳\",\"email\":\"wangwu@example.com\"}"
        },
        {
            "role": "user", 
            "content": "こんにちは、私の名前は田中一郎、34 歳で、メールアドレスは tanakaichiro@example.com です。"
        }
    ],
    "response_format": {
        "type": "json_object"
    }
}'

応答

{
    "choices": [
        {
            "message": {
                "role": "assistant",
                "content": "{\"name\":\"田中一郎\",\"age\":\"34 歳\"}"
            },
            "finish_reason": "stop",
            "index": 0,
            "logprobs": null
        }
    ],
    "object": "chat.completion",
    "usage": {
        "prompt_tokens": 207,
        "completion_tokens": 20,
        "total_tokens": 227,
        "prompt_tokens_details": {
            "cached_tokens": 0
        }
    },
    "created": 1756455080,
    "system_fingerprint": null,
    "model": "qwen-plus",
    "id": "chatcmpl-624b665b-fb93-99e7-9ebd-bb6d86d314d2"
}

import os
import dashscope
# 北京リージョンのモデルを使用する場合は、URL を https://dashscope.aliyuncs.com/api/v1 に置き換えます。
dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'

messages=[
    {
        "role": "system",
        "content": "ユーザーの名前と年齢を抽出し、JSON 形式で返します"
    },
    {
        "role": "user",
        "content": "こんにちは、私の名前は田中一郎、34 歳です。メールアドレスは tanakaichiro@example.com で、バスケットボールと旅行が趣味です。", 
    },
]
response = dashscope.Generation.call(
    # 環境変数を設定していない場合は、次の行を api_key="sk-xxx"（Alibaba Cloud Model Studio API キー）に置き換えます。
    api_key=os.getenv('DASHSCOPE_API_KEY'),
    model="qwen-flash", 
    messages=messages,
    result_format='message',
    response_format={'type': 'json_object'}
    )
json_string = response.output.choices[0].message.content
print(json_string)

応答

{
  "name": "Alex Brown",
  "age": 34
}

応答

{
  "name": "田中一郎",
  "age": 34
}

# ======= 重要な注意事項 =======
# 北京リージョンのモデルの場合、URL を次のように置き換えてください: https://dashscope.aliyuncs.com/api/v1/services/aigc/text-generation/generation
# API キーはリージョンによって異なります。API キーの取得方法: https://www.alibabacloud.com/help/zh/model-studio/get-api-key
# === 実行前にこのコメントを削除してください ===

curl -X POST https://dashscope-intl.aliyuncs.com/api/v1/services/aigc/text-generation/generation \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "qwen-flash",
    "input": {
        "messages": [
            {
                "role": "system",
                "content": "Extract the user's name and age, and return them in JSON format"
            },
            {
                "role": "user", 
                "content": "Hi everyone, my name is Alex Brown, I'm 34 years old, my email is alexbrown@example.com, and I enjoy playing basketball and traveling"
            }
        ]
    },
    "parameters": {
        "result_format": "message",
        "response_format": {
            "type": "json_object"
        }
    }
}'

応答

{
  "name": "田中一郎",
  "age": 34
}

import OpenAI from "openai";

const openai = new OpenAI({
  // API キーはリージョンによって異なります。API キーの取得方法：https://www.alibabacloud.com/help/zh/model-studio/get-api-key
  // 環境変数を設定していない場合は、次の行を apiKey: "sk-xxx"（Model Studio API キー）に置き換えます。
  apiKey: process.env.DASHSCOPE_API_KEY,
  // 北京リージョンのモデルを使用する場合は、base_url を https://dashscope.aliyuncs.com/compatible-mode/v1 に置き換えます。
  baseURL: "https://dashscope-intl.aliyuncs.com/compatible-mode/v1"
});

async function main() {
  const response = await openai.chat.completions.create({
    model: "qwen3-vl-plus",
    messages: [{
        role: "system",
        content: [{
          type: "text",
          text: "あなたは親切なアシスタントです。"
        }]
      },
      {
        role: "user",
        content: [{
            type: "image_url",
            image_url: {
              "url": "http://duguang-labelling.oss-cn-shanghai.aliyuncs.com/demo_ocr/receipt_zh_demo.jpg"
            }
          },
          {
            type: "text",
            text: "画像からチケット情報（配列型：travel_date、trains、seat_num、arrival_site、price）および請求書情報（配列型：invoice_code、invoice_number）を抽出し、両方の配列を含む JSON を出力します。"
          }
        ]
      }
    ],
    response_format: {type: "json_object"}
  });
  console.log(response.choices[0].message.content);
}

main()

応答

{
  "ticket": [
    {
      "travel_date": "2013-06-29",
      "trains": "stream",
      "seat_num": "371",
      "arrival_site": "Development Zone",
      "price": "8.00"
    }
  ],
  "invoice": [
    {
      "invoice_code": "221021325353",
      "invoice_number": "10283819"
    }
  ]
}

from openai import OpenAI
import os
import json
import textwrap  # 複数行文字列のインデント処理およびコードの可読性向上に使用

# モデルに期待される出力フォーマットを示すために、事前に例の応答を定義します
# 例 1：すべてのフィールドを含む完全な応答
example1_response = json.dumps(
    {
        "info": {"name": "山田太郎", "age": "25 歳", "email": "yamadataro@example.com"},
        "hobby": ["歌うこと"]
    },
    ensure_ascii=False
)
# 例 2：複数の趣味を含む応答
example2_response = json.dumps(
    {
        "info": {"name": "佐藤花子", "age": "30 歳", "email": "satohanako@example.com"},
        "hobby": ["踊ること", "泳ぐこと"]
    },
    ensure_ascii=False
)
# 例 3：趣味フィールドを含まない応答（趣味は任意）
example3_response = json.dumps(
    {
        "info": {"name": "鈴木一郎", "age": "28 歳", "email": "suzukichiro@example.com"}
    },
    ensure_ascii=False
)
# 例 4：趣味フィールドを含まない別の応答
example4_response = json.dumps(
    {
        "info": {"name": "高橋次郎", "age": "35 歳", "email": "takahashijiro@example.com"}
    },
    ensure_ascii=False
)

# OpenAI クライアントを初期化します
client = OpenAI(
    # 環境変数を設定していない場合は、次の行を api_key="sk-xxx" に置き換えます
    # API キーはリージョンによって異なります。API キーの取得方法：https://www.alibabacloud.com/help/en/model-studio/get-api-key
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    # 以下は北京リージョンの base_url です。シンガポールリージョンのモデルを使用する場合は、base_url を https://dashscope-intl.aliyuncs.com/compatible-mode/v1 に置き換えます
    base_url="https://dashscope.aliyuncs.com/compatible-mode/v1",
)

# dedent は各行の共通の先頭空白を削除し、コード内で文字列を読みやすくインデントしても、実行時に余分な空白が含まれないようにします
system_prompt = textwrap.dedent(f"""\
    ユーザー入力から個人情報を抽出し、指定された JSON スキーマ形式で出力してください：

    [出力フォーマット要件]
    出力は、以下の JSON 構造に厳密に従う必要があります：
    {{
      "info": {{
        "name": "文字列型、必須フィールド、ユーザーの氏名",
        "age": "文字列型、必須フィールド、フォーマットは '数字 歳'（例：'25 歳'）",
        "email": "文字列型、必須フィールド、標準的なメールアドレス形式（例：'user@example.com'）"
      }},
      "hobby": ["文字列配列型、任意フィールド、ユーザーのすべての趣味を含む。趣味が言及されていない場合は、このフィールドを完全に除外"]
    }}

    [フィールド抽出ルール]
    1. name：テキストからユーザーの氏名を特定、必須
    2. age：年齢情報を特定し、「数字 歳」フォーマットに変換、必須
    3. email：メールアドレスを特定し、元の形式を保持、必須
    4. hobby：ユーザーの趣味を特定し、文字列配列として出力；趣味が言及されていない場合は、hobby フィールドを完全に除外

    [参考例]
    例 1（趣味あり）：
    Q: 私の名前は山田太郎、25 歳で、メールアドレスは yamadataro@example.com、趣味は歌うことです
    A: {example1_response}

    例 2（複数の趣味あり）：
    Q: 私の名前は佐藤花子、30 歳で、メールアドレスは satohanako@example.com、趣味は踊ることと泳ぐことです
    A: {example2_response}

    例 3（趣味なし）：
    Q: 私の名前は鈴木一郎、28 歳で、メールアドレスは suzukichiro@example.com
    A: {example3_response}

    例 4（趣味なし）：
    Q: 私は高橋次郎、35 歳で、メールアドレスは takahashijiro@example.com
    A: {example4_response}

    上記のフォーマットおよびルールに厳密に従って情報を抽出し、JSON を出力してください。ユーザーが趣味について言及していない場合は、hobby フィールドを出力に含めないでください。\
""")

# LLM API を呼び出して情報抽出を行います
completion = client.chat.completions.create(
    model="qwen-plus",
    messages=[
        {
            "role": "system",
            "content": system_prompt
        },
        {
            "role": "user",
            "content": "こんにちは、私の名前は佐々木健太、34 歳で、メールアドレスは sasaki-kenta@example.com、趣味はバスケットボールと旅行です。", 
        },
    ],
    response_format={"type": "json_object"},  # JSON 形式での返答を指定
)

# モデルによって生成された JSON 結果を抽出して表示します
json_string = completion.choices[0].message.content
print(json_string)

応答

{
  "info": {
    "name": "Alex Brown",
    "age": "34 years old",
    "email": "alexbrown@example.com"
  },
  "hobby": ["Basketball", "Traveling"]  
}

import OpenAI from "openai";

// 事前に定義した例の応答（モデルに期待される出力フォーマットを示すため）
// 例 1：すべてのフィールドを含む完全な応答
const example1Response = JSON.stringify({
    info: { name: "山田太郎", age: "25 歳", email: "yamadataro@example.com" },
    hobby: ["歌うこと"]
}, null, 2);

// 例 2：複数の趣味を含む応答
const example2Response = JSON.stringify({
    info: { name: "佐藤花子", age: "30 歳", email: "satohanako@example.com" },
    hobby: ["踊ること", "泳ぐこと"]
}, null, 2);

// 例 3：趣味フィールドを含まない応答（趣味は任意）
const example3Response = JSON.stringify({
    info: { name: "鈴木一郎", age: "28 歳", email: "suzukichiro@example.com" }
}, null, 2);

// 例 4：趣味フィールドを含まない別の応答
const example4Response = JSON.stringify({
    info: { name: "高橋次郎", age: "35 歳", email: "takahashijiro@example.com" }
}, null, 2);

// OpenAI クライアントの設定を初期化
const openai = new OpenAI({
    // 環境変数を設定していない場合は、次の行を apiKey: "sk-xxx"（Alibaba Cloud Model Studio API キー）に置き換えます
    // API キーはリージョンによって異なります。API キーの取得方法：https://www.alibabacloud.com/help/en/model-studio/get-api-key
    apiKey: process.env.DASHSCOPE_API_KEY,
    // 以下は北京リージョンの base_url です。シンガポールリージョンのモデルを使用する場合は、base_url を https://dashscope-intl.aliyuncs.com/compatible-mode/v1 に置き換えます
    baseURL: "https://dashscope.aliyuncs.com/compatible-mode/v1"
});

// 構造化されたプロンプトを使用してチャット完了リクエストを作成し、出力の精度を向上させます
const completion = await openai.chat.completions.create({
    model: "qwen-plus",
    messages: [
        {
            role: "system",
            content: `ユーザー入力から個人情報を抽出し、指定された JSON スキーマ形式で出力してください：

[出力フォーマット要件]
出力は、以下の JSON 構造に厳密に従う必要があります：
{
  "info": {
    "name": "文字列型、必須フィールド、ユーザーの氏名",
    "age": "文字列型、必須フィールド、フォーマットは '数字 歳'（例：'25 歳'）",
    "email": "文字列型、必須フィールド、標準的なメールアドレス形式（例：'user@example.com'）"
  },
  "hobby": ["文字列配列型、任意フィールド、ユーザーのすべての趣味を含む。趣味が言及されていない場合は、このフィールドを完全に除外"]
}

[フィールド抽出ルール]
1. name：テキストからユーザーの氏名を特定、必須
2. age：年齢情報を特定し、「数字 歳」フォーマットに変換、必須
3. email：メールアドレスを特定し、元の形式を保持、必須
4. hobby：ユーザーの趣味を特定し、文字列配列として出力；趣味が言及されていない場合は、hobby フィールドを完全に除外

[参考例]
例 1（趣味あり）：
Q: 私の名前は山田太郎、25 歳で、メールアドレスは yamadataro@example.com、趣味は歌うことです
A: ${example1Response}

例 2（複数の趣味あり）：
Q: 私の名前は佐藤花子、30 歳で、メールアドレスは satohanako@example.com、趣味は踊ることと泳ぐことです
A: ${example2Response}

例 3（趣味なし）：
Q: 私の名前は鈴木一郎、28 歳で、メールアドレスは suzukichiro@example.com
A: ${example3Response}

例 4（趣味なし）：
Q: 私は高橋次郎、35 歳で、メールアドレスは takahashijiro@example.com
A: ${example4Response}

上記のフォーマットおよびルールに厳密に従って情報を抽出し、JSON を出力してください。ユーザーが趣味について言及していない場合は、hobby フィールドを出力に含めないでください。`
        },
        {
            role: "user",
            content: "こんにちは、私の名前は佐々木健太、34 歳で、メールアドレスは sasaki-kenta@example.com、趣味はバスケットボールと旅行です。"
        }
    ],
    response_format: {
        type: "json_object"
    }
});

// モデルによって生成された JSON 結果を抽出して表示します
const jsonString = completion.choices[0].message.content;
console.log(jsonString);

応答

{
  "info": {
    "name": "アレックス・ブラウン",
    "age": "34歳",
    "email": "alexbrown@example.com"
  },
  "hobby": [
    "バスケットボール",
    "旅行"
  ]
}

import os
import json
import dashscope

# シンガポールリージョンのモデルを使用する場合は、次の行のコメントを解除します
# dashscope.base_http_api_url = "https://dashscope-intl.aliyuncs.com/api/v1"

# 事前に定義した例の応答（モデルに期待される出力フォーマットを示すため）
example1_response = json.dumps(
    {
        "info": {"name": "山田太郎", "age": "25 歳", "email": "yamadataro@example.com"},
        "hobby": ["歌うこと"]
    },
    ensure_ascii=False
)
example2_response = json.dumps(
    {
        "info": {"name": "佐藤花子", "age": "30 歳", "email": "satohanako@example.com"},
        "hobby": ["踊ること", "泳ぐこと"]
    },
    ensure_ascii=False
)
example3_response = json.dumps(
    {
        "info": {"name": "鈴木一郎", "age": "40 歳", "email": "suzukichiro@example.com"},
        "hobby": ["ラップ", "バスケットボール"]
    },
    ensure_ascii=False
)

messages=[
        {
            "role": "system",
            "content": f"""ユーザー入力から個人情報を抽出し、指定された JSON スキーマ形式で出力してください：

[出力フォーマット要件]
出力は、以下の JSON 構造に厳密に従う必要があります：
{{
  "info": {{
    "name": "文字列型、必須フィールド、ユーザーの氏名",
    "age": "文字列型、必須フィールド、フォーマットは '数字 歳'（例：'25 歳'）",
    "email": "文字列型、必須フィールド、標準的なメールアドレス形式（例：'user@example.com'）"
  }},
  "hobby": ["文字列配列型、任意フィールド、ユーザーのすべての趣味を含む。趣味が言及されていない場合は、このフィールドを完全に除外"]
}}

[フィールド抽出ルール]
1. name：テキストからユーザーの氏名を特定、必須
2. age：年齢情報を特定し、「数字 歳」フォーマットに変換、必須
3. email：メールアドレスを特定し、元の形式を保持、必須
4. hobby：ユーザーの趣味を特定し、文字列配列として出力；趣味が言及されていない場合は、hobby フィールドを完全に除外

[参考例]
例 1（趣味あり）：
Q: 私の名前は山田太郎、25 歳で、メールアドレスは yamadataro@example.com、趣味は歌うことです
A: {example1_response}

例 2（複数の趣味あり）：
Q: 私の名前は佐藤花子、30 歳で、メールアドレスは satohanako@example.com、趣味は踊ることと泳ぐことです
A: {example2_response}

例 3（複数の趣味あり）：
Q: メールアドレスは suzukichiro@example.com、40 歳で、私の名前は鈴木一郎、趣味はラップとバスケットボールです
A: {example3_response}

上記のフォーマットおよびルールに厳密に従って情報を抽出し、JSON を出力してください。ユーザーが趣味について言及していない場合は、hobby フィールドを出力に含めないでください。"""
        },
        {
            "role": "user",
            "content": "こんにちは、私の名前は佐々木健太、34 歳で、メールアドレスは sasaki-kenta@example.com、趣味はバスケットボールと旅行です。", 
        },
    ]
response = dashscope.Generation.call(
    # 環境変数を設定していない場合は、次の行を api_key="sk-xxx"（Alibaba Cloud Model Studio API キー）に置き換えます
    api_key=os.getenv('DASHSCOPE_API_KEY'),
    model="qwen-plus", 
    messages=messages,
    result_format='message',
    response_format={'type': 'json_object'}
    )
json_string = response.output.choices[0].message.content
print(json_string)

応答

{
  "info": {
    "name": "Alex Brown",
    "age": "34 years old",
    "email": "alexbrown@example.com"
  },
  "hobby": [
    "playing basketball",
    "traveling"
  ]
}

応答

{
  "info": {
    "name": "Alex Brown",
    "age": "34 years old",
    "email": "alexbrown@example.com"
  },
  "hobby": [
    "Playing basketball",
    "Traveling"
  ]
}