cohere-ai

What is cohere-ai?

The cohere-ai npm package provides access to Cohere's natural language processing (NLP) models, enabling developers to integrate advanced language understanding and generation capabilities into their applications. This includes functionalities such as text generation, text classification, and language detection.

What are cohere-ai's main functionalities?

Text Generation

This feature allows you to generate text based on a given prompt. The code sample initializes the cohere-ai package, sets the API key, and generates text using the 'large' model with a prompt 'Once upon a time'.

const cohere = require('cohere-ai');
cohere.init('YOUR_API_KEY');

async function generateText() {
  const response = await cohere.generate({
    model: 'large',
    prompt: 'Once upon a time',
    max_tokens: 50
  });
  console.log(response.body.generations[0].text);
}
generateText();

Text Classification

This feature allows you to classify text into predefined categories. The code sample initializes the cohere-ai package, sets the API key, and classifies the given inputs using the 'large' model.

const cohere = require('cohere-ai');
cohere.init('YOUR_API_KEY');

async function classifyText() {
  const response = await cohere.classify({
    model: 'large',
    inputs: ['I love programming', 'I hate bugs']
  });
  console.log(response.body.classifications);
}
classifyText();

Language Detection

This feature allows you to detect the language of given texts. The code sample initializes the cohere-ai package, sets the API key, and detects the languages of the provided texts.

const cohere = require('cohere-ai');
cohere.init('YOUR_API_KEY');

async function detectLanguage() {
  const response = await cohere.detectLanguage({
    texts: ['Hello, how are you?', 'Bonjour, comment ça va?']
  });
  console.log(response.body.results);
}
detectLanguage();

Other packages similar to cohere-ai

openai

The openai npm package provides access to OpenAI's GPT-3 models, which offer similar functionalities such as text generation, text classification, and more. OpenAI's models are known for their high quality and versatility, making them a strong alternative to Cohere's offerings.

huggingface

The huggingface npm package provides access to Hugging Face's Transformers library, which includes a wide range of pre-trained models for tasks like text generation, classification, and language translation. Hugging Face is known for its extensive model repository and active community support.

wit

The wit npm package provides access to Wit.ai's natural language processing capabilities, including intent recognition and entity extraction. Wit.ai is particularly strong in building conversational interfaces and is backed by Facebook.

README

Welcome to the Cohere AI Node.js SDK.

This package provides functionality developed to simplify interfacing with the cohere.ai natural language API. This SDK provides support for both TypeScript and JavaScript Node.js projects. For a full description of the API please visit the Cohere Docs.

Installation

Install the package as a dependency.

npm install cohere-ai

Usage

Import the library to your node.js project.

const cohere = require("cohere-ai");

Initialize the library using the latest version of the API.

cohere.init("YOUR_API_KEY");

Or optionally initialize with a specific version. (Learn about versions here.)

cohere.init("YOUR_API_KEY", "2021-11-08");

Call the endpoint function you'd like to hit to interact with the Cohere API.

cohere.generate("MODEL_NAME", config);

Endpoints

For a full breakdown of endpoints and their config objects please consult the Cohere Docs.

Cohere Endpoint	Function
/generate	cohere.generate()
/embed	cohere.embed()
/classify	cohere.classify()
/tokenize	cohere.tokenize()

Models

To view an up to date list of available models please consult the Cohere CLI. To get started try out large.

Responses

All of the endpoint functions will return a response structure. For a detailed breakdown of the response body visit the Cohere Docs.

{
  statusCode: STATUS,
  body: RESPONSE_OBJ
}

Code Examples:

(async () => {
  cohere.init(process.env.COHERE_API_KEY);

  // Hit the `generate` endpoint on the `large` model
  const generateResponse = await cohere.generate({
    model: "large",
    prompt: "Once upon a time in a magical land called",
    max_tokens: 50,
    temperature: 1,
  });

  /*
  {
    statusCode: 200,
    body: {
      text: "Eldorado, the anointed monarchs of the ancient world and the ruling family were divided into three kingdoms, each of which was ruled by an individual leader."
    }
  }
  */
})();

Example error response:

// error response from cohere.generate() where api key was not previously provided.
{
  statusCode: 403,
  body: {
    message: "Whoops! You need to provide an API key before making requests. Try cohere.init(YOUR_KEY)."
  }
}

TypeScript support

Import the package as a class.

import cohere = require("cohere-ai");

Require the cohere package as usual, and the ./index.d.ts file will be imported by typescript automatically.

cohere-node package readme

If you'd like to help contribute to the package library itself or modify it locally, please check the development instructions readme.