Alibaba Cloud Model Studio:structured output

from openai import OpenAI
import os

client = OpenAI(
    # リージョンごとに個別の API キーが使用されます。環境変数を設定していない場合は、次の行をご利用の API キーに置き換えてください：api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    # 北京リージョンについては、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歳です。メールアドレスは ichiro.tanaka@example.com です。バスケットボールと旅行が好きです。", 
        },
    ],
    response_format={"type": "json_object"}
)

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

実行結果

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

import OpenAI from "openai";

const openai = new OpenAI({
    // 環境変数を設定していない場合は、次の行をご利用の API キーに置き換えてください：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歳で、メールアドレスは ichiro.tanaka@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/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歳で、メールアドレスは taro.tanaka@example.com です\nA:{\"name\":\"田中太郎\",\"age\":\"25歳\",\"email\":\"taro.tanaka@example.com\"}\nQ: 私の名前は鈴木花子です。30歳で、メールアドレスは hanako.suzuki@example.com です\nA:{\"name\":\"鈴木花子\",\"age\":\"30歳\",\"email\":\"hanako.suzuki@example.com\"}\nQ: 私の名前は佐藤次郎です。メールアドレスは jiro.sato@example.com で、40歳です\nA:{\"name\":\"佐藤次郎\",\"age\":\"40歳\",\"email\":\"jiro.sato@example.com\"}"
        },
        {
            "role": "user", 
            "content": "皆さん、こんにちは。私の名前は田中一郎です。34歳です。メールアドレスは ichiro.tanaka@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歳です。メールアドレスは ichiro.tanaka@example.com です。バスケットボールと旅行が好きです。", 
    },
]
response = dashscope.Generation.call(
    # 中国 (北京) リージョンのモデルを使用するには、そのリージョン専用の API キーを使用する必要があります。API キーは https://bailian.console.alibabacloud.com/?tab=model#/api-key から取得できます
    # 環境変数を設定していない場合は、次の行をご利用の Model Studio API キーに置き換えてください：api_key="sk-xxx",
    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": "田中一郎",
  "age": 34
}

実行結果

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

# ======= 重要 =======
# リージョンごとに個別の API キーが使用されます。API キーの取得方法の詳細については、https://www.alibabacloud.com/help/model-studio/get-api-key をご参照ください
#  中国 (北京) リージョンのモデルを使用する場合は、URL を https://dashscope.aliyuncs.com/api/v1/services/aigc/text-generation/generation に置き換えてください
# === 実行前にこのコメントを削除してください ===

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歳で、メールアドレスは ichiro.tanaka@example.com です。バスケットボールと旅行が好きです。"
            }
        ]
    },
    "parameters": {
        "result_format": "message",
        "response_format": {
            "type": "json_object"
        }
    }
}'

実行結果

{
    "output": {
        "choices": [
            {
                "finish_reason": "stop",
                "message": {
                    "role": "assistant",
                    "content": "{\n  \"Name\": \"田中一郎\",\n  \"Age\": 34\n}"
                }
            }
        ]
    },
    "usage": {
        "total_tokens": 72,
        "output_tokens": 18,
        "input_tokens": 54,
        "cached_tokens": 0
    },
    "request_id": "xxx-xxx-xxx-xxx-xxx"
}

import OpenAI from "openai";

const openai = new OpenAI({
  // リージョンごとに異なる API キーが使用されます。API キーの取得方法については、https://www.alibabacloud.com/help/model-studio/get-api-key をご参照ください
  // 環境変数を設定していない場合は、次の行をご自身の Model Studio API キーに置き換えてください: apiKey: "sk-xxx"
  apiKey: process.env.DASHSCOPE_API_KEY,
  // 以下は、中国 (北京) リージョンのモデルを使用する場合の base_url です。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: "You are a helpful assistant."
        }]
      },
      {
        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: "Extract the ticket information (array type, including travel_date, trains, seat_num, arrival_site, and price) and the invoice information (as an array, including invoice_code and invoice_number) from the image. Output a JSON object that contains the ticket and invoice arrays."
          }
        ]
      }
    ],
    response_format: {type: "json_object"}
  });
  console.log(response.choices[0].message.content);
}

main()

実行結果

{
  "ticket": [
    {
      "travel_date": "2013-06-29",
      "trains": "Serial Number",
      "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": "John Doe", "age": "25 years old", "email": "johndoe@example.com"},
        "hobby": ["singing"]
    },
    ensure_ascii=False
)
# 例 2: 複数の趣味を含む応答。
example2_response = json.dumps(
    {
        "info": {"name": "Jane Smith", "age": "30 years old", "email": "janesmith@example.com"},
        "hobby": ["dancing", "swimming"]
    },
    ensure_ascii=False
)
# 例 3: hobby フィールドを含まない応答 (hobby はオプションです)。
example3_response = json.dumps(
    {
        "info": {"name": "Peter Jones", "age": "28 years old", "email": "peterjones@example.com"}
    },
    ensure_ascii=False
)
# 例 4: hobby フィールドを含まない応答。
example4_response = json.dumps(
    {
        "info": {"name": "Emily White", "age": "35 years old", "email": "emilywhite@example.com"}
    },
    ensure_ascii=False
)

# OpenAI クライアントを初期化し、API キーとベース URL を設定します。
client = OpenAI(
    # リージョンごとに異なる API キーが使用されます。API キーを取得するには、https://www.alibabacloud.com/help/en/model-studio/get-api-key にアクセスしてください。
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    #  北京リージョンのモデルを使用する場合は、URL を https://dashscope.aliyuncs.com/compatible-mode/v1 に置き換えてください。
    base_url="https://dashscope-intl.aliyuncs.com/compatible-mode/v1",
)

# dedent 関数は、文字列の各行から共通の先頭の空白を削除します。
# これにより、コード内で文字列をきれいにインデントでき、余分なスペースは実行時に含まれなくなります。
system_prompt = textwrap.dedent(f"""\
    ユーザー入力から個人情報を抽出し、指定された JSON スキーマフォーマットで出力します:

    [出力フォーマット要件]
    出力は、以下の 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: My name is John Doe, I'm 25 years old, my email is johndoe@example.com, and I like to sing.
    A: {example1_response}

    例 2 (複数の趣味を含む):
    Q: My name is Jane Smith, I'm 30 years old, my email is janesmith@example.com, and I enjoy dancing and swimming.
    A: {example2_response}

    例 3 (趣味を含まない):
    Q: My name is Peter Jones, I'm 28 years old, and my email is peterjones@example.com.
    A: {example3_response}

    例 4 (趣味を含まない):
    Q: I'm Emily White, 35 years old. My email is emilywhite@example.com.
    A: {example4_response}

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

# LLM API を呼び出して情報を抽出します。
completion = client.chat.completions.create(
    model="qwen-plus",  # 使用するモデル (qwen-plus) を指定します。
    messages=[
        {
            "role": "system",
            "content": system_prompt  # 上記で定義したシステムプロンプトを使用します。
        },
        {
            "role": "user",
            "content": "Hi everyone, my name is Alex Brown. I'm 34 years old, my email is alexbrown@example.com, and I like to play basketball and travel.", 
        },
    ],
    response_format={"type": "json_object"},  # 構造化された出力を保証するために、応答フォーマットを JSON として指定します。
)

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

実行結果

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

import OpenAI from "openai";

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

// 例 2：複数の趣味を含む応答。
const example2Response = JSON.stringify({
    info: { name: "鈴木花子", age: "30 years old", email: "janesmith@example.com" },
    hobby: ["ダンス", "水泳"]
}, null, 2);

// 例 3：hobby フィールドを含まない応答。hobby フィールドはオプションです。
const example3Response = JSON.stringify({
    info: { name: "佐藤健太", age: "28 years old", email: "peterjones@example.com" }
}, null, 2);

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

// OpenAI クライアントの構成を初期化します。
const openai = new OpenAI({
    // リージョンごとに異なる API キーが使用されます。
    // 環境変数が設定されていない場合は、次の行を Alibaba Cloud Model Studio API キーに置き換えてください：apiKey: "sk-xxx",
    apiKey: process.env.DASHSCOPE_API_KEY,
    //  北京リージョンのモデルを使用する場合は、URL を 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-plus",
    messages: [
        {
            role: "system",
            content: `ユーザー入力から個人情報を抽出し、指定された JSON スキーマフォーマットで出力してください。

[出力フォーマット要件]
出力は、以下の 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歳、メールアドレスは johndoe@example.com、趣味は歌です。
A: ${example1Response}

例 2 (複数の趣味あり)：
Q: 私の名前は鈴木花子、30歳、メールアドレスは janesmith@example.com、普段はダンスと水泳が好きです。
A: ${example2Response}

例 3 (趣味なし)：
Q: 私の名前は佐藤健太、28歳、メールアドレスは peterjones@example.com です。
A: ${example3Response}

例 4 (趣味なし)：
Q: 私は高橋美咲、35歳、メールアドレスは emilywhite@example.com です。
A: ${example4Response}

上記のフォーマットとルールに厳密に従って情報を抽出し、JSON を出力してください。ユーザーが趣味について言及しなかった場合は、hobby フィールドを出力に含めないでください。`
        },
        {
            role: "user",
            content: "皆さん、こんにちは。私の名前は伊藤大輝、34歳です。メールアドレスは alexbrown@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
#  中国 (北京) リージョンのモデルを使用する場合は、URL を https://dashscope.aliyuncs.com/api/v1 に置き換えてください。
dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'

# モデルに期待される出力フォーマットを示すための応答例を事前定義します。
example1_response = json.dumps(
    {
        "info": {"name": "田中太郎", "age": "25 years old", "email": "johndoe@example.com"},
        "hobby": ["歌"]
    },
    ensure_ascii=False
)
example2_response = json.dumps(
    {
        "info": {"name": "鈴木花子", "age": "30 years old", "email": "janesmith@example.com"},
        "hobby": ["ダンス", "水泳"]
    },
    ensure_ascii=False
)
example3_response = json.dumps(
    {
        "info": {"name": "佐藤健太", "age": "40 years old", "email": "peterjones@example.com"},
        "hobby": ["ラップ", "バスケットボール"]
    },
    ensure_ascii=False
)

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

[出力フォーマット要件]
出力は、以下の 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歳、メールアドレスは johndoe@example.com、趣味は歌です。
A: {example1_response}

例 2 (複数の趣味あり)：
Q: 私の名前は鈴木花子、30歳、メールアドレスは janesmith@example.com、ダンスと水泳が好きです。
A: {example2_response}

例 3 (複数の趣味あり)：
Q: 私のメールアドレスは peterjones@example.com、40歳、名前は佐藤健太で、ラップとバスケットボールができます。
A: {example3_response}

上記のフォーマットとルールに厳密に従って情報を抽出し、JSON を出力してください。ユーザーが趣味について言及しなかった場合は、hobby フィールドを出力に含めないでください。"""
        },
        {
            "role": "user",
            "content": "皆さん、こんにちは。私の名前は伊藤大輝、34歳です。メールアドレスは alexbrown@example.com で、趣味はバスケットボールと旅行です。", 
        },
    ]
response = dashscope.Generation.call(
    # 中国 (北京) リージョンのモデルを使用する場合は、中国 (北京) リージョンの API キーを使用する必要があります。https://bailian.console.alibabacloud.com/?tab=model#/api-key で取得してください。
    # 環境変数が設定されていない場合は、次の行を Alibaba Cloud Model Studio API キーに置き換えてください：api_key="sk-xxx",
    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",
    "email": "alexbrown@example.com"
  },
  "hobby": [
    "Playing basketball",
    "Traveling"
  ]
}