ExOpenAI.Classifications (ex_openai.ex v1.0.4) View Source

Modules for interacting with the classifications group of OpenAI APIs

API Reference: https://platform.openai.com/docs/api-reference/classifications

Link to this section Summary


Classifies the specified query using provided examples.

Link to this section Functions

Link to this function

create_classification(model, query, opts \\ [])

View Source
This function is deprecated. Deprecated by OpenAI.


create_classification(String.t(), String.t(),
  user: String.t(),
  temperature: float(),
  search_model: String.t(),
  return_prompt: boolean(),
  return_metadata: boolean(),
  max_examples: integer(),
  logprobs: integer(),
  logit_bias: map(),
  labels: [String.t()],
  file: String.t(),
  expand: [map()],
  examples: [[String.t()]]
) ::
  {:ok, ExOpenAI.Components.CreateClassificationResponse.t()} | {:error, any()}

Classifies the specified query using provided examples.

The endpoint first 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 endpoint.

Labeled examples can be provided via an uploaded file, or explicitly listed in the request using the examples parameter for quick tests and small scale use cases.

Endpoint: https://api.openai.com/v1/classifications

Method: POST

Docs: https://platform.openai.com/docs/api-reference/classifications

Required Arguments:

  • model: 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.

  • query: Query to be classified.

Example: The plot is not very attractive.

Optional Arguments:

  • 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 either examples or file, but not both.

Example: "[['Do not see this film.', 'Negative'], ['Smart, provocative and blisteringly funny.', 'Positive']]"

  • 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 completion and file objects for expansion.

  • file: The ID of the uploaded file that contains training examples. See upload file for how to upload a file of the desired format and purpose.

You should specify either examples or file, 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.

Example: ["Positive", "Negative"]

  • logit_bias: 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.

  • logprobs: 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. 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.

  • max_examples: The maximum number of examples to be ranked by Search when using file. Setting it to a higher value leads to improved accuracy but with increased latency and cost.

  • return_metadata: 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.

  • return_prompt: 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.

  • search_model: ID of the model to use for Search. You can select one of ada, babbage, curie, or davinci.

  • temperature: 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.

Example: 0

  • user: A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

Example: "user-1234"