object Classifications
- Alphabetic
- By Inheritance
- Classifications
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- class Live extends Classifications
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def createClassification(model: String, query: Query, examples: Optional[Chunk[Chunk[ExamplesItemItem]]] = Optional.Absent, file: Optional[String] = Optional.Absent, labels: Optional[Chunk[String]] = Optional.Absent, searchModel: Optional[String] = Optional.Absent, temperature: Optional[Temperature] = Optional.Absent, logprobs: Optional[Logprobs] = Optional.Absent, maxExamples: Optional[Int] = Optional.Absent, logitBias: Optional[LogitBias] = Optional.Absent, returnPrompt: Optional[Boolean] = Optional.Absent, returnMetadata: Optional[Boolean] = Optional.Absent, expand: Optional[Chunk[ExpandItem]] = Optional.Absent, user: Optional[String] = Optional.Absent): ZIO[Classifications, OpenAIFailure, CreateClassificationResponse]
Classifies the specified
queryusing provided examples.Classifies the specified
queryusing provided examples.The endpoint first [searches](/docs/api-reference/searches) over the labeled examples to select the ones most relevant for the particular query. Then, the relevant examples are combined with the query to construct a prompt to produce the final label via the [completions](/docs/api-reference/completions) endpoint.
Labeled examples can be provided via an uploaded
file, or explicitly listed in the request using theexamplesparameter for quick tests and small scale use cases.- model
ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.
- query
Query to be classified.
- examples
A list of examples with labels, in the following format:
[ ["The movie is so interesting.", "Positive"], ["It is quite boring.", "Negative"], ...]All the label strings will be normalized to be capitalized. You should specify eitherexamplesorfile, but not both.- file
The ID of the uploaded file that contains training examples. See [upload file](/docs/api-reference/files/upload) for how to upload a file of the desired format and purpose. You should specify either
examplesorfile, but not both.- labels
The set of categories being classified. If not specified, candidate labels will be automatically collected from the examples you provide. All the label strings will be normalized to be capitalized.
- searchModel
ID of the model to use for [Search](/docs/api-reference/searches/create). You can select one of
ada,babbage,curie, ordavinci.- temperature
What sampling
temperatureto use. Higher values mean the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer.- logprobs
Include the log probabilities on the
logprobsmost likely tokens, as well the chosen tokens. For example, iflogprobsis 5, the API will return a list of the 5 most likely tokens. The API will always return thelogprobof the sampled token, so there may be up tologprobs+1elements in the response. The maximum value forlogprobsis 5. If you need more than this, please contact us through our [Help center](https://help.openai.com) and describe your use case. Whenlogprobsis set,completionwill be automatically added intoexpandto get the logprobs.- maxExamples
The maximum number of examples to be ranked by [Search](/docs/api-reference/searches/create) when using
file. Setting it to a higher value leads to improved accuracy but with increased latency and cost.- logitBias
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](/tokenizer?view=bpe) (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.- returnPrompt
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.- returnMetadata
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 whenfileis set.- expand
If 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
completionandfileobjects for expansion.- user
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).
- Annotations
- @deprecated
- Deprecated
- def createClassification(body: CreateClassificationRequest): ZIO[Classifications, OpenAIFailure, CreateClassificationResponse]
Classifies the specified
queryusing provided examples.Classifies the specified
queryusing provided examples.The endpoint first [searches](/docs/api-reference/searches) over the labeled examples to select the ones most relevant for the particular query. Then, the relevant examples are combined with the query to construct a prompt to produce the final label via the [completions](/docs/api-reference/completions) endpoint.
Labeled examples can be provided via an uploaded
file, or explicitly listed in the request using theexamplesparameter for quick tests and small scale use cases.- Annotations
- @deprecated
- Deprecated
- def default: ZLayer[Any, Throwable, Classifications]
- Annotations
- @deprecated
- Deprecated
- def live: ZLayer[Client, Nothing, Classifications]
- Annotations
- @deprecated
- Deprecated