Get all document's metadata extraction results

GET 
/documents/:documentId/metadataExtractionResults

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Retrieve all document's metadata extraction; available as an Add-On Module. Deprecated. This endpoint is no longer recommended. Please use /documents/{documentId}/ai/prompts/{llmPromptEntityName} instead.

Request

Path Parameters

documentId stringrequired

Document Identifier

Query Parameters

siteId string

Site Identifier

artifactId string

Artifact Document Identifier

limit string
Limit Results
Default value: 10
next string

Next page of results token

Responses

200

200 OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

next string

Next page of results token

metadataExtractions

object[]

List of Metadata Extractions

Array [

llmPromptEntityName string

Name of the LLM Prompt Entity

insertedDate string

Inserted Timestamp

content string

Result content

userId string

UserId that created Result

attributes

object[]

Attributes extracted from result content

Array [

key string

Data Classification Attribute Key

value string

Data Classification Attribute Value

]

]

Example (from schema)

{
  "next": "string",
  "metadataExtractions": [
    {
      "llmPromptEntityName": "string",
      "insertedDate": "string",
      "content": "string",
      "userId": "string",
      "attributes": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ]
}

Loading...