Struct TaskCompletion

pub struct TaskCompletion<'a> {
    pub prompt: Prompt<'a>,
    pub stopping: Stopping<'a>,
    pub sampling: Sampling,
    pub special_tokens: bool,
    pub logprobs: Logprobs,
    pub echo: bool,
}

Completes a prompt. E.g. continues a text.

Fields

prompt: Prompt<'a>

The prompt (usually text) to be completed. Unconditional completion can be started with an empty string. The prompt may contain a zero shot or few shot task.

stopping: Stopping<'a>

Controls in which circumstances the model will stop generating new tokens.

sampling: Sampling

Sampling controls how the tokens (“words”) are selected for the completion.

special_tokens: bool

Whether to include special tokens (e.g. <|endoftext|>, <|python_tag|>) in the completion.

logprobs: Logprobs

Wether you are interessted in the probabilities of the sampled tokens, or most likely tokens.

echo: bool

Echo the prompt in the completion. This may be especially helpful when log_probs is set to return logprobs for the prompt.

Implementations

impl<'a> TaskCompletion<'a>

pub fn from_text(text: &'a str) -> Self

Convenience constructor leaving most setting to default, just completing a given text

pub fn with_maximum_tokens(self, maximum_tokens: u32) -> Self

pub fn with_stop_sequences(self, stop_sequences: &'a [&str]) -> Self

pub fn with_special_tokens(self) -> Self

Include special tokens (e.g. <|endoftext|>, <|python_tag|>) in the completion.

pub fn with_logprobs(self, logprobs: Logprobs) -> Self

pub fn with_echo(self) -> Self

Trait Implementations

impl StreamTask for TaskCompletion<'_>

type Output = CompletionEvent

Output returned by crate::Client::output_of

type ResponseBody = DeserializedCompletionEvent

Expected answer of the Aleph Alpha API

fn build_request( &self, client: &Client, base: &str, model: &str, ) -> RequestBuilder

Prepare the request for the Aleph Alpha API. Authentication headers can be assumed to be already set.

fn body_to_output(&self, response: Self::ResponseBody) -> Option<Self::Output>

Parses the response of the server into higher level structs for the user. None implies the output should be skipped.

fn with_model<'a>(&'a self, model: &'a str) -> MethodJob<'a, Self>

where Self: Sized,

Turn your task into [Job] by annotating it with a model name.

impl Task for TaskCompletion<'_>

type Output = CompletionOutput

Output returned by crate::Client::output_of

type ResponseBody = ResponseCompletion

Expected answer of the Aleph Alpha API

fn build_request( &self, client: &Client, base: &str, model: &str, ) -> RequestBuilder

Prepare the request for the Aleph Alpha API. Authentication headers can be assumed to be already set.

fn body_to_output(&self, response: Self::ResponseBody) -> Self::Output

Parses the response of the server into higher level structs for the user.

fn with_model<'a>(&'a self, model: &'a str) -> MethodJob<'a, Self>

where Self: Sized,

Turn your task into Job by annotating it with a model name.