Struct Completions

pub struct Completions<'c, C: Config> { /* private fields */ }

Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position. We recommend most users use our Chat completions API. Learn more

Related guide: Legacy Completions

Implementations

impl<'c, C: Config> Completions<'c, C>

pub fn new(client: &'c Client<C>) -> Self

pub async fn create( &self, request: CreateCompletionRequest, ) -> Result<CreateCompletionResponse, OpenAIError>

Creates a completion for the provided prompt and parameters

pub async fn create_stream( &self, request: CreateCompletionRequest, ) -> Result<CompletionResponseStream, OpenAIError>

Creates a completion request for the provided prompt and parameters

Stream back partial progress. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message.

CompletionResponseStream is a parsed SSE stream until a [DONE] is received from server.