GPT[/v1/chat/completions]接口参数详解
2023-08-22 15:10:18 22 举报AI智能生成
GPT[/v1/chat/completions]接口是用于获取模型生成文本的接口。它接受以下参数： - func_name：要调用的函数名，例如“TTS”表示文本转语音。 - args：传递给函数的参数，可以是字符串、数字或其他类型的数据。 - intent：要执行的操作，例如“TTS”表示将文本转换为语音。 - parameters：与intent相关的参数，例如在TTS操作中，parameters可以包含要转换的文本和语言代码。 该接口返回一个JSON对象，其中包含生成的文本或执行操作的结果。您可以使用此接口来构建自定义应用程序，以便与模型进行交互并利用其强大的自然语言处理能力。
作者其他创作
大纲/内容
stream
类型
布尔值或null
是否必需
否
默认值
false
说明
用于控制生成文本的输出方式，如果将stream参数设置为true，则文本将以流的方式输出，即在生成文本的同时输出文本，而不是等待文本生成完成后再输出。这个参数适用于需要及时输出文本的场景。
stop
类型
字符串/数组/null
是否必需
否
默认值
null
说明
用于停止生成并返回结果。这个参数可以是单词或短语列表，当模型生成包含这些单词/短语的文本时，它将停止。这通常用于在生成过程中控制输出内容。用户可以自定义“stop"参数，具体应用能够节省比返回文本之后对结果进行筛选所需的时间更长时间和资源。
max_tokens（最大令牌数）
类型
整数
是否必需
否
默认值
无限制
说明
用于控制生成文本的最大长度(以令牌数为单位)。对于生成的文本长度有严格限制的任务(如推荐系统中的短文本生成)，可以设置较小的max_tokens值，以确保生成的文本符合预期的长度限制。而对于需亚生成较长的文本(如文章生成)，则可以增加max_tokens值以获得更多的生成文本。
GPT-4
gpt-4
8,192 tokens
gpt-4-0613
8,192 tokens
gpt-4-32k
32,768 tokens
gpt-4-32k-0613
32,768 tokens
GPT-3.5
gpt-3.5-turbo
4,096 tokens
gpt-3.5-turbo-16k
16,384 tokens
gpt-3.5-turbo-0613
4,096 tokens
gpt-3.5-turbo-16k-0613
16,384 tokens
presence_penalty（存在惩罚）
类型
数字或null
是否必需
否
默认值
0
说明
介于-2.0和2.0之间的数字。控制文本同一词汇重复情况，当此参数值大于0时，将鼓动模型生成不同的单词，并尽可能避免使用已经在之前生成的文本中出现过的单词。如 presence_penalry值越大，生成的文本中不同单词的数量可能越多，如果presence_penalty值为0，则不会考虑之前生成的单词，并且每次生成的单运明率分布都是相同的，例如，在文本生成任务中，如果需要鼓励生成不同的单词，并月避免使用相同的单词，可以增大presence_penalty的值。
frequency_penalty（频率惩罚）
类型
数字或null
是否必需
否
默认值
0
说明
介于-2.0和2.0之间的数字。控制文本罕见词汇出现情况，当此参数值大于0时，将抑制模型生成频繁出现的单词，并鼓助生成罕见的单词。如果frequency_penalty值越大，生成的文本中罕见单词的数量可能越多。如果frequency_penalty为0，则不会考单词的频率，并且每次生成的单词概率分布都是相同 的，如果需要鼓励生成罕见的单词，可以增大frequency_penalty的值。
logit_bias（对数偏差）
类型
map
是否必需
否
默认值
null
说明
接受一个json 对象，该对象将标记(由标记器中的标记ID 指定)映射到从 -100 到100 的关联偏差值。从数学上讲，偏差会在采样之前添加到模型生成的 logits 中确切的效果因模型而异，但-1和1之间的值应该会减少或增加选择的可能性;像100 或100 这样的值应该导致相关令牌的禁止或独占选择。
user（用户）
类型
字符串
是否必需
否
说明
代表您的最终用户的唯一标识符，可以帮助OpenAI监视和检测滥用情况。
model（模型）
类型
字符串
是否必需
是
说明
要使用的模型的ID。关于哪些模型可以与Chat API一起工作的详细信息，请查阅模型端点兼容性表。
messages（消息）
类型
数组
是否必需
是
说明
迄今为止构成对话的消息列表。
属性
role
类型
字符串
是否必须
是
描述
消息作者的角色。可能为system（系统）、user（用户）、assistant（助手）或function（函数）。
content
类型
字符串或null
是否必须
是
描述
消息的内容。所有消息都需要content，对于具有函数调用的助手消息，其内容可以为null。
name
类型
字符串
是否必须
否
描述
本消息的作者的名称。如果角色是function（函数），则需要name，并且应为其反应在content中的函数的名称。可能包含a-z、A-Z、0-9和下划线，最大长度为64个字符。
function_call
类型
对象
是否必须
否
描述
应该被调用的函数的名称和参数，由模型生成。
functions（函数）
类型
数组
是否必需
否
说明
模型可能为其生成JSON输入的函数列表。
function_call（函数调用）
类型
字符串或对象
是否必需
否
说明
控制模型如何响应函数调用。"none"表示模型不调用函数，并响应最终用户。"auto"表示模型可以选择最终用户或调用函数。通过{"name":"my_function"}指定特定的函数将强制模型调用该函数。没有函数时，默认为"none"。有函数时，默认为"auto"。
temperature（温度）
类型
数字或null
是否必需
否
默认值
1
说明
控制生成文本的多样性，较高的Temperature会导致生成的文本更具有创造性和多样性，但是也可能会导致生成的文本不够准确和不可信，较低的Temperature会导致生成的文本更加保守和保险，但是可能会过于死板和缺乏新意。因此，在设置 Temperature值时需要权衡准动性和多样性之间的平衡。
top_p
类型
数字或null
是否必需
否
默认值
1
说明
控制生成文本的多样性和保真度，top_p会根据生成文本的概率分布，只保留前面哪率之和达到一定阈值的词语，然后再从中随机选择一个词语作为下一个生成的词语。较高的top_p值会导致生成的文本更具有多样性，但是会牺牲一定的准确性和保真度。较低的top_p值则会导致生成的文本更加保险和准确，但是可能会过于死板和缺乏新意。在设置top_p值时，需要根据生成文本的任务类型和需求进行权衡。
n
类型
整数或null
是否必需
否
默认值
1
说明
这个参数可以用于控制生成文本的连贯性和自然程度。指定使用n-gram模型进行文本生成的n的作用值。当n的值较小时，生成的文本会更加流肠和自然，但是可能会出现过多的复制文本，当n的值较大时，生成的文本会更加接近原始文本，但可能会出现矛盾或不连贯的情况。
0 条评论
下一页
