Struct CreateCompletionResponse

pub struct CreateCompletionResponse {
    pub id: String,
    pub choices: Vec<CreateCompletionResponseChoice>,
    pub created: u64,
    pub model: String,
    pub system_fingerprint: Option<String>,
    pub usage: Option<CompletionUsage>,
}

Represents a completion response from the API. Note: both the streamed and non-streamed response objects share the same shape (unlike the chat endpoint).

Fields

id: String

A unique identifier for the completion.

choices: Vec<CreateCompletionResponseChoice>

The list of completion choices the model generated for the input prompt.

created: u64

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

model: String

The model used for completion.

system_fingerprint: Option<String>

This fingerprint represents the backend configuration that the model runs with.

Can be used in conjunction with the seed request parameter to understand when backend changes have been made that might impact determinism.

usage: Option<CompletionUsage>

Implementations

impl CreateCompletionResponse

pub fn builder() -> CreateCompletionResponseBuilder<((), (), (), (), (), ())>

Create a builder for building CreateCompletionResponse. On the builder, call .id(...), .choices(...), .created(...), .model(...), .system_fingerprint(...)(optional), .usage(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CreateCompletionResponse.

Trait Implementations

impl Clone for CreateCompletionResponse

fn clone(&self) -> CreateCompletionResponse

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateCompletionResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateCompletionResponse

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CreateCompletionResponse

fn eq(&self, other: &CreateCompletionResponse) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CreateCompletionResponse

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateCompletionResponse