DOC-API-MODEL-schema-1i0hjer0pd#overview
Annotation
Tagged provider annotation attached to generated content, such as a citation or PDF reference.
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-1i0hjer0pd#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1i0hjer0pd#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1i0hjer0pd#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1i0hjer0pd#request-field-kindkind | string (ANNOTATION_KIND_URL_CITATION, ANNOTATION_KIND_PDF) or integer (int32) | Optional; explicit presence | Selected kind; determines which submessage is populated |
Section ID: DOC-API-MODEL-schema-1i0hjer0pd#request-field-urlcitationurlCitation | UrlCitation | Optional | Submessage fields (optional); populate the one matching kind |
Section ID: DOC-API-MODEL-schema-1i0hjer0pd#request-field-pdfpdf | PdfAnnotation | Optional | PDF annotation identifying the parsed file and available parsing output. |
Section ID: DOC-API-MODEL-schema-1i0hjer0pd#request-field-metadatametadata | Map from string to string | Optional | Provider-specific extras. |
Values of kind
Section ID: DOC-API-MODEL-schema-1i0hjer0pd#request-values-kind
Kind of source annotation associated with generated content.
| Value | No. | Form | Meaning |
|---|---|---|---|
ANNOTATION_KIND_URL_CITATION | 0 | Canonical | A citation to a source identified by its URL. |
ANNOTATION_KIND_PDF | 1 | Canonical | An annotation identifying source content in a PDF document. |
In responses
Section ID: DOC-API-MODEL-schema-1i0hjer0pd#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1i0hjer0pd#field-kindSection ID: DOC-API-MODEL-schema-1i0hjer0pd#response-field-kindkind | string (ANNOTATION_KIND_URL_CITATION, ANNOTATION_KIND_PDF) or integer (int32) | Optional; explicit presence | Selected kind; determines which submessage is populated |
Section ID: DOC-API-MODEL-schema-1i0hjer0pd#field-urlcitationSection ID: DOC-API-MODEL-schema-1i0hjer0pd#response-field-urlcitationurlCitation | UrlCitation | Optional | Submessage fields (optional); populate the one matching kind |
Section ID: DOC-API-MODEL-schema-1i0hjer0pd#field-pdfSection ID: DOC-API-MODEL-schema-1i0hjer0pd#response-field-pdfpdf | PdfAnnotation | Optional | PDF annotation identifying the parsed file and available parsing output. |
Section ID: DOC-API-MODEL-schema-1i0hjer0pd#field-metadataSection ID: DOC-API-MODEL-schema-1i0hjer0pd#response-field-metadatametadata | Map from string to string | Optional | Provider-specific extras. |
Values of kind
Section ID: DOC-API-MODEL-schema-1i0hjer0pd#response-values-kind
Kind of source annotation associated with generated content.
| Value | No. | Form | Meaning |
|---|---|---|---|
ANNOTATION_KIND_URL_CITATION | 0 | Canonical | A citation to a source identified by its URL. |
ANNOTATION_KIND_PDF | 1 | Canonical | An annotation identifying source content in a PDF document. |
Where used
Section ID: DOC-API-MODEL-schema-1i0hjer0pd#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). |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1i0hjer0pd