azure_ai_foundry_tools 0.8.0

Vision and Document Intelligence clients for Azure AI Foundry - Rust SDK
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

# azure_ai_foundry_tools

[![Crates.io](https://img.shields.io/crates/v/azure_ai_foundry_tools.svg)](https://crates.io/crates/azure_ai_foundry_tools)
[![docs.rs](https://docs.rs/azure_ai_foundry_tools/badge.svg)](https://docs.rs/azure_ai_foundry_tools)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](../../LICENSE)

Vision and Document Intelligence clients for the Azure AI Foundry Rust SDK.

## Features

- **Vision** — Image Analysis 4.0: tags, captions, object detection, OCR, smart crops, people
- **Document Intelligence** — Document Intelligence v4.0: OCR, layout, invoices, receipts,
  ID documents, business cards
- **Tracing** — Full instrumentation with `tracing` spans

## Installation

```toml
[dependencies]
azure_ai_foundry_core = "0.8"
azure_ai_foundry_tools = "0.8"
tokio = { version = "1", features = ["full"] }
```

## Usage

### Analyze an Image

```rust,no_run
use azure_ai_foundry_core::client::FoundryClient;
use azure_ai_foundry_core::auth::FoundryCredential;
use azure_ai_foundry_tools::vision::{self, ImageAnalysisRequest, VisualFeature};

# async fn example() -> Result<(), Box<dyn std::error::Error>> {
let client = FoundryClient::builder()
    .endpoint("https://your-resource.services.ai.azure.com")
    .credential(FoundryCredential::api_key("your-key"))
    .build()?;

let request = ImageAnalysisRequest::builder()
    .url("https://example.com/image.jpg")
    .features(vec![VisualFeature::Tags, VisualFeature::Caption])
    .try_build()?;

let result = vision::analyze(&client, &request).await?;
if let Some(caption) = &result.caption_result {
    println!("Caption: {} ({:.1}%)", caption.text, caption.confidence * 100.0);
}
# Ok(())
# }
```

### Analyze a Document

```rust,no_run
use azure_ai_foundry_core::client::FoundryClient;
use azure_ai_foundry_core::auth::FoundryCredential;
use azure_ai_foundry_tools::document_intelligence::{
    self, DocumentAnalysisRequest, PREBUILT_READ,
};

# async fn example() -> Result<(), Box<dyn std::error::Error>> {
let client = FoundryClient::builder()
    .endpoint("https://your-resource.services.ai.azure.com")
    .credential(FoundryCredential::api_key("your-key"))
    .build()?;

let request = DocumentAnalysisRequest::builder()
    .model_id(PREBUILT_READ)
    .url_source("https://example.com/document.pdf")
    .try_build()?;

let operation = document_intelligence::analyze(&client, &request).await?;
let result = document_intelligence::poll_until_complete(
    &client,
    &operation.operation_location,
    std::time::Duration::from_secs(2),
    60,
).await?;

if let Some(ar) = &result.analyze_result {
    println!("Extracted text: {:?}", ar.content);
}
# Ok(())
# }
```

## Supported Models (Document Intelligence)

| Constant | Model ID | Purpose |
|---|---|---|
| `PREBUILT_READ` | `prebuilt-read` | General OCR |
| `PREBUILT_LAYOUT` | `prebuilt-layout` | Layout with tables |
| `PREBUILT_INVOICE` | `prebuilt-invoice` | Invoice extraction |
| `PREBUILT_RECEIPT` | `prebuilt-receipt` | Receipt extraction |
| `PREBUILT_ID_DOCUMENT` | `prebuilt-idDocument` | Passport / ID |
| `PREBUILT_BUSINESS_CARD` | `prebuilt-businessCard` | Business card |

## Tracing Spans

| Span | Fields |
|------|--------|
| `foundry::vision::analyze` | features |
| `foundry::document_intelligence::analyze` | model_id |
| `foundry::document_intelligence::get_result` | operation_location |
| `foundry::document_intelligence::poll_until_complete` | operation_location |

## Related Crates

- [`azure_ai_foundry_core`](../azure_ai_foundry_core) — Core types, authentication, and HTTP client
- [`azure_ai_foundry_models`](../azure_ai_foundry_models) — Chat completions and embeddings
- [`azure_ai_foundry_agents`](../azure_ai_foundry_agents) — Agent Service client

## License

This project is licensed under the [MIT License](../../LICENSE).