package
2.23.0+incompatible
Repository: https://github.com/mudler/localai.git
Documentation: pkg.go.dev

# Functions

ChatEndpoint is the OpenAI Completion API endpoint https://platform.openai.com/docs/api-reference/chat/create @Summary Generate a chat completions for a given prompt and model.
CompletionEndpoint is the OpenAI Completion API endpoint https://platform.openai.com/docs/api-reference/completions @Summary Generate completions for a given prompt and model.
No description provided by the author
CreateAssistantEndpoint is the OpenAI Assistant API endpoint https://platform.openai.com/docs/api-reference/assistants/createAssistant @Summary Create an assistant with a model and instructions.
No description provided by the author
DeleteAssistantEndpoint is the OpenAI Assistant API endpoint to delete assistents https://platform.openai.com/docs/api-reference/assistants/deleteAssistant @Summary Delete assistents @Success 200 {object} schema.DeleteAssistantResponse "Response" @Router /v1/assistants/{assistant_id} [delete].
No description provided by the author
DeleteFilesEndpoint is the OpenAI API endpoint to delete files https://platform.openai.com/docs/api-reference/files/delete @Summary Delete a file.
EditEndpoint is the OpenAI edit API endpoint @Summary OpenAI edit endpoint @Param request body schema.OpenAIRequest true "query params" @Success 200 {object} schema.OpenAIResponse "Response" @Router /v1/edits [post].
EmbeddingsEndpoint is the OpenAI Embeddings API endpoint https://platform.openai.com/docs/api-reference/embeddings @Summary Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
GetAssistantEndpoint is the OpenAI Assistant API endpoint to get assistents https://platform.openai.com/docs/api-reference/assistants/getAssistant @Summary Get assistent data @Success 200 {object} Assistant "Response" @Router /v1/assistants/{assistant_id} [get].
No description provided by the author
GetFilesContentsEndpoint is the OpenAI API endpoint to get files content https://platform.openai.com/docs/api-reference/files/retrieve-contents @Summary Returns information about a specific file.
GetFilesEndpoint is the OpenAI API endpoint to get files https://platform.openai.com/docs/api-reference/files/retrieve @Summary Returns information about a specific file.
* curl http://localhost:8080/v1/images/generations \ -H "Content-Type: application/json" \ -d '{ "prompt": "A cute baby sea otter", "n": 1, "size": "512x512" }' * */ ImageEndpoint is the OpenAI Image generation API endpoint https://platform.openai.com/docs/api-reference/images/create @Summary Creates an image given a prompt.
No description provided by the author
ListAssistantsEndpoint is the OpenAI Assistant API endpoint to list assistents https://platform.openai.com/docs/api-reference/assistants/listAssistants @Summary List available assistents @Param limit query int false "Limit the number of assistants returned" @Param order query string false "Order of assistants returned" @Param after query string false "Return assistants created after the given ID" @Param before query string false "Return assistants created before the given ID" @Success 200 {object} []Assistant "Response" @Router /v1/assistants [get].
ListFilesEndpoint https://platform.openai.com/docs/api-reference/files/list @Summary List files.
ListModelsEndpoint is the OpenAI Models API endpoint https://platform.openai.com/docs/api-reference/models @Summary List and describe the various models available in the API.
No description provided by the author
TranscriptEndpoint is the OpenAI Whisper API endpoint https://platform.openai.com/docs/api-reference/audio/create @Summary Transcribes audio into the input language.
UploadFilesEndpoint https://platform.openai.com/docs/api-reference/files/create.

# Constants

No description provided by the author
CorrelationIDKey to track request across process boundary.
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

# Variables

No description provided by the author
better to return empty array instead of "null".
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Assistant represents the structure of an assistant object from 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

# Type aliases

ToolType defines a type for tool options.