Train Index with Documents

curl --request POST \
  --url https://secureai.hiperai.ai/api/external/indexes/{indexName}/train \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'files=<string>' \
  --form 'text_inputs=[{"name":"doc1.txt","type":"text/plain","content":"Document content here","size":20}]' \
  --form files.items='@example-file'

import requests

url = "https://secureai.hiperai.ai/api/external/indexes/{indexName}/train"

files = { "files.items": ("example-file", open("example-file", "rb")) }
payload = {
    "files": "<string>",
    "text_inputs": "[{\"name\":\"doc1.txt\",\"type\":\"text/plain\",\"content\":\"Document content here\",\"size\":20}]"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('files', '<string>');
form.append('text_inputs', '[{"name":"doc1.txt","type":"text/plain","content":"Document content here","size":20}]');
form.append('files.items', '{
  "fileName": "example-file"
}');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://secureai.hiperai.ai/api/external/indexes/{indexName}/train', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "message": "Index trained successfully",
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "results": {
    "files_processed": 3,
    "documents_extracted": 3,
    "documents_indexed": 3,
    "total_vectors": 11,
    "total_chunks": 3,
    "index_name": "my-knowledge-base",
    "namespace": "user-60a7c8f5e8b4f5001f7a8c24-index-my-knowledge-base"
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

POST

indexes

{indexName}

train

Train Index with Documents

curl --request POST \
  --url https://secureai.hiperai.ai/api/external/indexes/{indexName}/train \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'files=<string>' \
  --form 'text_inputs=[{"name":"doc1.txt","type":"text/plain","content":"Document content here","size":20}]' \
  --form files.items='@example-file'

import requests

url = "https://secureai.hiperai.ai/api/external/indexes/{indexName}/train"

files = { "files.items": ("example-file", open("example-file", "rb")) }
payload = {
    "files": "<string>",
    "text_inputs": "[{\"name\":\"doc1.txt\",\"type\":\"text/plain\",\"content\":\"Document content here\",\"size\":20}]"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('files', '<string>');
form.append('text_inputs', '[{"name":"doc1.txt","type":"text/plain","content":"Document content here","size":20}]');
form.append('files.items', '{
  "fileName": "example-file"
}');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://secureai.hiperai.ai/api/external/indexes/{indexName}/train', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "message": "Index trained successfully",
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "results": {
    "files_processed": 3,
    "documents_extracted": 3,
    "documents_indexed": 3,
    "total_vectors": 11,
    "total_chunks": 3,
    "index_name": "my-knowledge-base",
    "namespace": "user-60a7c8f5e8b4f5001f7a8c24-index-my-knowledge-base"
  }
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked",
  "request_id": "req-abc123"
}

Index mit Dokumenten trainieren

Trainieren Sie einen Index, indem Sie Dokumente (Dateien) hochladen oder Texteingaben bereitstellen.

Endpunkt

POST /indexes/{indexName}/train

Beschreibung

Trainieren Sie einen Index, indem Sie Dokumente (Dateien) hochladen oder Texteingaben bereitstellen. Dieser Endpunkt unterstützt mehrere Dateiformate und kann bis zu 20 Dateien gleichzeitig verarbeiten.

Unterstützte Dateiformate

TXT
PDF
DOCX
DOC
JSON
CSV
XLS
XLSX

Authentifizierung

Erforderlich: API-Schlüssel

Authorization: Bearer sk-your-api-key-here

Pfadparameter

Parameter	Geben Sie	ein Erforderlich	Beschreibung
`indexName`	Zeichenfolge	Ja	Name des zu trainierenden Index

Anforderungstext

Dieser Endpunkt akzeptiert das Format multipart/form-data.

Parameter

Parameter	Geben Sie	ein Erforderlich	Beschreibung
`files`	Array von binären	Nein	Dokumentdateien zum Hochladen (bis zu 20 Dateien, jeweils 50 MB)
`text_inputs`	Zeichenfolge	Nein	JSON-String-Array mit Texteingaben. Jedes Element sollte Folgendes haben: Name, Typ, Inhalt, Größe

Texteingabeformat

Stellen Sie bei Verwendung von text_inputs ein JSON-String-Array mit Objekten bereit, die Folgendes enthalten:

[
  {
    "name": "doc1.txt",
    "type": "text/plain",
    "content": "Document content here",
    "size": 20
  }
]

Beispiele anfordern

Dateien hochladen (mehrteilige Formulardaten)

curl -X POST "https://{customer.name}.hiperai.ai/api/external/indexes/my-knowledge-base/train" \
  -H "Authorization: Bearer sk-your-api-key-here" \
  -F "files=@document1.pdf" \
  -F "files=@document2.docx" \
  -F "files=@document3.txt"

JavaScript/Node.js

const formData = new FormData();
formData.append('files', fileInput1.files[0]);
formData.append('files', fileInput2.files[0]);
formData.append('files', fileInput3.files[0]);

const response = await fetch('https://{customer.name}.hiperai.ai/api/external/indexes/my-knowledge-base/train', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sk-your-api-key-here'
  },
  body: formData
});

const data = await response.json();
console.log('Files processed:', data.results.files_processed);
console.log('Documents indexed:', data.results.documents_indexed);

Python

import requests

url = "https://{customer.name}.hiperai.ai/api/external/indexes/my-knowledge-base/train"
headers = {
    "Authorization": "Bearer sk-your-api-key-here"
}

files = [
    ('files', open('document1.pdf', 'rb')),
    ('files', open('document2.docx', 'rb')),
    ('files', open('document3.txt', 'rb'))
]

response = requests.post(url, headers=headers, files=files)
result = response.json()
print('Files processed:', result['results']['files_processed'])
print('Documents indexed:', result['results']['documents_indexed'])

Verwenden von Texteingaben

curl -X POST "https://{customer.name}.hiperai.ai/api/external/indexes/my-knowledge-base/train" \
  -H "Authorization: Bearer sk-your-api-key-here" \
  -F 'text_inputs=[{"name":"doc1.txt","type":"text/plain","content":"Document content here","size":20}]'

Antwort

Erfolgsantwort (200)

{
  "success": true,
  "message": "Index trained successfully",
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "results": {
    "files_processed": 3,
    "documents_extracted": 3,
    "documents_indexed": 3,
    "total_vectors": 11,
    "total_chunks": 3,
    "index_name": "my-knowledge-base",
    "namespace": "user-60a7c8f5e8b4f5001f7a8c24-index-my-knowledge-base"
  }
}

Antwortfelder

Feld	Geben Sie	ein Beschreibung
`success`	boolescher Wert	Bei erfolgreichen Anfragen immer wahr
`message`	Zeichenfolge	Erfolgsmeldung
`request_id`	Zeichenfolge	ID zur Nachverfolgung anfordern
`results`	Objekt	Trainingsergebnisse

Ergebnisobjekt

Feld	Geben Sie	ein Beschreibung
`files_processed`	Ganzzahl	Anzahl der verarbeiteten Dateien
`documents_extracted`	Ganzzahl	Anzahl der aus Dateien extrahierten Dokumente
`documents_indexed`	Ganzzahl	Anzahl der erfolgreich indexierten Dokumente
`total_vectors`	Ganzzahl	Gesamtzahl der in Pinecone	gespeicherten Vektoren
`total_chunks`	Ganzzahl	Gesamtzahl der erstellten Textblöcke
`index_name`	Zeichenfolge	Name des trainierten Index
`namespace`	Zeichenfolge	Namensraum des Index

Fehlerantworten

400 Ungültige Anfrage

{
  "success": false,
  "error": "Invalid request",
  "message": "Missing files or text_inputs"
}

401 Nicht autorisiert

{
  "success": false,
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked"
}

403 Verboten

{
  "success": false,
  "error": "Access denied",
  "message": "User doesn't have access to this index"
}

404 Nicht gefunden

{
  "success": false,
  "error": "Index not found",
  "message": "The specified index does not exist"
}

413 Nutzlast zu groß

{
  "success": false,
  "error": "File too large",
  "message": "Maximum file size is 50MB per file"
}

500 Interner Serverfehler

{
  "success": false,
  "error": "Index training failed",
  "message": "Vector database unavailable or training failed"
}

Notizen

Maximal 20 Dateien pro Anfrage
Maximal 50 MB pro Datei
Dateien können als Multipart-/Formulardaten hochgeladen werden – Texteingaben können als JSON-String-Array bereitgestellt werden
Dokumente werden für die semantische Suche automatisch in Chunks aufgeteilt und vektorisiert
Der Index muss vor dem Training vorhanden sein
Trainingsergebnisse zeigen, wie viele Dokumente erfolgreich indiziert wurden

Autorisierungen

Authorization

string

header

erforderlich

API key authentication using Bearer token format. Example: Authorization: Bearer sk-your-api-key-here

Pfadparameter

indexName

string

erforderlich

Name of the index to train

Beispiel:

"my-knowledge-base"

Body

multipart/form-data

files

file[]

Document files to upload (up to 20 files, 50MB each). Supported formats: TXT, PDF, DOCX, DOC, JSON, CSV, XLS, XLSX

Maximum array length: 20

text_inputs

string

JSON string array of text inputs. Each item should have:

name: string (filename)
type: string (MIME type, e.g., "text/plain")
content: string (text content)
size: number (content length in bytes)

Beispiel:

"[{\"name\":\"doc1.txt\",\"type\":\"text/plain\",\"content\":\"Document content here\",\"size\":20}]"

Antwort

Index trained successfully

success

boolean

Beispiel:

true

message

string

Beispiel:

"Index trained successfully"

request_id

string<uuid>

Beispiel:

"550e8400-e29b-41d4-a716-446655440000"

results

object

Show child attributes

Erste Schritte & Setup

Modelle & KI-Generierung

Knowledge Base & RAG

Sicherheit, Guardrails & Auditierung

Benutzer & Zugriff (IAM)

Abrechnung, Kontingente & Webhooks

Zugverzeichnis mit Dokumenten

Index mit Dokumenten trainieren

Endpunkt

Beschreibung

Unterstützte Dateiformate

Authentifizierung

Pfadparameter

Anforderungstext

Parameter

Texteingabeformat

Beispiele anfordern

Dateien hochladen (mehrteilige Formulardaten)

JavaScript/Node.js

Python

Verwenden von Texteingaben

Antwort

Erfolgsantwort (200)

Antwortfelder

Ergebnisobjekt

Fehlerantworten

400 Ungültige Anfrage

401 Nicht autorisiert

403 Verboten

404 Nicht gefunden

413 Nutzlast zu groß

500 Interner Serverfehler

Notizen

Autorisierungen

Pfadparameter

Body

Antwort

​Index mit Dokumenten trainieren

​Endpunkt

​Beschreibung

​Unterstützte Dateiformate

​Authentifizierung

​Pfadparameter

​Anforderungstext

​Parameter

​Texteingabeformat

​Beispiele anfordern

​Dateien hochladen (mehrteilige Formulardaten)

​JavaScript/Node.js

​Python

​Verwenden von Texteingaben

​Antwort

​Erfolgsantwort (200)

​Antwortfelder

​Ergebnisobjekt

​Fehlerantworten

​400 Ungültige Anfrage

​401 Nicht autorisiert

​403 Verboten

​404 Nicht gefunden

​413 Nutzlast zu groß

​500 Interner Serverfehler

​Notizen

Autorisierungen

Pfadparameter

Body

Antwort

Index mit Dokumenten trainieren

Endpunkt

Beschreibung

Unterstützte Dateiformate

Authentifizierung

Pfadparameter

Anforderungstext

Parameter

Texteingabeformat

Beispiele anfordern

Dateien hochladen (mehrteilige Formulardaten)

JavaScript/Node.js

Python

Verwenden von Texteingaben

Antwort

Erfolgsantwort (200)

Antwortfelder

Ergebnisobjekt

Fehlerantworten

400 Ungültige Anfrage

401 Nicht autorisiert

403 Verboten

404 Nicht gefunden

413 Nutzlast zu groß

500 Interner Serverfehler

Notizen