model_routers

Creates, updates, deletes, gets or lists a model_routers resource.

Overview

Name	model_routers
Type	Resource
Id	digitalocean.genai.model_routers

Fields

The following fields are returned by SELECT queries:

genai_get_model_router

A successful response.

Name	Datatype	Description
name	string	Name of the model router (example: example name)
config	object
created_at	string (date-time)	Creation date / time (example: 2023-01-01T00:00:00Z)
description	string	Description (example: example string)
regions	array	Target regions for the router
updated_at	string (date-time)	Last modified (example: 2023-01-01T00:00:00Z)
uuid	string	Unique id (example: 123e4567-e89b-12d3-a456-426614174000)

genai_list_model_routers

A successful response.

Name	Datatype	Description
name	string	Name of the model router (example: example name)
config	object
created_at	string (date-time)	Creation date / time (example: 2023-01-01T00:00:00Z)
description	string	Description (example: example string)
regions	array	Target regions for the router
updated_at	string (date-time)	Last modified (example: 2023-01-01T00:00:00Z)
uuid	string	Unique id (example: 123e4567-e89b-12d3-a456-426614174000)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
genai_get_model_router	select	uuid		To retrieve details of a model router, send a GET request to /v2/gen-ai/models/routers/{uuid}.
genai_list_model_routers	select		page, per_page	To list model routers, send a GET request to /v2/gen-ai/models/routers.
genai_create_model_router	insert			To create a model router, send a POST request to /v2/gen-ai/models/routers.
genai_update_model_router	replace	uuid		To update a model router, send a PUT request to /v2/gen-ai/models/routers/{uuid}.
genai_delete_model_router	delete	uuid		To delete a model router, send a DELETE request to /v2/gen-ai/models/routers/{uuid}.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
uuid	string	Model router id (example: "123e4567-e89b-12d3-a456-426614174000")
page	integer	Page number. (example: 1)
per_page	integer	Items per page. (example: 1)

SELECT examples

genai_get_model_router

To retrieve details of a model router, send a GET request to /v2/gen-ai/models/routers/{uuid}.

SELECT
name,
config,
created_at,
description,
regions,
updated_at,
uuid
FROM digitalocean.genai.model_routers
WHERE uuid = '{{ uuid }}' -- required
;

genai_list_model_routers

To list model routers, send a GET request to /v2/gen-ai/models/routers.

SELECT
name,
config,
created_at,
description,
regions,
updated_at,
uuid
FROM digitalocean.genai.model_routers
WHERE page = '{{ page }}'
AND per_page = '{{ per_page }}'
;

INSERT examples

genai_create_model_router

To create a model router, send a POST request to /v2/gen-ai/models/routers.

INSERT INTO digitalocean.genai.model_routers (
description,
fallback_models,
name,
policies,
regions
)
SELECT 
'{{ description }}',
'{{ fallback_models }}',
'{{ name }}',
'{{ policies }}',
'{{ regions }}'
RETURNING
model_router
;

Manifest

# Description fields are for documentation purposes
- name: model_routers
props:
  - name: description
    value: "{{ description }}"
    description: |
      Model router description
  - name: fallback_models
    value:
      - "{{ fallback_models }}"
    description: |
      At least one fallback model is required; order defines failover priority
  - name: name
    value: "{{ name }}"
    description: |
      Model router name: lowercase, at most 255 characters, only a-z, 0-9, and hyphens
  - name: policies
    description: |
      Router policies
    value:
      - custom_task:
          description: "{{ description }}"
          name: "{{ name }}"
        models: "{{ models }}"
        selection_policy:
          prefer: "{{ prefer }}"
        task_slug: "{{ task_slug }}"
  - name: regions
    value:
      - "{{ regions }}"
    description: |
      DEPRECATED: this field does not affect deployment and model routers are always
      deployed to all regions. Must be omitted or set to ["all"].

REPLACE examples

genai_update_model_router

To update a model router, send a PUT request to /v2/gen-ai/models/routers/{uuid}.

REPLACE digitalocean.genai.model_routers
SET 
description = '{{ description }}',
fallback_models = '{{ fallback_models }}',
name = '{{ name }}',
policies = '{{ policies }}',
regions = '{{ regions }}',
uuid = '{{ uuid }}'
WHERE 
uuid = '{{ uuid }}' --required
RETURNING
model_router;

DELETE examples

genai_delete_model_router

To delete a model router, send a DELETE request to /v2/gen-ai/models/routers/{uuid}.

DELETE FROM digitalocean.genai.model_routers
WHERE uuid = '{{ uuid }}' --required
;