Section ID: DOC-API-MODEL-schema-q7dt6t9g53#overview

BranchMetadata

Reason, labels, and quality metadata recorded for an alternative conversation branch.

Type-reference view: API Schema 626klhca0u. Request and response views describe this type; they do not declare an endpoint.

Meaning and usage

Section ID: DOC-API-MODEL-schema-q7dt6t9g53#meaning

See the definition above.

Usage profiles

Section ID: DOC-API-MODEL-schema-q7dt6t9g53#fields

Usage	Fields and validation
In requests	View fields
In responses	View fields

In requests

Section ID: DOC-API-MODEL-schema-q7dt6t9g53#request

API JSON uses JSON field names (camelCase).

Field	Type	Presence	Meaning
Section ID: DOC-API-MODEL-schema-q7dt6t9g53#request-field-createdreasoncreatedReason	string	Optional	See meaning below.
Section ID: DOC-API-MODEL-schema-q7dt6t9g53#request-field-descriptiondescription	string	Optional	Description of the conversation branch’s purpose.
Section ID: DOC-API-MODEL-schema-q7dt6t9g53#request-field-tagstags	Map from string to string	Optional	Key-value labels associated with the conversation branch.
Section ID: DOC-API-MODEL-schema-q7dt6t9g53#request-field-qualityscorequalityScore	number (double) or string (NaN, Infinity, -Infinity)	Optional	0-1, how good this branch is.

createdReason

Reason recorded when creating the alternative conversation branch.

"user_request", "error_recovery", "a_b_test"

In responses

Section ID: DOC-API-MODEL-schema-q7dt6t9g53#response

API JSON uses JSON field names (camelCase).

Field	Type	Presence	Meaning
Section ID: DOC-API-MODEL-schema-q7dt6t9g53#field-createdreasonSection ID: DOC-API-MODEL-schema-q7dt6t9g53#response-field-createdreasoncreatedReason	string	Optional	See meaning below.
Section ID: DOC-API-MODEL-schema-q7dt6t9g53#field-descriptionSection ID: DOC-API-MODEL-schema-q7dt6t9g53#response-field-descriptiondescription	string	Optional	Description of the conversation branch’s purpose.
Section ID: DOC-API-MODEL-schema-q7dt6t9g53#field-tagsSection ID: DOC-API-MODEL-schema-q7dt6t9g53#response-field-tagstags	Map from string to string	Optional	Key-value labels associated with the conversation branch.
Section ID: DOC-API-MODEL-schema-q7dt6t9g53#field-qualityscoreSection ID: DOC-API-MODEL-schema-q7dt6t9g53#response-field-qualityscorequalityScore	number (double) or string (NaN, Infinity, -Infinity)	Optional	0-1, how good this branch is.

createdReason

Reason recorded when creating the alternative conversation branch.

"user_request", "error_recovery", "a_b_test"

Where used

Section ID: DOC-API-MODEL-schema-q7dt6t9g53#where-used

Reference	Relationship
ConversationBranch	API JSON uses JSON field names (camelCase).

Models containing this value

Model	Relationship
ConversationBranch	Nested in model
ConversationBranch	Nested in model

Download the public reference contract.

Document ID: DOC-API-MODEL-schema-q7dt6t9g53