Expand description
The client, its builder, and the one request path every endpoint shares.
Re-exports§
pub use jobs::JobItem;pub use jobs::JobSink;pub use jobs::JobSource;pub use jobs::JobSubmit;pub use jobs::Jobs;pub use jobs::chunk_is_retrievable;pub use jobs::connection_name;pub use jobs::decode_chunk_payload;pub use jobs::require_connection_name;pub use jobs::require_connection_schema_policy;pub use jobs::require_connector_idempotency_key;pub use stream::ChunkStream;
Modules§
- jobs
/v1/jobs: batch jobs over inline items or over a connector’s data store.- stream
- Server-sent event streaming for the generation endpoints.
Structs§
- Batch
Create - Creates a batch. Build with
Batches::create. - Batch
List Request - Lists batches. Build with
Batches::list. - Batches
- The batches namespace. Obtain one with
Client::batches. - Chat
Request - Generates a chat completion. Build with
Client::chat. - Client
- A handle to one SIE server.
- Client
Builder - Configures a
Client. - Connection
Add - Stores a credential. Build with
Connections::add. - Connections
- The connections namespace. Obtain one with
Client::connections. - Encode
Request - Embeds one or more items. Build with
Client::encode. - Extract
Request - Extracts structure from items. Build with
Client::extract. - File
List Request - Lists files. Build with
Files::list. - File
Upload - Uploads a file. Build with
Files::uploadorFiles::upload_path. - Files
- The files namespace. Obtain one with
Client::files. - Generate
Request - Generates text with the native endpoint. Build with
Client::generate. - Pool
Create - Creates a pool. Build with
Pools::create. - Pools
- The pools namespace. Obtain one with
Client::pools. - Responses
Request - Generates a response. Build with
Client::responses. - Score
Request - Scores a query against candidates. Build with
Client::score.
Enums§
- Response
Input - Input to the Responses API: a bare prompt or a message list.
- Sort
Order - Sort order for a listing.
- Watch
Mode - Which status endpoint to watch.