Skip to main content

GetDocumentRelationsResponseBody

$schemauri

A URL to the JSON Schema for this object.

Example: https://example.com/schemas/GetDocumentRelationsResponseBody.json
links object[]required

Individual cross-document similarity links

  • Array [
    • similaritydoublerequired
    sourceChunkUuidstringrequired
    sourceFullPathstringrequired
    sourceTextstringrequired
    targetChunkUuidstringrequired
    targetDocTitlestringrequired
    targetDocUuidstringrequired
    targetFullPathstringrequired
    targetTextstringrequired
  • ]
    • relatedDocuments object[]required

    Summary of related documents

  • Array [
    • avgSimilaritydoublerequired
    documentTitlestringrequired
    documentUuidstringrequired
    isoStandardstring
    linkCountint64required
    maxSimilaritydoublerequired
  • ]
    • totalLinksint64required

    Total number of cross-document links

    GetDocumentRelationsResponseBody
    {
      "$schema": "https://example.com/schemas/GetDocumentRelationsResponseBody.json",
      "links": "Unknown Type: array,null",
      "relatedDocuments": "Unknown Type: array,null",
      "totalLinks": 0
    }