DOC-API-MODEL-schema-q92tfl8qp2#overview
TextDocument
Text and associated metadata submitted for an embedding-assisted upsert. id identifies the vector record, text supplies the content to embed, and metadata carries additional attributes.
Type-reference view: API Schema t0tqko5pgb. Request and response views describe this type; they do not declare an endpoint.
Meaning and usage
Section ID: DOC-API-MODEL-schema-q92tfl8qp2#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-q92tfl8qp2#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-q92tfl8qp2#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-q92tfl8qp2#request-field-idid | string | Required in requests | Identifier used to associate embedded text with its vector record. Minimum length: 1. |
Section ID: DOC-API-MODEL-schema-q92tfl8qp2#request-field-texttext | string | Required in requests | Text content supplied for the embedding or document. Minimum length: 1. |
Section ID: DOC-API-MODEL-schema-q92tfl8qp2#request-field-metadatametadata | Map from string to JSON value | Optional | Additional attributes associated with the resource. |
Request validation
Section ID: DOC-API-MODEL-schema-q92tfl8qp2#request-validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
id | Minimum length | 1 |
text | Minimum length | 1 |
In responses
Section ID: DOC-API-MODEL-schema-q92tfl8qp2#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-q92tfl8qp2#field-idSection ID: DOC-API-MODEL-schema-q92tfl8qp2#response-field-idid | string | Required in requests | Identifier used to associate embedded text with its vector record. |
Section ID: DOC-API-MODEL-schema-q92tfl8qp2#field-textSection ID: DOC-API-MODEL-schema-q92tfl8qp2#response-field-texttext | string | Required in requests | Text content supplied for the embedding or document. |
Section ID: DOC-API-MODEL-schema-q92tfl8qp2#field-metadataSection ID: DOC-API-MODEL-schema-q92tfl8qp2#response-field-metadatametadata | Map from string to JSON value | Optional | Additional attributes associated with the resource. |
DOC-API-MODEL-schema-q92tfl8qp2#validation
Request validation
Section ID: DOC-API-MODEL-schema-q92tfl8qp2#response-validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
id | Minimum length | 1 |
text | Minimum length | 1 |
Where used
Section ID: DOC-API-MODEL-schema-q92tfl8qp2#where-used
| Reference | Relationship |
|---|---|
| TextDocument | API JSON uses JSON field names (camelCase). |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-q92tfl8qp2