Skip to main content
API docs by Redocly

Nuclia Understanding API (v1)

API reference for the Nuclia Understanding API.

Processing

Ingest API endpoints to process data and get results back.

Get Processed Activity Log

Get latest events related to activity of a Nuclia Understanding API client

query Parameters
page
integer (Page)
Default: 0
size
integer (Size)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "pagination": {
    }
}

Download Binary File

Download a file referenced in an upload token

query Parameters
token
required
string (Token)

Responses

Response samples

Content type
application/json
null

Pull

Pull internal message on a partition

query Parameters
timeout
integer (Timeout)
Default: 5
partition
integer (Partition)
Default: 1
from_cursor
integer (From Cursor)
limit
integer (Limit)
Default: 5

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "payload": "string",
  • "payloads": [ ],
  • "msgid": "string",
  • "cursor": 0
}

Pull Head

Get the pull api position

Responses

Response samples

Content type
application/json
{
  • "cursor": 0
}

Send Data To Process

Push data to process

Request Body schema: application/json
required
kbid
string (Kbid)
uuid
string (Uuid)
title
string (Title)
labels
Array of strings (Labels)
Default: []
slug
string (Slug)
source
integer (Source)
Enum: 0 1

An enumeration.

userid
string (Userid)
object (Genericfield)
Default: {}
object (Filefield)
Default: {}
object (Linkfield)
Default: {}
object (Textfield)
Default: {}
object (Layoutfield)
Default: {}
object (Conversationfield)
Default: {}
object (PushProcessingOptions)
object (LearningConfig)
object (WebhookConfig)

Responses

Request samples

Content type
application/json
{
  • "kbid": "string",
  • "uuid": "string",
  • "title": "string",
  • "labels": [ ],
  • "slug": "string",
  • "source": 0,
  • "userid": "string",
  • "genericfield": { },
  • "filefield": { },
  • "linkfield": { },
  • "textfield": { },
  • "layoutfield": { },
  • "conversationfield": { },
  • "processing_options": {
    },
  • "learning_config": {
    },
  • "webhook_config": {
    }
}

Response samples

Content type
application/json
{
  • "seqid": 0,
  • "account_seq": 0,
  • "queue": "shared",
  • "uuid": "string",
  • "processing_id": "string"
}

Get Processed Data

Retreive status of processed and unprocessed payloads from a zone

query Parameters
cursor
string (Cursor)
limit
integer (Limit)
Default: 20
scheduled
boolean (Scheduled)
kbid
string (Kbid)
sort_on
string (SortFields)
Default: "timestamp"
Enum: "timestamp" "scheduled_at" "completed_at"

An enumeration.

sort_order
string (SortOrder)
Default: "asc"
Enum: "asc" "desc"

An enumeration.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "cursor": "string"
}

Get Processed Data

Retreive status of processed and unprocessed payloads from a zone

path Parameters
processing_id
required
string (Processing Id)

Responses

Response samples

Content type
application/json
{
  • "processing_id": "string",
  • "resource_id": "string",
  • "kbid": "string",
  • "title": "string",
  • "labels": [
    ],
  • "completed": true,
  • "scheduled": true,
  • "timestamp": "2019-08-24T14:15:22Z",
  • "completed_at": "2019-08-24T14:15:22Z",
  • "scheduled_at": "2019-08-24T14:15:22Z",
  • "failed": false,
  • "retries": 0,
  • "schedule_eta": 0,
  • "schedule_order": 0,
  • "request": "string",
  • "response": "string"
}

Upload Binary File

Upload a file using a multipart request

header Parameters
x-filename
string (X-Filename)
Default:
x-password
string (X-Password)
x-language
string (X-Language)
x-md5
string (X-Md5)

Responses

Response samples

Content type
application/json
null

Processing TUS uploads

Processing uploadas using TUS protocol

Create New Upload

An empty POST request is used to create a new upload resource. The Upload-Length header indicates the size of the entire upload in bytes.

Responses

Response samples

Content type
application/json
null

Tus Server Information

Gather information about the Server’s current configuration such as enabled extensions, version...

path Parameters
upload_id
required
string (Upload Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Upload Information

Get information about a current download (completed upload size)

path Parameters
upload_id
required
string (Upload Id)

Responses

Response samples

Content type
application/json
null

Upload Data

Upload all bytes in the requests and append them in the specifyied offset

path Parameters
upload_id
required
string (Upload Id)

Responses

Response samples

Content type
application/json
null

Training

Training API endpoints to train custom models with your data.

Download Account Predictive Model File

Download the trained model or any other generated file as a result of a training task on a Knowledge Box

path Parameters
kbid
required
string (Kbid)
model_id
required
string (Model Id)
filename
required
string (Filename)
query Parameters
account_id
required
string (Account Id)

Responses

Response samples

Content type
application/json
null

Models

Models API

Learning Configuration Schema

Get available models

path Parameters
account_id
required
string (Account Id)
dataset_id
required
string (Dataset Id)

Responses

Response samples

Content type
application/json
{ }

Learning Configuration Schema

Get trained models

path Parameters
account_id
required
string (Account Id)
model_id
required
string (Model Id)

Responses

Response samples

Content type
application/json
{ }

Model Deletion On Account

Delete specific model from account, destroying action

path Parameters
account_id
required
string (Account Id)
model_id
required
string (Model Id)

Responses

Response samples

Content type
application/json
null

Learning Configuration Models From Account

Get trained models

path Parameters
account_id
required
string (Account Id)

Responses

Response samples

Content type
application/json
{ }

Add A Model To A Kb

Add a model to a KB to be used

path Parameters
account_id
required
string (Account Id)
kbid
required
string (Kbid)
Request Body schema: application/json
required
id
required
string (Id)

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
null

Delete A Model From A Kb

Remove from availability a model from a KB

path Parameters
kbid
required
string (Kbid)
model_id
required
string (Model Id)
account_id
required
string (Account Id)

Responses

Response samples

Content type
application/json
null

Learning Configuration Schema

Get schema for creating a KB

path Parameters
account_id
required
string (Account Id)

Responses

Response samples

Content type
application/json
{ }

Learning Configuration Schema

Get available models onprem

path Parameters
kbid
required
string (Kbid)

Responses

Response samples

Content type
application/json
{ }

Add A Model To A Kb Onprem

Add a model to a KB to be used

path Parameters
kbid
required
string (Kbid)
Request Body schema: application/json
required
id
required
string (Id)

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
null

Model Configuration

Get trained models

path Parameters
kbid
required
string (Kbid)
model_id
required
string (Model Id)

Responses

Response samples

Content type
application/json
{ }

Knowledge Boxes

Knowledge Boxes API

Knowledgebox Models Configuration

Current configuration of models assigned to a knowledgebox

path Parameters
kbid
required
string (Kbid)

Responses

Response samples

Content type
application/json
{
  • "resource_labelers_models": [
    ],
  • "paragraph_labelers_models": [
    ],
  • "intent_models": [
    ],
  • "semantic_model": "multilingual-2023-02-21",
  • "anonymization_model": "disabled",
  • "generative_model": "chatgpt-azure-3",
  • "ner_model": "multilingual",
  • "relation_model": "base",
  • "visual_labeling": "disabled",
  • "user_keys": {
    },
  • "user_prompts": {
    },
  • "semantic_vector_similarity": "dot",
  • "semantic_vector_size": 768,
  • "semantic_matryoshka_dims": [ ],
  • "semantic_threshold": 1.5,
  • "summary": "simple",
  • "summary_model": "chatgpt-azure-3",
  • "summary_prompt": {
    }
}

Knowledgebox Models Add Configuration

Current configuration of models assigned to a knowledgebox

path Parameters
kbid
required
string (Kbid)
Request Body schema: application/json
required
AnonymizationModel (string) or Anonymization Model (string) (Anonymization Model)
Default: "disabled"
VisualLabeling (string) or Visual Labeling (string) (Visual Labeling)
Default: "disabled"
GenerativeModel (string) or Generative Model (string) (Generative Model)
Default: "chatgpt-azure-3"
NERModel (string) or Ner Model (string) (Ner Model)
Default: "multilingual"
RelationModel (string) or Relation Model (string) (Relation Model)
Default: "base"
object (UserLearningKeys)
object (UserPrompts)
summary
string (Summary)
Default: "simple"
Enum: "extended" "simple"

An enumeration.

GenerativeModel (string) or Summary Model (string) (Summary Model)
Default: "anthropic"
object (SummaryPrompt)
resource_labelers_models
Array of strings (Resource Labelers Models)
paragraph_labelers_models
Array of strings (Paragraph Labelers Models)
intent_models
Array of strings (Intent Models)
semantic_model
string (SemanticModel)
Default: "multilingual-2023-02-21"
Enum: "en" "bge-large-en-v1-5" "multilingual-2023-02-21" "multilingual-2023-08-16" "text-embedding-3-small" "text-embedding-3-large" "gecko-embeddings-multi"

An enumeration.

Responses

Request samples

Content type
application/json
{
  • "anonymization_model": "disabled",
  • "visual_labeling": "disabled",
  • "generative_model": "chatgpt-azure-3",
  • "ner_model": "multilingual",
  • "relation_model": "base",
  • "user_keys": {
    },
  • "user_prompts": {
    },
  • "summary": "simple",
  • "summary_model": "anthropic",
  • "summary_prompt": {
    },
  • "resource_labelers_models": [
    ],
  • "paragraph_labelers_models": [
    ],
  • "intent_models": [
    ],
  • "semantic_model": "multilingual-2023-02-21"
}

Response samples

Content type
application/json
{
  • "resource_labelers_models": [
    ],
  • "paragraph_labelers_models": [
    ],
  • "intent_models": [
    ],
  • "semantic_model": "multilingual-2023-02-21",
  • "anonymization_model": "disabled",
  • "generative_model": "chatgpt-azure-3",
  • "ner_model": "multilingual",
  • "relation_model": "base",
  • "visual_labeling": "disabled",
  • "user_keys": {
    },
  • "user_prompts": {
    },
  • "semantic_vector_similarity": "dot",
  • "semantic_vector_size": 768,
  • "semantic_matryoshka_dims": [ ],
  • "semantic_threshold": 1.5,
  • "summary": "simple",
  • "summary_model": "chatgpt-azure-3",
  • "summary_prompt": {
    }
}

Knowledgebox Models Configuration

Delete a KB configuration

path Parameters
kbid
required
string (Kbid)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Knowledgebox Models Update Configuration

Current configuration of models assigned to a knowledgebox

path Parameters
kbid
required
string (Kbid)
Request Body schema: application/json
required
AnonymizationModel (string) or Anonymization Model (string) (Anonymization Model)
Default: "disabled"
VisualLabeling (string) or Visual Labeling (string) (Visual Labeling)
Default: "disabled"
GenerativeModel (string) or Generative Model (string) (Generative Model)
Default: "chatgpt-azure-3"
NERModel (string) or Ner Model (string) (Ner Model)
Default: "multilingual"
RelationModel (string) or Relation Model (string) (Relation Model)
Default: "base"
object (UserLearningKeys)
object (UserPrompts)
summary
string (Summary)
Default: "simple"
Enum: "extended" "simple"

An enumeration.

GenerativeModel (string) or Summary Model (string) (Summary Model)
Default: "anthropic"
object (SummaryPrompt)
resource_labelers_models
Array of strings (Resource Labelers Models)
paragraph_labelers_models
Array of strings (Paragraph Labelers Models)
intent_models
Array of strings (Intent Models)

Responses

Request samples

Content type
application/json
{
  • "anonymization_model": "disabled",
  • "visual_labeling": "disabled",
  • "generative_model": "chatgpt-azure-3",
  • "ner_model": "multilingual",
  • "relation_model": "base",
  • "user_keys": {
    },
  • "user_prompts": {
    },
  • "summary": "simple",
  • "summary_model": "anthropic",
  • "summary_prompt": {
    },
  • "resource_labelers_models": [
    ],
  • "paragraph_labelers_models": [
    ],
  • "intent_models": [
    ]
}

Response samples

Content type
application/json
{
  • "resource_labelers_models": [
    ],
  • "paragraph_labelers_models": [
    ],
  • "intent_models": [
    ],
  • "semantic_model": "multilingual-2023-02-21",
  • "anonymization_model": "disabled",
  • "generative_model": "chatgpt-azure-3",
  • "ner_model": "multilingual",
  • "relation_model": "base",
  • "visual_labeling": "disabled",
  • "user_keys": {
    },
  • "user_prompts": {
    },
  • "semantic_vector_similarity": "dot",
  • "semantic_vector_size": 768,
  • "semantic_matryoshka_dims": [ ],
  • "semantic_threshold": 1.5,
  • "summary": "simple",
  • "summary_model": "chatgpt-azure-3",
  • "summary_prompt": {
    }
}

Learning Configuration Schema

Get jsonschema definition for learning_configuration field of knowledgebox creation payload

Responses

Response samples

Content type
application/json
{
  • "resource_labelers_models": {
    },
  • "paragraph_labelers_models": {
    },
  • "intent_models": {
    },
  • "semantic_model": {
    },
  • "anonymization_model": {
    },
  • "visual_labeling": {
    },
  • "generative_model": {
    },
  • "ner_model": {
    },
  • "relation_model": {
    },
  • "summary_model": {
    },
  • "summary": {
    },
  • "user_keys": {
    },
  • "user_prompts": {
    },
  • "summary_prompt": {
    }
}

Learning Configuration Schema

Get jsonschema definition for learning_configuration field of knowledgebox creation payload

Responses

Response samples

Content type
application/json
{
  • "resource_labelers_models": {
    },
  • "paragraph_labelers_models": {
    },
  • "intent_models": {
    },
  • "semantic_model": {
    },
  • "anonymization_model": {
    },
  • "visual_labeling": {
    },
  • "generative_model": {
    },
  • "ner_model": {
    },
  • "relation_model": {
    },
  • "summary_model": {
    },
  • "summary": {
    },
  • "user_keys": {
    },
  • "user_prompts": {
    },
  • "summary_prompt": {
    }
}

Learning Configuration Schema

Get jsonschema definition for learning_configuration field of knowledgebox update payload

path Parameters
kbid
required
string (Kbid)

Responses

Response samples

Content type
application/json
{
  • "resource_labelers_models": {
    },
  • "paragraph_labelers_models": {
    },
  • "intent_models": {
    },
  • "semantic_model": {
    },
  • "anonymization_model": {
    },
  • "visual_labeling": {
    },
  • "generative_model": {
    },
  • "ner_model": {
    },
  • "relation_model": {
    },
  • "summary_model": {
    },
  • "summary": {
    },
  • "user_keys": {
    },
  • "user_prompts": {
    },
  • "summary_prompt": {
    }
}

Datasets

Datasets API endpoints to store structured data for training.

Predict

Predict API to get predictions from our models

Predict Chat

Chat interface for your NucliaDB

query Parameters
model
string (Model)
Default: "chatgpt-azure-3"
Request Body schema: application/json
required
question
required
string (Question)
retrieval
boolean (Retrieval)
Default: true
user_id
required
string (User Id)
system
string (System)
Array of objects (Chat History)
Default: []
Array of objects (Context)
Default: []
Array of Query Context (strings) or Query Context (object) (Query Context)
Default: {}
object (Query Context Order)
Default: {}
truncate
boolean (Truncate)
Default: false
object (UserPrompt)
citations
boolean (Citations)
Default: false
generative_model
string (Generative Model)
max_tokens
integer (Max Tokens)
Array of Query Context Images (objects) or Query Context Images (object) (Query Context Images)
Default: {}

Responses

Request samples

Content type
application/json
{
  • "question": "string",
  • "retrieval": true,
  • "user_id": "string",
  • "system": "string",
  • "chat_history": [ ],
  • "context": [ ],
  • "query_context": { },
  • "query_context_order": { },
  • "truncate": false,
  • "user_prompt": {
    },
  • "citations": false,
  • "generative_model": "string",
  • "max_tokens": 0,
  • "query_context_images": { }
}

Response samples

Content type
application/json
null

Predict Chat Kbid

Chat interface for your NucliaDB

path Parameters
kbid
required
string (Kbid)
Request Body schema: application/json
required
question
required
string (Question)
retrieval
boolean (Retrieval)
Default: true
user_id
required
string (User Id)
system
string (System)
Array of objects (Chat History)
Default: []
Array of objects (Context)
Default: []
Array of Query Context (strings) or Query Context (object) (Query Context)
Default: {}
object (Query Context Order)
Default: {}
truncate
boolean (Truncate)
Default: false
object (UserPrompt)
citations
boolean (Citations)
Default: false
generative_model
string (Generative Model)
max_tokens
integer (Max Tokens)
Array of Query Context Images (objects) or Query Context Images (object) (Query Context Images)
Default: {}

Responses

Request samples

Content type
application/json
{
  • "question": "string",
  • "retrieval": true,
  • "user_id": "string",
  • "system": "string",
  • "chat_history": [ ],
  • "context": [ ],
  • "query_context": { },
  • "query_context_order": { },
  • "truncate": false,
  • "user_prompt": {
    },
  • "citations": false,
  • "generative_model": "string",
  • "max_tokens": 0,
  • "query_context_images": { }
}

Response samples

Content type
application/json
null

Predict Feedback

Get feedback

query Parameters
model
required
string (Model)
Request Body schema: application/json
required
ident
required
string (Ident)
good
required
boolean (Good)
task
required
string (FeedbackTasks)
Enum: "CHAT" "SUMMARY"

An enumeration.

feedback
string (Feedback)
user_id
string (User Id)
client
string (Client)
forwarded
string (Forwarded)

Responses

Request samples

Content type
application/json
{
  • "ident": "string",
  • "good": true,
  • "task": "CHAT",
  • "feedback": "string",
  • "user_id": "string",
  • "client": "string",
  • "forwarded": "string"
}

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Predict Feedback Kbid

Get feedback

path Parameters
kbid
required
string (Kbid)
Request Body schema: application/json
required
ident
required
string (Ident)
good
required
boolean (Good)
task
required
string (FeedbackTasks)
Enum: "CHAT" "SUMMARY"

An enumeration.

feedback
string (Feedback)
user_id
string (User Id)
client
string (Client)
forwarded
string (Forwarded)

Responses

Request samples

Content type
application/json
{
  • "ident": "string",
  • "good": true,
  • "task": "CHAT",
  • "feedback": "string",
  • "user_id": "string",
  • "client": "string",
  • "forwarded": "string"
}

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Predict Query

Get the vector of a sentence

query Parameters
text
required
string (Text)
semantic_model
string (Semantic Model)
Default: "multilingual-2023-02-21"
token_model
string (Token Model)
Default: "multilingual"
generative_model
string (Generative Model)
Default: "chatgpt-azure-3"
rephrase
boolean (Rephrase)
Default: false

Responses

Response samples

Content type
application/json
{
  • "language": "string",
  • "stop_words": [
    ],
  • "semantic_threshold": 0,
  • "visual_llm": true,
  • "max_context": 0,
  • "entities": {
    },
  • "sentence": {
    },
  • "query": "string"
}

Predict Query Kbid

Get the vector of a sentence

path Parameters
kbid
required
string (Kbid)
query Parameters
text
required
string (Text)
generative_model
string (Generative Model)
Default: "chatgpt-azure-3"
rephrase
boolean (Rephrase)
Default: false

Responses

Response samples

Content type
application/json
{
  • "language": "string",
  • "stop_words": [
    ],
  • "semantic_threshold": 0,
  • "visual_llm": true,
  • "max_context": 0,
  • "entities": {
    },
  • "sentence": {
    },
  • "query": "string"
}

Predict Rephrase

Rephrase interface for your NucliaDB

query Parameters
model
string (Model)
Default: "chatgpt-azure-3"
Request Body schema: application/json
required
question
required
string (Question)
Array of objects (Chat History)
Default: []
Array of objects (Context)
Default: []
user_context
Array of strings (User Context)
Default: []
user_id
required
string (User Id)
generative_model
string (Generative Model)

Responses

Request samples

Content type
application/json
{
  • "question": "string",
  • "chat_history": [ ],
  • "context": [ ],
  • "user_context": [ ],
  • "user_id": "string",
  • "generative_model": "string"
}

Response samples

Content type
application/json
"string"

Predict Rephrase Kbid

Rephrase interface for your NucliaDB with Container

path Parameters
kbid
required
string (Kbid)
Request Body schema: application/json
required
question
required
string (Question)
Array of objects (Chat History)
Default: []
Array of objects (Context)
Default: []
user_context
Array of strings (User Context)
Default: []
user_id
required
string (User Id)
generative_model
string (Generative Model)

Responses

Request samples

Content type
application/json
{
  • "question": "string",
  • "chat_history": [ ],
  • "context": [ ],
  • "user_context": [ ],
  • "user_id": "string",
  • "generative_model": "string"
}

Response samples

Content type
application/json
null

Predict Sentence

Get the vector of a sentence

query Parameters
text
required
string (Text)
model
string (Model)
Default: "multilingual-2023-02-21"

Responses

Response samples

Content type
application/json
{
  • "data": [ ],
  • "time": 0
}

Predict Sentence Kbid

Get the vector of a sentence

path Parameters
kbid
required
string (Kbid)
query Parameters
text
required
string (Text)

Responses

Response samples

Content type
application/json
{
  • "data": [ ],
  • "time": 0
}

Predict Summarize

Get summarized answers via NUA

query Parameters
model
string (Model)
Default: "anthropic"
Request Body schema: application/json
required
required
object (Resources)
summary_kind
string (SummaryKind)
Default: "simple"
Enum: "simple" "extended"

An enumeration.

user_prompt
string (User Prompt)
Default: ""
generative_model
string (Generative Model)

Responses

Request samples

Content type
application/json
{
  • "resources": {
    },
  • "summary_kind": "simple",
  • "user_prompt": "",
  • "generative_model": "string"
}

Response samples

Content type
application/json
null

Predict Summarize Kbid

Get summarized answers via NUA with Container

path Parameters
kbid
required
string (Kbid)
Request Body schema: application/json
required
required
object (Resources)
summary_kind
string (SummaryKind)
Default: "simple"
Enum: "simple" "extended"

An enumeration.

user_prompt
string (User Prompt)
Default: ""
generative_model
string (Generative Model)

Responses

Request samples

Content type
application/json
{
  • "resources": {
    },
  • "summary_kind": "simple",
  • "user_prompt": "",
  • "generative_model": "string"
}

Response samples

Content type
application/json
null

Predict Tokens

Get tokens of a sentence

query Parameters
text
required
string (Text)
model
string (Model)
Default: "multilingual"

Responses

Response samples

Content type
application/json
{
  • "tokens": [ ],
  • "time": 0
}

Predict Tokens Kbid

Get tokens of a sentence with Container

path Parameters
kbid
required
string (Kbid)
query Parameters
text
required
string (Text)

Responses

Response samples

Content type
application/json
{
  • "tokens": [ ],
  • "time": 0
}

Collector

Collector API

Feedback Avalaible Months

List of months within the last year with feedback data

path Parameters
kbid
required
string (Kbid)

Responses

Response samples

Content type
application/json
null

Get Feedback

Given a month, returns a csv with all the feedback data from it

path Parameters
kbid
required
string (Kbid)
month
required
string (Month)

Responses

Response samples

Content type
application/json
null

Knowledgebox activity

Download Knowledgebox activity

Download Knowledgebox Activity

Download the csv file for the activity audit for a given month

path Parameters
kb_uuid
required
string (Kb Uuid)
query Parameters
type
required
string (EventType)
Enum: "VISITED" "MODIFIED" "DELETED" "NEW" "STARTED" "STOPPED" "SEARCH" "PROCESSED" "SUGGEST" "CHAT"

Audit event type

month
required
string (Month) ^\d+-(0[1-9]|1[012])$

Month in YYYY-MM format

Responses

Response samples

Content type
application/json
null

Get Knowledgebox Activity Downloads List

Get the list of monthly activity audit files available to download

path Parameters
kb_uuid
required
string (Kb Uuid)
query Parameters
type
required
string (EventType)
Enum: "VISITED" "MODIFIED" "DELETED" "NEW" "STARTED" "STOPPED" "SEARCH" "PROCESSED" "SUGGEST" "CHAT"

Audit event type

Responses

Response samples

Content type
application/json
{
  • "downloads": [
    ]
}

NUA Client

Get Processed Activity Log

Get latest events related to activity of a Nuclia Understanding API client

path Parameters
account_slug
required
string (Account Slug)
client_id
required
string (Client Id)
query Parameters
page
integer (Page)
Default: 0
size
integer (Size)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "pagination": {
    }
}

Knowledgebox activity log

Get Knowledgebox Activity Deprecated

Get latest events related to activity of a knowledgebox

path Parameters
kb_uuid
required
string (Kb Uuid)
query Parameters
type
string (EventType)
Default: "PROCESSED"
Enum: "VISITED" "MODIFIED" "DELETED" "NEW" "STARTED" "STOPPED" "SEARCH" "PROCESSED" "SUGGEST" "CHAT"

An enumeration.

page
integer (Page)
Default: 0
size
integer (Size)
Default: 50

Responses

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "pagination": {
    }
}