Detect annotations in engineering diagrams

from cognite.client.data_classes.contextualization import FileReference
detect_job = client.diagrams.detect(
    entities=[
        {"userDefinedField": "21PT1017","ignoredField": "AA11"},
        {"userDefinedField": "21PT1018"}],
    search_field="userDefinedField",
    partial_match=True,
    min_tokens=2,
    file_ids=[101],
    file_external_ids=["Test1"],
    file_references=[
        FileReference(id=20, first_page=1, last_page=10),
        FileReference(external_id="ext_20", first_page=11, last_page=20)
    ])
result = detect_job.result
print(result)

from cognite.client.data_classes.contextualization import ConnectionFlags, DiagramDetectConfig
config = DiagramDetectConfig(
    remove_leading_zeros=True,
    connection_flags=ConnectionFlags(
        no_text_inbetween=True,
        natural_reading_order=True,
    )
)
job = client.diagrams.detect(entities=[{"name": "A1"}], file_id=123, config=config)

curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/diagram/detect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "fileId": 1234
    }
  ],
  "entities": [
    {
      "userDefinedField": "21PT1017",
      "ignoredField": "AA11"
    },
    {
      "userDefinedField": [
        "21PT1017-A",
        "21PT1017-B"
      ]
    }
  ],
  "searchField": "userDefinedField",
  "partialMatch": false,
  "minTokens": 2
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    items: [{fileId: 1234}],
    entities: [
      {userDefinedField: '21PT1017', ignoredField: 'AA11'},
      {userDefinedField: ['21PT1017-A', '21PT1017-B']}
    ],
    searchField: 'userDefinedField',
    partialMatch: false,
    minTokens: 2
  })
};

fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/diagram/detect', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/diagram/detect",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'items' => [
        [
                'fileId' => 1234
        ]
    ],
    'entities' => [
        [
                'userDefinedField' => '21PT1017',
                'ignoredField' => 'AA11'
        ],
        [
                'userDefinedField' => [
                                '21PT1017-A',
                                '21PT1017-B'
                ]
        ]
    ],
    'searchField' => 'userDefinedField',
    'partialMatch' => false,
    'minTokens' => 2
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/diagram/detect"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"fileId\": 1234\n    }\n  ],\n  \"entities\": [\n    {\n      \"userDefinedField\": \"21PT1017\",\n      \"ignoredField\": \"AA11\"\n    },\n    {\n      \"userDefinedField\": [\n        \"21PT1017-A\",\n        \"21PT1017-B\"\n      ]\n    }\n  ],\n  \"searchField\": \"userDefinedField\",\n  \"partialMatch\": false,\n  \"minTokens\": 2\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/diagram/detect")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"fileId\": 1234\n    }\n  ],\n  \"entities\": [\n    {\n      \"userDefinedField\": \"21PT1017\",\n      \"ignoredField\": \"AA11\"\n    },\n    {\n      \"userDefinedField\": [\n        \"21PT1017-A\",\n        \"21PT1017-B\"\n      ]\n    }\n  ],\n  \"searchField\": \"userDefinedField\",\n  \"partialMatch\": false,\n  \"minTokens\": 2\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/context/diagram/detect")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"fileId\": 1234\n    }\n  ],\n  \"entities\": [\n    {\n      \"userDefinedField\": \"21PT1017\",\n      \"ignoredField\": \"AA11\"\n    },\n    {\n      \"userDefinedField\": [\n        \"21PT1017-A\",\n        \"21PT1017-B\"\n      ]\n    }\n  ],\n  \"searchField\": \"userDefinedField\",\n  \"partialMatch\": false,\n  \"minTokens\": 2\n}"

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "fileId": 1234,
      "pageRange": {
        "begin": 51,
        "end": 100
      }
    }
  ],
  "jobId": 123,
  "status": "Queued",
  "createdTime": 1730204346000,
  "startTime": 1730204346000,
  "statusTime": 1730204346000,
  "errorMessage": null,
  "searchField": "userDefinedField",
  "partialMatch": false,
  "minTokens": 2
}

{
  "error": {
    "code": 401,
    "message": "Could not authenticate.",
    "missing": [
      {}
    ],
    "duplicated": [
      {}
    ]
  }
}