Platform For AI:API 機能の説明

チャット補完

サンプルコード

1. リクエスト例

   Python

   import os
   from openai import OpenAI
   
   
   def main():
       base_url = "https://aiservice.cn-hangzhou.aliyuncs.com/v1"
       judge_model_token = os.getenv("JUDGE_MODEL_TOKEN")
   
       client = OpenAI(
           api_key=f'Authorization: Bearer {judge_model_token}',
           base_url=base_url
       )
       completion = client.chat.completions.create(
           model='pai-judge',
           messages=[
               {
                   "role": "user",
                   "content": [
                       {
                           "mode": "single",
                           "type": "json",
                           "json": {
                               "question": "According to the first couplet, give the second couplet. first couplet: To climb the mountain, reach the peak", // 上の句に基づいて、下の句を挙げてください。上の句：山に登り、頂上に到達する
                               "answer": "To cross the river, find the creek." // 川を渡り、小川を見つける
                           }
                       }
                   ]
               }
           ]
       )
       print(completion.model_dump())
   
   
   if __name__ == '__main__':
       main()

   curl

   $ curl -X POST https://aiservice.cn-hangzhou.aliyuncs.com/v1/chat/completions \
     -H "Authorization: Bearer ${JUDGE_MODEL_TOKEN}" \
     -H "Content-Type: application/json" \
     -d '{
       "model": "pai-judge",
       "messages": [
           {
               "role": "user",
               "content": [
                   {
                       "mode": "single",
                       "type": "json",
                       "json": {
                           "question": "According to the first couplet, give the second couplet. first couplet: To climb the mountain, reach the peak", // 上の句に基づいて、下の句を挙げてください。上の句：山に登り、頂上に到達する
                           "answer": "To cross the river, find the creek." // 川を渡り、小川を見つける
                       }
                   }
               ]
           }
       ]
   }'

2. レスポンス例

   {
       "id": "3b7c3822-1e51-4dc9-b2ad-18b9649a7f19",
       "choices": [
           {
               "finish_reason": "stop",
               "index": 0,
               "logprobs": null,
               "message": {
                   "content": "I think the overall score of the answer is [[2]] due to the following reasons:\n Advantages of the answer:\n1. Relevance: The answer directly addresses the user's question, providing a second couplet that corresponds to the first couplet. ThiS meets the relevance criteria.[[4]]\n2. Harmlessness: The answer does not contain offensive content. This meets the harmlessness criteria.[[5]]\n\n Disadvantages of the answer: \n1. Accuracy: The content \"To cross the river, find the creek\" does not fully align with the logical sequence of \"climbing\" and \"reaching the peak\" in the user's question, which affects the accuracy of the answer.[[2]]\n2. Completeness: The answer does not fully address all aspects of the question because the answer does not provide a complete story or completely align with the question. This affects the completeness of the answer.[[2]]\n3. Source reliability: The answer does not provide source information. Although the source information may not be necessary in some scenarios, the information can enhance the credibility of the answer.[[3]]\n4. Clarity and structure: Although the answer is simple in structure, its clarity and comprehensibility are affected because the answer does not fully correspond to the question.[[3]]\n5. Adaptability to the user level: Although the answer directly addresses the question, the answer may not be completely suitable for users who have a certain understanding of couplets or traditional literature due to inaccuracy.[[3]]\n\n In summary, although the answer performs well in relevance and harmlessness, the answer shows shortcomings in accuracy, completeness, source reliability, clarity and structure, and adaptability to the user level, which results in an overall rating of 2.", // 回答の全体的なスコアは、以下の理由により[[2]]だと思います。\n回答の長所：\n1. 関連性：回答はユーザーの質問に直接答え、最初の対句に対応する2番目の対句を提供しています。これは関連性の基準を満たしています。[[4]]\n2. 無害性：回答には不快な内容は含まれていません。これは無害性の基準を満たしています。[[5]]\n\n回答の短所：\n1. 正確性：「川を渡り、小川を見つける」という内容は、ユーザーの質問の「登る」と「頂上に到達する」という論理的シーケンスと完全には一致しておらず、回答の正確性に影響を与えています。[[2]]\n2. 完全性：回答は完全なストーリーを提供していない、または質問と完全には一致していないため、質問のすべての側面に完全には対応していません。これは回答の完全性に影響を与えています。[[2]]\n3. ソースの信頼性：回答はソース情報を提供していません。ソース情報は一部のシナリオでは必要ない場合がありますが、情報は回答の信頼性を高めることができます。[[3]]\n4. 明確さと構造：回答の構造は単純ですが、質問と完全には対応していないため、明確さと分かりやすさが影響を受けています。[[3]]\n5. ユーザーレベルへの適応性：回答は質問に直接答えていますが、不正確さのため、対句や伝統文学についてある程度の理解があるユーザーには完全に適していない可能性があります。[[3]]\n\n要約すると、回答は関連性と無害性の点で優れたパフォーマンスを示していますが、正確性、完全性、ソースの信頼性、明確さと構造、およびユーザーレベルへの適応性に欠点があるため、全体的な評価は2です。
                   "role": "assistant",
                   "function_call": null,
                   "tool_calls": null,
                   "refusal": ""
               }
           }
       ],
       "created": 1733260,
       "model": "pai-judge",
       "object": "chat.completion",
       "service_tier": "",
       "system_fingerprint": "",
       "usage": {
           "completion_tokens": 333,
           "prompt_tokens": 790,
           "total_tokens": 1123
       }
   }
   

リクエストパラメーター

判定モデルの API は OpenAI の API と互換性があります。次の表に示すパラメーターを構成できます。

messages パラメーター

messages パラメーターは、判定モデルが受信した情報を指定します。次のサンプルコードは例を示しています。

messages=[
    {
        "role": "user", // ユーザー
        "content": [
            {
                "mode": "single", // single
                "type": "json", // json
                "json": {
                    "question": "Provide the second couplet to \"To climb the mountain, reach the peak\"", // 「山に登り、頂上に到達する」の下の句を提供する
                    "answer": "To cross the river, find the creek" // 川を渡り、小川を見つける
                }
            }
        ]
    }
]

messages パラメーターは配列形式です。各要素は {"role":role, "content": content} 形式です。role は user を指定します。content は、モデルによって評価されるコンテンツを指定します。コンテンツには次の情報が含まれます。

• mode: 評価モード。single は単一モデル評価を指定します。pairwise はデュアルモデルコンペティションを指定します。

• type: 値を json に設定します。

• json: 評価されるコンテンツの詳細。

次の表では、json パラメーターについて説明します。

content のパラメーターは、プロンプトテンプレートに入力して生成するために使用されます。単一モデル評価と デュアルモデルコンペティションのリクエスト例では、次のテンプレートを使用してリクエストを構築します。content の内容は、テンプレートの対応する位置に自動的に入力されます。

Your task is to evaluate the quality of an AI assistant's answer. // あなたのタスクは、AI アシスタントの回答の品質を評価することです。

You clearly understand that when a user provides a question about the [${scene}] scenario (defined as: ${scene_desc}), an AI assistant's answer should meet the following criteria (listed in order of importance from highest to lowest): // ユーザーが[${scene}]シナリオ（定義：${scene_desc}）に関する質問をした場合、AI アシスタントの回答は次の基準を満たす必要があることを明確に理解しています（重要度の高い順にリストされています）。
[Start of criteria] // [基準の開始]
${metric} // ${metric}
[End of criteria] // [基準の終了]

The scoring system uses a ${max_score}-level scale (1-${max_score}), with each score level defined as follows: // スコアリングシステムは${max_score}レベルスケール（1-${max_score}）を使用し、各スコアレベルは次のように定義されます。
[Start of score description] // [スコアの記述の開始]
${score_desc} // ${score_desc}
[End of score description] // [スコアの記述の終了]

We have collected the following answer from an AI assistant to a user question. // ユーザーの質問に対する AI アシスタントからの次の回答を収集しました。
Please comprehensively evaluate the answer based on the criteria that you use for the current scenario. The following items describe the question and answer from an AI assistant: // 現在のシナリオで使用する基準に基づいて、回答を総合的に評価してください。次の項目では、AI アシスタントからの質問と回答について説明します。
[Start of data]  // [データの開始]
***
[User question]: ${question} // [ユーザーの質問]: ${question}
***
[Answer]: ${answer} // [回答]: ${answer}
***
[Reference answer]: ${ref_answer} // [参照回答]: ${ref_answer}
***
[End of data] // [データの終了]

You must evaluate the preceding answer based on the following process: // 次のプロセスに基づいて上記の回答を評価する必要があります。
${steps} // ${steps}

Think carefully and then provide your conclusion. // よく考えてから結論を出してください。

Your task is to evaluate the quality of AI assistants' answers. // あなたのタスクは、AI アシスタントの回答の品質を評価することです。

You clearly understand that when a user provides a question about the [${scene}] scenario (defined as: ${scene_desc}), an AI assistant's answer should meet the following criteria (listed in order of importance from highest to lowest): // ユーザーが[${scene}]シナリオ（定義：${scene_desc}）に関する質問をした場合、AI アシスタントの回答は次の基準を満たす必要があることを明確に理解しています（重要度の高い順にリストされています）。
[Start of criteria] // [基準の開始]
${metric} // ${metric}
[End of criteria] // [基準の終了]

The scoring system uses a ${max_score}-level scale (1-${max_score}), with each score level defined as follows: // スコアリングシステムは${max_score}レベルスケール（1-${max_score}）を使用し、各スコアレベルは次のように定義されます。
[Start of score description] // [スコアの記述の開始]
${score_desc} // ${score_desc}
[End of score description] // [スコアの記述の終了]

For a user question in the [${scene}] scenario, we have collected answers from two AI assistants. // [${scene}]シナリオのユーザーの質問に対して、2 人の AI アシスタントから回答を収集しました。
Please comprehensively evaluate the answers and determine which answer is better or whether the quality of the two answers is the same based on the criteria that you use for the current scenario. The following items describe a question and the answers from the AI assistants: // 現在のシナリオで使用する基準に基づいて、回答を総合的に評価し、どちらの回答が優れているか、または 2 つの回答の品質が同じかどうかを判断してください。次の項目では、質問と AI アシスタントからの回答について説明します。
[Start of data] // [データの開始]
***
[User question]: ${question} // [ユーザーの質問]: ${question}
***
[Answer 1]: ${answer1} // [回答 1]: ${answer1}
***
[Answer 2]: ${answer2} // [回答 2]: ${answer2}
***
[Reference answer]: ${ref_answer} // [参照回答]: ${ref_answer}
***
[End of data] // [データの終了]

You must evaluate and compare the two answers based on the following process: // 次のプロセスに基づいて 2 つの回答を評価および比較する必要があります。
{steps} // {steps}

Think carefully and then provide your conclusion. // よく考えてから結論を出してください。

レスポンスパラメーター

ステータスコード

{
  "content": [
    {
      "type": "json", 
      "mode": "[single / pairwise]", 
      "json": {
        "question": "<question>", 
        "answer": "<answer>",
        ...
      }
    }
  ]
}

ファイル

ファイルをアップロードする：POST /v1/files

• リクエスト例

  Python

  import os
  from openai import OpenAI
  
  
  def main():
      base_url = "https://aiservice.cn-hangzhou.aliyuncs.com/v1"
      judge_model_token = os.getenv("JUDGE_MODEL_TOKEN")
  
      client = OpenAI(
          api_key=f'Authorization: Bearer {judge_model_token}',
          base_url=base_url
      )
      upload_files = client.files.create(
          file=open("/home/xxx/input.jsonl", "rb"), // /home/xxx/input.jsonl
          purpose="batch", // batch
      )
      print(upload_files.model_dump_json(indent=4))
  
  
  if __name__ == '__main__':
      main()

  curl

  $ curl -XPOST https://aiservice.cn-hangzhou.aliyuncs.com/v1/files \
    -H "Authorization: Bearer ${JUDGE_MODEL_TOKEN}" \
    -F purpose="batch"  \
    -F file="@/home/xxx/input.jsonl" // -F file="@/home/xxx/input.jsonl"
  

• レスポンス例

  {
      "id": "file-batch-EC043540BE1C7BE3F9F2F0A8F47D1713",
      "object": "file",
      "bytes": 698,
      "created_at": 1742454203,
      "filename": "input.jsonl",
      "purpose": "batch"
  }

• リクエストパラメーター

  パラメーター	タイプ	必須	説明
  file	file	はい	ファイル。
  purpose	string	はい	ファイルの用途。 assistants: アシスタントファイルとメッセージファイル。 vision: アシスタント画像ファイル。 batch: バッチ処理用の API ファイル。 fine-tune: ファインチューニングファイル。

• レスポンスパラメーター

  詳細については、「ファイルの説明」をご参照ください。

ファイルのリストを照会する：GET /v1/files

• リクエスト例

  Python

  import os
  from openai import OpenAI
  
  
  def main():
      base_url = "https://aiservice.cn-hangzhou.aliyuncs.com/v1"
      judge_model_token = os.getenv("JUDGE_MODEL_TOKEN")
  
      client = OpenAI(
          api_key=f'Authorization: Bearer {judge_model_token}',
          base_url=base_url
      )
      list_files = client.files.list(
          purpose="batch", // batch
          order="desc", // desc
          limit=10, // 10
          after="" // 
      )
      print(list_files.model_dump_json(indent=4))
  
  
  if __name__ == '__main__':
      main()

  curl

  $ curl -XGET https://aiservice.cn-hangzhou.aliyuncs.com/v1/files \
    -H "Authorization: Bearer ${JUDGE_MODEL_TOKEN}"

• レスポンス例

  {
      "object": "list",
      "data": [
          {
              "id": "file-batch-EC043540BE1C7BE3F9F2F0A8F47D1713",
              "object": "file",
              "bytes": 698,
              "created_at": 1742454203,
              "filename": "input.jsonl",
              "purpose": "batch"
          },
          {
              "id": "file-batch_output-66f245a0-88d1-458c-8e1c-a819a5943022",
              "object": "file",
              "bytes": 1420,
              "created_at": 1742455638,
              "filename": "file-batch_output-66f245a0-88d1-458c-8e1c-a819a5943022_success.jsonl",
              "purpose": "batch_output"
          }
      ]
  }

• リクエストパラメーター

  パラメーター	タイプ	必須	説明
  purpose	string	いいえ	特定の用途のファイルのみを返します。
  limit	string	いいえ	ファイルの用途。 バッチ処理用の API ファイルのみがサポートされています。 デフォルト値：10000。
  order	string	いいえ	created_at パラメーターを使用してクエリ結果をソートする順序。 asc desc (デフォルト)
  after	string	いいえ	ページネーション用のカーソル。このパラメーターは、クエリ結果の位置を示すオブジェクト ID を定義します。たとえば、リクエストを送信して obj_foo で終わる 100 個のオブジェクトを受信した場合、後続の呼び出しで after を obj_foo に設定して、obj_foo 以降のクエリ結果を取得できます。

• レスポンスパラメーター

  パラメーター	タイプ	説明
  object	string	特定の用途のファイルのみを返します。
  data	array	詳細については、「ファイルの説明」をご参照ください。

ファイルを照会する：GET /v1/files/{file_id}

• リクエスト例

  Python

  import os
  from openai import OpenAI
  
  
  def main():
      base_url = "https://aiservice.cn-hangzhou.aliyuncs.com/v1"
      judge_model_token = os.getenv("JUDGE_MODEL_TOKEN")
  
      client = OpenAI(
          api_key=f'Authorization: Bearer {judge_model_token}',
          base_url=base_url
      )
      retrieve_files = client.files.retrieve(
          file_id="file-batch-EC043540BE1C7BE3F9F2F0A8F47D1713", // file-batch-EC043540BE1C7BE3F9F2F0A8F47D1713
      )
      print(retrieve_files.model_dump_json(indent=4))
  
  
  if __name__ == '__main__':
      main()

  curl

  $ curl -XGET https://aiservice.cn-hangzhou.aliyuncs.com/v1/files/file-batch-EC043540BE1C7BE3F9F2F0A8F47D1713 \
      -H "Authorization: Bearer ${JUDGE_MODEL_TOKEN}"

• レスポンス例

  {
      "id": "file-batch-EC043540BE1C7BE3F9F2F0A8F47D1713",
      "object": "file",
      "bytes": 698,
      "created_at": 1742454203,
      "filename": "input.jsonl",
      "purpose": "batch"
  }

• リクエストパラメーター

  パラメーター	タイプ	必須	説明
  file_id	string	はい	ファイルの ID。

• レスポンスパラメーター

  詳細については、「ファイルの説明」をご参照ください。

ファイルの内容を照会またはダウンロードする：GET /v1/files/{file_id}/content

• リクエスト例

  Python

  import os
  from openai import OpenAI
  
  
  def main():
      base_url = "https://aiservice.cn-hangzhou.aliyuncs.com/v1"
      judge_model_token = os.getenv("JUDGE_MODEL_TOKEN")
  
      client = OpenAI(
          api_key=f'Authorization: Bearer {judge_model_token}',
          base_url=base_url
      )
      content_files = client.files.content(
          file_id="file-batch_output-66f245a0-88d1-458c-8e1c-a819a5943022", // file-batch_output-66f245a0-88d1-458c-8e1c-a819a5943022
      )
      print(content_files)
  
  
  if __name__ == '__main__':
      main()

  curl

  $ curl -XGET https://aiservice.cn-hangzhou.aliyuncs.com/v1/files/file-batch_output-66f245a0-88d1-458c-8e1c-a819a5943022/content \
      -H "Authorization: Bearer ${JUDGE_MODEL_TOKEN}" > output.jsonl // output.jsonl

• レスポンス例

  {"id":"dcee3584-6f30-9541-a855-873a6d86b7d9","custom_id":"request-1","response":{"status_code":200,"request_id":"dcee3584-6f30-9541-a855-873a6d86b7d9","body":{"created":1737446797,"usage":{"completion_tokens":7,"prompt_tokens":26,"total_tokens":33},"model":"qwen-max","id":"chatcmpl-dcee3584-6f30-9541-a855-873a6d86b7d9","choices":[{"finish_reason":"stop","index":0,"message":{"content":"2+2 equals 4."}}],"object":"chat.completion"}},"error":null} // {"id":"dcee3584-6f30-9541-a855-873a6d86b7d9","custom_id":"request-1","response":{"status_code":200,"request_id":"dcee3584-6f30-9541-a855-873a6d86b7d9","body":{"created":1737446797,"usage":{"completion_tokens":7,"prompt_tokens":26,"total_tokens":33},"model":"qwen-max","id":"chatcmpl-dcee3584-6f30-9541-a855-873a6d86b7d9","choices":[{"finish_reason":"stop","index":0,"message":{"content":"2+2 equals 4."}}],"object":"chat.completion"}},"error":null}
  {"id":"dcee3584-6f30-9541-a855-873a6d86b7d9","custom_id":"request-2","response":{"status_code":200,"request_id":"dcee3584-6f30-9541-a855-873a6d86b7d9","body":{"created":1737446797,"usage":{"completion_tokens":7,"prompt_tokens":26,"total_tokens":33},"model":"qwen-max","id":"chatcmpl-dcee3584-6f30-9541-a855-873a6d86b7d9","choices":[{"finish_reason":"stop","index":0,"message":{"content":"2+2 equals 4."}}],"object":"chat.completion"}},"error":null} // {"id":"dcee3584-6f30-9541-a855-873a6d86b7d9","custom_id":"request-2","response":{"status_code":200,"request_id":"dcee3584-6f30-9541-a855-873a6d86b7d9","body":{"created":1737446797,"usage":{"completion_tokens":7,"prompt_tokens":26,"total_tokens":33},"model":"qwen-max","id":"chatcmpl-dcee3584-6f30-9541-a855-873a6d86b7d9","choices":[{"finish_reason":"stop","index":0,"message":{"content":"2+2 equals 4."}}],"object":"chat.completion"}},"error":null}

• リクエストパラメーター

  パラメーター	タイプ	必須	説明
  file_id	string	はい	ファイルの ID。

• レスポンスパラメーター

  詳細については、「ファイルの説明」をご参照ください。

ファイルを削除する：DELETE /v1/files/{file_id}

• リクエスト例

  Python

  import os
  from openai import OpenAI
  
  
  def main():
      base_url = "https://aiservice.cn-hangzhou.aliyuncs.com/v1"
      judge_model_token = os.getenv("JUDGE_MODEL_TOKEN")
  
      client = OpenAI(
          api_key=f'Authorization: Bearer {judge_model_token}',
          base_url=base_url
      )
      delete_files = client.files.delete(
          file_id="file-batch_output-66f245a0-88d1-458c-8e1c-a819a5943022", // file-batch_output-66f245a0-88d1-458c-8e1c-a819a5943022
      )
      print(delete_files)
  
  
  if __name__ == '__main__':
      main()

  curl

  $ curl -XDELETE https://aiservice.cn-hangzhou.aliyuncs.com/v1/files/file-batch_output-66f245a0-88d1-458c-8e1c-a819a5943022 \
      -H "Authorization: Bearer ${JUDGE_MODEL_TOKEN}"

• レスポンス例

  {
      "id": "batch_66f245a0-88d1-458c-8e1c-a819a5943022",
      "object": "file",
      "deleted": "true"
  }

• リクエストパラメーター

  パラメーター	タイプ	必須	説明
  file_id	string	はい	ファイルの ID。

• レスポンスパラメーター

  パラメーター	タイプ	説明
  id	string	削除されたファイルの ID。
  object	string	削除されたファイルのタイプ。
  deleted	string	ファイルが削除されたかどうかを示します。

ファイルの説明

バッチ

バッチタスクを作成する：POST /v1/batches

• リクエスト例

  Python

  import os
  from openai import OpenAI
  
  
  def main():
      base_url = "https://aiservice.cn-hangzhou.aliyuncs.com/v1"
      judge_model_token = os.getenv("JUDGE_MODEL_TOKEN")
  
      client = OpenAI(
          api_key=f'Authorization: Bearer {judge_model_token}',
          base_url=base_url
      )
      create_batches = client.batches.create(
          endpoint="/v1/chat/completions", // /v1/chat/completions
          input_file_id="file-batch-EC043540BE1C7BE3F9F2F0A8F47D1713", // file-batch-EC043540BE1C7BE3F9F2F0A8F47D1713
          completion_window="24h", // 24h
      )
      print(create_batches.model_dump_json(indent=4))
  
  
  if __name__ == '__main__':
      main()

  curl

  $ curl -XPOST https://aiservice.cn-hangzhou.aliyuncs.com/v1/batches \
      -H "Authorization: Bearer ${JUDGE_MODEL_TOKEN}" \
      -d '{
          "input_file_id": "file-batch-EC043540BE1C7BE3F9F2F0A8F47D1713", // "input_file_id": "file-batch-EC043540BE1C7BE3F9F2F0A8F47D1713",
          "endpoint": "/v1/chat/completions", // "endpoint": "/v1/chat/completions",
          "completion_window": "24h" // "completion_window": "24h"
   }'

• レスポンス例

  {
      "id": "batch_66f245a0-88d1-458c-8e1c-a819a5943022",
      "object": "batch",
      "endpoint": "/v1/chat/completions",
      "errors": null,
      "input_file_id": "file-batch-EC043540BE1C7BE3F9F2F0A8F47D1713",
      "completion_window": "24h",
      "status": "Creating", // Creating
      "output_file_id": null,
      "error_file_id": null,
      "created_at": 1742455213,
      "in_process_at": null,
      "expires_at": null,
      "FinalizingAt": null,
      "completed_at": null,
      "failed_at": null,
      "expired_at": null,
      "cancelling_at": null,
      "cancelled_at": null,
      "request_counts": {
          "total": 3,
          "completed": 0,
          "failed": 0
      },
      "metadata": null
  }

• リクエストパラメーター

  パラメーター	タイプ	必須	説明
  input_file_id	string	はい	.jsonl ファイルとしてフォーマットされ、ターゲットバッチタスクでアップロードする必要があるファイルの ID。ファイルには最大 50,000 件のリクエストを含めることができ、サイズは最大 20 MB です。
  endpoint	string	はい	バッチタスクのすべてのリクエストに使用するエンドポイント。/v1/chat/completions のみがサポートされています。
  completion_window	string	はい	ファイルのバッチが処理される時間範囲。値を 24h に設定します。
  completion_window	object	いいえ	バッチタスクのカスタムメタデータ。

• レスポンスパラメーター

  詳細については、「バッチタスクの説明」をご参照ください。

バッチタスクのリストを照会する：GET /v1/files

• リクエスト例

  Python

  import os
  from openai import OpenAI
  
  
  def main():
      base_url = "http://aiservice.cn-hangzhou.aliyuncs.com/v1"
      judge_model_token = os.getenv("JUDGE_MODEL_TOKEN")
  
      client = OpenAI(
          api_key=f'Authorization: Bearer {judge_model_token}',
          base_url=base_url
      )
      list_batches = client.batches.list(
          after="batch_66f245a0-88d1-458c-8e1c-a819a5943022", // batch_66f245a0-88d1-458c-8e1c-a819a5943022
          limit=10, // 10
      )
      print(list_batches.model_dump_json(indent=4))
  
  
  if __name__ == '__main__':
      main()

  curl

  $ curl -XGET https://aiservice.cn-hangzhou.aliyuncs.com/v1/batches \
      -H "Authorization: Bearer ${JUDGE_MODEL_TOKEN}"

• レスポンス例

  {
      "object": "list",
      "data": [
          {
              "id": "batch_66f245a0-88d1-458c-8e1c-a819a5943022",
              "object": "batch",
              "endpoint": "/v1/chat/completions",
              "errors": null,
              "input_file_id": "file-batch-EC043540BE1C7BE3F9F2F0A8F47D1713",
              "completion_window": "24h",
              "status": "Succeeded", // Succeeded
              "output_file_id": "file-batch_output-66f245a0-88d1-458c-8e1c-a819a5943022",
              "error_file_id": null,
              "created_at": 1742455213,
              "in_process_at": 1742455640,
              "expires_at": 1742455640,
              "FinalizingAt": 1742455889,
              "completed_at": 1742455889,
              "failed_at": null,
              "expired_at": null,
              "cancelling_at": null,
              "cancelled_at": null,
              "request_counts": {
                  "total": 3,
                  "completed": 3,
                  "failed": 0
              },
              "metadata": null
          }
      ],
      "first_id": "",
      "last_id": "",
      "has_more": false
  }

• リクエストパラメーター

  パラメーター	タイプ	必須	説明
  purpose	string	いいえ	特定の用途のファイルのみを返します。
  limit	string	いいえ	ファイルの用途。 assistants: アシスタントファイルとメッセージファイル。 vision: アシスタント画像ファイル。 batch: バッチ処理用の API ファイル。 fine-tune: ファインチューニングファイル。
  order	string	いいえ	created_at パラメーターを使用してクエリ結果をソートする順序。 asc desc (デフォルト)
  after	string	いいえ	ページネーション用のカーソル。このパラメーターは、クエリ結果の位置を示すオブジェクト ID を定義します。たとえば、リクエストを送信して obj_foo で終わる 100 個のオブジェクトを受信した場合、後続の呼び出しで after を obj_foo に設定して、obj_foo 以降のクエリ結果を取得できます。

• レスポンスパラメーター

  パラメーター	タイプ	説明
  object	string	オブジェクトタイプ。
  data	array	バッチタスクの説明。

バッチタスクを照会する：GET /v1/batches/{batch_id}

• リクエスト例

  Python

  import os
  from openai import OpenAI
  
  
  def main():
      base_url = "http://aiservice.cn-hangzhou.aliyuncs.com/v1"
      judge_model_token = os.getenv("JUDGE_MODEL_TOKEN")
  
      client = OpenAI(
          api_key=f'Authorization: Bearer {judge_model_token}',
          base_url=base_url
      )
      retrieve_batches = client.batches.retrieve(
          batch_id="batch_66f245a0-88d1-458c-8e1c-a819a5943022", // batch_66f245a0-88d1-458c-8e1c-a819a5943022
      )
      print(retrieve_batches.model_dump_json(indent=4))
  
  
  if __name__ == '__main__':
      main()

  curl

  $ curl -XGET https://aiservice.cn-hangzhou.aliyuncs.com/v1/batches/batch_66f245a0-88d1-458c-8e1c-a819a5943022 \
      -H "Authorization: Bearer ${JUDGE_MODEL_TOKEN}"

• レスポンス例

  {
      "id": "batch_66f245a0-88d1-458c-8e1c-a819a5943022",
      "object": "batch",
      "endpoint": "/v1/chat/completions",
      "errors": null,
      "input_file_id": "file-batch-EC043540BE1C7BE3F9F2F0A8F47D1713",
      "completion_window": "24h",
      "status": "Succeeded", // Succeeded
      "output_file_id": "file-batch_output-66f245a0-88d1-458c-8e1c-a819a5943022",
      "error_file_id": null,
      "created_at": 1742455213,
      "in_process_at": 1742455640,
      "expires_at": 1742455640,
      "FinalizingAt": 1742455889,
      "completed_at": 1742455889,
      "failed_at": null,
      "expired_at": null,
      "cancelling_at": null,
      "cancelled_at": null,
      "request_counts": {
          "total": 3,
          "completed": 3,
          "failed": 0
      },
      "metadata": null
  }

• リクエストパラメーター

  パラメーター	タイプ	必須	説明
  batch_id	string	はい	バッチタスクの ID。

• レスポンスパラメーター

  詳細については、「バッチタスクの説明」をご参照ください。

バッチタスクをキャンセルする：POST /v1/batches/{batch_id}/cancel

進行中のバッチタスクをキャンセルします。バッチタスクは、キャンセル済み状態に変わるまで最大 10 分間キャンセル中状態を維持します。この場合、バッチタスクが出力を生成すると、出力ファイルで使用できるようになります。

• リクエスト例

  Python

  import os
  from openai import OpenAI
  
  
  def main():
      base_url = "https://aiservice.cn-hangzhou.aliyuncs.com/v1"
      judge_model_token = os.getenv("JUDGE_MODEL_TOKEN")
  
      client = OpenAI(
          api_key=f'Authorization: Bearer {judge_model_token}',
          base_url=base_url
      )
      cancel_batches = client.batches.cancel(
          batch_id="batch_66f245a0-88d1-458c-8e1c-a819a5943022", // batch_66f245a0-88d1-458c-8e1c-a819a5943022
      )
      print(cancel_batches.model_dump_json(indent=4))
  
  
  if __name__ == '__main__':
      main()

  curl

  $ curl -XPOST https://aiservice.cn-hangzhou.aliyuncs.com/v1/batches/batch_66f245a0-88d1-458c-8e1c-a819a5943022/cancel \
      -H "Authorization: Bearer ${JUDGE_MODEL_TOKEN}"

• レスポンス例

  {
      "id": "batch_66f245a0-88d1-458c-8e1c-a819a5943022",
      "object": "batch",
      "endpoint": "/v1/chat/completions",
      "errors": null,
      "input_file_id": "file-batch-EC043540BE1C7BE3F9F2F0A8F47D1713",
      "completion_window": "24h",
      "status": "Stopping", // Stopping
      "output_file_id": "file-batch_output-66f245a0-88d1-458c-8e1c-a819a5943022",
      "error_file_id": null,
      "created_at": 1742455213,
      "in_process_at": 1742455640,
      "expires_at": 1742455640,
      "FinalizingAt": 1742455889,
      "completed_at": 1742455889,
      "failed_at": null,
      "expired_at": null,
      "cancelling_at": null,
      "cancelled_at": null,
      "request_counts": {
          "total": 3,
          "completed": 3,
          "failed": 0
      },
      "metadata": null
  }

• リクエストパラメーター

  パラメーター	タイプ	必須	説明
  batch_id	string	はい	バッチタスクの ID。

• レスポンスパラメーター

  詳細については、「バッチタスクの説明」をご参照ください。

バッチタスクを削除する：DELETE /v1/batches/{batch_id}

• リクエスト例

  $ curl -XDELETE https://aiservice.cn-hangzhou.aliyuncs.com/v1/batches/batch_66f245a0-88d1-458c-8e1c-a819a5943022 \
      -H "Authorization: Bearer ${JUDGE_MODEL_TOKEN}"

• レスポンス例

  {
      "id": "batch_66f245a0-88d1-458c-8e1c-a819a5943022",
      "object": "batch",
      "deleted": "true"
  }

• リクエストパラメーター

  パラメーター	タイプ	必須	説明
  batch_id	string	はい	バッチタスクの ID。

• レスポンスパラメーター

  パラメーター	タイプ	説明
  id	string	バッチタスクの ID。
  object	string	削除されたバッチタスクのタイプ。
  deleted	string	バッチタスクが削除されたかどうかを示します。

バッチタスクの説明