ResponseFormat - Go SDK

ResponseFormat type definition

The Go SDK and docs are currently in beta. Report issues on GitHub.

Response format configuration

Supported Types

ChatFormatTextConfig

1responseFormat := components.CreateResponseFormatText(components.ChatFormatTextConfig{/* values here */})

FormatJSONObjectConfig

1responseFormat := components.CreateResponseFormatJSONObject(components.FormatJSONObjectConfig{/* values here */})

ChatFormatJSONSchemaConfig

1responseFormat := components.CreateResponseFormatJSONSchema(components.ChatFormatJSONSchemaConfig{/* values here */})

ChatFormatGrammarConfig

1responseFormat := components.CreateResponseFormatGrammar(components.ChatFormatGrammarConfig{/* values here */})

ChatFormatPythonConfig

1responseFormat := components.CreateResponseFormatPython(components.ChatFormatPythonConfig{/* values here */})

Union Discrimination

Use the Type field to determine which variant is active, then access the corresponding field:

1switch responseFormat.Type {
2 case components.ResponseFormatTypeText:
3 // responseFormat.ChatFormatTextConfig is populated
4 case components.ResponseFormatTypeJSONObject:
5 // responseFormat.FormatJSONObjectConfig is populated
6 case components.ResponseFormatTypeJSONSchema:
7 // responseFormat.ChatFormatJSONSchemaConfig is populated
8 case components.ResponseFormatTypeGrammar:
9 // responseFormat.ChatFormatGrammarConfig is populated
10 case components.ResponseFormatTypePython:
11 // responseFormat.ChatFormatPythonConfig is populated
12}