:構造化出力

from openai import OpenAI
import os

client = OpenAI(
    # API キーはリージョンごとに異なります。環境変数を設定していない場合は、次の行を api_key="sk-xxx" に置き換えます
    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 歳です。メールアドレスは tanaka@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({
    // 環境変数を設定していない場合は、次の行を 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 歳です。メールアドレスは tanaka@example.com で、バスケットボールと旅行が趣味です"
        }
    ],
    response_format: {
        type: "json_object"
    }
});

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

応答

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

# ======= 重要事項 =======
# API キーはリージョンごとに異なります。API キーの取得方法： https://www.alibabacloud.com/help/ja/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 years old\",\"email\":\"zhangsan@example.com\"}\nQ: 私の名前は李四で、30 歳、メールアドレスは lisi@example.com です\nA: {\"name\":\"李四\",\"age\":\"30 years old\",\"email\":\"lisi@example.com\"}\nQ: 私の名前は王五で、メールアドレスは wangwu@example.com、40 歳です\nA: {\"name\":\"王五\",\"age\":\"40 years old\",\"email\":\"wangwu@example.com\"}"
        },
        {
            "role": "user", 
            "content": "みなさん、こんにちは。私の名前は田中一郎で、34 歳、メールアドレスは tanaka@example.com です"
        }
    ],
    "response_format": {
        "type": "json_object"
    }
}'

応答

{
    "choices": [
        {
            "message": {
                "role": "assistant",
                "content": "{\"name\":\"Alex Brown\",\"age\":\"34 years old\"}"
            },
            "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 歳です。メールアドレスは tanaka@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/ja/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": "ユーザー'\''の名前と年齢を抽出し、JSON 形式で返してください"
            },
            {
                "role": "user", 
                "content": "みなさん、こんにちは。私の名前は田中一郎で、34 歳です。メールアドレスは tanaka@example.com で、バスケットボールと旅行が趣味です"
            }
        ]
    },
    "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/ja/model-studio/get-api-key
  // 環境変数を設定していない場合は、次の行を apiKey: "sk-xxx"（Model Studio API キー）に置き換えます
  apiKey: process.env.DASHSCOPE_API_KEY,
  // 中国 (北京) リージョンのモデルを使用する場合は、baseURL を 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 years old", "email": "zhangsan@example.com"},
        "hobby": ["singing"]
    },
    ensure_ascii=False
)
# 例 2：複数の趣味を含む応答
example2_response = json.dumps(
    {
        "info": {"name": "李四", "age": "30 years old", "email": "lisi@example.com"},
        "hobby": ["dancing", "swimming"]
    },
    ensure_ascii=False
)
# 例 3：hobby フィールドを含まない応答（hobby は任意）
example3_response = json.dumps(
    {
        "info": {"name": "趙六", "age": "28 years old", "email": "zhaoliu@example.com"}
    },
    ensure_ascii=False
)
# 例 4：hobby フィールドを含まない別の応答
example4_response = json.dumps(
    {
        "info": {"name": "孫七", "age": "35 years old", "email": "sunqi@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 Schema 形式で出力してください：

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

    [フィールド抽出ルール]
    1. name：テキストからユーザーの名前を特定し、必ず抽出します
    2. age：年齢情報を特定し、'数字 years old' 形式に変換し、必ず抽出します
    3. email：メールアドレスを特定し、元の形式を保持し、必ず抽出します
    4. hobby：ユーザーの趣味を特定し、文字列の配列として出力します。趣味が言及されていない場合は、hobby フィールドを完全に省略します

    [参照例]
    例 1（趣味あり）：
    Q: 私の名前は張三で、25 歳、メールアドレスは zhangsan@example.com、趣味は歌うこと
    A: {example1_response}

    例 2（複数の趣味あり）：
    Q: 私の名前は李四で、30 歳、メールアドレスは lisi@example.com、ダンスと水泳が好き
    A: {example2_response}

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

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

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

# 情報抽出のためにモデル API を呼び出します
completion = client.chat.completions.create(
    model="qwen-plus",
    messages=[
        {
            "role": "system",
            "content": system_prompt
        },
        {
            "role": "user",
            "content": "みなさん、こんにちは。私の名前は田中一郎で、34 歳、メールアドレスは tanaka@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 years old", email: "zhangsan@example.com" },
    hobby: ["singing"]
}, null, 2);

// 例 2：複数の趣味を含む応答
const example2Response = JSON.stringify({
    info: { name: "李四", age: "30 years old", email: "lisi@example.com" },
    hobby: ["dancing", "swimming"]
}, null, 2);

// 例 3：hobby フィールドを含まない応答（hobby は任意）
const example3Response = JSON.stringify({
    info: { name: "趙六", age: "28 years old", email: "zhaoliu@example.com" }
}, null, 2);

// 例 4：hobby フィールドを含まない別の応答
const example4Response = JSON.stringify({
    info: { name: "孫七", age: "35 years old", email: "sunqi@example.com" }
}, null, 2);

// OpenAI クライアント構成を初期化します
const openai = new OpenAI({
    // 環境変数を設定していない場合は、次の行を api_key="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 構造に厳密に従う必要があります：
{
  "info": {
    "name": "文字列型、必須フィールド、ユーザーの名前",
    "age": "文字列型、必須フィールド、形式は '数字 years old'（例：'25 years old'）",
    "email": "文字列型、必須フィールド、標準的なメール形式（例：'user@example.com'）"
  },
  "hobby": ["文字列の配列型、任意フィールド、ユーザーのすべての趣味を含む。言及されていない場合は完全に省略"]
}

[フィールド抽出ルール]
1. name：テキストからユーザーの名前を特定し、必ず抽出します
2. age：年齢情報を特定し、'数字 years old' 形式に変換し、必ず抽出します
3. email：メールアドレスを特定し、元の形式を保持し、必ず抽出します
4. hobby：ユーザーの趣味を特定し、文字列の配列として出力します。趣味が言及されていない場合は hobby フィールドを完全に省略します

[参照例]
例 1（趣味あり）：
Q: 私の名前は張三で、25 歳、メールアドレスは zhangsan@example.com、趣味は歌うこと
A: ${example1Response}

例 2（複数の趣味あり）：
Q: 私の名前は李四で、30 歳、メールアドレスは lisi@example.com、ダンスと水泳が好き
A: ${example2Response}

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

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

上記の形式とルールに厳密に従って情報を抽出し、JSON を出力してください。ユーザーが趣味を言及していない場合は、hobby フィールドを含めないでください。`
        },
        {
            role: "user",
            content: "みなさん、こんにちは。私の名前は田中一郎で、34 歳、メールアドレスは tanaka@example.com、バスケットボールと旅行が趣味です"
        }
    ],
    response_format: {
        type: "json_object"
    }
});

// モデルが生成した JSON 結果を抽出して出力します
const jsonString = completion.choices[0].message.content;
console.log(jsonString);

応答

{
  "info": {
    "name": "Alex Brown",
    "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 years old", "email": "zhangsan@example.com"},
        "hobby": ["singing"]
    },
    ensure_ascii=False
)
example2_response = json.dumps(
    {
        "info": {"name": "李四", "age": "30 years old", "email": "lisi@example.com"},
        "hobby": ["dancing", "swimming"]
    },
    ensure_ascii=False
)
example3_response = json.dumps(
    {
        "info": {"name": "王五", "age": "40 years old", "email": "wangwu@example.com"},
        "hobby": ["Rap", "basketball"]
    },
    ensure_ascii=False
)

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

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

[フィールド抽出ルール]
1. name：テキストからユーザーの名前を特定し、必ず抽出します
2. age：年齢情報を特定し、'数字 years old' 形式に変換し、必ず抽出します
3. email：メールアドレスを特定し、元の形式を保持し、必ず抽出します
4. hobby：ユーザーの趣味を特定し、文字列の配列として出力します。趣味が言及されていない場合は hobby フィールドを完全に省略します

[参照例]
例 1（趣味あり）：
Q: 私の名前は張三で、25 歳、メールアドレスは zhangsan@example.com、趣味は歌うこと
A: {example1_response}

例 2（複数の趣味あり）：
Q: 私の名前は李四で、30 歳、メールアドレスは lisi@example.com、ダンスと水泳が好き
A: {example2_response}

例 3（複数の趣味あり）：
Q: メールアドレスは wangwu@example.com、40 歳、名前は王五で、Rap ができてバスケットボールができます
A: {example3_response}

上記の形式とルールに厳密に従って情報を抽出し、JSON を出力してください。ユーザーが趣味を言及していない場合は、hobby フィールドを含めないでください。"""
        },
        {
            "role": "user",
            "content": "みなさん、こんにちは。私の名前は田中一郎で、34 歳、メールアドレスは tanaka@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 歳",
    "email": "alexbrown@example.com"
  },
  "hobby": [
    "バスケットボールをする",
    "旅行"
  ]
}

応答

{
  "info": {
    "name": "Alex Brown",
    "age": "34 years old",
    "email": "alexbrown@example.com"
  },
  "hobby": [
    "バスケットボールをする",
    "旅行"
  ]
}