Skip to content

Latest commit

 

History

History
94 lines (65 loc) · 3.93 KB

openai.md

File metadata and controls

94 lines (65 loc) · 3.93 KB

OpenAI

OpenAI

OpenAI is an artificial intelligence (AI) research and deployment company. They aim to ensure that artificial general intelligence (AGI)—by which they mean highly autonomous systems that outperform humans at most economically valuable work—benefits all of humanity. OpenAI conducts fundamental, long-term research toward the creation of safe AGI. They also build and release AI systems such as ChatGPT and DALL-E, with the goal of pushing the boundaries of AI capabilities while prioritizing ethical considerations and safety. OpenAI is dedicated to ensuring that their technology is used responsibly and for the betterment of society.

Interface Name

  • openai

Example Usage

const { LLMInterface } = require('llm-interface');

LLMInterface.setApiKey({'openai': process.env.OPENAI_API_KEY});

async function main() {
  try {
    const response = await LLMInterface.sendMessage('openai', 'Explain the importance of low latency LLMs.');
    console.log(response.results);
  } catch (error) {
    console.error(error);
    throw error;
  }
}

main();

Model Aliases

The following model aliases are provided for this provider.

  • default: gpt-3.5-turbo
  • large: gpt-4o
  • small: gpt-3.5-turbo
  • agent: gpt-4o

Embeddings Model Aliases

  • default: text-embedding-ada-002
  • large: text-embedding-3-large
  • small: text-embedding-3-small

Options

The following parameters can be passed through options.

  • frequency_penalty: Details not available, please refer to the LLM provider documentation.
  • function_call: Details not available, please refer to the LLM provider documentation.
  • functions: Details not available, please refer to the LLM provider documentation.
  • logit_bias: Details not available, please refer to the LLM provider documentation.
  • logprobs: Details not available, please refer to the LLM provider documentation.
  • max_tokens: Details not available, please refer to the LLM provider documentation.
  • n: Details not available, please refer to the LLM provider documentation.
  • parallel_tool_calls: Details not available, please refer to the LLM provider documentation.
  • presence_penalty: Details not available, please refer to the LLM provider documentation.
  • response_format: Details not available, please refer to the LLM provider documentation.
  • seed: Details not available, please refer to the LLM provider documentation.
  • service_tier: Details not available, please refer to the LLM provider documentation.
  • stop: Details not available, please refer to the LLM provider documentation.
  • stream: Details not available, please refer to the LLM provider documentation.
  • stream_options: Details not available, please refer to the LLM provider documentation.
  • temperature: Details not available, please refer to the LLM provider documentation.
  • tool_choice: Details not available, please refer to the LLM provider documentation.
  • tools: Details not available, please refer to the LLM provider documentation.
  • top_logprobs: Details not available, please refer to the LLM provider documentation.
  • top_p: Details not available, please refer to the LLM provider documentation.
  • user: Details not available, please refer to the LLM provider documentation.

Features

  • Native JSON Mode
  • Streaming
  • Functions
  • Tools
  • Embeddings

Getting an API Key

Commercial (Credit Card Required): The OpenAI API is a commercial product and requires a credit card to get started.

To get an API key, first create an OpenAI account, then visit the link below.

OpenAI Documentation

OpenAI documentation is available here.