> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orq.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Azure Foundry SDK Reference

> SDK reference for Azure Foundry in the Models API, available in Node.js and Python.

## Models

### Azure Foundry Deployments

Lists Azure Foundry deployments under the given base\_url and merges each entry with the matching model catalog entry. Only OpenAI-developed deployments in succeeded state with chat/completion/embedding/vision model types are returned.

```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
from orq_ai_sdk import Orq
import os

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

    res = orq.models.azure_foundry_deployments(api_key="<value>", base_url="https://project.openai.azure.com/openai/v1", provider="<value>")

    # Handle response
    print(res)

```

```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
import { Orq } from "@orq-ai/node";

const orq = new Orq({
  apiKey: process.env["ORQ_API_KEY"] ?? "",
});

async function run() {
  const result = await orq.models.azureFoundryDeployments({
    apiKey: "<value>",
    baseUrl: "https://project.openai.azure.com/openai/v1",
    provider: "<value>",
  });

  console.log(result);
}

run();
```

**Parameters**

```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
    "api_key": str,  # required
    "base_url": str,  # required
    "provider": str,  # required
    "api_version": Optional[str],
}
```

```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  apiKey: string;  // required
  apiVersion?: string;
  baseUrl: string;  // required
  provider: string;  // required
}
```

**Response**

```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
    "deployments": [{
        "base_url": Optional[str],
        "id": str,
        "master_data": {  # optional
            "has_functions": bool,
            "id": str,
            "input_cost": float,
            "metadata": Dict[str, Any],  # optional
            "model_developer": Nullable[str],
            "model_family": Nullable[str],
            "model_id": str,
            "model_type": str,
            "output_cost": float,
            "parameters": List[Any],
        },
        "model": str,
        "publisher": Optional[str],
        "wire": Optional[str],
    }],
    "region": str,
}
```

```typescript Node.js theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  deployments: {
    baseUrl?: string;
    id: string;
    masterData?: {
      hasFunctions: boolean;
      id: string;
      inputCost: number;
      metadata?: Record<string, any>;
      modelDeveloper: string;
      modelFamily: string;
      modelId: string;
      modelType: string;
      outputCost: number;
      parameters: any[];
    };
    model: string;
    publisher?: string;
    wire?: string;
  }[];
  region: string;
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.