Test prompts with document
POST /v2/document/{documentId}
POST
/v2/document/{documentId}
Test prompts with a specific document
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” documentId
required
string
A document Id
Example
f52b1f9e-b9a6-4248-afc5-d3ae358e723aHeader Parameters
Section titled “Header Parameters ” X-API-Key
string
API Key
X-API-Secret
string
API Secret
Request Body required
Section titled “Request Body required ”object
documentId
The document id to prompt against
string
f52b1f9e-b9a6-4248-afc5-d3ae358e723a prompts
required
A group of prompts or properties to be extracted or analyzed from the document
Array<object>
object
id
required
A prompt Id
string
a1b2c3d4-5678-4e2a-9c1a-2b3c4d5e6f7a name
required
A prompt name
string
Summary fieldType
required
A field type
string
text format
required
A format
string
string description
required
A description
string
Whats the summary of the document? itemType
An item type
string
string children
Array<object> recursive
docType
required
The document type
string
invoice docName
required
The document name
string
Invoice Q1 2024 llmProvider
The provider of the prompt
string
OPENAI llmModel
The model of the prompt
string
GPT_4 tester
required
Set the prompt as a test
boolean
trueResponses
Section titled “ Responses ”The resource has been successfully created.
object
queryId
required
The process ID. Since this is a synchronous request, it returns only the ID. You must wait for the webhook notification to receive the actual result.
string
f52b1f9e-b9a6-4248-afc5-d3ae358e723a