Skip to content

README.md

Latest commit

 

History

History
157 lines (109 loc) · 18.9 KB

README.md

File metadata and controls

157 lines (109 loc) · 18.9 KB
Raw

ModelCatalog

Overview

Available Operations

  • list - List the model catalog
  • list_offerings - List model catalog offerings
  • get - Retrieve a model catalog entry

list

Returns every model orq offers, optionally filtered, searched and sorted. Deprecated models are never listed; fetch one directly by id to inspect it. Unset limit returns the whole catalog. Use starting_after or ending_before to page through the collection.

Example Usage

from orq_ai_sdk import Orq
import os


with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.model_catalog.list()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
limit Optional[int] ➖ Page size, 1–1000. Unset returns every non-deprecated model in one response.
starting_after Optional[str] ➖ Cursor for forward pagination. Set to the id of the last item from
the previous page.
ending_before Optional[str] ➖ Cursor for backward pagination. Set to the id of the first item
from the previous page.
provider List[str] ➖ Filter by catalog provider key. Repeat to match any of several
providers.
endpoint List[str] ➖ Filter by API endpoint. Repeat to match any of several endpoints.
input_modality List[str] ➖ Filter by input modality. Repeat to match any of several modalities.
output_modality List[str] ➖ Filter by output modality. Repeat to match any of several modalities.
location List[str] ➖ Filter by region. Repeat to match any of several regions.
feature List[str] ➖ Filter by normalized feature name. Repeat to match any of several
features.
supported_parameter List[str] ➖ Filter by supported parameter key. Repeat to match any of several
parameters.
tier List[str] ➖ Filter by supported service tier. Repeat to match any of several
tiers.
offering_of Optional[str] ➖ Filter to offerings of one base model reference, <developer>/<stem>.
search Optional[str] ➖ Case-insensitive substring search over id, name and description.
sort_by Optional[str] ➖ Field to sort by.
order Optional[str] ➖ Sort order. Defaults to ascending.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ListModelCatalogResponse

Errors

Error Type Status Code Content Type
models.APIDefaultError 4XX, 5XX */*

list_offerings

Returns every provider offering of one base model, identified by <developer>/<stem> (for example anthropic/claude-opus-4-7). Deprecated models are never listed.

Example Usage

from orq_ai_sdk import Orq
import os


with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.model_catalog.list_offerings(model="Cruze")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description Example
model str ✔️ Base model reference, <developer>/<stem> (for example
anthropic/claude-opus-4-7).		 openai/gpt-5.6-sol
limit Optional[int] ➖ Page size, 1–1000. Unset returns every non-deprecated model in one response.
starting_after Optional[str] ➖ Cursor for forward pagination. Set to the id of the last item from
the previous page.
ending_before Optional[str] ➖ Cursor for backward pagination. Set to the id of the first item
from the previous page.
provider List[str] ➖ Filter by catalog provider key. Repeat to match any of several
providers.
endpoint List[str] ➖ Filter by API endpoint. Repeat to match any of several endpoints.
input_modality List[str] ➖ Filter by input modality. Repeat to match any of several modalities.
output_modality List[str] ➖ Filter by output modality. Repeat to match any of several modalities.
location List[str] ➖ Filter by region. Repeat to match any of several regions.
feature List[str] ➖ Filter by normalized feature name. Repeat to match any of several
features.
supported_parameter List[str] ➖ Filter by supported parameter key. Repeat to match any of several
parameters.
tier List[str] ➖ Filter by supported service tier. Repeat to match any of several
tiers.
search Optional[str] ➖ Case-insensitive substring search over id, name and description.
sort_by Optional[str] ➖ Field to sort by.
order Optional[str] ➖ Sort order. Defaults to ascending.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ListModelCatalogOfferingsResponse

Errors

Error Type Status Code Content Type
models.APIDefaultError 4XX, 5XX */*

get

Retrieves a single catalog entry by its id, <provider>/<model> (for example openai/gpt-4o). Unlike the list endpoints this also resolves deprecated models; check deprecated and deprecation on the response.

Example Usage

from orq_ai_sdk import Orq
import os


with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.model_catalog.get(id="<id>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
id str ✔️ Catalog identifier, <provider>/<model> (for example openai/gpt-4o).
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.GetModelCatalogModelResponse

Errors

Error Type Status Code Content Type
models.APIDefaultError 4XX, 5XX */*