Sign in
AI Collections

Get collection settings

Returns the retrieval settings for a collection.

get/ai/collections/{uuid}/settings

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

Changed in 2 of the 99 revisions of this API.228

  • a6a61a29ecdd227See the full diff
    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      the response property // became required for the status

      response-property-became-required

    • ○

      removed the keyword enum value from the // response property for the response status

      response-property-enum-value-removed

    This revision also has 34 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1571b0380bd71See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 99 revisions, 1 has no diff computed.