glopenai - v1.0.0

glopenai/completion

Types

CompletionChoice

</>

A single completion choice returned by the API.

pub type CompletionChoice {
  CompletionChoice(
    text: String,
    index: Int,
    logprobs: option.Option(Logprobs),
    finish_reason: option.Option(CompletionFinishReason),
  )
}

Constructors

CompletionFinishReason

</>

How the model stopped generating tokens.

pub type CompletionFinishReason {
  FinishReasonStop
  FinishReasonLength
  FinishReasonContentFilter
}

Constructors 

  • FinishReasonStop
  • FinishReasonLength
  • FinishReasonContentFilter

CreateCompletionRequest

</>

Request to create a legacy text completion.

pub type CreateCompletionRequest {
  CreateCompletionRequest(
    model: String,
    prompt: Prompt,
    suffix: option.Option(String),
    max_tokens: option.Option(Int),
    temperature: option.Option(Float),
    top_p: option.Option(Float),
    n: option.Option(Int),
    stream: option.Option(Bool),
    logprobs: option.Option(Int),
    echo_prompt: option.Option(Bool),
    stop: option.Option(StopConfiguration),
    presence_penalty: option.Option(Float),
    frequency_penalty: option.Option(Float),
    best_of: option.Option(Int),
    logit_bias: option.Option(dynamic.Dynamic),
    user: option.Option(String),
    seed: option.Option(Int),
  )
}

Constructors

CreateCompletionResponse

</>

Response from creating a legacy text completion.

pub type CreateCompletionResponse {
  CreateCompletionResponse(
    id: String,
    choices: List(CompletionChoice),
    created: Int,
    model: String,
    system_fingerprint: option.Option(String),
    object: String,
    usage: option.Option(shared.CompletionUsage),
  )
}

Constructors

Logprobs

</>

Log probability information for generated tokens.

pub type Logprobs {
  Logprobs(
    tokens: List(String),
    token_logprobs: List(option.Option(Float)),
    top_logprobs: List(dynamic.Dynamic),
    text_offset: List(Int),
  )
}

Constructors 

  • Logprobs(
  tokens: List(String),
  token_logprobs: List(option.Option(Float)),
  top_logprobs: List(dynamic.Dynamic),
  text_offset: List(Int),
)

Prompt

</>

Prompt input: a single string, array of strings, array of token IDs, or array of token ID arrays. Encoded as an untagged union.

pub type Prompt {
  PromptString(String)
  PromptStringArray(List(String))
  PromptIntegerArray(List(Int))
  PromptArrayOfIntegerArray(List(List(Int)))
}

Constructors 

  • PromptString(String)
  • PromptStringArray(List(String))
  • PromptIntegerArray(List(Int))
  • PromptArrayOfIntegerArray(List(List(Int)))

StopConfiguration

</>

Stop sequences: a single string or an array of up to 4 strings.

pub type StopConfiguration {
  StopString(String)
  StopStringArray(List(String))
}

Constructors 

  • StopString(String)
  • StopStringArray(List(String))

Values

completion_choice_decoder

</> 
pub fn completion_choice_decoder() -> decode.Decoder(
  CompletionChoice,
)

completion_finish_reason_decoder

</> 
pub fn completion_finish_reason_decoder() -> decode.Decoder(
  CompletionFinishReason,
)

completion_finish_reason_to_json

</> 
pub fn completion_finish_reason_to_json(
  reason: CompletionFinishReason,
) -> json.Json

create_completion_request_to_json

</> 
pub fn create_completion_request_to_json(
  request: CreateCompletionRequest,
) -> json.Json

create_request

</> 
pub fn create_request(
  config: config.Config,
  params: CreateCompletionRequest,
) -> request.Request(String)

Build a request to create a legacy text completion.

create_response

</> 
pub fn create_response(
  response: response.Response(String),
) -> Result(CreateCompletionResponse, error.GlopenaiError)

Parse the response from creating a legacy text completion.

logprobs_decoder

</> 
pub fn logprobs_decoder() -> decode.Decoder(Logprobs)

new_create_request

</> 
pub fn new_create_request(
  model model: String,
  prompt prompt: Prompt,
) -> CreateCompletionRequest

Create a new completion request with required fields.

prompt_to_json

</> 
pub fn prompt_to_json(prompt: Prompt) -> json.Json

stop_configuration_to_json

</> 
pub fn stop_configuration_to_json(
  stop: StopConfiguration,
) -> json.Json

with_best_of

</> 
pub fn with_best_of(
  request: CreateCompletionRequest,
  best_of: Int,
) -> CreateCompletionRequest

with_echo_prompt

</> 
pub fn with_echo_prompt(
  request: CreateCompletionRequest,
  echo_prompt: Bool,
) -> CreateCompletionRequest

with_frequency_penalty

</> 
pub fn with_frequency_penalty(
  request: CreateCompletionRequest,
  frequency_penalty: Float,
) -> CreateCompletionRequest

with_logprobs

</> 
pub fn with_logprobs(
  request: CreateCompletionRequest,
  logprobs: Int,
) -> CreateCompletionRequest

with_max_tokens

</> 
pub fn with_max_tokens(
  request: CreateCompletionRequest,
  max_tokens: Int,
) -> CreateCompletionRequest

with_n

</> 
pub fn with_n(
  request: CreateCompletionRequest,
  n: Int,
) -> CreateCompletionRequest

with_presence_penalty

</> 
pub fn with_presence_penalty(
  request: CreateCompletionRequest,
  presence_penalty: Float,
) -> CreateCompletionRequest

with_seed

</> 
pub fn with_seed(
  request: CreateCompletionRequest,
  seed: Int,
) -> CreateCompletionRequest

with_stop

</> 
pub fn with_stop(
  request: CreateCompletionRequest,
  stop: StopConfiguration,
) -> CreateCompletionRequest

with_stream

</> 
pub fn with_stream(
  request: CreateCompletionRequest,
  stream: Bool,
) -> CreateCompletionRequest

with_suffix

</> 
pub fn with_suffix(
  request: CreateCompletionRequest,
  suffix: String,
) -> CreateCompletionRequest

with_temperature

</> 
pub fn with_temperature(
  request: CreateCompletionRequest,
  temperature: Float,
) -> CreateCompletionRequest

with_top_p

</> 
pub fn with_top_p(
  request: CreateCompletionRequest,
  top_p: Float,
) -> CreateCompletionRequest

with_user

</> 
pub fn with_user(
  request: CreateCompletionRequest,
  user: String,
) -> CreateCompletionRequest
✨ Search Document