package
0.0.0-20240401083311-4d07feff5333
Repository: https://github.com/karenelise07/goaiproxy.git
Documentation: pkg.go.dev

# README

Go API Server for swagger

The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.

Overview

This server was generated by the [swagger-codegen] (https://github.com/swagger-api/swagger-codegen) project.
By using the OpenAPI-Spec from a remote server, you can easily generate a server stub.

To see how to make this your own, look here:

README

  • API version: 2.0.0
  • Build date: 2024-03-28T03:25:30.876399727Z[GMT] For more information, please visit https://help.openai.com/

Running the server

To run the server, follow these simple steps:

go run main.go

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

List of ChatCompletionRole.
No description provided by the author
No description provided by the author
List of ChatCompletionRole.
List of ChatCompletionRole.
List of ChatCompletionRole.
List of ChatCompletionRole.

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A list of [Files](/docs/api-reference/files) attached to an `assistant`.
Represents an `assistant` that can call the model and use tools.
Represents an event emitted when streaming a Run.
No description provided by the author
No description provided by the author
No description provided by the author
Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The function that the model called.
Specifies a tool the model should use.
No description provided by the author
No description provided by the author
Deprecated and replaced by `tool_calls`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A chat completion message generated by the model.
A chat completion delta generated by streamed model responses.
Deprecated and replaced by `tool_calls`.
No description provided by the author
No description provided by the author
No description provided by the author
Controls which (if any) function is called by the model.
Usage statistics for the completion request.
No description provided by the author
No description provided by the author
Represents a chat completion response returned by model, based on the provided input.
No description provided by the author
Represents a streamed chunk of a chat completion response returned by model, based on the provided input.
No description provided by the author
An object specifying the format that the model must output.
Represents a chat completion response returned by model, based on the provided input.
No description provided by the author
Log probability information for the choice.
Represents a streamed chunk of a chat completion response returned by model, based on the provided input.
No description provided by the author
No description provided by the author
Represents a completion response from the API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The usage information for the request.
No description provided by the author
No description provided by the author
The hyperparameters used for the fine-tuning job.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Represents if a given text input is potentially harmful.
A list of the categories, and whether they are flagged or not.
A list of the categories along with their scores as predicted by model.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Represents a transcription response returned by model, based on the provided input.
Represents a verbose json transcription response returned by model, based on the provided input.
No description provided by the author
No description provided by the author
No description provided by the author
Deletes the association between the assistant and the file, but does not delete the [File](/docs/api-reference/files) object itself.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Occurs when a stream ends.
Represents an embedding vector returned by embedding endpoint.
Occurs when an [error](/docs/guides/error-codes/api-errors) occurs.
No description provided by the author
The `fine_tuning.job` object represents a fine-tuning job that has been created through the API.
For fine-tuning jobs that have `failed`, this will contain more information on the cause of the failure.
Fine-tuning job event object.
The hyperparameters used for the fine-tuning job.
No description provided by the author
Represents the url or the content of an image generated by the OpenAI API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
References an image [File](/docs/api-reference/files) in the content of a message.
No description provided by the author
A citation within the message that points to a specific quote from a specific File associated with the assistant or the message.
No description provided by the author
A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.
No description provided by the author
The text content that is part of a message.
No description provided by the author
References an image [File](/docs/api-reference/files) in the content of a message.
No description provided by the author
A citation within the message that points to a specific quote from a specific File associated with the assistant or the message.
No description provided by the author
A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.
No description provided by the author
The text content that is part of a message.
No description provided by the author
Represents a message delta i.e.
The delta containing the fields that have changed on the Message.
A list of files attached to a `message`.
Represents a message within a [thread](/docs/api-reference/threads).
On an incomplete message, details about why the message is incomplete.
No description provided by the author
Describes an OpenAI model offering that can be used with the API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The `File` object represents a document that has been uploaded to OpenAI.
No description provided by the author
Usage statistics related to the run.
Represents an execution run on a [thread](/docs/api-reference/threads).
The last error associated with this run.
Details on the action required to continue the run.
Details on the tool outputs needed for this run to continue.
Usage statistics related to the run step.
Represents a run step delta i.e.
The delta containing the fields that have changed on the run step.
Details of the message creation by the run step.
No description provided by the author
Details of the Code Interpreter tool call the run step was involved in.
The Code Interpreter tool call definition.
No description provided by the author
No description provided by the author
Text output from the Code Interpreter tool call as part of a run step.
No description provided by the author
The definition of the function that was called.
Details of the tool call.
No description provided by the author
Details of the message creation by the run step.
No description provided by the author
Details of the Code Interpreter tool call the run step was involved in.
The Code Interpreter tool call definition.
No description provided by the author
No description provided by the author
Text output from the Code Interpreter tool call as part of a run step.
No description provided by the author
The definition of the function that was called.
Details of the tool call.
No description provided by the author
Represents a step in execution of a run.
The last error associated with this run step.
No description provided by the author
No description provided by the author
Tool call objects.
The function definition.
No description provided by the author
No description provided by the author
Represents a thread that contains [messages](/docs/api-reference/messages).
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

ChatCompletionRole : The role of the author of a message.
No description provided by the author