Product Docs
  • What is Dataworkz?
  • Getting Started
    • What You Will Need
    • Advanced RAG Quickstart
      • Configure LLM's
        • AWS Bedrock
      • Connecting Your Data
        • Finding Your Data Storage: Collections
      • Ingesting Unstructured Data
      • Create Vector Embeddings
        • How to Build the Vector embeddings from Scratch
        • How do Modify Existing Chunking/Embedding Dataflows
      • Response History
    • Embed RAG into your App
    • Data Lake to Salesforce
  • Concepts
    • Datasets
    • No-code Transformations
    • Lineage
      • Features of Lineage:
      • Viewing a dataset's lineage:
    • Discovery
      • How to: Discovery
    • Dataflows
      • Single Dataflows:
      • Composite dataflows:
      • Benefits of Dataflows:
  • Guides
    • Working With Rag Applications
      • High Precision RAG
      • Advanced RAG - Access Control for your data corpus
      • Creating RAG Experiments with Dataworkz
      • Embedding Models
        • Privately Hosted Embedding Models
        • Amazon Bedrock Hosted Embedding Model
        • OpenAI Embedding Model
      • Unstructured Data Ingestion
        • File Ingestion
        • Html/Sharepoint Ingestion
    • Transformation Functions
      • Column Transformations
        • String Operations
          • Format Operations
          • String Calculation Operations
          • Remove Stop Words Operation
          • Fuzzy Match Operation
          • Masking Operations
          • 1-way Hash Operation
          • Copy Operation
          • Unnest Operation
          • Convert Operation
          • Vlookup Operation
        • Numeric Operations
          • Tiles Operation
          • Numeric Calculation Operations
          • Custom Calculation Operation
          • Numeric Encode Operation
          • Mask Operation
          • 1-way Hash Operation
          • Copy Operation
          • Convert Operation
          • VLookup Operation
        • Boolean Operations
          • Mask Operation
          • 1-way Hash Operation
          • Copy Operation
        • Date Operations
          • Date Format Operations
          • Date Calculation Operations
          • Mask Operation
          • 1-way Hash Operation
          • Copy Operation
          • Encode Operation
          • Convert Operation
        • Datetime/Timestamp Operations
          • Datetime Format Operations
          • Datetime Calculation Operations
          • Mask Operation
          • 1-way Hash Operation
          • Copy Operation
          • Encode Operation
          • Page 1
      • Dataset Transformations
        • Utility Functions
          • Area Under the Curve
          • Page Rank Utility Function
          • Transpose Utility Function
          • Semantic Search Template Utility Function
          • New Header Utility Function
          • Transform to JSON Utility Function
          • Text Utility Function
          • UI Utility Function
        • Window Functions
        • Case Statement
          • Editor Query
          • UI Query
        • Filter
          • Editor Query
          • UI Query
    • Working with CSV files
    • Connect to data source(s)
      • Cloud Data Platforms
        • AWS S3
        • BigQuery
        • Google Cloud Storage
        • Azure
        • Snowflake
        • Redshift
        • Databricks
      • Databases
        • MySQL
        • Microsoft SQL Server
        • Oracle
        • MariaDB
        • Postgres
        • DB2
        • MongoDB
        • Couchbase
        • Aerospike
        • Pinecone
      • SaaS Applications
        • Google Ads
        • Google Analytics
        • Marketo
        • Zoom
        • JIRA
        • Salesforce
        • Zendesk
        • Hubspot
        • Outreach
        • Fullstory
        • Pendo
        • Box
        • Google Sheets
        • Slack
        • OneDrive / Sharepoint
    • IP safelist
    • Data Prep
      • Joins
        • Configuring a Join
      • Union
        • Configuring a Union
    • Job Monitoring
    • Authentication
    • User Management
  • API
    • Generate API Key in Dataworkz
  • Open Source License Types
Powered by GitBook
On this page

API

Q&A API Documentation.

PreviousUser ManagementNextGenerate API Key in Dataworkz

Last updated 1 month ago

Note: All API needs an API Key to be sent in the request headers. Please follow these steps to generate an API Key.

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;

public class GetSystems {

    public static void main(String[] args) throws Exception {
        String url = System.getenv("DATAWORKZ_SERVICE") != null ? System.getenv("DATAWORKZ_SERVICE") : "https://ragapps.dataworkz.com"; // Replace ragapps.dataworkz.com with actual service host
        url = url + "/api/qna/v1/systems";
        String authorizationHeader = "SSWS " + System.getenv("DATAWORKZ_API_TOKEN");

        if (System.getenv("DATAWORKZ_API_TOKEN") == null) {
            System.err.println("System environment variable DATAWORKZ_API_TOKEN not set.");
            System.exit(1);
        }

        // Create URL object
        URL apiUrl = new URL(url);

        HttpURLConnection connection = null;
        // Open a connection
        try {
            connection = (HttpURLConnection) apiUrl.openConnection();

            // Set the request method to GET
            connection.setRequestMethod("GET");

            // Set request headers
            connection.setRequestProperty("accept", "application/json");
            connection.setRequestProperty("Authorization", authorizationHeader);

            // Get the response code
            int responseCode = connection.getResponseCode();
            System.out.println("Response Code: " + responseCode);

            // Read the response
            try (BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
                String line;
                StringBuilder response = new StringBuilder();
                while ((line = reader.readLine()) != null) {
                    response.append(line);
                }

                // Print the response
                System.out.println("Response: " + response.toString());
            }

        } finally {
            // Close the connection
            if (connection != null) {
                connection.disconnect();
            }
        }
    }
}
curl -X GET 'https://ragapps.dataworkz.com/api/qna/v1/systems' \
-H 'accept: application/json' \
-H 'Authorization: SSWS <DATAWORKZ_API_TOKEN>'

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;

public class GetSystem {

    public static void main(String[] args) throws Exception {
        String url = System.getenv("DATAWORKZ_SERVICE") != null ? System.getenv("DATAWORKZ_SERVICE") : "https://ragapps.dataworkz.com"; // Replace ragapps.dataworkz.com with actual service host
        url = url + "/api/qna/v1/systems/{systemId}";

        String systemId = System.getenv("DATAWORKZ_SYSTEM_ID");
        String authorizationHeader = "SSWS " + System.getenv("DATAWORKZ_API_TOKEN");

        if (systemId == null || System.getenv("DATAWORKZ_API_TOKEN") == null) {
            System.err.println("All Environment variables - DATAWORKZ_SYSTEM_ID, DATAWORKZ_API_TOKEN are not set. ");
            System.exit(1);
        }
        String result = sendHttpGetRequest(url, systemId, authorizationHeader);
        System.out.println(result);
    }

    private static String sendHttpGetRequest(String apiUrl, String systemId, String authorizationHeader) throws IOException {
        String apiUrlWithSystemId = apiUrl.replace("{systemId}", systemId);

        // Create URL object
        URL url = new URL(apiUrlWithSystemId);

        // Open a connection
        HttpURLConnection connection = null;
        try {
            connection = (HttpURLConnection) url.openConnection();

            // Set the request method to GET
            connection.setRequestMethod("GET");

            // Set request headers
            connection.setRequestProperty("accept", "application/json");
            connection.setRequestProperty("Authorization", authorizationHeader);

            // Get the response code
            int responseCode = connection.getResponseCode();
            System.out.println("Response Code: " + responseCode);

            // Read the response
            StringBuilder response = new StringBuilder();
            try (BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
                String line;
                while ((line = reader.readLine()) != null) {
                    response.append(line);
                }
            }
            return response.toString();
        } finally {
            // Close the connection
            if (connection != null) {
                connection.disconnect();
            }
        }
    }
}
curl -X GET 'https://ragapps.dataworkz.com/api/qna/v1/systems/{systemId}' \
-H 'accept: application/json' \
-H 'Authorization: SSWS <DATAWORKZ_API_TOKEN>'

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;

public class GetLLMProviders {

    public static void main(String[] args) throws Exception {
        String apiUrl = System.getenv("DATAWORKZ_SERVICE") != null ? System.getenv("DATAWORKZ_SERVICE") : "https://ragapps.dataworkz.com"; // Replace ragapps.dataworkz.com with actual service host
        apiUrl = apiUrl + "/api/qna/v1/systems/{systemId}/llm-providers";
        String systemId = System.getenv("DATAWORKZ_SYSTEM_ID");
        String authorizationHeader = "SSWS " + System.getenv("DATAWORKZ_API_TOKEN");

        if (systemId == null || System.getenv("DATAWORKZ_API_TOKEN") == null) {
            System.err.println("All Environment variables - DATAWORKZ_SYSTEM_ID, DATAWORKZ_API_TOKEN are not set. ");
            System.exit(1);
        }

        String result = sendHttpGetRequest(apiUrl, systemId, authorizationHeader);
        System.out.println(result);
    }

    private static String sendHttpGetRequest(String apiUrl, String systemId, String authorizationHeader) throws IOException {
        String apiUrlWithSystemId = apiUrl.replace("{systemId}", systemId);

        // Create URL object
        URL url = new URL(apiUrlWithSystemId);

        // Open a connection
        HttpURLConnection connection = null;
        try {
            connection = (HttpURLConnection) url.openConnection();

            // Set the request method to GET
            connection.setRequestMethod("GET");

            // Set request headers
            connection.setRequestProperty("accept", "application/json");
            connection.setRequestProperty("Authorization", authorizationHeader);

            // Get the response code
            int responseCode = connection.getResponseCode();
            System.out.println("Response Code: " + responseCode);

            // Read the response
            StringBuilder response = new StringBuilder();
            try (BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
                String line;
                while ((line = reader.readLine()) != null) {
                    response.append(line);
                }
            }
            return response.toString();
        } finally {
            // Close the connection
            if (connection != null) {
                connection.disconnect();
            }
        }
    }
}
curl -X GET 'https://ragapps.dataworkz.com/api/qna/v1/systems/{systemId}/llm-providers' \
-H 'accept: application/json' \
-H 'Authorization: SSWS <DATAWORKZ_API_TOKEN>'

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;

public class GetAnswer {

    public static void main(String[] args) throws Exception {
        if (args.length == 0) {
            System.err.println("Query must be passed as argument to this program.");
            System.exit(1);
        }
        String apiUrl = System.getenv("DATAWORKZ_SERVICE") != null ? System.getenv("DATAWORKZ_SERVICE") : "https://ragapps.dataworkz.com"; // Replace ragapps.dataworkz.com with actual service host
        apiUrl = apiUrl + "/api/qna/v1/systems/{systemId}/answer?questionText={questionText}&llmProviderId={llmProviderId}";
        String systemId = System.getenv("DATAWORKZ_SYSTEM_ID");
        String authorizationHeader = "SSWS " + System.getenv("DATAWORKZ_API_TOKEN");
        String questionText = args[0];
        String llmProviderId = System.getenv("DATAWORKZ_LLM_ID");

        if (systemId == null || llmProviderId == null || System.getenv("DATAWORKZ_API_TOKEN") == null) {
            System.err.println("System Environment variables are not set. Need to set DATAWORKZ_SYSTEM_ID, DATAWORKZ_LLM_ID, DATAWORKZ_API_TOKEN");
            System.exit(1);
        }

        String result = sendHttpGetRequest(apiUrl, systemId, questionText, llmProviderId, authorizationHeader);
        System.out.println(result);
    }

    private static String sendHttpGetRequest(String apiUrl, String systemId, String questionText, String llmProviderId, String authorizationHeader) throws IOException {
        String apiUrlWithParams = apiUrl
                .replace("{systemId}", systemId)
                .replace("{questionText}", URLEncoder.encode(questionText, "UTF-8"))
                .replace("{llmProviderId}", URLEncoder.encode(llmProviderId, "UTF-8"));

        // Create URL object
        URL url = new URL(apiUrlWithParams);

        // Open a connection
        HttpURLConnection connection = null;
        try {
            connection = (HttpURLConnection) url.openConnection();

            // Set the request method to GET
            connection.setRequestMethod("GET");

            // Set request headers
            connection.setRequestProperty("accept", "application/json");
            connection.setRequestProperty("Authorization", authorizationHeader);

            // Get the response code
            int responseCode = connection.getResponseCode();
            System.out.println("Response Code: " + responseCode);

            // Read the response
            StringBuilder response = new StringBuilder();
            try (BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
                String line;
                while ((line = reader.readLine()) != null) {
                    response.append(line);
                }
            }
            return response.toString();
        } finally {
            if (connection == null) {
                // Close the connection
                connection.disconnect();
            }
        }
    }
}
curl -X GET 'https://ragapps.dataworkz.com/api/qna/v1/systems/{systemId}/answer?questionText=<question>&llmProviderId=<llm-id>' \
-H 'accept: application/json' \
-H 'Authorization: SSWS <DATAWORKZ_API_TOKEN>'

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;

public class GetSearchResults {

    public static void main(String[] args) throws Exception {
        if (args.length == 0) {
            System.err.println("Query must be passed as argument to this program.");
            System.exit(1);
        }
        String apiUrl = System.getenv("DATAWORKZ_SERVICE") != null ? System.getenv("DATAWORKZ_SERVICE") : "https://ragapps.dataworkz.com"; // Replace ragapps.dataworkz.com with actual service host
        apiUrl = apiUrl + "/api/qna/v1/systems/{systemId}/search?query={questionText}";
        String systemId = System.getenv("DATAWORKZ_SYSTEM_ID");
        String authorizationHeader = "SSWS " + System.getenv("DATAWORKZ_API_TOKEN");
        String questionText = args[0];

        if (systemId == null || System.getenv("DATAWORKZ_API_TOKEN") == null) {
            System.err.println("System Environment variables are not set. Need to set DATAWORKZ_SYSTEM_ID, DATAWORKZ_API_TOKEN");
            System.exit(1);
        }

        String result = sendHttpGetRequest(apiUrl, systemId, questionText, authorizationHeader);
        System.out.println(result);
    }

    private static String sendHttpGetRequest(String apiUrl, String systemId, String questionText, String authorizationHeader) throws IOException {
        String apiUrlWithParams = apiUrl
                .replace("{systemId}", systemId)
                .replace("{questionText}", URLEncoder.encode(questionText, "UTF-8"));

        // Create URL object
        URL url = new URL(apiUrlWithParams);

        // Open a connection
        HttpURLConnection connection = null;
        try {
            connection = (HttpURLConnection) url.openConnection();

            // Set the request method to GET
            connection.setRequestMethod("GET");

            // Set request headers
            connection.setRequestProperty("accept", "application/json");
            connection.setRequestProperty("Authorization", authorizationHeader);

            // Get the response code
            int responseCode = connection.getResponseCode();
            System.out.println("Response Code: " + responseCode);

            // Read the response
            StringBuilder response = new StringBuilder();
            try (BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
                String line;
                while ((line = reader.readLine()) != null) {
                    response.append(line);
                }
            }
            return response.toString();
        } finally {
            if (connection == null) {
                // Close the connection
                connection.disconnect();
            }
        }
    }
}
curl -X GET 'https://ragapps.dataworkz.com/api/qna/v1/systems/{systemId}/search?query=<query>' \
-H 'accept: application/json' \
-H 'Authorization: SSWS <DATAWORKZ_API_TOKEN>'

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;

public class GetFilters {

    public static void main(String[] args) throws Exception {
        String url = System.getenv("DATAWORKZ_SERVICE") != null ? System.getenv("DATAWORKZ_SERVICE") : "https://ragapps.dataworkz.com"; // Replace ragapps.dataworkz.com with actual service host
        url = url + "/api/qna/v1/systems/{systemId}/filters";

        String systemId = System.getenv("DATAWORKZ_SYSTEM_ID");
        String authorizationHeader = "SSWS " + System.getenv("DATAWORKZ_API_TOKEN");

        if (systemId == null || System.getenv("DATAWORKZ_API_TOKEN") == null) {
            System.err.println("All Environment variables - DATAWORKZ_SYSTEM_ID, DATAWORKZ_API_TOKEN are not set. ");
            System.exit(1);
        }
        String result = sendHttpGetRequest(url, systemId, authorizationHeader);
        System.out.println(result);
    }

    private static String sendHttpGetRequest(String apiUrl, String systemId, String authorizationHeader) throws IOException {
        String apiUrlWithSystemId = apiUrl.replace("{systemId}", systemId);

        // Create URL object
        URL url = new URL(apiUrlWithSystemId);

        // Open a connection
        HttpURLConnection connection = null;
        try {
            connection = (HttpURLConnection) url.openConnection();

            // Set the request method to GET
            connection.setRequestMethod("GET");

            // Set request headers
            connection.setRequestProperty("accept", "application/json");
            connection.setRequestProperty("Authorization", authorizationHeader);

            // Get the response code
            int responseCode = connection.getResponseCode();
            System.out.println("Response Code: " + responseCode);

            // Read the response
            StringBuilder response = new StringBuilder();
            try (BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
                String line;
                while ((line = reader.readLine()) != null) {
                    response.append(line);
                }
            }
            return response.toString();
        } finally {
            // Close the connection
            if (connection != null) {
                connection.disconnect();
            }
        }
    }
}
curl -X GET 'https://ragapps.dataworkz.com/api/qna/v1/systems/{systemId}/filters' \
-H 'accept: application/json' \
-H 'Authorization: SSWS <DATAWORKZ_API_TOKEN>'

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;

public class HttpExample {

    public static void main(String[] args) {
        String apiUrl = "https://{genAI}.dataworkz.com"; // Replace {genAI} with actual service host
        apiUrl = apiUrl + "/api/qna/v1/systems/{systemId}/questionshistory";
        String systemId = "123"; // Replace with the actual system ID
        String authorizationHeader = "SSWS xxxxxxx"; // Replace with the actual authorization token

        try {
            String result = sendHttpGetRequest(apiUrl, systemId, authorizationHeader);
            System.out.println(result);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    private static String sendHttpGetRequest(String apiUrl, String systemId, String authorizationHeader) throws IOException {
        String apiUrlWithSystemId = apiUrl.replace("{systemId}", systemId);

        // Create URL object
        URL url = new URL(apiUrlWithSystemId);

        // Open a connection
        HttpURLConnection connection = (HttpURLConnection) url.openConnection();

        // Set the request method to GET
        connection.setRequestMethod("GET");

        // Set request headers
        connection.setRequestProperty("accept", "application/json");
        connection.setRequestProperty("Authorization", authorizationHeader);

        // Get the response code
        int responseCode = connection.getResponseCode();
        System.out.println("Response Code: " + responseCode);

        // Read the response
        StringBuilder response = new StringBuilder();
        try (BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
            String line;
            while ((line = reader.readLine()) != null) {
                response.append(line);
            }
        }

        // Close the connection
        connection.disconnect();

        return response.toString();
    }
}

curl -X GET 'https://ragapps.dataworkz.com/api/qna/v1/systems/{systemId}/questionshistory' \
-H 'accept: application/json' \
-H 'Authorization: SSWS xxxxxxx'



import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;

public class HttpExample {

    public static void main(String[] args) {
        String apiUrl = "https://{genAI}.dataworkz.com"; // Replace {genAI} with actual service host
        apiUrl = apiUrl "/api/qna/v1/systems/{systemId}/questions/{questionId}";
        String systemId = "123"; // Replace with the actual system ID
        String questionId = "456"; // Replace with the actual question ID
        String authorizationHeader = "SSWS xxxxxxx"; // Replace with the actual authorization token

        try {
            String result = sendHttpGetRequest(apiUrl, systemId, questionId, authorizationHeader);
            System.out.println(result);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    private static String sendHttpGetRequest(String apiUrl, String systemId, String questionId, String authorizationHeader) throws IOException {
        String apiUrlWithIds = apiUrl
                .replace("{systemId}", systemId)
                .replace("{questionId}", questionId);

        // Create URL object
        URL url = new URL(apiUrlWithIds);

        // Open a connection
        HttpURLConnection connection = (HttpURLConnection) url.openConnection();

        // Set the request method to GET
        connection.setRequestMethod("GET");

        // Set request headers
        connection.setRequestProperty("accept", "application/json");
        connection.setRequestProperty("Authorization", authorizationHeader);

        // Get the response code
        int responseCode = connection.getResponseCode();
        System.out.println("Response Code: " + responseCode);

        // Read the response
        StringBuilder response = new StringBuilder();
        try (BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
            String line;
            while ((line = reader.readLine()) != null) {
                response.append(line);
            }
        }

        // Close the connection
        connection.disconnect();

        return response.toString();
    }
}

curl -X GET 'https://ragapps.dataworkz.com/api/qna/v1/systems/{systemId}/questions/{questionId}' \
-H 'accept: application/json' \
-H 'Authorization: SSWS xxxxxxx'
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;

public class GetChatAnswer {

    public static void main(String[] args) throws Exception {
        if (args.length == 0) {
            System.err.println("Query and conversation history must be passed as argument to this program.");
            System.exit(1);
        }
        String apiUrl = System.getenv("DATAWORKZ_SERVICE") != null ? System.getenv("DATAWORKZ_SERVICE") : "https://ragapps.dataworkz.com"; // Replace ragapps.dataworkz.com with actual service host
        apiUrl = apiUrl + "/api/qna/v1/systems/{systemId}/answer?questionText={questionText}&llmProviderId={llmProviderId}";
        String systemId = System.getenv("DATAWORKZ_SYSTEM_ID");
        String authorizationHeader = "SSWS " + System.getenv("DATAWORKZ_API_TOKEN");
        String questionText = args[0];
        String conversationHistory = args[1];
        String llmProviderId = System.getenv("DATAWORKZ_LLM_ID");

        if (systemId == null || llmProviderId == null || System.getenv("DATAWORKZ_API_TOKEN") == null) {
            System.err.println("System Environment variables are not set. Need to set DATAWORKZ_SYSTEM_ID, DATAWORKZ_LLM_ID, DATAWORKZ_API_TOKEN");
            System.exit(1);
        }

        String result = sendHttpGetRequest(apiUrl, systemId, questionText, llmProviderId, conversationHistory, authorizationHeader);
        System.out.println(result);
    }

    private static String sendHttpGetRequest(String apiUrl, String systemId, String questionText, String llmProviderId, String conversationHistory, String authorizationHeader) throws IOException {
        String apiUrlWithParams = apiUrl
                .replace("{systemId}", systemId)
                .replace("{questionText}", URLEncoder.encode(questionText, "UTF-8"))
                .replace("{llmProviderId}", URLEncoder.encode(llmProviderId, "UTF-8"));

        // Create URL object
        URL url = new URL(apiUrlWithParams);

        // Open a connection
        HttpURLConnection connection = null;
        try {
            connection = (HttpURLConnection) url.openConnection();

            // Set the request method to GET
            connection.setRequestMethod("POST");

            // Set request headers
            connection.setRequestProperty("accept", "application/json");
            connection.setRequestProperty("Content-Type", "application/json");
            connection.setRequestProperty("Authorization", authorizationHeader);

            connection.setDoOutput(true);
            connection.getOutputStream().write(("{ \"conversationHistory\": " + conversationHistory + "}").getBytes());

            // Get the response code
            int responseCode = connection.getResponseCode();
            System.out.println("Response Code: " + responseCode);

            // Read the response
            StringBuilder response = new StringBuilder();
            try (BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
                String line;
                while ((line = reader.readLine()) != null) {
                    response.append(line);
                }
            }
            return response.toString();
        } finally {
            if (connection == null) {
                // Close the connection
                connection.disconnect();
            }
        }
    }
}
curl -X POST 'https://ragapps.dataworkz.com/api/qna/v1/systems/79596cb6-fae8-47dd-8540-d3bf5c6f0748/answer?llmProviderId=b5e6e2bf-e4d3-4dc9-be4c-5ae8c5b175e6&questionText=What%20is%20the%20returns%20process%3F' \
-H  "Authorization: SSWS $TOKEN" -H "Content-Type: application/json" \
-d '{"conversationHistory":[{"by":"USER", "text":"Hi"}, {"by":"AI", "text":"Hi"}]}'
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;

public class GetAgents {

    public static void main(String[] args) throws Exception {
        String apiUrl = System.getenv("DATAWORKZ_SERVICE") != null ? System.getenv("DATAWORKZ_SERVICE") : "https://ragapps.dataworkz.com"; // Replace ragapps.dataworkz.com with actual service host
        apiUrl = apiUrl + "/api/qna/v1/agents";
        String authorizationHeader = "SSWS " + System.getenv("DATAWORKZ_API_TOKEN");

        if (System.getenv("DATAWORKZ_API_TOKEN") == null) {
            System.err.println("System Environment variables are not set. Need to set DATAWORKZ_API_TOKEN");
            System.exit(1);
        }

        String result = sendHttpGetRequest(apiUrl, authorizationHeader);
        System.out.println(result);
    }

    private static String sendHttpGetRequest(String apiUrl, String authorizationHeader) throws IOException {
        String apiUrlWithParams = apiUrl;

        // Create URL object
        URL url = new URL(apiUrlWithParams);

        // Open a connection
        HttpURLConnection connection = null;
        try {
            connection = (HttpURLConnection) url.openConnection();

            // Set the request method to GET
            connection.setRequestMethod("GET");

            // Set request headers
            connection.setRequestProperty("accept", "application/json");
            connection.setRequestProperty("Authorization", authorizationHeader);

            // Get the response code
            int responseCode = connection.getResponseCode();
            System.out.println("Response Code: " + responseCode);

            // Read the response
            StringBuilder response = new StringBuilder();
            try (BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
                String line;
                while ((line = reader.readLine()) != null) {
                    response.append(line);
                }
            }
            return response.toString();
        } finally {
            if (connection == null) {
                // Close the connection
                connection.disconnect();
            }
        }
    }
}
curl -X GET https://ragapps.dataworkz.com/api/qna/v1/agents \
-H "Authorization: SSWS $TOKEN" -H "Content-Type: application/json"
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;

public class GetAgentResponse {

    public static void main(String[] args) throws Exception {
        if (args.length == 0) {
            System.err.println("Query and conversation history must be passed as argument to this program.");
            System.exit(1);
        }
        String apiUrl = System.getenv("DATAWORKZ_SERVICE") != null ? System.getenv("DATAWORKZ_SERVICE") : "https://ragapps.dataworkz.com"; // Replace ragapps.dataworkz.com with actual service host
        apiUrl = apiUrl + "/api/qna/v1/agents/{agentId}/response?userText={userText}&llmProviderId={llmProviderId}";
        String agentId = System.getenv("DATAWORKZ_AGENT_ID");
        String authorizationHeader = "SSWS " + System.getenv("DATAWORKZ_API_TOKEN");
        String questionText = args[0];
	String conversationHistory = args[1];
        String llmProviderId = System.getenv("DATAWORKZ_LLM_ID");

        if (agentId == null || llmProviderId == null || System.getenv("DATAWORKZ_API_TOKEN") == null) {
            System.err.println("System Environment variables are not set. Need to set DATAWORKZ_AGENT_ID, DATAWORKZ_LLM_ID, DATAWORKZ_API_TOKEN");
            System.exit(1);
        }

        String result = sendHttpGetRequest(apiUrl, agentId, questionText, llmProviderId, conversationHistory, authorizationHeader);
        System.out.println(result);
    }

    private static String sendHttpGetRequest(String apiUrl, String agentId, String questionText, String llmProviderId, String conversationHistory, String authorizationHeader) throws IOException {
        String apiUrlWithParams = apiUrl
                .replace("{agentId}", agentId)
                .replace("{userText}", URLEncoder.encode(questionText, "UTF-8"))
                .replace("{llmProviderId}", URLEncoder.encode(llmProviderId, "UTF-8"));

        // Create URL object
        URL url = new URL(apiUrlWithParams);

        // Open a connection
        HttpURLConnection connection = null;
        try {
            connection = (HttpURLConnection) url.openConnection();

            // Set the request method to GET
            connection.setRequestMethod("POST");

            // Set request headers
            connection.setRequestProperty("accept", "application/json");
            connection.setRequestProperty("Content-Type", "application/json");
            connection.setRequestProperty("Authorization", authorizationHeader);

	    connection.setDoOutput(true);
	    String body = ("{ \"conversationHistory\": " + conversationHistory + " }"); 
	    System.out.println("Body " + body);
	    connection.getOutputStream().write(body.getBytes());

            // Get the response code
            int responseCode = connection.getResponseCode();
            System.out.println("Response Code: " + responseCode);

            // Read the response
            StringBuilder response = new StringBuilder();
            try (BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
                String line;
                while ((line = reader.readLine()) != null) {
                    response.append(line);
                }
            }
            return response.toString();
        } finally {
            if (connection == null) {
                // Close the connection
                connection.disconnect();
            }
        }
    }
}
curl -X POST 'https://ragapps.dataworkz.com/api/qna/v1/agents/79596cb6-fae8-47dd-8540-d3bf5c6f0748/response?llmProviderId=b5e6e2bf-e4d3-4dc9-be4c-5ae8c5b175e6&userText=What%20is%20the%20returns%20process%3F' \
-H  "Authorization: SSWS $TOKEN" -H "Content-Type: application/json" \
-d '{"conversationHistory":[{"by":"USER", "text":"Hi"}, {"by":"AI", "text":"Hi"}]}'

To generate an API key for interacting with these APIs, please follow the steps outlined in the "API key generation" section.

Get answer to the question asked or use as chat api

Ask a simple question to a specific QnA system or ask a question in the context of a conversation and leverage RAG techniques to get the question answered based on the data corpus configured for that QnA system. You should specify the LLM to use from the ones configured for this QnA system. Note that for chat type conversations (i.e. with conversation history) you are limited to gpt-4 and llama3-70B models. You can pass filter expressions to control the data retrieval process. Optionally, flags can be passed to configure the RAG engine behaviour. Each request is associated with an id to perform additional actions later.

post

/qna/v1/systems/{systemId}/answer

Authorizations
Path parameters
systemIdstringrequired

Id of the QnA system

Example: 3756809c-4032-4e48-b3f0-2a6d30a03a54
Query parameters
questionTextstringrequired

Text of the question asked to the QnA system

Example: Example to join 2 datasets in S3 and write the output to MongoDB
llmProviderIdstringrequired

Reference to Large language model to use for parts of the pipeline such as Generate Answer and Query Rewriting.

Example: 774c246b-a079-4fa5-b3dc-4a82b35aa258
filterstring

Filter expression to apply to data retrieval

Example: version in ('1.2', '2.0')
propertiesstring

Flags to control behaviour. Format is Key=value pairs separated by ; Supported flags - include_probe : Default is true. Set to false to disable returning probe data with request

Example: include_probe=false;context=3
Header parameters
Authorizationany

For Dataworkz API Token use the format 'SSWS <token>' and for OAuth2 generated JWT token use 'Bearer <token>'

Body
object
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/api/qna/v1/systems/{systemId}/answer?questionText=text&llmProviderId=text' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "conversationHistory": [
      {
        "by": "USER",
        "text": "Hi"
      },
      {
        "by": "AI",
        "text": "Hi! How can I assist you today?"
      },
      {
        "by": "USER",
        "text": "I would like status for order 33"
      },
      {
        "by": "AI",
        "text": "Order 33 is delayed. Would you like more details?"
      }
    ]
  }'
200
{
  "answer": "This is the answer based on system id and question text",
  "type": "Dataworkz",
  "questionText": "question Text",
  "questionUuid": "6b807b37-0c41-4cd9-a420-7d2dc9170fe9",
  "context": [
    {
      "source": "",
      "type": "",
      "data": "",
      "link": ""
    }
  ]
}

successful operation

Get a list of all agents in this account

Get a list of all agents in this account - id, name, description

get

/qna/v1/agents

Authorizations
Header parameters
Authorizationany

For Dataworkz API Token use the format 'SSWS <token>' and for OAuth2 generated JWT token use 'Bearer <token>'

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '/api/qna/v1/agents' \
  --header 'Authorization: YOUR_API_KEY'
200
text

successful operation

Get the agent's response to user text

For the given agent specified by the agentId, get the agent's response for the user's text and the conversation history

post

/qna/v1/agents/{agentId}/response

Authorizations
Path parameters
agentIdstringrequired

Id of the Agent in the system

Example: 3756809c-4032-4e48-b3f0-2a6d30a03a54
Query parameters
userTextstringrequired

The last text from the user

Example: What is the status of the order?
llmProviderIdstringrequired

id of the LLM to use with the agent. This must be one of the LLMs configured in this account. Currently, gpt-4 and llama3-70B models are supported.

Example: 3756809c-4032-4e48-b3f0-2a6d30a03a54
propertiesstring

Any additional properties to be passed to influence execution

Header parameters
Authorizationany

For Dataworkz API Token use the format 'SSWS <token>' and for OAuth2 generated JWT token use 'Bearer <token>'

Body
object
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/api/qna/v1/agents/{agentId}/response?userText=text&llmProviderId=text' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "conversationHistory": [
      {
        "by": "USER",
        "text": "Hi"
      },
      {
        "by": "AI",
        "text": "Hi! How can I assist you today?"
      },
      {
        "by": "USER",
        "text": "I would like status for order 33"
      },
      {
        "by": "AI",
        "text": "Order 33 is delayed. Would you like more details?"
      }
    ]
  }'
200
{}

successful operation

  • GETGet all QnA systems configured in this account
  • GETGet details of a specific QnA system
  • GETGet LLM providers configured for a given QnA system
  • GETGet answer to the question asked
  • GETSemantic Enterprise Search for the provided query
  • GETGet list of all filters with metadata
  • GETGet list of all questions asked by a user in last 6 months
  • GETGet details about previously asked question
  • POSTGet answer to the question asked or use as chat api
  • GETGet a list of all agents in this account
  • POSTGet the agent's response to user text

Get all QnA systems configured in this account

Returns a map containing unique identifier and name for all QnA systems that have been set up in Dataworkz

get

/qna/v1/systems

Authorizations
Header parameters
Authorizationany

For Dataworkz API Token use the format 'SSWS <token>' and for OAuth2 generated JWT token use 'Bearer <token>'

Responses
application/json
cURL
JavaScript
Python
HTTP
200

successful operation

Get details of a specific QnA system

Get details of a specific QnA system

get

/qna/v1/systems/{systemId}

Authorizations
Path parameters
systemIdstringrequired

Id of the QnA system

Example: 3756809c-4032-4e48-b3f0-2a6d30a03a54
Header parameters
Authorizationany

For Dataworkz API Token use the format 'SSWS <token>' and for OAuth2 generated JWT token use 'Bearer <token>'

Responses
application/json
cURL
JavaScript
Python
HTTP
200

successful operation

Get LLM providers configured for a given QnA system

Returns a map containing unique identifier and LLM models that have been configured for a given QnA system

get

/qna/v1/systems/{systemId}/llm-providers

Authorizations
Path parameters
systemIdstringrequired

Id of the QnA system

Example: 3756809c-4032-4e48-b3f0-2a6d30a03a54
Header parameters
Authorizationany

For Dataworkz API Token use the format 'SSWS <token>' and for OAuth2 generated JWT token use 'Bearer <token>'

Responses
application/json
cURL
JavaScript
Python
HTTP
200

successful operation

Get answer to the question asked

Ask a question to a specific QnA system and leverage RAG techniques to get the question answered based on the data corpus configured for that QnA system. You should specify the LLM to use from the ones configured for this QnA system. You can pass filter expressions to control the data retrieval process. Optionally, flags can be passed to configure the RAG engine behaviour. Each request is associated with an id to perform additional actions later.

get

/qna/v1/systems/{systemId}/answer

Authorizations
Path parameters
systemIdstringrequired

Id of the QnA system

Example: 3756809c-4032-4e48-b3f0-2a6d30a03a54
Query parameters
questionTextstringrequired

Text of the question asked to the QnA system

Example: Example to join 2 datasets in S3 and write the output to MongoDB
llmProviderIdstringrequired

Reference to Large language model to use for parts of the pipeline such as Generate Answer and Query Rewriting.

Example: 774c246b-a079-4fa5-b3dc-4a82b35aa258
filterstring

Filter expression to apply to data retrieval

Example: version in ('1.2', '2.0')
propertiesstring

Flags to control behaviour. Format is Key=value pairs separated by ; Supported flags - include_probe : Default is true. Set to false to disable returning probe data with request

Example: include_probe=false;context=3
Header parameters
Authorizationany

For Dataworkz API Token use the format 'SSWS <token>' and for OAuth2 generated JWT token use 'Bearer <token>'

Responses
application/json
cURL
JavaScript
Python
HTTP
200

successful operation

Semantic Enterprise Search for the provided query

Get a list of search results from the configured system that semantically match the query asked based on similarity with the data corpus configured for that QnA system. You can pass filter expressions to control the data retrieval process. Optionally, flags can be passed to configure the RAG engine behaviour. Each request is associated with an id to perform additional actions later.

get

/qna/v1/systems/{systemId}/search

Authorizations
Path parameters
systemIdstringrequired

Id of the QnA system

Example: 3756809c-4032-4e48-b3f0-2a6d30a03a54
Query parameters
querystringrequired

search query terms

Example: Example to join 2 datasets in S3 and write the output to MongoDB
llmProviderIdstring

Reference to Large language model to use for parts of the pipeline such as Query Rewriting. Will only be used if required.

Example: 774c246b-a079-4fa5-b3dc-4a82b35aa258
filterstring

Filter expression to apply to data retrieval

Example: version in ('1.2', '2.0')
propertiesstring

Flags to control behaviour. Format is Key=value pairs separated by ; Supported flags - include_probe : Default is true. Set to false to disable returning probe data with request

Example: include_probe=false;context=3
Header parameters
Authorizationany

For Dataworkz API Token use the format 'SSWS <token>' and for OAuth2 generated JWT token use 'Bearer <token>'

Responses
application/json
cURL
JavaScript
Python
HTTP
200

successful operation

Get list of all filters with metadata

Get a list of all filters associated with this system and their metadata which includes their datatype, cardinality and values (for low cardinality filters)

get

/qna/v1/systems/{systemId}/filters

Authorizations
Path parameters
systemIdstringrequired

Id of the QnA system

Example: 3756809c-4032-4e48-b3f0-2a6d30a03a54
Header parameters
Authorizationany

For Dataworkz API Token use the format 'SSWS <token>' and for OAuth2 generated JWT token use 'Bearer <token>'

Responses
application/json
cURL
JavaScript
Python
HTTP
200

successful operation

Get list of all questions asked by a user in last 6 months

Get list of all questions that have been asked by a user in last 6 months from a QnA system

get

/qna/v1/systems/{systemId}/questionshistory

Authorizations
Path parameters
systemIdstringrequired

Id of the QnA system

Example: 3756809c-4032-4e48-b3f0-2a6d30a03a54
Header parameters
Authorizationany

For Dataworkz API Token use the format 'SSWS <token>' and for OAuth2 generated JWT token use 'Bearer <token>'

Responses
application/json
cURL
JavaScript
Python
HTTP
200

successful operation

Get details about previously asked question

Get details about any question that had been asked previously by a user from a QnA system

get

/qna/v1/systems/{systemId}/questions/{questionId}

Authorizations
Path parameters
systemIdstringrequired

Id of the QnA system

Example: 3756809c-4032-4e48-b3f0-2a6d30a03a54
questionIdstringrequired

Id of the answer request

Example: a647381-1087-6e98-b3f0-5o9876a03a54
Header parameters
Authorizationany

For Dataworkz API Token use the format 'SSWS <token>' and for OAuth2 generated JWT token use 'Bearer <token>'

Responses
application/json
cURL
JavaScript
Python
HTTP
200

successful operation

curl -L \
  --url '/api/qna/v1/systems' \
  --header 'Authorization: YOUR_API_KEY'
{
  "f9c5aa7e-57a9-4f77-9e91-e8b37eb46": "Security Policies QnA"
}
curl -L \
  --url '/api/qna/v1/systems/{systemId}' \
  --header 'Authorization: YOUR_API_KEY'
{
  "uuid": "f9c5aa7e-57a9-4f77-9e91-e8b37eb46c18",
  "name": "mdb",
  "mode": "qa",
  "prompt": "this is a prompt",
  "dimensions": "0",
  "database": "mongodb",
  "params": "{}"
}
curl -L \
  --url '/api/qna/v1/systems/{systemId}/llm-providers' \
  --header 'Authorization: YOUR_API_KEY'
{
  "47b51bb5-bdfa-413d-8bfa-ff040ab1c901": "llama-2-13b-chat"
}
curl -L \
  --url '/api/qna/v1/systems/{systemId}/answer?questionText=text&llmProviderId=text' \
  --header 'Authorization: YOUR_API_KEY'
{
  "answer": "This is the answer based on system id and question text",
  "type": "Dataworkz",
  "questionText": "question Text",
  "questionUuid": "6b807b37-0c41-4cd9-a420-7d2dc9170fe9",
  "context": [
    {
      "source": "",
      "type": "",
      "data": "",
      "link": ""
    }
  ]
}
curl -L \
  --url '/api/qna/v1/systems/{systemId}/search?query=text' \
  --header 'Authorization: YOUR_API_KEY'
{
  "answer": "This is the answer based on system id and question text",
  "type": "Dataworkz",
  "query": "question Text",
  "questionUuid": "6b807b37-0c41-4cd9-a420-7d2dc9170fe9",
  "context": [
    {
      "source": "",
      "type": "",
      "data": "",
      "link": ""
    }
  ]
}
curl -L \
  --url '/api/qna/v1/systems/{systemId}/filters' \
  --header 'Authorization: YOUR_API_KEY'
{
  "filters": [
    {
      "name": "year",
      "type": "integer",
      "description": "The year that the data was published",
      "cardinality": 3,
      "values": [
        2021,
        2022,
        2023
      ]
    }
  ]
}
curl -L \
  --url '/api/qna/v1/systems/{systemId}/questionshistory' \
  --header 'Authorization: YOUR_API_KEY'
{
  "llm_response": {
    "answer": "This is the answer based on system id and question text",
    "type": "Dataworkz",
    "questionText": "question Text",
    "questionUuid": "6b807b37-0c41-4cd9-a420-7d2dc9170fe9",
    "context": [
      {
        "source": "",
        "type": "",
        "data": "",
        "link": ""
      }
    ]
  },
  "activity_response_date": "2024-01-04T05:49:01.000+00:00",
  "comments": "",
  "llm_model": "",
  "retrival_relevance": "",
  "retrival_context_recall": "",
  "generation_groundedness": "",
  "generation_correctness": "",
  "generation_relevance": "",
  "generation_confidence_score": "",
  "response_sentiment": "",
  "expert_comments": "",
  "expert_sentiment": ""
}
curl -L \
  --url '/api/qna/v1/systems/{systemId}/questions/{questionId}' \
  --header 'Authorization: YOUR_API_KEY'
{
  "llm_response": {
    "answer": "This is the answer based on system id and question text",
    "type": "Dataworkz",
    "questionText": "question Text",
    "questionUuid": "6b807b37-0c41-4cd9-a420-7d2dc9170fe9",
    "context": [
      {
        "source": "",
        "type": "",
        "data": "",
        "link": ""
      }
    ]
  },
  "activity_response_date": "2024-01-04T05:49:01.000+00:00",
  "comments": "",
  "llm_model": "",
  "retrival_relevance": "",
  "retrival_context_recall": "",
  "generation_groundedness": "",
  "generation_correctness": "",
  "generation_relevance": "",
  "generation_confidence_score": "",
  "response_sentiment": "",
  "expert_comments": "",
  "expert_sentiment": ""
}