Skip to main content

Embed documents

POST 

/ai/embeddings

Perform embedding on a Telnyx Storage Bucket using the a embedding model. The current supported file types are:

  • PDF
  • HTML
  • txt/unstructured text files
  • json
  • csv
  • audio / video (mp3, mp4, mpeg, mpga, m4a, wav, or webm ) - Max of 20mb file size.

Any files not matching the above types will be attempted to be embedded as unstructured text.

This process can be slow, so it runs in the background and the user can check the status of the task using the endpoint /ai/embeddings/{task_id}.

Important Note: When you update documents in a Telnyx Storage bucket, their associated embeddings are automatically kept up to date. If you add or update a file, it is automatically embedded. If you delete a file, the embeddings are deleted for that particular file.

You can also specify a custom loader param. Currently the only supported loader value is intercom which loads Intercom article jsons as specified by the Intercom article API This loader will split each article into paragraphs and save additional parameters relevant to Intercom docs, such as article_url and heading. These values will be returned by the /v2/ai/embeddings/similarity-search endpoint in the loader_metadata field.

Request

Body

required

    bucket_name Bucket Namerequired
    document_chunk_size Document Chunk Size

    Default value: 1024

    document_chunk_overlap_size Document Chunk Overlap Size

    Default value: 512

    embedding_model object

    Supported models to vectorize and embed documents.

    loader object

    Supported types of custom document loaders for embeddings.

Responses

200: Successful Response

Schema

    data

    object

    required

    task_id uuid
    task_name Task Name
    status Status
    created_at Created At
    finished_at Finished Atnullable
    user_id uuid

422: Validation Error

Schema

    detail

    object[]

  • Array [

  • loc

    object[]

    required

  • Array [

  • anyOf

    string

  • ]

  • msg Messagerequired
    type Error Typerequired
  • ]

Loading...