Skip to content

Home

Jump to bottom
MarcoDotIO edited this page Mar 1, 2023 · 4 revisions

Types

  • ChatRole: Used for selecting who sent the message
  • FileStatus: The uploaded status of the file.
  • FineTuneEventInfo: The Fine-tune event information type.
  • FineTuneStatus: Provides Fine-tune status information about the fine-tune model.
  • ImageData: The image type of the image response data.
  • ImageResolutions: The image resolution being requested.
  • ResponseFormat: The type of image of the response data that will be returned
  • ContentPolicyModels: Two content moderations models are available: text-moderation-stable and text-moderation-latest. The default is text-moderation-latest which will be automatically upgraded over time. This ensures you are always using our most accurate model. If you use text-moderation-stable, we will provide advanced notice before updating the model. Accuracy of text-moderation-stable may be slightly lower than for text-moderation-latest.
  • OpenAIError: OpenAIKit errors that are thrown depending on the context.
  • OpenAIObject: A specific type of object that OpenAI has responded with.
  • HTTPMethod: Uses URLRequest to set up a HTTPMethod, and implement default values for the method cases.
  • ChatParameters
  • CompletionParameters: Parameter struct used for creating GPT3 completions.
  • EditParameters: Parameter struct for the Edit endpoint.
  • EmbeddingsParameters: Parameter used for the Embeddings endpoint.
  • UploadFileParameters: Parameter used for uploading files.
  • CreateFineTuneParameters: Parameter struct used for creating Fine-tune jobs.
  • ImageEditParameters: Parameter used for creating image edits
  • ImageParameters: Parameter used for generating images given a prompt.
  • ImageVariationParameters: Parameter struct used for generating image variation(s).
  • ContentPolicyParameters: The parameter struct used for the Moderations endpoint
  • ChatResponse
  • CompletionResponse: Completion Response from OpenAI
  • EditResponse: The Edit response sent from OpenAI
  • EmbeddingsData: Contains the raw embeddings for the Embeddings endpoint
  • EmbeddingsResponse: The response sent by the Embeddings endpoint.
  • EmbeddingsUsage: The token usage of the Embeddings endpoint.
  • File: The file object used to read file information from the Files endpoint.
  • ListFilesResponse: The response object sent by the File endpoint
  • FineTune: The fine-tune job object itself that shows information pertaining to the job.
  • FineTuneEvent: The struct that lists information pertaining to a Fine-tune job event.
  • FineTuneEventsResponse: The response sent by the Fine-tune Event Endpoint
  • FineTuneHyperparamters: The hyperparameters used to tweak the Fine-tune model.
  • FineTuneTraining: The struct representing each data point within a Fine-tune training file.
  • ListFineTuneResponse: The struct sent from the List Fine-tune Endpoint
  • ImageResponse: The struct sent by the Images Endpoint
  • ListModelResponse: The struct sent by the List Models Endpoint
  • Model: The GPT3 models used for text and code completions.
  • ModelPermission: Struct containing permissions associated with the model.
  • ContentPolicyCategories: The categories flagged by the Moderations endpoint.
  • ContentPolicyCategoryScore: The moderation score amount associated with a prompt.
  • ContentPolicyResponse: The struct sent from the Moderations endpoint.
  • ContentPolicyResult: The result of the moderation check from the Moderations endpoint.
  • ChatChoice: The output choice for the Chat Ednpoint.
  • ChatMessage: The chat message object used for each chat conversation message.
  • Choice: The output completion / edit of the Completions and Edits endpoints.
  • Configuration: The configuration object used for the OpenAIKit object to represent the organization of the user.
  • DeleteObject: The struct returned from deleting a file or Fine-tune from their associated endpoints.
  • FormData: The form query parameter used for submitting images and files with their associated endpoints.
  • OpenAIErrorMessage: The struct sent if the request is malformed, or if OpenAI's server isn't functioning correctly.
  • OpenAIErrorResponse: The response struct itself when an error is thrown.
  • Usage: The amount of tokens used with any GPT3 function.

Global Functions

Generated at 2023-03-04T02:43:47+0000 using swift-doc 1.0.0-rc.1.

Types
Global Functions
Clone this wiki locally