COcouchbase
Models (AI Data Plane)

List Models

Changed on

Fetches the details of all the models.

In order to access this endpoint, the provided API key must have at least one of the following roles:

  • Organization Member

To learn more, see Organization, Project, and Database Access Overview.

get/v4/organizations/{organizationId}/aiServices/models

Request

Query parameters

pageinteger

Sets the page you would like to view.

perPageinteger

Sets the number of results you would like to have on each page.

modelStatus'pending' | 'deploying' | 'deployFailed' | 'healthy' | 'unhealthy' | 'pausing' | 'paused' | 'resuming' | 'pauseFailed' | 'resumeFailed'

Filter by model status. All models are returned when set empty.

modelKind'embedding-generation' | 'sparse-embedding-generation' | 'text-generation'

Filter by model kind. All models are returned when this is set empty.

Response

Successfully fetched the models.

Example response

{
  "data": [
    {
      "model": {
        "id": "fffffffff-aaaa-1414-eeee-000000000000",
        "name": "my-new-model",
        "config": {
          "catalogModelName": "meta-llama/Llama-3.1-8B-Instruct",
          "provider": "meta",
          "quantization": "fullPrecision",
          "optimization": "latency",
          "dimensions": 4096,
          "caching": {
            "enableStandard": true,
            "semantic": {
              "embeddingModel": "my-embedding-model-id",
              "scoreThreshold": 0.75,
              "dimensions": 4096,
              "distanceMetric": "dot_product"
            },
            "defaultCache": "semantic",
            "expiryTTL": 1000
          },
          "enableBatching": true,
          "keywordFiltering": [
            "harassment",
            "murder"
          ]
        },
        "cloudConfig": {
          "provider": "aws",
          "region": "us-east-1",
          "compute": {
            "cpu": 4,
            "gpuMemory": 48
          }
        },
        "status": "deploying",
        "usageMetrics": {
          "tokens": {
            "value": 345,
            "trend": "increasing"
          },
          "requests": {
            "value": 4094,
            "trend": "increasing"
          }
        },
        "connectionString": "http://endpoint.com",
        "audit": {
          "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
          "createdAt": "2021-09-01T12:34:56Z",
          "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
          "modifiedAt": "2021-09-01T12:34:56Z",
          "version": 1
        },
        "actions": [
          "delete"
        ]
      }
    }
  ],
  "cursor": {
    "pages": {
      "page": 2,
      "next": 3,
      "previous": 1,
      "last": 10,
      "perPage": 10,
      "totalItems": 10
    },
    "hrefs": {
      "first": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "last": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "previous": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "next": "https://cloud.couchbase.com/v4/users?page=1&perPage=10"
    }
  }
}

Changes

  • a5e88bcf71cbRevision changes
    • warning

      added the new sparse-embedding-generation enum value to the //// response property for the response status

    • info

      added the new enum value sparse-embedding-generation to the query request parameter modelKind

  • e67df5d1f74eRevision changes
    • info

      api tag Models (AI Data Plane) added

    • info

      api tag Models (AI Services) removed