How to use structured outputs with Assistants?

[simrat39]

Hi, how do I use the structured outputs (json_schema) mode with the assistants / runs. I tried this but it doesn't seem to be working (unless I'm doing something wrong):

        RunObject runObject = await _client.createThreadRun(
          threadId: _threadObject.id,
          request: CreateRunRequest(
            assistantId: ...,
            responseFormat: const CreateRunRequestResponseFormat.format(
              AssistantsResponseFormat(
                type: AssistantsResponseFormatType.jsonObject,
              ),
            ),
          ),
        );

[davidmigloz]

Hey @simrat39,

You have to use ResponseFormat.jsonSchema, like:

RunObject runObject = await client.createThreadRun(
  threadId: _threadObject.id,
  request: CreateRunRequest(
      assistantId: ...,
      responseFormat: CreateRunRequestResponseFormat.responseFormat(
          ResponseFormat.jsonSchema(
            jsonSchema: JsonSchemaObject(
              name: 'Names',
              description: 'A list of names',
              strict: true,
              schema: {
                'type': 'object',
                'properties': {
                  'names': {
                    'type': 'array',
                    'items': {
                      'type': 'string',
                    },
                  },
                },
                'additionalProperties': false,
                'required': ['names'],
              },
            ),
          ),
      ),
  ),
);

[simrat39]

This works. Thanks.

Thanks for the work on the amazing library as well!

[davidmigloz]

awesome, thanks! ☺️