Module async_openai::types

Types used in OpenAI API requests and responses. These types are created from component schemas in the OpenAPI spec

Structs

• AudioInput
• Category
• CategoryScore
  A list of the categories along with their scores as predicted by model.
• ChatChoice
• ChatCompletionFunctions
• ChatCompletionFunctionsArgs
  Builder for ChatCompletionFunctions.
• ChatCompletionRequestMessage
• ChatCompletionRequestMessageArgs
  Builder for ChatCompletionRequestMessage.
• ChatCompletionResponseMessage
  A chat completion message generated by the model.
• ChatCompletionResponseStreamMessage
• ChatCompletionStreamResponseDelta
  A chat completion delta generated by streamed model responses.
• Choice
• CompletionUsage
  Usage statistics for the completion request.
• ContentModerationResult
• CreateChatCompletionRequest
• CreateChatCompletionRequestArgs
  Builder for CreateChatCompletionRequest.
• CreateChatCompletionResponse
  Represents a chat completion response returned by model, based on the provided input.
• CreateChatCompletionStreamResponse
  Represents a streamed chunk of a chat completion response returned by model, based on the provided input.
• CreateCompletionRequest
• CreateCompletionRequestArgs
  Builder for CreateCompletionRequest.
• CreateCompletionResponse
• CreateEditRequest
• CreateEditRequestArgs
  Builder for CreateEditRequest.
• CreateEditResponse
• CreateEmbeddingRequest
• CreateEmbeddingRequestArgs
  Builder for CreateEmbeddingRequest.
• CreateEmbeddingResponse
• CreateFileRequest
• CreateFileRequestArgs
  Builder for CreateFileRequest.
• CreateFineTuneRequest
• CreateFineTuneRequestArgs
  Builder for CreateFineTuneRequest.
• CreateFineTuningJobRequest
• CreateFineTuningJobRequestArgs
  Builder for CreateFineTuningJobRequest.
• CreateImageEditRequest
• CreateImageEditRequestArgs
  Builder for CreateImageEditRequest.
• CreateImageRequest
• CreateImageRequestArgs
  Builder for CreateImageRequest.
• CreateImageVariationRequest
• CreateImageVariationRequestArgs
  Builder for CreateImageVariationRequest.
• CreateModerationRequest
• CreateModerationRequestArgs
  Builder for CreateModerationRequest.
• CreateModerationResponse
  Represents policy compliance report by OpenAI’s content moderation model against a given input.
• CreateTranscriptionRequest
• CreateTranscriptionRequestArgs
  Builder for CreateTranscriptionRequest.
• CreateTranscriptionResponse
• CreateTranslationRequest
• CreateTranslationRequestArgs
  Builder for CreateTranslationRequest.
• CreateTranslationResponse
• DeleteFileResponse
• DeleteModelResponse
• Embedding
  Represents an embedding vector returned by embedding endpoint.
• EmbeddingUsage
• FileInput
• FineTune
• FineTuneEvent
• FineTuneJobError
  For fine-tuning jobs that have failed, this will contain more information on the cause of the failure.
• FineTuningJob
  The fine_tuning.job object represents a fine-tuning job that has been created through the API.
• FineTuningJobEvent
  Fine-tuning job event object
• FunctionCall
  The name and arguments of a function that should be called, as generated by the model.
• FunctionCallStream
• Hyperparameters
• ImageInput
• ImagesResponse
• ListFilesResponse
• ListFineTuneEventsResponse
• ListFineTuneEventsStreamResponse
• ListFineTuneResponse
• ListFineTuningJobEventsResponse
• ListModelResponse
• ListPaginatedFineTuningJobsResponse
• Logprobs
• Model
  Describes an OpenAI model offering that can be used with the API.
• OpenAIFile
  The File object represents a document that has been uploaded to OpenAI.

Enums

• AudioResponseFormat
• ChatCompletionFunctionCall
• CompletionFinishReason
• EmbeddingInput
• EncodingFormat
• FinishReason
• Image
• ImageSize
• Level
• ModerationInput
• NEpochs
• Prompt
• ResponseFormat
• Role
• Stop
• TextModerationModel

Type Aliases

• ChatCompletionResponseStream
  Parsed server side events stream until an [DONE] is received from server.
• CompletionResponseStream
  Parsed server side events stream until an [DONE] is received from server.
• FineTuneEventsResponseStream
  Parsed server side events stream until an [DONE] is received from server.