1 stable release

1.1.0	Jan 12, 2023

#34 in #sampling

MIT license

150KB
2K SLoC

Rust API client for openai-rs

APIs for sampling from and fine-tuning language models

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

API version: 1.1.0
Package version: 1.1.0
Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named openapi-rs and add the following to Cargo.toml under [dependencies]:

openapi-rs = { path = "./openapi-rs" }

Documentation for API Endpoints

All URIs are relative to https://api.openai.com/v1

Class	Method	HTTP request	Description
OpenAiApi	cancel_fine_tune	POST /fine-tunes/{fine_tune_id}/cancel	Immediately cancel a fine-tune job.
OpenAiApi	create_answer	POST /answers	Answers the specified question using the provided documents and examples. The endpoint first searches over provided documents or files to find relevant context. The relevant context is combined with the provided examples and question to create the prompt for completion.
OpenAiApi	create_classification	POST /classifications	Classifies the specified `query` using provided examples. The endpoint first searches over the labeled examples to select the ones most relevant for the particular query. Then, the relevant examples are combined with the query to construct a prompt to produce the final label via the completions endpoint. Labeled examples can be provided via an uploaded `file`, or explicitly listed in the request using the `examples` parameter for quick tests and small scale use cases.
OpenAiApi	create_completion	POST /completions	Creates a completion for the provided prompt and parameters
OpenAiApi	create_edit	POST /edits	Creates a new edit for the provided input, instruction, and parameters
OpenAiApi	create_embedding	POST /embeddings	Creates an embedding vector representing the input text.
OpenAiApi	create_file	POST /files	Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
OpenAiApi	create_fine_tune	POST /fine-tunes	Creates a job that fine-tunes a specified model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete. Learn more about Fine-tuning
OpenAiApi	create_image	POST /images/generations	Creates an image given a prompt.
OpenAiApi	create_image_edit	POST /images/edits	Creates an edited or extended image given an original image and a prompt.
OpenAiApi	create_image_variation	POST /images/variations	Creates a variation of a given image.
OpenAiApi	create_moderation	POST /moderations	Classifies if text violates OpenAI's Content Policy
OpenAiApi	create_search	POST /engines/{engine_id}/search	The search endpoint computes similarity scores between provided query and documents. Documents can be passed directly to the API if there are no more than 200 of them. To go beyond the 200 document limit, documents can be processed offline and then used for efficient retrieval at query time. When `file` is set, the search endpoint searches over all the documents in the given file and returns up to the `max_rerank` number of documents. These documents will be returned along with their search scores. The similarity score is a positive score that usually ranges from 0 to 300 (but can sometimes go higher), where a score above 200 usually means the document is semantically similar to the query.
OpenAiApi	delete_file	DELETE /files/{file_id}	Delete a file.
OpenAiApi	delete_model	DELETE /models/{model}	Delete a fine-tuned model. You must have the Owner role in your organization.
OpenAiApi	download_file	GET /files/{file_id}/content	Returns the contents of the specified file
OpenAiApi	list_engines	GET /engines	Lists the currently available (non-finetuned) models, and provides basic information about each one such as the owner and availability.
OpenAiApi	list_files	GET /files	Returns a list of files that belong to the user's organization.
OpenAiApi	list_fine_tune_events	GET /fine-tunes/{fine_tune_id}/events	Get fine-grained status updates for a fine-tune job.
OpenAiApi	list_fine_tunes	GET /fine-tunes	List your organization's fine-tuning jobs
OpenAiApi	list_models	GET /models	Lists the currently available models, and provides basic information about each one such as the owner and availability.
OpenAiApi	retrieve_engine	GET /engines/{engine_id}	Retrieves a model instance, providing basic information about it such as the owner and availability.
OpenAiApi	retrieve_file	GET /files/{file_id}	Returns information about a specific file.
OpenAiApi	retrieve_fine_tune	GET /fine-tunes/{fine_tune_id}	Gets info about the fine-tune job. Learn more about Fine-tuning
OpenAiApi	retrieve_model	GET /models/{model}	Retrieves a model instance, providing basic information about the model such as the owner and permissioning.

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

Dependencies

~5–17MB
~235K SLoC