Create
Create a completion by providing details of the model configuration in the request.
Request
- Base URL: https://api.humanloop.com/v4
- URL: https://api.humanloop.com/v4/completion
- Auth: API key in header X-API-KEY
Request body
Unique project name. If no project exists with this name, a new project will be created.
Unique ID of a project to associate to the log. Either this or project must be provided.
ID of the session to associate the datapoint.
A unique string identifying the session to associate the datapoint to. Allows you to log multiple datapoints to a session (using an ID kept by your internal systems) by passing the same session_reference_id in subsequent log requests. Specify at most one of this or session_id.
ID associated to the parent datapoint in a session.
A unique string identifying the previously-logged parent datapoint in a session. Allows you to log nested datapoints with your internal system IDs by passing the same reference ID as parent_id in a prior log request. Specify at most one of this or parent_id. Note that this cannot refer to a datapoint being logged in the same request.
The inputs passed to the prompt template.
Identifies where the model was called from.
Any additional metadata to record.
Whether the request/response payloads will be stored on Humanloop.
ID of the source datapoint if this is a log derived from a datapoint in a dataset.
The number of generations.
If true, tokens will be sent as data-only server-sent events. If num_samples > 1, samples are streamed back independently.
Template engine to use for rendering templates.
End-user ID passed through to provider call.
Deprecated field: the seed is instead set as part of the request.config object.
Whether to return the inputs in the response. If false, the response will contain an empty dictionary under inputs. This is useful for reducing the size of the response. Defaults to true.
Include the log probabilities of the top n tokens in the provider_response
The suffix that comes after a completion of inserted text. Useful for completions that act like inserts.
Changes
No recorded changes to this operation across all 1 revision of this API.