AI Collections

Get collection settings

Changed on

Returns the retrieval settings for a collection.

get/ai/collections/{uuid}/settings

Request

  • Base URL
    https://api.telnyx.com/v2
  • URL
    https://api.telnyx.com/v2/ai/collections/{uuid}/settings
  • Auth
    HTTP bearer

Path parameters

uuidstring uuid required
Example:6a09ccbd-8f9b-4c3a-9b0e-2f1d3c4b5a6e

The collection's unique identifier.

Response

The collection's retrieval settings.

Example response

{
  "data": {
    "record_type": "ai_collection_settings",
    "retrieval": {
      "top_k": 5,
      "retrieval_type": "vector"
    }
  }
}

Changes

  • 67df31283a8aRevision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • a72569d69430Revision changes
    • info

      endpoint added