Completions

Create Completion

Description

Given a user’s input, runs LLM inference to produce the model’s response.

Details

LLM completions have many use cases, such as content summarization, question-answering, and text generation.

The model parameter determines which LLM will be used to generate the completion. Keep in mind that different models have varying sizes, costs, and may perform differently across different tasks.

The user input, commonly referred to as the “prompt”, is a required field in the request body. The quality of the model’s response can vary greatly depending on the input prompt. Good prompt engineering can significantly enhance the response quality. If you encounter suboptimal results, consider writing more specific instructions or providing examples to the LLM before trying more expensive techniques such as swapping in other models or finetuning.

By default, the endpoint will return the entire response as one whole object. If you would prefer to stream the completion in real-time, you can achieve this by setting the stream flag to true.

POST

completions

import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const completionsResponse = await client.completions.create({ model: 'gpt-4', prompt: 'prompt' });

  console.log(completionsResponse.completion);
}

main();

{
  "completion": {
    "text": "<string>",
    "finish_reason": "<string>",
    "response_metadata": {}
  },
  "token_usage": {
    "prompt": 123,
    "completion": 123,
    "total": 123
  }
}

Authorizations

x-api-key

string

header

required

Body

application/json

Response

200

application/json

Successful Response

The response is of type object.

Execute Agent Create Chat Completion

import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const completionsResponse = await client.completions.create({ model: 'gpt-4', prompt: 'prompt' });

  console.log(completionsResponse.completion);
}

main();

{
  "completion": {
    "text": "<string>",
    "finish_reason": "<string>",
    "response_metadata": {}
  },
  "token_usage": {
    "prompt": 123,
    "completion": 123,
    "total": 123
  }
}

Knowledge Bases

Chunks

Agents

Completions

Chat Completions

Models

Users

Accounts

Organizations

Question Sets

Evaluations

Evaluation Configs

Evaluation Datasets

Studio Projects

Application Specs

Questions

Knowledge Base Data Sources

Model Templates V3 (Beta)

Model server

API Reference

Fine Tuning Jobs V3 (Beta)

Training Datasets V3 (Beta)

package deployments

Beta

Applications

ChatThreads

Interactions

MonitoringDashboard

Chat Themes

account groups

account