Almacenes de documentos

Lista todos los almacenes de documentos

GET /document-store/store

Recupera una lista de todos los almacenes de documentos.

Authorizations

HTTP

    GET /document-store/store HTTP/1.1
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*

cURL

curl -L \
--url '/document-store/store' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: */*'

JavaScript

  const response = await fetch('/document-store/store', {
method: 'GET',
headers: {
  "Authorization": "Bearer YOUR_SECRET_TOKEN",
  "Accept": "*/*"
},
});

const data = await response.json();

Python

  import requests

response = requests.get(
"/document-store/store",
headers={"Authorization":"Bearer YOUR_SECRET_TOKEN","Accept":"*/*"},
)

data = response.json()

Obtiene un almacén de documentos específico

GET /document-store/store/{id}

Recupera los detalles de un almacén de documentos específico por su ID.

Authorizations

Path parameters

HTTP

    GET /document-store/store/{id} HTTP/1.1
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*

cURL

curl -L \
--url '/document-store/store/{id}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: */*'

JavaScript

  const response = await fetch('/document-store/store/{id}', {
method: 'GET',
headers: {
  "Authorization": "Bearer YOUR_SECRET_TOKEN",
  "Accept": "*/*"
},
});

const data = await response.json();

Python

  import requests

response = requests.get(
"/document-store/store/{id}",
headers={"Authorization":"Bearer YOUR_SECRET_TOKEN","Accept":"*/*"},
)

data = response.json()

Crea un nuevo almacén de documentos

POST /document-store/store

Crea un nuevo almacén de documentos con los detalles proporcionados.

Authorizations

Body

HTTP

    POST /document-store/store HTTP/1.1
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*

    {
      "name": "My Document Store",
      "description": "Store description"
    }

cURL

curl -L \
--request POST \
--url '/document-store/store' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"name": "My Document Store",
"description": "Store description"
}'

JavaScript

  const response = await fetch('/document-store/store', {
method: 'POST',
headers: {
  "Authorization": "Bearer YOUR_SECRET_TOKEN",
  "Content-Type": "application/json"
},
body: JSON.stringify({
  "name": "My Document Store",
  "description": "Store description"
})
});

const data = await response.json();

Python

  import json
import requests

response = requests.post(
"/document-store/store",
headers={"Authorization":"Bearer YOUR_SECRET_TOKEN","Content-Type":"application/json"},
data=json.dumps({
  "name": "My Document Store",
  "description": "Store description"
})
)

data = response.json()

Actualiza un almacén de documentos específico

PUT /document-store/store/{id}

Actualiza los detalles de un almacén de documentos específico por su ID.

Authorizations

Path parameters

Body

HTTP

    PUT /document-store/store/{id} HTTP/1.1
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*

    {
      "name": "My Document Store",
      "description": "Updated description"
    }

cURL

curl -L \
--request PUT \
--url '/document-store/store/{id}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"name": "My Document Store",
"description": "Updated description"
}'

JavaScript

  const response = await fetch('/document-store/store/{id}', {
method: 'PUT',
headers: {
  "Authorization": "Bearer YOUR_SECRET_TOKEN",
  "Content-Type": "application/json"
},
body: JSON.stringify({
  "name": "My Document Store",
  "description": "Updated description"
})
});

const data = await response.json();

Python

  import json
import requests

response = requests.put(
"/document-store/store/{id}",
headers={"Authorization":"Bearer YOUR_SECRET_TOKEN","Content-Type":"application/json"},
data=json.dumps({
  "name": "My Document Store",
  "description": "Updated description"
})
)

data = response.json()

Elimina un almacén de documentos específico

delete /document-store/store/{id}

Elimina un almacén de documentos por su ID.

Authorizations

Path parameters

HTTP

    DELETE /document-store/store/{id} HTTP/1.1
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*

cURL

curl -L \
--request DELETE \
--url '/document-store/store/{id}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: */*'

JavaScript

  const response = await fetch('/document-store/store/{id}', {
method: 'DELETE',
headers: {
  "Authorization": "Bearer YOUR_SECRET_TOKEN",
  "Accept": "*/*"
},
});

const data = await response.json();

Python

  import requests

response = requests.delete(
"/document-store/store/{id}",
headers={"Authorization":"Bearer YOUR_SECRET_TOKEN","Accept":"*/*"},
)

data = response.json()

Obtiene fragmentos de un cargador de documentos específico

GET /document-store/chunks/{storeId}/{loaderId}/{pageNo}

Obtiene fragmentos de un cargador de documentos específico dentro de un almacén de documentos.

Authorizations

Path parameters

HTTP

    GET /document-store/chunks/{storeId}/{loaderId}/{pageNo} HTTP/1.1
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*

cURL

curl -L \
--url '/document-store/chunks/{storeId}/{loaderId}/{pageNo}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: */*'

JavaScript

  const response = await fetch('/document-store/chunks/{storeId}/{loaderId}/{pageNo}', {
method: 'GET',
headers: {
  "Authorization": "Bearer YOUR_SECRET_TOKEN",
  "Accept": "*/*"
},
});

const data = await response.json();

Python

  import requests

response = requests.get(
"/document-store/chunks/{storeId}/{loaderId}/{pageNo}",
headers={"Authorization":"Bearer YOUR_SECRET_TOKEN","Accept":"*/*"},
)

data = response.json()

Actualiza un fragmento específico

PUT /document-store/chunks/{storeId}/{loaderId}/{chunkId}

Actualiza un fragmento específico de un cargador de documentos.

Authorizations

Path parameters

Body

HTTP

    PUT /document-store/chunks/{storeId}/{loaderId}/{chunkId} HTTP/1.1
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*

    {
      "pageContent": "Updated chunk content",
      "metadata": {}
    }

cURL

curl -L \
--request PUT \
--url '/document-store/chunks/{storeId}/{loaderId}/{chunkId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"pageContent": "Updated chunk content",
"metadata": {}
}'

JavaScript

  const response = await fetch('/document-store/chunks/{storeId}/{loaderId}/{chunkId}', {
method: 'PUT',
headers: {
  "Authorization": "Bearer YOUR_SECRET_TOKEN",
  "Content-Type": "application/json"
},
body: JSON.stringify({
  "pageContent": "Updated chunk content",
  "metadata": {}
})
});

const data = await response.json();

Python

  import json
import requests

response = requests.put(
"/document-store/chunks/{storeId}/{loaderId}/{chunkId}",
headers={"Authorization":"Bearer YOUR_SECRET_TOKEN","Content-Type":"application/json"},
data=json.dumps({
  "pageContent": "Updated chunk content",
  "metadata": {}
})
)

data = response.json()

Elimina un fragmento específico de un cargador de documentos

delete /document-store/chunks/{storeId}/{loaderId}/{chunkId}

Elimina un fragmento específico de un cargador de documentos.

Authorizations

Path parameters

HTTP

    DELETE /document-store/chunks/{storeId}/{loaderId}/{chunkId} HTTP/1.1
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*

cURL

curl -L \
--request DELETE \
--url '/document-store/chunks/{storeId}/{loaderId}/{chunkId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: */*'

JavaScript

  const response = await fetch('/document-store/chunks/{storeId}/{loaderId}/{chunkId}', {
method: 'DELETE',
headers: {
  "Authorization": "Bearer YOUR_SECRET_TOKEN",
  "Accept": "*/*"
},
});

const data = await response.json();

Python

  import requests

response = requests.delete(
"/document-store/chunks/{storeId}/{loaderId}/{chunkId}",
headers={"Authorization":"Bearer YOUR_SECRET_TOKEN","Accept":"*/*"},
)

data = response.json()

Inserta un documento en el almacén de documentos

POST /document-store/upsert/{id}

Inserta un documento en el almacén de documentos.

Authorizations

Path parameters

Body

HTTP

    POST /document-store/upsert/{id} HTTP/1.1
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: multipart/form-data
    Accept: */*

cURL

curl -L \
--request POST \
--url '/document-store/upsert/{id}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: multipart/form-data' \
--form 'files=@document.pdf'

JavaScript

  const formData = new FormData();
formData.append("files", fileInput.files[0]);

const response = await fetch('/document-store/upsert/{id}', {
method: 'POST',
headers: {
  "Authorization": "Bearer YOUR_SECRET_TOKEN"
},
body: formData
});

const data = await response.json();

Python

  import requests

files = [("files", open("document.pdf", "rb"))]

response = requests.post(
"/document-store/upsert/{id}",
headers={"Authorization":"Bearer YOUR_SECRET_TOKEN"},
files=files
)

data = response.json()

Reprocesa e inserta todos los documentos en el almacén de documentos

POST /document-store/refresh/{id}

Reprocesa e inserta todos los documentos existentes en el almacén de documentos.

Authorizations

Path parameters

Body

HTTP

    POST /document-store/refresh/{id} HTTP/1.1
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*

    {
      "items": []
    }

cURL

curl -L \
--request POST \
--url '/document-store/refresh/{id}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--data '{"items": []}'

JavaScript

  const response = await fetch('/document-store/refresh/{id}', {
method: 'POST',
headers: {
  "Authorization": "Bearer YOUR_SECRET_TOKEN",
  "Content-Type": "application/json"
},
body: JSON.stringify({ "items": [] })
});

const data = await response.json();

Python

  import json
import requests

response = requests.post(
"/document-store/refresh/{id}",
headers={"Authorization":"Bearer YOUR_SECRET_TOKEN","Content-Type":"application/json"},
data=json.dumps({"items": []})
)

data = response.json()

Consulta de recuperación

POST /document-store/vectorstore/query

Consulta de recuperación para los fragmentos insertados.

Authorizations

Body

HTTP

    POST /document-store/vectorstore/query HTTP/1.1
    Authorization: Bearer YOUR_SECRET_TOKEN
    Content-Type: application/json
    Accept: */*

    {
      "storeId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "query": "search text"
    }

cURL

curl -L \
--request POST \
--url '/document-store/vectorstore/query' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"storeId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"query": "search text"
}'

JavaScript

  const response = await fetch('/document-store/vectorstore/query', {
method: 'POST',
headers: {
  "Authorization": "Bearer YOUR_SECRET_TOKEN",
  "Content-Type": "application/json"
},
body: JSON.stringify({
  "storeId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "query": "search text"
})
});

const data = await response.json();

Python

  import json
import requests

response = requests.post(
"/document-store/vectorstore/query",
headers={"Authorization":"Bearer YOUR_SECRET_TOKEN","Content-Type":"application/json"},
data=json.dumps({
  "storeId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "query": "search text"
})
)

data = response.json()

Elimina un cargador de documentos específico y sus fragmentos asociados

delete /document-store/loader/{storeId}/{loaderId}

Elimina un cargador de documentos específico y sus fragmentos asociados del almacén de documentos. Esto no elimina los datos de la tienda vectorial.

Authorizations

Path parameters

HTTP

    DELETE /document-store/loader/{storeId}/{loaderId} HTTP/1.1
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*

cURL

curl -L \
--request DELETE \
--url '/document-store/loader/{storeId}/{loaderId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: */*'

JavaScript

  const response = await fetch('/document-store/loader/{storeId}/{loaderId}', {
method: 'DELETE',
headers: {
  "Authorization": "Bearer YOUR_SECRET_TOKEN",
  "Accept": "*/*"
},
});

const data = await response.json();

Python

  import requests

response = requests.delete(
"/document-store/loader/{storeId}/{loaderId}",
headers={"Authorization":"Bearer YOUR_SECRET_TOKEN","Accept":"*/*"},
)

data = response.json()

Elimina datos del almacén vectorial

delete /document-store/vectorstore/{id}

Solo se eliminarán los datos que fueron insertados con Record Manager del almacén vectorial.

Authorizations

Path parameters

HTTP

    DELETE /document-store/vectorstore/{id} HTTP/1.1
    Authorization: Bearer YOUR_SECRET_TOKEN
    Accept: */*

cURL

curl -L \
--request DELETE \
--url '/document-store/vectorstore/{id}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: */*'

JavaScript

  const response = await fetch('/document-store/vectorstore/{id}', {
method: 'DELETE',
headers: {
  "Authorization": "Bearer YOUR_SECRET_TOKEN",
  "Accept": "*/*"
},
});

const data = await response.json();

Python

  import requests

response = requests.delete(
"/document-store/vectorstore/{id}",
headers={"Authorization":"Bearer YOUR_SECRET_TOKEN","Accept":"*/*"},
)

data = response.json()