Section ID:
DOC-API-MODEL-schema-1ilcikuhu8#overview
TurnInfo
Turn position within an agentic generation run
Type-reference view: API Schema 9frhv4euve, API Schema 9ftjkkjhfa. Request and response views describe this type; they do not declare an endpoint.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1ilcikuhu8#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1ilcikuhu8#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1ilcikuhu8#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1ilcikuhu8#request-field-currentturncurrentTurn | string (int64) | Optional | Current turn position within the generation run. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1ilcikuhu8#request-field-maxturnsmaxTurns | string (int64) | Optional | Maximum turns configured for the generation run. Pattern: ^-?\d+$. |
In responses
Section ID: DOC-API-MODEL-schema-1ilcikuhu8#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1ilcikuhu8#field-currentturnSection ID: DOC-API-MODEL-schema-1ilcikuhu8#response-field-currentturncurrentTurn | string (int64) | Optional | Current turn position within the generation run. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1ilcikuhu8#field-maxturnsSection ID: DOC-API-MODEL-schema-1ilcikuhu8#response-field-maxturnsmaxTurns | string (int64) | Optional | Maximum turns configured for the generation run. Pattern: ^-?\d+$. |
Where used
Section ID: DOC-API-MODEL-schema-1ilcikuhu8#where-used
| Reference | Relationship |
|---|---|
| Withdraw your rating on a message | POST /api/v1/llm/delete-message-rating |
| Get full conversation state | POST /api/v1/llm/conversation-state |
| Rate an assistant message | POST /api/v1/llm/rate-message |
| Send a message and wait for the result | POST /api/v1/llm/send-message-sync |
| Submit client-side tool results and wait for the next segment | POST /api/v1/llm/submit-client-tool-results-sync |
| Append a message without generating | POST /api/v1/llm/append-message |
| Send a message to a conversation | POST /api/v1/llm/send-message |
| ReceiveMessageRequest | API JSON uses JSON field names (camelCase). |
| ClientToolDispatch | API JSON uses JSON field names (camelCase). |
Models containing this value
| Model | Relationship |
|---|---|
| GenerationContext | Nested in model |
| GenerationContext | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1ilcikuhu8