Can messages have metadata in chat completions?

API
4

Hi @ning.li !

Ok I figured it out - that metadata parameter is only used when you are storing your chat completions, e.g. for use with evaluation or distillation - so you have to also set store to true, in combination with metadata.

I did a simple call with "metadata": {"foo": "bar"}, and "store": true and this is what it looks like on my dashboard:

The image shows a chat completion log with details like creation date, request ID, model used, and a simple interaction between a user and an assistant. (Captioned by AI)
The image shows a chat completion log with details like creation date, request ID, model used, and a simple interaction between a user and an assistant. (Captioned by AI)775×882 43.2 KB

I hope that clarifies it!

In the meantime I will also create a note that the API reference should be updated, i.e. store must be set to true otherwise you will get the following error:

  "error": {
    "message": "The 'metadata' parameter is only allowed when 'store' is enabled.",
    "type": "invalid_request_error",
    "param": "metadata",
    "code": null
  }