Creates a model response for the given chat conversation.

client.Chat.Completions.New(ctx, body) (*ChatCompletionNewResponse, error)

post/chat/completions

ParametersExpand Collapse

body ChatCompletionNewParams

Messages param.Field[[]ChatCompletionNewParamsMessage]

A list of messages comprising the conversation so far.

ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessage

Content ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentUnion

The contents of the system message.

Accepts one of the following:

UnionString

ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentChatCompletionRequestContentPartText

Text string

The text content

Type ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentChatCompletionRequestContentPartTextType

The type of content part

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentChatCompletionRequestContentPartTextTypeText ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentChatCompletionRequestContentPartTextType = "text"

CacheControl ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentChatCompletionRequestContentPartTextCacheControloptional

Cache control settings for the content part.

Type ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentChatCompletionRequestContentPartTextCacheControlType

The cache control type.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentChatCompletionRequestContentPartTextCacheControlTypeEphemeral ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentChatCompletionRequestContentPartTextCacheControlType = "ephemeral"

Ttl ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentChatCompletionRequestContentPartTextCacheControlTtloptional

The cache TTL.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentChatCompletionRequestContentPartTextCacheControlTtl5m ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentChatCompletionRequestContentPartTextCacheControlTtl = "5m"

const ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentChatCompletionRequestContentPartTextCacheControlTtl1h ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentChatCompletionRequestContentPartTextCacheControlTtl = "1h"

ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentArrayOfContentParts

Accepts one of the following:

UnionString

ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentArrayOfContentPartsChatCompletionRequestContentPartText

Text string

The text content

Type ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextType

The type of content part

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextTypeText ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextType = "text"

CacheControl ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControloptional

Cache control settings for the content part.

Type ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlType

The cache control type.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTypeEphemeral ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlType = "ephemeral"

Ttl ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtloptional

The cache TTL.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtl5m ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtl = "5m"

const ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtl1h ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtl = "1h"

Role ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageRole

The role of the messages author, in this case system.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageRoleSystem ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageRole = "system"

ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessage

Content ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentUnion

The contents of the developer message.

Accepts one of the following:

UnionString

ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentChatCompletionRequestContentPartText

Text string

The text content

Type ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentChatCompletionRequestContentPartTextType

The type of content part

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentChatCompletionRequestContentPartTextTypeText ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentChatCompletionRequestContentPartTextType = "text"

CacheControl ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentChatCompletionRequestContentPartTextCacheControloptional

Cache control settings for the content part.

Type ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentChatCompletionRequestContentPartTextCacheControlType

The cache control type.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentChatCompletionRequestContentPartTextCacheControlTypeEphemeral ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentChatCompletionRequestContentPartTextCacheControlType = "ephemeral"

Ttl ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentChatCompletionRequestContentPartTextCacheControlTtloptional

The cache TTL.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentChatCompletionRequestContentPartTextCacheControlTtl5m ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentChatCompletionRequestContentPartTextCacheControlTtl = "5m"

const ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentChatCompletionRequestContentPartTextCacheControlTtl1h ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentChatCompletionRequestContentPartTextCacheControlTtl = "1h"

ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentArrayOfContentParts

Accepts one of the following:

UnionString

ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentArrayOfContentPartsChatCompletionRequestContentPartText

Text string

The text content

Type ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextType

The type of content part

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextTypeText ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextType = "text"

CacheControl ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControloptional

Cache control settings for the content part.

Type ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlType

The cache control type.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTypeEphemeral ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlType = "ephemeral"

Ttl ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtloptional

The cache TTL.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtl5m ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtl = "5m"

const ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtl1h ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtl = "1h"

Role ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageRole

The role of the messages author, in this case developer.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageRoleDeveloper ChatCompletionNewParamsMessagesChatCompletionRequestDeveloperMessageRole = "developer"

ChatCompletionNewParamsMessagesChatCompletionRequestUserMessage

Content ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentUnion

The contents of the user message.

Accepts one of the following:

UnionString

ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartText

Text string

The text content

Type ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartTextType

The type of content part

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartTextTypeText ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartTextType = "text"

CacheControl ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartTextCacheControloptional

Cache control settings for the content part.

Type ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartTextCacheControlType

The cache control type.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartTextCacheControlTypeEphemeral ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartTextCacheControlType = "ephemeral"

Ttl ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartTextCacheControlTtloptional

The cache TTL.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartTextCacheControlTtl5m ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartTextCacheControlTtl = "5m"

const ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartTextCacheControlTtl1h ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartTextCacheControlTtl = "1h"

ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartImageURL

ImageURL ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartImageURLImageURL

Image URL settings.

URL string

A URL or data URL containing image content.

Detail ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartImageURLImageURLDetailoptional

Optional detail level for image understanding.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartImageURLImageURLDetailAuto ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartImageURLImageURLDetail = "auto"

const ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartImageURLImageURLDetailLow ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartImageURLImageURLDetail = "low"

const ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartImageURLImageURLDetailHigh ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartImageURLImageURLDetail = "high"

Type ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartImageURLType

The type of content part

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartImageURLTypeImageURL ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartImageURLType = "image_url"

ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartVideoURL

Type ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartVideoURLType

The type of content part

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartVideoURLTypeVideoURL ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartVideoURLType = "video_url"

VideoURL ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentChatCompletionRequestContentPartVideoURLVideoURL

Video URL settings.

URL string

A URL or data URL containing video content.

ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentParts

Accepts one of the following:

UnionString

ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartText

Text string

The text content

Type ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextType

The type of content part

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextTypeText ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextType = "text"

CacheControl ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControloptional

Cache control settings for the content part.

Type ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlType

The cache control type.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTypeEphemeral ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlType = "ephemeral"

Ttl ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtloptional

The cache TTL.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtl5m ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtl = "5m"

const ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtl1h ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtl = "1h"

ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartImageURL

ImageURL ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartImageURLImageURL

Image URL settings.

URL string

A URL or data URL containing image content.

Detail ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartImageURLImageURLDetailoptional

Optional detail level for image understanding.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartImageURLImageURLDetailAuto ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartImageURLImageURLDetail = "auto"

const ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartImageURLImageURLDetailLow ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartImageURLImageURLDetail = "low"

const ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartImageURLImageURLDetailHigh ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartImageURLImageURLDetail = "high"

Type ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartImageURLType

The type of content part

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartImageURLTypeImageURL ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartImageURLType = "image_url"

ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartVideoURL

Type ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartVideoURLType

The type of content part

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartVideoURLTypeVideoURL ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartVideoURLType = "video_url"

VideoURL ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageContentArrayOfContentPartsChatCompletionRequestContentPartVideoURLVideoURL

Video URL settings.

URL string

A URL or data URL containing video content.

Role ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageRole

The role of the messages author, in this case user.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageRoleUser ChatCompletionNewParamsMessagesChatCompletionRequestUserMessageRole = "user"

ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessage

Role ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageRole

The role of the messages author, in this case assistant.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageRoleAssistant ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageRole = "assistant"

Content ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentUnionoptional

The contents of the assistant message.

Accepts one of the following:

UnionString

ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentChatCompletionRequestContentPartText

Text string

The text content

Type ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentChatCompletionRequestContentPartTextType

The type of content part

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentChatCompletionRequestContentPartTextTypeText ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentChatCompletionRequestContentPartTextType = "text"

CacheControl ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentChatCompletionRequestContentPartTextCacheControloptional

Cache control settings for the content part.

Type ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentChatCompletionRequestContentPartTextCacheControlType

The cache control type.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentChatCompletionRequestContentPartTextCacheControlTypeEphemeral ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentChatCompletionRequestContentPartTextCacheControlType = "ephemeral"

Ttl ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentChatCompletionRequestContentPartTextCacheControlTtloptional

The cache TTL.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentChatCompletionRequestContentPartTextCacheControlTtl5m ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentChatCompletionRequestContentPartTextCacheControlTtl = "5m"

const ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentChatCompletionRequestContentPartTextCacheControlTtl1h ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentChatCompletionRequestContentPartTextCacheControlTtl = "1h"

ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentArrayOfContentParts

Accepts one of the following:

UnionString

ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentArrayOfContentPartsChatCompletionRequestContentPartText

Text string

The text content

Type ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextType

The type of content part

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextTypeText ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextType = "text"

CacheControl ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControloptional

Cache control settings for the content part.

Type ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlType

The cache control type.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTypeEphemeral ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlType = "ephemeral"

Ttl ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtloptional

The cache TTL.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtl5m ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtl = "5m"

const ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtl1h ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtl = "1h"

ToolCalls []ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageToolCalloptional

The tool calls generated by the model, such as function calls.

ID string

The ID of the tool call.

Function ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageToolCallsFunction

The function that the model called.

Arguments string

The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.

Name string

The name of the function to call.

Type ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageToolCallsType

The type of the tool. Currently, only function is supported.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageToolCallsTypeFunction ChatCompletionNewParamsMessagesChatCompletionRequestAssistantMessageToolCallsType = "function"

ChatCompletionNewParamsMessagesChatCompletionRequestToolMessage

Content ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentUnion

The contents of the tool message.

Accepts one of the following:

UnionString

ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentChatCompletionRequestContentPartText

Text string

The text content

Type ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentChatCompletionRequestContentPartTextType

The type of content part

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentChatCompletionRequestContentPartTextTypeText ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentChatCompletionRequestContentPartTextType = "text"

CacheControl ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentChatCompletionRequestContentPartTextCacheControloptional

Cache control settings for the content part.

Type ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentChatCompletionRequestContentPartTextCacheControlType

The cache control type.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentChatCompletionRequestContentPartTextCacheControlTypeEphemeral ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentChatCompletionRequestContentPartTextCacheControlType = "ephemeral"

Ttl ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentChatCompletionRequestContentPartTextCacheControlTtloptional

The cache TTL.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentChatCompletionRequestContentPartTextCacheControlTtl5m ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentChatCompletionRequestContentPartTextCacheControlTtl = "5m"

const ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentChatCompletionRequestContentPartTextCacheControlTtl1h ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentChatCompletionRequestContentPartTextCacheControlTtl = "1h"

ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentArrayOfContentParts

Accepts one of the following:

UnionString

ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentArrayOfContentPartsChatCompletionRequestContentPartText

Text string

The text content

Type ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextType

The type of content part

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextTypeText ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextType = "text"

CacheControl ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControloptional

Cache control settings for the content part.

Type ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlType

The cache control type.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTypeEphemeral ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlType = "ephemeral"

Ttl ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtloptional

The cache TTL.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtl5m ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtl = "5m"

const ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtl1h ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageContentArrayOfContentPartsChatCompletionRequestContentPartTextCacheControlTtl = "1h"

Role ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageRole

The role of the messages author, in this case tool.

Accepts one of the following:

const ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageRoleTool ChatCompletionNewParamsMessagesChatCompletionRequestToolMessageRole = "tool"

ToolCallID string

Tool call that this message is responding to.

Model param.Field[string]

Model ID used to generate the response.

FrequencyPenalty param.Field[float64]optional

Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.

minimum-2

maximum2

LogitBias param.Field[map[string, int64]]optional

Modify the likelihood of specified tokens appearing in the completion.

Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.

Logprobs param.Field[bool]optional

Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.

MaxCompletionTokens param.Field[int64]optional

The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run.

minimum256

MaxTokens param.Field[int64]optional

The maximum number of tokens that can be generated in the completion.

The token count of your prompt plus max_tokens cannot exceed the model's context length.

minimum0

Metadata param.Field[map[string, string]]optional

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

N param.Field[int64]optional

How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs.

minimum1

maximum128

PresencePenalty param.Field[float64]optional

Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.

minimum-2

maximum2

ReasoningEffort param.Field[ChatCompletionNewParamsReasoningEffort]optional

Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.

const ChatCompletionNewParamsReasoningEffortNone ChatCompletionNewParamsReasoningEffort = "none"

const ChatCompletionNewParamsReasoningEffortMinimal ChatCompletionNewParamsReasoningEffort = "minimal"

const ChatCompletionNewParamsReasoningEffortLow ChatCompletionNewParamsReasoningEffort = "low"

const ChatCompletionNewParamsReasoningEffortMedium ChatCompletionNewParamsReasoningEffort = "medium"

const ChatCompletionNewParamsReasoningEffortHigh ChatCompletionNewParamsReasoningEffort = "high"

const ChatCompletionNewParamsReasoningEffortXhigh ChatCompletionNewParamsReasoningEffort = "xhigh"

Stop param.Field[ChatCompletionNewParamsStopUnion]optional

Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.

UnionString

ChatCompletionNewParamsStopArray

StreamOptions param.Field[ChatCompletionNewParamsStreamOptions]optional

Options for streaming response. Only set this when you set stream: true.

IncludeUsage booloptional

If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array.

All other chunks will also include a usage field, but with a null value. NOTE: If the stream is interrupted, you may not receive the final usage chunk which contains the total token usage for the request.

Temperature param.Field[float64]optional

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.

minimum0

maximum2

ToolChoice param.Field[ChatCompletionNewParamsToolChoiceUnion]optional

Controls which (if any) tool is called by the model. none means the model will not call any tool and instead generates a message. auto means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools. Specifying a particular tool via {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.

none is the default when no tools are present. auto is the default if tools are present.

ChatCompletionNewParamsToolChoiceString

Accepts one of the following:

const ChatCompletionNewParamsToolChoiceStringNone ChatCompletionNewParamsToolChoiceString = "none"

const ChatCompletionNewParamsToolChoiceStringAuto ChatCompletionNewParamsToolChoiceString = "auto"

const ChatCompletionNewParamsToolChoiceStringRequired ChatCompletionNewParamsToolChoiceString = "required"

ChatCompletionNewParamsToolChoiceChatCompletionNamedToolChoice

Function ChatCompletionNewParamsToolChoiceChatCompletionNamedToolChoiceFunction

Name string

The name of the function to call.

Type ChatCompletionNewParamsToolChoiceChatCompletionNamedToolChoiceType

The type of the tool. Currently, only function is supported.

Accepts one of the following:

const ChatCompletionNewParamsToolChoiceChatCompletionNamedToolChoiceTypeFunction ChatCompletionNewParamsToolChoiceChatCompletionNamedToolChoiceType = "function"

Tools param.Field[[]ChatCompletionNewParamsTool]optional

A list of tools the model may call. Currently, only functions are supported as a tool.

Function ChatCompletionNewParamsToolsFunction

Name string

The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

Description stringoptional

A description of what the function does, used by the model to choose when and how to call the function.

Parameters map[string, unknown]optional

The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format.

Omitting parameters defines a function with an empty parameter list.

Type ChatCompletionNewParamsToolsType

The type of the tool. Currently, only function is supported.

Accepts one of the following:

const ChatCompletionNewParamsToolsTypeFunction ChatCompletionNewParamsToolsType = "function"

TopLogprobs param.Field[int64]optional

An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used.

minimum0

maximum20

TopP param.Field[float64]optional

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

We generally recommend altering this or temperature but not both.

minimum0

maximum1

User param.Field[string]optional

A unique identifier representing your end-user, which can help DigitalOcean to monitor and detect abuse.

ReturnsExpand Collapse

type ChatCompletionNewResponse struct{…}

Represents a chat completion response returned by model, based on the provided input.

ID string

A unique identifier for the chat completion.

Choices []ChatCompletionNewResponseChoice

A list of chat completion choices. Can be more than one if n is greater than 1.

FinishReason ChatCompletionNewResponseChoicesFinishReason

The reason the model stopped generating tokens. This will be stop if the model hit a natural stop point or a provided stop sequence, or length if the maximum number of tokens specified in the request was reached, tool_calls if the model called a tool.

Accepts one of the following:

const ChatCompletionNewResponseChoicesFinishReasonStop ChatCompletionNewResponseChoicesFinishReason = "stop"

const ChatCompletionNewResponseChoicesFinishReasonLength ChatCompletionNewResponseChoicesFinishReason = "length"

const ChatCompletionNewResponseChoicesFinishReasonToolCalls ChatCompletionNewResponseChoicesFinishReason = "tool_calls"

const ChatCompletionNewResponseChoicesFinishReasonContentFilter ChatCompletionNewResponseChoicesFinishReason = "content_filter"

Index int64

The index of the choice in the list of choices.

Logprobs ChatCompletionNewResponseChoicesLogprobs

Log probability information for the choice.

Content []ChatCompletionTokenLogprob

A list of message content tokens with log probability information.

Token string

The token.

Bytes []int64

A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token.

Logprob float64

The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely.

TopLogprobs []ChatCompletionTokenLogprobTopLogprob

List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested top_logprobs returned.

Token string

The token.

Bytes []int64

Logprob float64

The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely.

Refusal []ChatCompletionTokenLogprob

A list of message refusal tokens with log probability information.

Token string

The token.

Bytes []int64

Logprob float64

The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely.

TopLogprobs []ChatCompletionTokenLogprobTopLogprob

List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested top_logprobs returned.

Token string

The token.

Bytes []int64

Logprob float64

The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely.

Message ChatCompletionNewResponseChoicesMessage

A chat completion message generated by the model.

Content string

The contents of the message.

ReasoningContent string

The reasoning content generated by the model.

Refusal string

The refusal message generated by the model.

Role ChatCompletionNewResponseChoicesMessageRole

The role of the author of this message.

Accepts one of the following:

const ChatCompletionNewResponseChoicesMessageRoleAssistant ChatCompletionNewResponseChoicesMessageRole = "assistant"

ToolCalls []ChatCompletionNewResponseChoicesMessageToolCalloptional

The tool calls generated by the model, such as function calls.

ID string

The ID of the tool call.

Function ChatCompletionNewResponseChoicesMessageToolCallsFunction

The function that the model called.

Arguments string

Name string

The name of the function to call.

Type ChatCompletionNewResponseChoicesMessageToolCallsType

The type of the tool. Currently, only function is supported.

Accepts one of the following:

const ChatCompletionNewResponseChoicesMessageToolCallsTypeFunction ChatCompletionNewResponseChoicesMessageToolCallsType = "function"

Created int64

The Unix timestamp (in seconds) of when the chat completion was created.

Model string

The model used for the chat completion.

Object ChatCompletionNewResponseObject

The object type, which is always chat.completion.

Accepts one of the following:

const ChatCompletionNewResponseObjectChatCompletion ChatCompletionNewResponseObject = "chat.completion"

Usage CompletionUsageoptional

Usage statistics for the completion request.

CacheCreatedInputTokens int64

Number of prompt tokens written to cache.

CacheCreation CompletionUsageCacheCreation

Breakdown of prompt tokens written to cache.

Ephemeral1hInputTokens int64

Number of prompt tokens written to 1h cache.

Ephemeral5mInputTokens int64

Number of prompt tokens written to 5m cache.

CacheReadInputTokens int64

Number of prompt tokens read from cache.

CompletionTokens int64

Number of tokens in the generated completion.

PromptTokens int64

Number of tokens in the prompt.

TotalTokens int64

Total number of tokens used in the request (prompt + completion).

Creates a model response for the given chat conversation.

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
  "github.com/stainless-sdks/-go/shared"
)

func main() {
  client := gradient.NewClient(
    option.WithModelAccessKey("My Model Access Key"),
  )
  completion, err := client.Chat.Completions.New(context.TODO(), gradient.ChatCompletionNewParams{
    Messages: gradient.F([]gradient.ChatCompletionNewParamsMessageUnion{gradient.ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessage{
      Content: gradient.F[gradient.ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageContentUnion](shared.UnionString("string")),
      Role: gradient.F(gradient.ChatCompletionNewParamsMessagesChatCompletionRequestSystemMessageRoleSystem),
    }}),
    Model: gradient.F("llama3-8b-instruct"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", completion.ID)
}

{
  "id": "id",
  "choices": [
    {
      "finish_reason": "stop",
      "index": 0,
      "logprobs": {
        "content": [
          {
            "token": "token",
            "bytes": [
              0
            ],
            "logprob": 0,
            "top_logprobs": [
              {
                "token": "token",
                "bytes": [
                  0
                ],
                "logprob": 0
              }
            ]
          }
        ],
        "refusal": [
          {
            "token": "token",
            "bytes": [
              0
            ],
            "logprob": 0,
            "top_logprobs": [
              {
                "token": "token",
                "bytes": [
                  0
                ],
                "logprob": 0
              }
            ]
          }
        ]
      },
      "message": {
        "content": "content",
        "reasoning_content": "reasoning_content",
        "refusal": "refusal",
        "role": "assistant",
        "tool_calls": [
          {
            "id": "id",
            "function": {
              "arguments": "arguments",
              "name": "name"
            },
            "type": "function"
          }
        ]
      }
    }
  ],
  "created": 0,
  "model": "model",
  "object": "chat.completion",
  "usage": {
    "cache_created_input_tokens": 0,
    "cache_creation": {
      "ephemeral_1h_input_tokens": 0,
      "ephemeral_5m_input_tokens": 0
    },
    "cache_read_input_tokens": 0,
    "completion_tokens": 0,
    "prompt_tokens": 0,
    "total_tokens": 0
  }
}

Returns Examples

{
  "id": "id",
  "choices": [
    {
      "finish_reason": "stop",
      "index": 0,
      "logprobs": {
        "content": [
          {
            "token": "token",
            "bytes": [
              0
            ],
            "logprob": 0,
            "top_logprobs": [
              {
                "token": "token",
                "bytes": [
                  0
                ],
                "logprob": 0
              }
            ]
          }
        ],
        "refusal": [
          {
            "token": "token",
            "bytes": [
              0
            ],
            "logprob": 0,
            "top_logprobs": [
              {
                "token": "token",
                "bytes": [
                  0
                ],
                "logprob": 0
              }
            ]
          }
        ]
      },
      "message": {
        "content": "content",
        "reasoning_content": "reasoning_content",
        "refusal": "refusal",
        "role": "assistant",
        "tool_calls": [
          {
            "id": "id",
            "function": {
              "arguments": "arguments",
              "name": "name"
            },
            "type": "function"
          }
        ]
      }
    }
  ],
  "created": 0,
  "model": "model",
  "object": "chat.completion",
  "usage": {
    "cache_created_input_tokens": 0,
    "cache_creation": {
      "ephemeral_1h_input_tokens": 0,
      "ephemeral_5m_input_tokens": 0
    },
    "cache_read_input_tokens": 0,
    "completion_tokens": 0,
    "prompt_tokens": 0,
    "total_tokens": 0
  }
}