-
Notifications
You must be signed in to change notification settings - Fork 0
@ralphschuler.ai function caller.index.<internal>.OpenAI.Completions.CompletionCreateParamsNonStreaming
OpenAI.Completions.CompletionCreateParamsNonStreaming
-
↳
CompletionCreateParamsNonStreaming
- best_of
- echo
- frequency_penalty
- logit_bias
- logprobs
- max_tokens
- model
- n
- presence_penalty
- prompt
- seed
- stop
- stream
- suffix
- temperature
- top_p
- user
• Optional best_of: null | number
Generates best_of completions server-side and returns the "best" (the one with
the highest log probability per token). Results cannot be streamed.
When used with n, best_of controls the number of candidate completions and
n specifies how many to return – best_of must be greater than n.
Note: Because this parameter generates many completions, it can quickly
consume your token quota. Use carefully and ensure that you have reasonable
settings for max_tokens and stop.
CompletionCreateParamsBase.best_of
node_modules/openai/resources/completions.d.ts:118
• Optional echo: null | boolean
Echo back the prompt in addition to the completion
CompletionCreateParamsBase.echo
node_modules/openai/resources/completions.d.ts:122
• Optional frequency_penalty: null | number
Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
See more information about frequency and presence penalties.
CompletionCreateParamsBase.frequency_penalty
node_modules/openai/resources/completions.d.ts:130
• Optional logit_bias: null | Record<string, number>
Modify the likelihood of specified tokens appearing in the completion.
Accepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this tokenizer tool (which works for both GPT-2 and GPT-3) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.
As an example, you can pass {"50256": -100} to prevent the <|endoftext|> token
from being generated.
CompletionCreateParamsBase.logit_bias
node_modules/openai/resources/completions.d.ts:146
• Optional logprobs: null | number
Include the log probabilities on the logprobs most likely tokens, as well the
chosen tokens. For example, if logprobs is 5, the API will return a list of
the 5 most likely tokens. The API will always return the logprob of the
sampled token, so there may be up to logprobs+1 elements in the response.
The maximum value for logprobs is 5.
CompletionCreateParamsBase.logprobs
node_modules/openai/resources/completions.d.ts:155
• Optional max_tokens: null | number
The maximum number of tokens to generate in the completion.
The token count of your prompt plus max_tokens cannot exceed the model's
context length.
Example Python code
for counting tokens.
CompletionCreateParamsBase.max_tokens
node_modules/openai/resources/completions.d.ts:164
• model: string & {} | "babbage-002" | "davinci-002" | "gpt-3.5-turbo-instruct" | "text-davinci-003" | "text-davinci-002" | "text-davinci-001" | "code-davinci-002" | "text-curie-001" | "text-babbage-001" | "text-ada-001"
ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.
CompletionCreateParamsBase.model
node_modules/openai/resources/completions.d.ts:97
• Optional n: null | number
How many completions to generate for each prompt.
Note: Because this parameter generates many completions, it can quickly
consume your token quota. Use carefully and ensure that you have reasonable
settings for max_tokens and stop.
node_modules/openai/resources/completions.d.ts:172
• Optional presence_penalty: null | number
Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.
See more information about frequency and presence penalties.
CompletionCreateParamsBase.presence_penalty
node_modules/openai/resources/completions.d.ts:180
• prompt: null | string | string[] | number[] | number[][]
The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.
Note that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document.
CompletionCreateParamsBase.prompt
node_modules/openai/resources/completions.d.ts:106
• Optional seed: null | number
If specified, our system will make a best effort to sample deterministically,
such that repeated requests with the same seed and parameters should return
the same result.
Determinism is not guaranteed, and you should refer to the system_fingerprint
response parameter to monitor changes in the backend.
CompletionCreateParamsBase.seed
node_modules/openai/resources/completions.d.ts:189
• Optional stop: null | string | string[]
Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.
CompletionCreateParamsBase.stop
node_modules/openai/resources/completions.d.ts:194
• Optional stream: null | false
Whether to stream back partial progress. If set, tokens will be sent as
data-only
server-sent events
as they become available, with the stream terminated by a data: [DONE]
message.
Example Python code.
CompletionCreateParamsBase.stream
node_modules/openai/resources/completions.d.ts:244
• Optional suffix: null | string
The suffix that comes after a completion of inserted text.
CompletionCreateParamsBase.suffix
node_modules/openai/resources/completions.d.ts:207
• Optional temperature: null | number
What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.
We generally recommend altering this or top_p but not both.
CompletionCreateParamsBase.temperature
node_modules/openai/resources/completions.d.ts:215
• Optional top_p: null | number
An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.
We generally recommend altering this or temperature but not both.
CompletionCreateParamsBase.top_p
node_modules/openai/resources/completions.d.ts:223
• Optional user: string
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
CompletionCreateParamsBase.user
node_modules/openai/resources/completions.d.ts:229
- @ralphschuler/ai-function-caller
- index
- types/AIFunction
- types/Message
- @ralphschuler/assert
- assert
- assert
- assert
- assert
- assert
- assert
- assert
- assert
- assert
- assert
- assert
- assert
- assert
- error
- index
- util
- @ralphschuler/better-map
- @ralphschuler/better-set
- @ralphschuler/binary-serializer
- @ralphschuler/bit-mask
- @ralphschuler/complex-compare
- @ralphschuler/i811n
- @ralphschuler/logger
- Color
- ColorMap
- Logger
- animations/BallonAnimation
- animations/BaseAnimation
- animations/BombAnimation
- animations/BouncingBallAnimation
- animations/ClockAnimation
- animations/DotsAnimation
- animations/HorizontalBarAnimation
- animations/PongAnimation
- animations/ProgressAnimation
- animations/ProgressBarAnimation
- animations/SpinnerAnimation
- animations/VerticalBarAnimation
- enums/LogLevel
- index
- interfaces/IColor
- interfaces/IMessage
- types/ColorName
- types/Colors
- @ralphschuler/lsystem
- @ralphschuler/mixin-class-factory
- @ralphschuler/neuronal-network
- @ralphschuler/parser-combinator
- index
- inputTypes
- parser
- unicode
- @ralphschuler/prom-metrics-decorator
- @ralphschuler/prom-metrics-parser
- @ralphschuler/random
- PseudoRandomItemSelector
- PseudoRandomNumberGenerator
- Seed
- index
- strategies
- strategy
- strategy
- strategy
- strategy
- strategy
- strategy
- types
- type
- type
- type
- @ralphschuler/safe-array
- @ralphschuler/slot-mashine
- @ralphschuler/state-store
- StateStore
- index
- type
- type
- type
- type
- type
- type
- type
- type
- util
- @ralphschuler/stats-tracker
- @ralphschuler/ts-error
- error
- index
- type
- util
- util
- util
- util
- @ralphschuler/webgl-sand-engine
- index
- pixel-renderer
- @ralphschuler/webgl-shader-factory
- "node:stream/consumers"
- "node:stream/promises"
- ChatCompletionSnapshot
- Choice
- Message
- ToolCall
- EventEmitter
- FormData
- OpenAI
- OpenAI
- Audio
- Speech
- Transcriptions
- Translations
- Beta
- Assistants
- Assistant
- AssistantCreateParams
- AssistantUpdateParams
- Files
- Chat
- Threads
- Messages
- Files
- MessageContentImageFile
- MessageContentText
- Text
- FileCitation
- FilePath
- Runs
- RequiredActionFunctionToolCall
- Run
- RequiredAction
- RunCreateParams
- RunSubmitToolOutputsParams
- Steps
- CodeToolCall
- CodeInterpreter
- Image
- FunctionToolCall
- MessageCreationStepDetails
- RunStep
- ThreadCreateAndRunParams
- Thread
- ThreadCreateParams
- Chat
- Completions
- ChatCompletion
- ChatCompletionAssistantMessageParam
- ChatCompletionChunk
- Choice
- Delta
- ToolCall
- ChatCompletionContentPartImage
- ChatCompletionCreateParams
- ChatCompletionMessage
- ChatCompletionMessageToolCall
- ChatCompletionNamedToolChoice
- Completions
- CompletionChoice
- CompletionCreateParams
- Edits
- Edit
- Embeddings
- CreateEmbeddingResponse
- Files
- FineTunes
- FineTune
- FineTuneCreateParams
- FineTuneListEventsParams
- FineTuning
- Jobs
- FineTuningJob
- JobCreateParams
- Images
- Models
- Moderations
- Moderation
- internal
- finished
- pipeline
- "node:stream/consumers"
- "node:stream/promises"
- EventEmitter
- internal
- finished
- pipeline
- Counter
- Gauge
- Histogram
- Summary