提示完成

创建提示完成

POST /prompts/:id/completions

为在 Portkey 的提示选项卡中创建的给定提示 ID 创建一个完成。

为选定的提示 ID 创建完成

POST https://api.portkey.ai/v1/prompts/:id/completions

路径参数

名称	类型	描述
id*	字符串	用于完成请求的提示 ID。

请求体

名称	类型	描述
variables*	对象	提示模板中提到的变量。
hyperparameters	多个	添加任何超参数以覆盖提示定义中的设置。
stream	布尔值	使用服务器推送事件增量流式传输响应。默认为 false。

200: OK

API期望提示 ID、提示变量，和可选的任何超参数用于此请求。它返回统一格式的聊天完成或完成对象，符合OpenAI签名。

SDK 使用

prompts.completions.create 方法在 Portkey SDK 中提供了一种生成提示完成的方法。

方法签名

NodeJS

prompt.completions.create(promptParams)

Python

参数

• promptParams (对象): 提示完成请求的参数，包括 promptID、变量以及可选的任何超参数。

示例用法

NodeJS

import Portkey from 'portkey-ai'

const portkey = new Portkey({
    apiKey: "PORTKEY_API_KEY",
})

// Make the prompt creation call with the variables
const promptCompletion = await portkey.prompts.completions.create({
    promptID: "Your Prompt ID",
    variables: {
       // The variables specified in the prompt
    }
})

// We can also override the hyperparameters
const promptCompletion = await portkey.prompts.completions.create({
    promptID: "Your Prompt ID",
    variables: {
       // The variables specified in the prompt
    },
    max_tokens: 250,
    presence_penalty: 0.2
})

Python

REST

流式模式

使用新的 /prompts/:id/completions 路由时，如果希望流式返回响应，必须设置 stream:True。 这与之前可以在 Portkey 提示游乐场 UI 中切换流式模式并自动返回流式响应的情况有所不同。 现在，无论提示游乐场中的流式切换状态如何，如果您希望使用流式模式，必须在发起调用时将其设置为 true。

NodeJS

const streamPromptCompletion = await portkey.prompts.completions.create({
    promptID: "Your Prompt ID",
    variables: {
       // The variables specified in the prompt
    },
    stream: true // Defaults to false
})

Python

REST API