EmbeddingsSearchResult

One passage a search found, with the file it came from. Results come best match first.

Kind: an object, used in responses.

Fields

Every field is present in a response; empty ones are null.

Field	Type	Description
id	uuid	The file’s id.
name	string	The file’s name.
contentType	string	The file’s MIME type.
size	integer	The file’s size, in bytes.
type	IngestedFileType	What kind of document the file is.
text	string	The matching passage, cut to 1,000 characters.
score	number	How well the passage matches the query: higher is better.

Example

{
  "id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "name": "...",
  "contentType": "...",
  "size": 0,
  "type": "WordDocument",
  "text": "...",
  "score": 0
}

Where it’s used

• files.search (PUT /files/embeddings/search)