huggingface-api

A simple wrapper for the Huggingface api.

Example

Javascript

1const hf = require('huggingface-api')
2
3hf.request({
4	text: 'My name is Jeff and',
5	model: 'EleutherAI/gpt-neo-2.7B',
6	api_key: 'api_[API KEY REDACTED]',
7	return_type: 'STRING'
8}).then((data) => {
9	console.log(data)
10})

Typescript

1import * as hf from 'huggingface-api'
2
3hf.request({
4	text: 'My name is Jeff and',
5	model: 'EleutherAI/gpt-neo-2.7B',
6	api_key: 'api_[API KEY REDACTED]',
7	return_type: 'STRING'
8}).then((data) => {
9	console.log(data)
10})

In-depth

request

1export declare function request(data: Data): Promise<any>

Data is an argument containing the request data:

1export interface Data {
2	text?: string
3	file?: string
4	api_key: string
5	model: string
6	return_type: 'FULL' | 'OBJ' | 'STRING'
7}

text: The text you want to submit. file: If you want to read the text from a file, use this.

NOTE: If both text and file are used, text has a priority

api_key: Your huggingface api key. This can be found in here model: Name of the model.

If you are on the page of the model, the name eg. the EleutherAI/gpt-neo-2.7B part of huggingface.co/EleutherAI/gpt-neo-2.7B

return_type: How is the data returned: FULL

1[
2	{
3		generated_text: 'Something...'
4	}
5]

OBJ

1{
2	generated_text: 'Something...'
3}

STRING

1'Something...'