Create span document annotations

curl --request POST \
  --url https://api.example.com/v1/document_annotations \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": [
    {
      "name": "<string>",
      "span_id": "<string>",
      "document_position": 123,
      "result": {
        "label": "<string>",
        "score": 123,
        "explanation": "<string>"
      },
      "metadata": {},
      "identifier": ""
    }
  ]
}
'

import requests

url = "https://api.example.com/v1/document_annotations"

payload = { "data": [
        {
            "name": "<string>",
            "span_id": "<string>",
            "document_position": 123,
            "result": {
                "label": "<string>",
                "score": 123,
                "explanation": "<string>"
            },
            "metadata": {},
            "identifier": ""
        }
    ] }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    data: [
      {
        name: '<string>',
        span_id: '<string>',
        document_position: 123,
        result: {label: '<string>', score: 123, explanation: '<string>'},
        metadata: {},
        identifier: ''
      }
    ]
  })
};

fetch('https://api.example.com/v1/document_annotations', 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://api.example.com/v1/document_annotations",
  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([
    'data' => [
        [
                'name' => '<string>',
                'span_id' => '<string>',
                'document_position' => 123,
                'result' => [
                                'label' => '<string>',
                                'score' => 123,
                                'explanation' => '<string>'
                ],
                'metadata' => [
                                
                ],
                'identifier' => ''
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.example.com/v1/document_annotations"

	payload := strings.NewReader("{\n  \"data\": [\n    {\n      \"name\": \"<string>\",\n      \"span_id\": \"<string>\",\n      \"document_position\": 123,\n      \"result\": {\n        \"label\": \"<string>\",\n        \"score\": 123,\n        \"explanation\": \"<string>\"\n      },\n      \"metadata\": {},\n      \"identifier\": \"\"\n    }\n  ]\n}")

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

	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://api.example.com/v1/document_annotations")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": [\n    {\n      \"name\": \"<string>\",\n      \"span_id\": \"<string>\",\n      \"document_position\": 123,\n      \"result\": {\n        \"label\": \"<string>\",\n        \"score\": 123,\n        \"explanation\": \"<string>\"\n      },\n      \"metadata\": {},\n      \"identifier\": \"\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/document_annotations")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": [\n    {\n      \"name\": \"<string>\",\n      \"span_id\": \"<string>\",\n      \"document_position\": 123,\n      \"result\": {\n        \"label\": \"<string>\",\n        \"score\": 123,\n        \"explanation\": \"<string>\"\n      },\n      \"metadata\": {},\n      \"identifier\": \"\"\n    }\n  ]\n}"

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

{
  "data": [
    {
      "id": "<string>"
    }
  ]
}

"<string>"

"<string>"

"<string>"

POST

document_annotations

Create span document annotations

curl --request POST \
  --url https://api.example.com/v1/document_annotations \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": [
    {
      "name": "<string>",
      "span_id": "<string>",
      "document_position": 123,
      "result": {
        "label": "<string>",
        "score": 123,
        "explanation": "<string>"
      },
      "metadata": {},
      "identifier": ""
    }
  ]
}
'

import requests

url = "https://api.example.com/v1/document_annotations"

payload = { "data": [
        {
            "name": "<string>",
            "span_id": "<string>",
            "document_position": 123,
            "result": {
                "label": "<string>",
                "score": 123,
                "explanation": "<string>"
            },
            "metadata": {},
            "identifier": ""
        }
    ] }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    data: [
      {
        name: '<string>',
        span_id: '<string>',
        document_position: 123,
        result: {label: '<string>', score: 123, explanation: '<string>'},
        metadata: {},
        identifier: ''
      }
    ]
  })
};

fetch('https://api.example.com/v1/document_annotations', 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://api.example.com/v1/document_annotations",
  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([
    'data' => [
        [
                'name' => '<string>',
                'span_id' => '<string>',
                'document_position' => 123,
                'result' => [
                                'label' => '<string>',
                                'score' => 123,
                                'explanation' => '<string>'
                ],
                'metadata' => [
                                
                ],
                'identifier' => ''
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.example.com/v1/document_annotations"

	payload := strings.NewReader("{\n  \"data\": [\n    {\n      \"name\": \"<string>\",\n      \"span_id\": \"<string>\",\n      \"document_position\": 123,\n      \"result\": {\n        \"label\": \"<string>\",\n        \"score\": 123,\n        \"explanation\": \"<string>\"\n      },\n      \"metadata\": {},\n      \"identifier\": \"\"\n    }\n  ]\n}")

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

	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://api.example.com/v1/document_annotations")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": [\n    {\n      \"name\": \"<string>\",\n      \"span_id\": \"<string>\",\n      \"document_position\": 123,\n      \"result\": {\n        \"label\": \"<string>\",\n        \"score\": 123,\n        \"explanation\": \"<string>\"\n      },\n      \"metadata\": {},\n      \"identifier\": \"\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/document_annotations")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": [\n    {\n      \"name\": \"<string>\",\n      \"span_id\": \"<string>\",\n      \"document_position\": 123,\n      \"result\": {\n        \"label\": \"<string>\",\n        \"score\": 123,\n        \"explanation\": \"<string>\"\n      },\n      \"metadata\": {},\n      \"identifier\": \"\"\n    }\n  ]\n}"

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

{
  "data": [
    {
      "id": "<string>"
    }
  ]
}

"<string>"

"<string>"

"<string>"

Query Parameters

sync

boolean

default:false

If set to true, the annotations are inserted synchronously.

Body

application/json

data

SpanDocumentAnnotationData · object[]

required

Show child attributes

Response

Span document annotation inserted successfully

data

InsertedSpanDocumentAnnotation · object[]

required

Show child attributes

⌘I

Python

TypeScript

Rest API

OpenInference SDK

Create span document annotations

Query Parameters

Body

Response