3.2.0 • Published 2 years ago

humanloop-typescript-sdk v3.2.0

Weekly downloads
-
License
Unlicense
Repository
github
Last release
2 years ago

humanloop-typescript-sdk@3.2.0

This library that utilizes axios. The generated Node module can be used in the following environments:

Environment

  • Node.js
  • Webpack
  • Browserify

Language level

  • ES5 - you must have a Promises/A+ library installed
  • ES6

Module system

  • CommonJS
  • ES6 module system

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Consuming

navigate to the folder of your consuming project and run the following command.

npm install humanloop-typescript-sdk@3.2.0 --save

Getting Started

import { Humanloop } from "humanloop-typescript-sdk"

const humanloop = new Humanloop({
    // Defining the base path is optional and defaults to https://api.humanloop.com/v3
    // basePath: "https://api.humanloop.com/v3",
    apiKey: 'API_KEY',
})

const submitResponse = await humanloop.feedback({
        "type": "string_example",
    })

console.log(submitResponse)

const generateResponse = await humanloop.generate({
        "project": "project_example",
        "inputs": {},
        "provider_api_keys": {
        },
        "num_samples": 1,
        "stream": false,
        "model_config": {
            "model": "model_example",
            "prompt_template": "prompt_template_example",
            "temperature": 1,
            "max_tokens": 16,
            "top_p": 1,
            "presence_penalty": 0,
            "frequency_penalty": 0,
        },
    })

console.log(generateResponse)

const logResponse = await humanloop.log({
        "project": "project_example",
        "inputs": {},
        "output": "output_example",
    })

console.log(logResponse)

Documentation for API Endpoints

All URIs are relative to https://api.humanloop.com/v3

ClassMethodHTTP requestDescription
ExperimentsApicreatePOST /projects/{project_id}/experimentsCreate Project Experiment
ExperimentsApideleteDELETE /experiments/{experiment_id}Delete Experiment
ExperimentsApigetModelConfigGET /experiments/{experiment_id}/model-configGet Model Config From Experiment
ExperimentsApilistGET /projects/{project_id}/experimentsGet Project Experiments
ExperimentsApiupdatePATCH /experiments/{experiment_id}Update Experiment
FeedbackApisubmitPOST /feedbackFeedback
GenerateApigeneratePOST /generateGenerate
LogsApilogPOST /logsLog
MetricsApicreatePOST /projects/{project_id}/metricsCreate Metric
MetricsApideleteDELETE /projects/{project_id}/metrics/{metric_id}Delete Metric
MetricsApilistGET /projects/{project_id}/metricsGet Metrics
MetricsApiupdatePATCH /projects/{project_id}/metrics/{metric_id}Update Metric
ModelConfigsApigetGET /model-configs/{id}Get Model Config
ModelConfigsApiregisterPOST /model-configsRegister Project Model Config
OrganizationsApicreateToolPOST /organizations/{id}/toolsCreate Organization Tool
OrganizationsApigetGET /organizations/{id}Get Organization
OrganizationsApigetApiKeysGET /organizations/{id}/api-keysGet Api Keys
OrganizationsApigetSubscriptionsGET /organizations/{id}/subscriptionsGet Organization Subscriptions
OrganizationsApigetToolsGET /organizations/{id}/toolsGet Organization Tools
OrganizationsApiremoveUserDELETE /organizations/{id}/users/{user_id}Remove User From Organization
OrganizationsApiupdatePATCH /organizations/{id}Update Organization
OrganizationsApiupdateToolPATCH /organizations/{id}/tools/{tool_id}Update Organization Tool
OrganizationsApiupdateUserRolePUT /organizations/{id}/users/{user_id}/roleUpdate Organization User Role
ProjectsApicreatePOST /projectsCreate Project
ProjectsApideleteActiveExperimentDELETE /projects/{id}/active-experimentDelete Active Experiment
ProjectsApideleteActiveModelConfigDELETE /projects/{id}/active-model-configDelete Active Model Config
ProjectsApiexportDatapointsPOST /projects/{id}/exportExport Datapoints
ProjectsApigetGET /projects/{id}Get Project
ProjectsApigetModelConfigGET /projects/{id}/model-configGet Model Config From Project
ProjectsApigetModelConfigsGET /projects/{id}/model-configsGet Project Model Configs
ProjectsApilistGET /projectsGet Projects
ProjectsApiupdatePATCH /projects/{id}Update Project
ProjectsApiupdateFeedbackTypesPATCH /projects/{id}/feedback-typesUpdate Feedback Types
ToolsApigetSpecsGET /toolsGet Tool Specs
3.2.0

2 years ago

3.1.0

2 years ago

3.0.0

2 years ago

2.3.0

2 years ago

2.2.0

2 years ago

2.1.0

2 years ago

2.0.0

2 years ago

1.0.0

2 years ago