Function structuredOutput

packages/openai-base/src/adapters/responses-text.ts:180–267

* Generate structured output using the provider's native JSON Schema response format. * Uses stream: false to get the complete response in one call. * * OpenAI-compatible Responses APIs have strict requirements for structured output: * - All properties must be in the `required` array

(
    options: StructuredOutputOptions<TProviderOptions>,
  )

   * We apply provider-specific transformations for structured output compatibility.
   */
  async structuredOutput(
    options: StructuredOutputOptions<TProviderOptions>,
  ): Promise<StructuredOutputResult<unknown>> {
    const { chatOptions, outputSchema } = options
    const requestParams = this.mapOptionsToRequest(chatOptions)

    // Apply provider-specific transformations for structured output compatibility
    const jsonSchema = this.makeStructuredOutputCompatible(
      outputSchema,
      outputSchema.required,
    )

    try {
      // Strip streaming-only fields a subclass override of mapOptionsToRequest
      // might have returned (parallel to chat-completions's structuredOutput
      // cleanup) — sending stream_options to a non-streaming call is a 4xx.
      const {
        stream: _stream,
        stream_options: _streamOptions,
        ...cleanParams
      } = requestParams as Record<string, unknown>
      void _stream
      void _streamOptions
      chatOptions.logger.request(
        `activity=structuredOutput provider=${this.name} model=${this.model} messages=${chatOptions.messages.length}`,
        { provider: this.name, model: this.model },
      )
      const response = await this.client.responses.create(
        {
          ...(cleanParams as Omit<ResponseCreateParams, 'stream'>),
          stream: false,
          // Configure structured output via text.format
          text: {
            format: {
              type: 'json_schema',
              name: 'structured_output',
              schema: jsonSchema,
              strict: true,
            },
          },
        },
        extractRequestOptions(chatOptions.request),
      )

      // Extract text content from the response. `stream: false` narrows the
      // SDK return type to `Response`, but the explicit annotation makes
      // that contract local rather than relying on inference through the
      // overloaded `client.responses.create` signature.
      const rawText = this.extractTextFromResponse(response satisfies Response)

      // Fail loud on empty content rather than letting it cascade into a
      // confusing "Failed to parse JSON. Content: " error — the root cause
      // (the model returned no text content for the structured request) is
      // then visible in logs. Mirrors the chat-completions sibling.
      if (rawText.length === 0) {
        throw new Error(
          `${this.name}.structuredOutput: response contained no content`,
        )