Skip to content

Commit

Permalink
feat: update /ai/extract_structured response schema
Browse files Browse the repository at this point in the history
  • Loading branch information
box-apimgmt committed Jan 29, 2025
1 parent 1516dda commit 205bea8
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 5 deletions.
34 changes: 32 additions & 2 deletions openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"url": "http://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2024.0",
"x-box-commit-hash": "04cc4aa874"
"x-box-commit-hash": "0346d978be"
},
"servers": [
{
Expand Down Expand Up @@ -24445,7 +24445,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AiExtractResponse"
"$ref": "#/components/schemas/AiExtractStructuredResponse"
}
}
}
Expand Down Expand Up @@ -25126,6 +25126,36 @@
"title": "AI Extract Structured Request",
"x-box-tag": "ai"
},
"AiExtractStructuredResponse": {
"description": "AI response",
"type": "object",
"properties": {
"answer": {
"$ref": "#/components/schemas/AiExtractResponse"
},
"created_at": {
"description": "The ISO date formatted timestamp of when the answer to the prompt was created.",
"type": "string",
"format": "date-time",
"example": "2012-12-12T10:53:43-08:00"
},
"completion_reason": {
"description": "The reason the response finishes.",
"type": "string",
"example": "done"
},
"ai_agent_info": {
"$ref": "#/components/schemas/AiAgentInfo"
}
},
"required": [
"answer",
"created_at"
],
"title": "AI response",
"x-box-resource-id": "ai_extract_structured_response",
"x-box-tag": "ai"
},
"AiItem--Base": {
"description": "The item to be processed by the LLM.",
"type": "object",
Expand Down
2 changes: 1 addition & 1 deletion openapi/openapi-v2025.0.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"url": "http://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2025.0",
"x-box-commit-hash": "04cc4aa874"
"x-box-commit-hash": "0346d978be"
},
"servers": [
{
Expand Down
34 changes: 32 additions & 2 deletions openapi/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"url": "http://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2024.0",
"x-box-commit-hash": "04cc4aa874"
"x-box-commit-hash": "0346d978be"
},
"servers": [
{
Expand Down Expand Up @@ -24445,7 +24445,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AiExtractResponse"
"$ref": "#/components/schemas/AiExtractStructuredResponse"
}
}
}
Expand Down Expand Up @@ -25126,6 +25126,36 @@
"title": "AI Extract Structured Request",
"x-box-tag": "ai"
},
"AiExtractStructuredResponse": {
"description": "AI response",
"type": "object",
"properties": {
"answer": {
"$ref": "#/components/schemas/AiExtractResponse"
},
"created_at": {
"description": "The ISO date formatted timestamp of when the answer to the prompt was created.",
"type": "string",
"format": "date-time",
"example": "2012-12-12T10:53:43-08:00"
},
"completion_reason": {
"description": "The reason the response finishes.",
"type": "string",
"example": "done"
},
"ai_agent_info": {
"$ref": "#/components/schemas/AiAgentInfo"
}
},
"required": [
"answer",
"created_at"
],
"title": "AI response",
"x-box-resource-id": "ai_extract_structured_response",
"x-box-tag": "ai"
},
"AiItem--Base": {
"description": "The item to be processed by the LLM.",
"type": "object",
Expand Down

0 comments on commit 205bea8

Please sign in to comment.