Completions Class

Definition

Representation of the response data from a completions request. Completions support a wide variety of tasks and generate text that continues from or "completes" provided prompt data.

public class Completions : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Completions>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Completions>
type Completions = class
    interface IJsonModel<Completions>
    interface IPersistableModel<Completions>
Public Class Completions
Implements IJsonModel(Of Completions), IPersistableModel(Of Completions)
Inheritance
Completions
Implements

Properties

Choices

The collection of completions choices associated with this completions response. Generally, n choices are generated per provided prompt with a default value of 1. Token limits and other settings may limit the number of choices generated.

Created

The first timestamp associated with generation activity for this completions response, represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970.

Id

A unique identifier associated with this completions response.

PromptFilterResults

Content filtering results for zero or more prompts in the request. In a streaming request, results for different prompts may arrive at different times or in different orders.

Usage

Usage information for tokens processed and generated as part of this completions operation.

Explicit Interface Implementations

IJsonModel<Completions>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<Completions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<Completions>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<Completions>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<Completions>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to