Optional documentsList of documents from which the answer for the input question should
be derived. If this is an empty list, the question will be answered based
on the question-answer examples. You should specify either documents
or a file, but not both.
CreateAnswerRequest
List of (question, answer) pairs that will help steer the model towards the tone and answer format you'd like. We recommend adding 2 to 3 examples.
CreateAnswerRequest
A text snippet containing the contextual information used to generate the
answers for the examples you provide.
CreateAnswerRequest
Optional expandIf an object name is in the list, we provide the full information of the
object; otherwise, we only provide the object ID. Currently we support
completion and file objects for expansion.
CreateAnswerRequest
Optional fileThe ID of an uploaded file that contains documents to search over. See
upload file for how to upload a file
of the desired format and purpose. You should specify either documents
or a file, but not both.
CreateAnswerRequest
Optional logit_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.
CreateAnswerRequest
Optional logprobsInclude 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. If you
need more than this, please contact us through our Help
center and describe your use case. When
logprobs is set, completion will be automatically added into expand
to get the logprobs.
CreateAnswerRequest
Optional max_The maximum number of documents to be ranked by
Search when using file. Setting
it to a higher value leads to improved accuracy but with increased
latency and cost.
CreateAnswerRequest
Optional max_The maximum number of tokens allowed for the generated answer
CreateAnswerRequest
ID of the model to use for completion. You can select one of ada,
babbage, curie, or davinci.
CreateAnswerRequest
Optional nHow many answers to generate for each question.
CreateAnswerRequest
Question to get answered.
CreateAnswerRequest
Optional return_A special boolean flag for showing metadata. If set to true, each
document entry in the returned JSON will contain a "metadata" field.
This flag only takes effect when file is set.
CreateAnswerRequest
Optional return_If set to true, the returned JSON will include a "prompt" field
containing the final prompt that was used to request a completion. This
is mainly useful for debugging purposes.
CreateAnswerRequest
Optional search_ID of the model to use for Search.
You can select one of ada, babbage, curie, or davinci.
CreateAnswerRequest
Optional stopCreateAnswerRequest
Optional temperatureWhat sampling temperature to use. Higher values mean the model will take more risks and value 0 (argmax sampling) works better for scenarios with a well-defined answer.
CreateAnswerRequest
Optional userA unique identifier representing your end-user, which will help OpenAI to monitor and detect abuse. Learn more.
CreateAnswerRequest
Generated using TypeDoc
Export
Interface
CreateAnswerRequest