Przetwórz dokument

curl --request POST \
  --url https://api.example.com/api/v1/knowledge-base/process-document \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "document_uuid": "<string>",
  "s3_key": "<string>",
  "embedding_service": "openai"
}
'

import requests

url = "https://api.example.com/api/v1/knowledge-base/process-document"

payload = {
    "document_uuid": "<string>",
    "s3_key": "<string>",
    "embedding_service": "openai"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({document_uuid: '<string>', s3_key: '<string>', embedding_service: 'openai'})
};

fetch('https://api.example.com/api/v1/knowledge-base/process-document', 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/api/v1/knowledge-base/process-document",
  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([
    'document_uuid' => '<string>',
    's3_key' => '<string>',
    'embedding_service' => 'openai'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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/api/v1/knowledge-base/process-document"

	payload := strings.NewReader("{\n  \"document_uuid\": \"<string>\",\n  \"s3_key\": \"<string>\",\n  \"embedding_service\": \"openai\"\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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/api/v1/knowledge-base/process-document")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"document_uuid\": \"<string>\",\n  \"s3_key\": \"<string>\",\n  \"embedding_service\": \"openai\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/knowledge-base/process-document")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"document_uuid\": \"<string>\",\n  \"s3_key\": \"<string>\",\n  \"embedding_service\": \"openai\"\n}"

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

{
  "id": 123,
  "document_uuid": "<string>",
  "filename": "<string>",
  "file_size_bytes": 123,
  "file_hash": "<string>",
  "mime_type": "<string>",
  "processing_status": "<string>",
  "total_chunks": 123,
  "custom_metadata": {},
  "docling_metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "organization_id": 123,
  "created_by": 123,
  "is_active": true,
  "processing_error": "<string>",
  "source_url": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

api

knowledge-base

process-document

Przetwórz dokument

curl --request POST \
  --url https://api.example.com/api/v1/knowledge-base/process-document \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "document_uuid": "<string>",
  "s3_key": "<string>",
  "embedding_service": "openai"
}
'

import requests

url = "https://api.example.com/api/v1/knowledge-base/process-document"

payload = {
    "document_uuid": "<string>",
    "s3_key": "<string>",
    "embedding_service": "openai"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({document_uuid: '<string>', s3_key: '<string>', embedding_service: 'openai'})
};

fetch('https://api.example.com/api/v1/knowledge-base/process-document', 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/api/v1/knowledge-base/process-document",
  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([
    'document_uuid' => '<string>',
    's3_key' => '<string>',
    'embedding_service' => 'openai'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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/api/v1/knowledge-base/process-document"

	payload := strings.NewReader("{\n  \"document_uuid\": \"<string>\",\n  \"s3_key\": \"<string>\",\n  \"embedding_service\": \"openai\"\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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/api/v1/knowledge-base/process-document")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"document_uuid\": \"<string>\",\n  \"s3_key\": \"<string>\",\n  \"embedding_service\": \"openai\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/knowledge-base/process-document")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"document_uuid\": \"<string>\",\n  \"s3_key\": \"<string>\",\n  \"embedding_service\": \"openai\"\n}"

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

{
  "id": 123,
  "document_uuid": "<string>",
  "filename": "<string>",
  "file_size_bytes": 123,
  "file_hash": "<string>",
  "mime_type": "<string>",
  "processing_status": "<string>",
  "total_chunks": 123,
  "custom_metadata": {},
  "docling_metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "organization_id": 123,
  "created_by": 123,
  "is_active": true,
  "processing_error": "<string>",
  "source_url": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Autoryzacje

X-API-Key

string

header

wymagane

Klucz API organizacji (konto w lewym dolnym rogu panelu → Brosbots API).

Nagłówki

authorization

string | null

X-API-Key

string | null

Treść

application/json

Uruchomienie przetwarzania dokumentu.

document_uuid

string

wymagane

UUID dokumentu do przetworzenia.

s3_key

string

wymagane

Klucz wgranego pliku w magazynie plików.

embedding_service

enum<string>

domyślnie:openai

Usługa embeddingów użyta do przetwarzania: 'openai' (domyślna, 1536 wymiarów, wymaga klucza API) albo 'sentence_transformer' (bezpłatna, 384 wymiary).

Dostępne opcje:

sentence_transformer,

openai

Odpowiedź

Pomyślna odpowiedź

Metadane dokumentu.

integer

wymagane

document_uuid

string

wymagane

filename

string

wymagane

file_size_bytes

integer

wymagane

file_hash

string

wymagane

mime_type

string

wymagane

processing_status

string

wymagane

total_chunks

integer

wymagane

custom_metadata

object

wymagane

docling_metadata

object

wymagane

created_at

string<date-time>

wymagane

updated_at

string<date-time>

wymagane

organization_id

integer

wymagane

created_by

integer

wymagane

is_active

boolean

wymagane

processing_error

string | null

source_url

string | null

Start

Endpointy

Przetwórz dokument

Autoryzacje

Nagłówki

Treść

Odpowiedź