AIの応答 (Full) - Box Dev Docs

APIバージョン 2024.0 AIの質問への応答。

このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。Fullバリアントに含まれるフィールドは、fieldsパラメータをサポートするAPIエンドポイントによって返すことができます。たとえば、IDでファイルを取得するときに、fieldsリクエストパラメータをid,typeに設定すると、これらのフィールドのみがAPIレスポンスで返されます。

ai_agent_info

object

リクエストで使用されるモデルおよびプロセッサに関する情報。

表示子属性

models

object[]

リクエストに使用されるモデル。

表示子属性

name

string

例 azure__openai__text_embedding_ada_002リクエストに使用されるモデルの名前。

provider

string

例 azureリクエストに使用されるモデルを所有するプロバイダ。

supported_purpose

string

例 embeddingリクエストに使用されるモデルで利用されるサポートされている目的。

processor

string

例 basic_textリクエストに使用されるプロセッサ。

answer

string

例 Public APIs are important because of key and important reasons.LLMから提供された回答。

citations

object[]

LLMの回答で参照された部分の引用情報。

表示子属性

string

例 123項目のID。

type

string

例 file項目のタイプ。次の値に固定: file

content

string

例 Public APIs are key drivers of innovation and growth.回答が参照された部分の具体的な内容。

name

string

例 The importance of public APIs.pdf項目の名前。

completion_reason

string

例 done応答が終了した理由。

created_at

string(date-time)

例 2012-12-12T10:53:43-08:00プロンプトに対する回答が作成された時点のISO日付形式のタイムスタンプ。

{
  "ai_agent_info": {
    "models": [
      {
        "name": "azure__openai__text_embedding_ada_002",
        "provider": "azure",
        "supported_purpose": "embedding"
      }
    ],
    "processor": "basic_text"
  },
  "answer": "Public APIs are important because of key and important reasons.",
  "citations": [
    {
      "content": "Public APIs are key drivers of innovation and growth.",
      "id": "123",
      "name": "The importance of public APIs.pdf",
      "type": "file"
    }
  ],
  "completion_reason": "done",
  "created_at": "2012-12-12T10:53:43-08:00"
}