Alibaba Cloud Model Studio：structured output

from openai import OpenAI
import os

client = OpenAI(
    # Kunci API untuk wilayah Singapura dan Beijing berbeda. Jika Anda belum mengatur variabel lingkungan, ganti baris berikut dengan Kunci API Anda: api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    # URL dasar berikut untuk wilayah Singapura. Untuk wilayah Beijing, gunakan 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": "Ekstrak nama dan usia pengguna, lalu kembalikan informasinya dalam format JSON."
        },
        {
            "role": "user",
            "content": "Halo semuanya, nama saya Alex Brown. Saya berusia 34 tahun. Email saya alexbrown@example.com. Saya suka bermain basket dan bepergian.", 
        },
    ],
    response_format={"type": "json_object"}
)

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

Hasil pengembalian

{
  "name": "Liu Wu",
  "age": 34
}

import OpenAI from "openai";

const openai = new OpenAI({
    // Jika Anda belum mengonfigurasi variabel lingkungan, ganti baris berikut dengan Kunci API Anda: apiKey: "sk-xxx"
    apiKey: process.env.DASHSCOPE_API_KEY,
    // URL dasar berikut untuk wilayah Singapura. Untuk menggunakan model di wilayah Beijing, ganti URL dasar dengan: 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: "Ekstrak informasi nama dan usia pengguna, lalu kembalikan dalam format JSON."
        },
        {
            role: "user",
            content: "Halo semuanya, nama saya Alex Brown, saya berusia 34 tahun, dan email saya alexbrown@example.com. Saya suka bermain basket dan bepergian."
        }
    ],
    response_format: {
        type: "json_object"
    }
});

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

Hasil pengembalian

{
  "Name": "Liu Wu",
  "Age": 34
}

# ======= Penting =======
# Kunci API untuk wilayah Singapura dan China (Beijing) berbeda. Untuk informasi lebih lanjut tentang cara mendapatkan Kunci API, lihat https://www.alibabacloud.com/help/en/model-studio/get-api-key
# Berikut adalah URL untuk wilayah Singapura. Jika Anda menggunakan model di wilayah China (Beijing), ganti URL dengan: https://dashscope.aliyuncs.com/compatible-mode/v1/chat/completions
# === Hapus komentar ini sebelum eksekusi ===
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": "Anda perlu mengekstrak nama (string), usia (string), dan email (string). Keluarkan string JSON. Jangan keluarkan konten lain.\nContoh:\nQ: Nama saya John Doe, saya berusia 25 tahun, dan email saya johndoe@example.com\nA:{\"name\":\"John Doe\",\"age\":\"25 years old\",\"email\":\"johndoe@example.com\"}\nQ: Nama saya Jane Smith, saya berusia 30 tahun, dan email saya janesmith@example.com\nA:{\"name\":\"Jane Smith\",\"age\":\"30 years old\",\"email\":\"janesmith@example.com\"}\nQ: Nama saya Peter Jones, email saya peterjones@example.com, dan saya berusia 40 tahun\nA:{\"name\":\"Peter Jones\",\"age\":\"40 years old\",\"email\":\"peterjones@example.com\"}"
        },
        {
            "role": "user", 
            "content": "Halo semuanya, nama saya Alex Brown, dan saya berusia 34 tahun. Email saya alexbrown@example.com"
        }
    ],
    "response_format": {
        "type": "json_object"
    }
}'

Hasil pengembalian

{
    "choices": [
        {
            "message": {
                "role": "assistant",
                "content": "{\"name\":\"Liu Wu\",\"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 berikut untuk wilayah Singapura. Untuk menggunakan model di wilayah Beijing, ganti URL dengan https://dashscope.aliyuncs.com/api/v1
dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'

messages=[
    {
        "role": "system",
        "content": "Ekstrak nama dan usia pengguna, lalu kembalikan informasinya dalam format JSON."
    },
    {
        "role": "user",
        "content": "Halo semuanya, nama saya Alex Brown. Saya berusia 34 tahun. Email saya alexbrown@example.com. Saya suka bermain basket dan bepergian.", 
    },
]
response = dashscope.Generation.call(
    # Untuk menggunakan model di wilayah China (Beijing), Anda harus menggunakan Kunci API khusus wilayah tersebut. Anda dapat memperoleh Kunci API dari: https://bailian.console.alibabacloud.com/?tab=model#/api-key
    # Jika Anda belum mengonfigurasi variabel lingkungan, ganti baris berikut dengan Kunci API Model Studio Anda: 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)

Hasil pengembalian

{
  "name": "Liu Wu",
  "age": 34
}

Hasil pengembalian

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

# ======= Penting =======
# Kunci API untuk wilayah Singapura dan China (Beijing) berbeda. Untuk informasi lebih lanjut tentang cara mendapatkan Kunci API, lihat https://www.alibabacloud.com/help/en/model-studio/get-api-key
# Berikut adalah URL untuk wilayah Singapura. Jika Anda menggunakan model di wilayah China (Beijing), ganti URL dengan: https://dashscope.aliyuncs.com/api/v1/services/aigc/text-generation/generation
# === Hapus komentar ini sebelum eksekusi ===

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": "Ekstrak nama dan usia, lalu kembalikan informasinya dalam format JSON."
            },
            {
                "role": "user", 
                "content": "Halo semuanya, nama saya Alex Brown, saya berusia 34 tahun, email saya alexbrown@example.com, dan saya suka bermain basket serta bepergian."
            }
        ]
    },
    "parameters": {
        "result_format": "message",
        "response_format": {
            "type": "json_object"
        }
    }
}'

Hasil pengembalian

{
    "output": {
        "choices": [
            {
                "finish_reason": "stop",
                "message": {
                    "role": "assistant",
                    "content": "{\n  \"Name\": \"Liu Wu\",\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({
  // Kunci API untuk wilayah Singapura dan China (Beijing) berbeda. Untuk mendapatkan Kunci API, lihat https://www.alibabacloud.com/help/en/model-studio/get-api-key
  // Jika Anda belum mengonfigurasi variabel lingkungan, ganti baris berikut dengan Kunci API Model Studio Anda: apiKey: "sk-xxx"
  apiKey: process.env.DASHSCOPE_API_KEY,
  // Berikut adalah URL dasar untuk wilayah Singapura. Jika Anda menggunakan model di wilayah China (Beijing), ganti URL dasar dengan 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: "Anda adalah asisten yang membantu."
        }]
      },
      {
        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: "Ekstrak informasi tiket (termasuk travel_date, trains, seat_num, arrival_site, dan price) dan informasi faktur (sebagai array, termasuk invoice_code dan invoice_number) dari citra. Keluarkan objek JSON yang berisi array tiket dan faktur."
          }
        ]
      }
    ],
    response_format: {type: "json_object"}
  });
  console.log(response.choices[0].message.content);
}

main()

Hasil pengembalian

{
  "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  # Digunakan untuk menangani indentasi string multi-baris dan meningkatkan keterbacaan kode.

# Pra-definisikan contoh respons untuk menunjukkan format output yang diharapkan model.
# Contoh 1: Respons lengkap yang mencakup hobi.
example1_response = json.dumps(
    {
        "info": {"name": "John Doe", "age": "25 years old", "email": "johndoe@example.com"},
        "hobby": ["singing"]
    },
    ensure_ascii=False
)
# Contoh 2: Respons yang mencakup beberapa hobi.
example2_response = json.dumps(
    {
        "info": {"name": "Jane Smith", "age": "30 years old", "email": "janesmith@example.com"},
        "hobby": ["dancing", "swimming"]
    },
    ensure_ascii=False
)
# Contoh 3: Respons yang tidak mencakup field hobby (hobby opsional).
example3_response = json.dumps(
    {
        "info": {"name": "Peter Jones", "age": "28 years old", "email": "peterjones@example.com"}
    },
    ensure_ascii=False
)
# Contoh 4: Respons yang tidak mencakup field hobby.
example4_response = json.dumps(
    {
        "info": {"name": "Emily White", "age": "35 years old", "email": "emilywhite@example.com"}
    },
    ensure_ascii=False
)

# Inisialisasi klien OpenAI dan konfigurasikan Kunci API serta URL dasar.
client = OpenAI(
    # Kunci API untuk wilayah Singapura dan Beijing berbeda. Untuk mendapatkan Kunci API, kunjungi: https://www.alibabacloud.com/help/en/model-studio/get-api-key
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    # Berikut adalah URL untuk wilayah Singapura. Jika Anda menggunakan model di wilayah Beijing, ganti URL dengan: https://dashscope.aliyuncs.com/compatible-mode/v1
    base_url="https://dashscope-intl.aliyuncs.com/compatible-mode/v1",
)

# Fungsi dedent menghapus spasi awal umum dari setiap baris dalam string.
# Ini memungkinkan Anda mengindentasi string dengan rapi di kode, dan spasi tambahan tidak akan disertakan saat runtime.
system_prompt = textwrap.dedent(f"""\
    Ekstrak informasi pribadi dari input pengguna dan keluarkan dalam format JSON Schema yang ditentukan:

    [Persyaratan Format Output]
    Output harus mengikuti struktur JSON di bawah ini secara ketat:
    {{
      "info": {{
        "name": "String. Wajib. Nama.",
        "age": "String. Wajib. Formatnya 'angka years old', contohnya '25 years old'.",
        "email": "String. Wajib. Format email standar, contohnya 'user@example.com'."
      }},
      "hobby": ["Array string. Opsional. Berisi semua hobi. Jika tidak ada hobi yang disebutkan, field ini harus dihilangkan dari output."]
    }}

    [Aturan Ekstraksi Field]
    1. name: Identifikasi nama dari teks. Field ini wajib.
    2. age: Identifikasi informasi usia dan ubah ke format 'angka years old'. Field ini wajib.
    3. email: Identifikasi alamat email dan pertahankan format aslinya. Field ini wajib.
    4. hobby: Identifikasi hobi dan keluarkan sebagai array string. Jika tidak ada hobi yang disebutkan, hilangkan field hobby sepenuhnya.

    [Contoh Referensi]
    Contoh 1 (termasuk hobi):
    Q: Nama saya John Doe, saya berusia 25 tahun, email saya johndoe@example.com, dan saya suka menyanyi.
    A: {example1_response}

    Contoh 2 (termasuk beberapa hobi):
    Q: Nama saya Jane Smith, saya berusia 30 tahun, email saya janesmith@example.com, dan saya suka menari dan berenang.
    A: {example2_response}

    Contoh 3 (tidak termasuk hobi):
    Q: Nama saya Peter Jones, saya berusia 28 tahun, dan email saya peterjones@example.com.
    A: {example3_response}

    Contoh 4 (tidak termasuk hobi):
    Q: Saya Emily White, berusia 35 tahun. Email saya emilywhite@example.com.
    A: {example4_response}

    Ikuti secara ketat format dan aturan di atas untuk mengekstrak informasi dan mengeluarkan JSON. Jika pengguna tidak menyebutkan hobi apa pun, jangan sertakan field hobby dalam output.\
""")

# Panggil API LLM untuk mengekstrak informasi.
completion = client.chat.completions.create(
    model="qwen-plus",  # Tentukan model yang digunakan, yaitu qwen-plus.
    messages=[
        {
            "role": "system",
            "content": system_prompt  # Gunakan prompt sistem yang didefinisikan di atas.
        },
        {
            "role": "user",
            "content": "Hai semuanya, nama saya Alex Brown. Saya berusia 34 tahun, email saya alexbrown@example.com, dan saya suka bermain basket serta bepergian.", 
        },
    ],
    response_format={"type": "json_object"},  # Tentukan format respons sebagai JSON untuk memastikan output terstruktur.
)

# Ekstrak dan cetak hasil JSON yang dihasilkan model.
json_string = completion.choices[0].message.content
print(json_string)

Hasil pengembalian

{
  "info": {
    "name": "Liu Wu",
    "age": "34",
    "email": "liuwu@example.com"
  },
  "hobby": ["basketball", "travel"]  
}

import OpenAI from "openai";

// Pra-definisikan respons contoh untuk menunjukkan format output yang diharapkan model.
// Contoh 1: Respons lengkap yang berisi semua field.
const example1Response = JSON.stringify({
    info: { name: "John Doe", age: "25 years old", email: "johndoe@example.com" },
    hobby: ["singing"]
}, null, 2);

// Contoh 2: Respons yang berisi beberapa hobi.
const example2Response = JSON.stringify({
    info: { name: "Jane Smith", age: "30 years old", email: "janesmith@example.com" },
    hobby: ["dancing", "swimming"]
}, null, 2);

// Contoh 3: Respons tanpa field hobby. Field hobby opsional.
const example3Response = JSON.stringify({
    info: { name: "Peter Jones", age: "28 years old", email: "peterjones@example.com" }
}, null, 2);

// Contoh 4: Respons lain tanpa field hobby.
const example4Response = JSON.stringify({
    info: { name: "Emily White", age: "35 years old", email: "emilywhite@example.com" }
}, null, 2);

// Inisialisasi konfigurasi klien OpenAI.
const openai = new OpenAI({
    // Kunci API untuk wilayah Singapura dan Beijing berbeda.
    // Jika variabel lingkungan belum dikonfigurasi, ganti baris berikut dengan Kunci API Alibaba Cloud Model Studio Anda: apiKey: "sk-xxx",
    apiKey: process.env.DASHSCOPE_API_KEY,
    // Berikut adalah URL untuk wilayah Singapura. Jika Anda menggunakan model di wilayah Beijing, ganti URL dengan: https://dashscope.aliyuncs.com/compatible-mode/v1
    baseURL: "https://dashscope-intl.aliyuncs.com/compatible-mode/v1"
});

// Buat permintaan penyelesaian chat. Gunakan prompt terstruktur untuk meningkatkan akurasi output.
const completion = await openai.chat.completions.create({
    model: "qwen-plus",
    messages: [
        {
            role: "system",
            content: `Silakan ekstrak informasi pribadi dari input pengguna dan keluarkan dalam format JSON Schema yang ditentukan.

[Persyaratan Format Output]
Output harus mengikuti struktur JSON di bawah ini secara ketat:
{
  "info": {
    "name": "Tipe string, field wajib, nama",
    "age": "Tipe string, field wajib, format: '[angka] years old', contohnya '25 years old'",
    "email": "Tipe string, field wajib, format email standar, contohnya 'user@example.com'"
  },
  "hobby": ["Tipe array string, opsional. Berisi semua hobi pengguna. Hilangkan field ini jika tidak ada hobi yang disebutkan."]
}

[Aturan Ekstraksi Field]
1. name: Identifikasi nama dari teks dan ekstrak. Field ini wajib.
2. age: Identifikasi informasi usia, ubah ke format '[angka] years old', dan ekstrak. Field ini wajib.
3. email: Identifikasi alamat email, pertahankan format aslinya, dan ekstrak. Field ini wajib.
4. hobby: Identifikasi hobi dan keluarkan sebagai array string. Jika tidak ada informasi hobi yang disebutkan, hilangkan field hobby sepenuhnya dari output.

[Contoh Referensi]
Contoh 1 (dengan hobi):
Q: Nama saya John Doe, saya berusia 25 tahun, email saya johndoe@example.com, dan hobi saya menyanyi.
A: ${example1Response}

Contoh 2 (dengan beberapa hobi):
Q: Nama saya Jane Smith, saya berusia 30 tahun, email saya janesmith@example.com, dan saya biasanya suka menari dan berenang.
A: ${example2Response}

Contoh 3 (tanpa hobi):
Q: Nama saya Peter Jones, saya berusia 28 tahun, dan email saya peterjones@example.com.
A: ${example3Response}

Contoh 4 (tanpa hobi):
Q: Saya Emily White, berusia 35 tahun, dan email saya emilywhite@example.com.
A: ${example4Response}

Ikuti secara ketat format dan aturan di atas untuk mengekstrak informasi dan mengeluarkan JSON. Jika pengguna tidak menyebutkan hobi apa pun, jangan sertakan field hobby dalam output.`
        },
        {
            role: "user",
            content: "Halo semuanya, nama saya Alex Brown, saya berusia 34 tahun, email saya alexbrown@example.com, dan saya biasanya suka bermain basket serta bepergian."
        }
    ],
    response_format: {
        type: "json_object"
    }
});

// Ekstrak dan cetak hasil JSON yang dihasilkan model.
const jsonString = completion.choices[0].message.content;
console.log(jsonString);

Hasil pengembalian

{
  "info": {
    "name": "Liu Wu",
    "age": "34 years old",
    "email": "liuwu@example.com"
  },
  "hobby": [
    "Playing basketball",
    "Traveling"
  ]
}

import os
import json
import dashscope
# Berikut adalah URL untuk wilayah Singapura. Jika Anda menggunakan model di wilayah China (Beijing), ganti URL dengan: https://dashscope.aliyuncs.com/api/v1
dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'

# Pra-definisikan respons contoh untuk menunjukkan format output yang diharapkan model.
example1_response = json.dumps(
    {
        "info": {"name": "John Doe", "age": "25 years old", "email": "johndoe@example.com"},
        "hobby": ["singing"]
    },
    ensure_ascii=False
)
example2_response = json.dumps(
    {
        "info": {"name": "Jane Smith", "age": "30 years old", "email": "janesmith@example.com"},
        "hobby": ["dancing", "swimming"]
    },
    ensure_ascii=False
)
example3_response = json.dumps(
    {
        "info": {"name": "Peter Jones", "age": "40 years old", "email": "peterjones@example.com"},
        "hobby": ["Rap", "basketball"]
    },
    ensure_ascii=False
)

messages=[
        {
            "role": "system",
            "content": f"""Silakan ekstrak informasi pribadi dari input pengguna dan keluarkan dalam format JSON Schema yang ditentukan:

[Persyaratan Format Output]
Output harus mengikuti struktur JSON di bawah ini secara ketat:
{{
  "info": {{
    "name": "string, wajib, nama pengguna",
    "age": "string, wajib, dalam format 'angka years old', contohnya '25 years old'",
    "email": "string, wajib, dalam format email standar, contohnya 'user@example.com'"
  }},
  "hobby": ["array string, opsional, berisi semua hobi pengguna. Jika tidak ada hobi yang disebutkan, hilangkan field ini sepenuhnya."]
}}

[Aturan Ekstraksi Field]
1. name: Identifikasi nama pengguna dari teks. Field ini wajib.
2. age: Identifikasi informasi usia dan ubah ke format "angka years old". Field ini wajib.
3. email: Identifikasi alamat email dan pertahankan format aslinya. Field ini wajib.
4. hobby: Identifikasi hobi pengguna dan keluarkan sebagai array string. Jika tidak ada informasi hobi yang disebutkan, hilangkan field hobby sepenuhnya.

[Contoh Referensi]
Contoh 1 (termasuk hobi):
Q: Nama saya John Doe, saya berusia 25 tahun, email saya johndoe@example.com, dan hobi saya menyanyi.
A: {example1_response}

Contoh 2 (termasuk beberapa hobi):
Q: Nama saya Jane Smith, saya berusia 30 tahun, email saya janesmith@example.com, dan saya suka menari dan berenang.
A: {example2_response}

Contoh 3 (termasuk beberapa hobi):
Q: Email saya peterjones@example.com, saya berusia 40 tahun, nama saya Peter Jones, dan saya bisa rap serta bermain basket.
A: {example3_response}

Silakan ikuti secara ketat format dan aturan di atas untuk mengekstrak informasi dan mengeluarkan JSON. Jika pengguna tidak menyebutkan hobi apa pun, jangan sertakan field hobby dalam output."""
        },
        {
            "role": "user",
            "content": "Halo semuanya, nama saya Alex Brown, saya berusia 34 tahun, email saya alexbrown@example.com, dan saya suka bermain basket serta bepergian.", 
        },
    ]
response = dashscope.Generation.call(
    # Jika Anda menggunakan model di wilayah China (Beijing), Anda harus menggunakan Kunci API untuk wilayah China (Beijing). Dapatkan di: https://bailian.console.alibabacloud.com/?tab=model#/api-key
    # Jika variabel lingkungan belum dikonfigurasi, ganti baris berikut dengan Kunci API Alibaba Cloud Model Studio Anda: 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)

Hasil pengembalian

{
  "info": {
    "name": "Liu Wu",
    "age": "34 years old",
    "email": "liuwu@example.com"
  },
  "hobby": [
    "Playing basketball",
    "Traveling"
  ]
}

Hasil pengembalian

{
  "info": {
    "name": "Liu Wu",
    "age": "34",
    "email": "liuwu@example.com"
  },
  "hobby": [
    "Playing basketball",
    "Traveling"
  ]
}