Databricks での構造化された出力

プレビュー

この機能は パブリック プレビュー 段階であり、基盤モデル エンドポイント APIs トークン単位の従量課金エンドポイントとプロビジョニング スループット エンドポイントの両方でサポートされています。

この記事では、 Databricks で構造化された出力と、それらを生成AI アプリケーション ワークフローの一部として使用する方法について説明します。 Structured outputs は OpenAI と互換性があり、基盤モデル APIsの一部としてモデルサービング中のみ使用できます。

構造化アウトプットとは?

構造化出力は、入力データから JSON オブジェクトの形式で構造化データを生成する方法を提供します。 テキスト、非構造化 JSON オブジェクト、および特定の JSON スキーマに準拠する JSON オブジェクトを生成することを選択できます。 構造化された出力は、基盤モデル APIs トークン単位の従量課金とプロビジョニング スループット エンドポイントを使用して提供されるチャット モデルでサポートされています。

Databricks では、次のシナリオで構造化出力を使用することをお勧めします。

  • 大量のドキュメントからデータを抽出する。 たとえば、製品レビューのフィードバックを特定して、否定的、肯定的、または中立的に分類します。

  • 出力が指定された形式である必要があるバッチ推論タスク。

  • 非構造化データを構造化データに変換するなどのデータ処理。

構造化された出力を使用する

チャットリクエストで response_format を使用して構造化された出力を指定します。 基盤モデル REST API リファレンスを参照してください。

以下は、特定のJSONスキーマへの研究論文のデータ抽出の例です。

import os
import json
from openai import OpenAI

DATABRICKS_TOKEN = os.environ.get('YOUR_DATABRICKS_TOKEN')
DATABRICKS_BASE_URL = os.environ.get('YOUR_DATABRICKS_BASE_URL')

client = OpenAI(
  api_key=DATABRICKS_TOKEN,
  base_url=DATABRICKS_BASE_URL
  )

response_format = {
      "type": "json_schema",
      "json_schema": {
        "name": "research_paper_extraction",
        "schema": {
          "type": "object",
          "properties": {
            "title": { "type": "string" },
            "authors": {
              "type": "array",
              "items": { "type": "string" }
            },
            "abstract": { "type": "string" },
            "keywords": {
              "type": "array",
              "items": { "type": "string" }
            }
          },
        },
        "strict": True
      }
    }

messages = [{
        "role": "system",
        "content": "You are an expert at structured data extraction. You will be given unstructured text from a research paper and should convert it into the given structure."
      },
      {
        "role": "user",
        "content": "..."
      }]

response = client.chat.completions.create(
    model="databricks-meta-llama-3-1-70b-instruct",
    messages=messages,
    response_format=response_format
)

print(json.dumps(response.choices[0].message.model_dump()['content'], indent=2))

以下はJSON抽出の例ですが、JSONスキーマは事前にはわかっていません。

import os
import json
from openai import OpenAI

DATABRICKS_TOKEN = os.environ.get('YOUR_DATABRICKS_TOKEN')
DATABRICKS_BASE_URL = os.environ.get('YOUR_DATABRICKS_BASE_URL')

client = OpenAI(
  api_key=DATABRICKS_TOKEN,
  base_url=DATABRICKS_BASE_URL
  )

response_format = {
      "type": "json_object",
    }

messages = [
      {
        "role": "user",
        "content": "Extract the name, size, price, and color from this product description as a JSON object:\n<description>\nThe SmartHome Mini is a compact smart home assistant available in black or white for only $49.99. It's 5 inches wide.\n</description>"
      }]

response = client.chat.completions.create(
    model="databricks-meta-llama-3-1-70b-instruct",
    messages=messages,
    response_format=response_format
)

print(json.dumps(response.choices[0].message.model_dump()['content'], indent=2))

JSON スキーマ

基盤モデル APIs OpenAI が受け入れる構造化された出力を広くサポートします。 ただし、JSON スキーマ定義に単純な JSON スキーマを使用すると、JSON 生成の品質が向上します。 より高品質な生成を促進するために、基盤モデルはAPIs JSONスキーマ仕様 の一部のみをサポートします。

次の関数呼び出し定義キーはサポートされていません。

  • pattern.

  • anyOfoneOfallOfprefixItems、または $refを使用した複雑なネストまたはスキーマの構成と検証。

  • 型のリスト (ただし、リスト内の 1 つの型が有効な JSON 型で、もう 1 つの型が有効な JSON 型である [type, “null”] の特殊なケースを除く) "null"

トークンの使用量

プロンプトインジェクションやその他の手法を使用して、構造化された出力の品質を向上させます。 これを行うと、モデルによって消費される入力トークンと出力トークンの数に影響が及び、課金に影響が及びます。

制限事項

  • JSON スキーマで指定されるキーの最大数は 64です。

  • 基盤モデルAPIオブジェクトと配列の長さやサイズの制約を強制しません。

    • これには、 maxPropertiesminPropertiesmaxLengthなどのキーワードが含まれます。

  • ネストされた JSON スキーマが多いと、生成の品質が低下します。 可能であれば、より良い結果を得るために JSON スキーマをフラット化してみてください。