Passages
Search Passages
ModelsExpand Collapse
Passage { embedding, embedding_config, text, 12 more }
Representation of a passage, which is stored in archival memory.
embedding: Array<number> | null
The embedding of the passage.
embedding_config: EmbeddingConfig { embedding_dim, embedding_endpoint_type, embedding_model, 7 more } | null
Configuration for embedding model connection and processing parameters.
embedding_dim: number
The dimension of the embedding.
embedding_endpoint_type: "openai" | "anthropic" | "bedrock" | 16 more
The endpoint type for the model.
embedding_model: string
The model for the embedding.
azure_deployment?: string | null
The Azure deployment for the model.
azure_endpoint?: string | null
The Azure endpoint for the model.
azure_version?: string | null
The Azure version for the model.
batch_size?: number
The maximum batch size for processing embeddings.
embedding_chunk_size?: number | null
The chunk size of the embedding.
embedding_endpoint?: string | null
The endpoint for the model (None if local).
handle?: string | null
The handle for this config, in the format provider/model-name.
text: string
The text of the passage.
id?: string
The human-friendly ID of the Passage
archive_id?: string | null
The unique identifier of the archive containing this passage.
created_at?: string
The creation date of the passage.
created_by_id?: string | null
The id of the user that made this object.
file_id?: string | null
The unique identifier of the file associated with the passage.
file_name?: string | null
The name of the file (only for source passages).
is_deleted?: boolean
Whether this passage is deleted or not.
last_updated_by_id?: string | null
The id of the user that made this object.
metadata?: Record<string, unknown> | null
The metadata of the passage.
Deprecatedsource_id?: string | null
Deprecated: Use folder_id field instead. The data source of the passage.
tags?: Array<string> | null
Tags associated with this passage.
updated_at?: string | null
The timestamp when the object was last updated.