ResponseFormat - Go SDK

ResponseFormat type definition

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

Response format configuration

Supported Types

ChatFormatGrammarConfig

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

FormatJSONObjectConfig

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

ChatFormatJSONSchemaConfig

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

ChatFormatPythonConfig

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

ChatFormatTextConfig

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

Union Discrimination

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

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

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