Terminology

CRUD

The most common methods used to make API calls to interact with resources are POST, GET, PUT, and DELETE. These methods correspond to the Create, Retrieve, Update, and Delete (CRUD) actions, respectively.

REST API

A Representational State Transfer Application Programming Interface (REST API) is a simple and flexible design pattern that allows developers to communicate with applications or devices over the web. When a client makes a request to a server using a REST API, the server responds with the representation of a resource (for example, an HTML, XML, or JSON document), which contains hypermedia links that can be followed to change the state of the system.

Only the identifier of the first requested resource from the REST API needs to be known, as all other identifiers will be discovered. This allows the identifiers to change without having to inform the client beforehand, and it only allows for loose coupling between the client and server.

Action

An API action is a specific operation that an API allows you to perform. It represents a task or request you can make to the system — like generate metadata, updating a record, deleting an item, or extract insights.

Common examples of an API action are: GET //health - To check the health of an application or service. POST /orders - Create a new order. DELETE /files{id} - Remove a specific file.

Schema

An API schema is a structured blueprint that defines how an API works. It describes the available endpoints, the types of requests you can make, the data formats expected, and the responses you’ll receive.

Think of it as a map or guide that helps developers understand how to interact with the API correctly.

Presigned URL

A presigned URL is like a temporary key that lets someone access a file for a limited time, without needing a password. A presigned URL can enable you to upload a file to a cloud storage like Amazon S3 or Google Cloud Storage.

Chunks

In Knowledge Enrichment, chunks can be referred as units of content that are enriched with metadata, context, or semantic relationships. These segments of text are extracted from documents during the data curation process.

Asynchronous Processing

Asynchronous processing refers to a method where you submit a request to the API, and instead of waiting for the operation to complete immediately, the system notifies you once the task is done or you check back later.