Azure AI Immersive Reader

azure AI serviceazure-immersive-reader

Embedded reading surface with read-aloud, translation, syllabification and parts-of-speech highlighting.

Provider: azure
Kind: AI service
Category: Compute
Official docs: https://learn.microsoft.com/en-us/azure/ai-services/immersive-reader/overview

Properties · 6 set by this component

property	type	values	required	kind default	this component
auth	enum	api-key \| oauth \| iam \| none	no	—	▸ iam
contentFiltering	boolean	—	no	—	inherited
customerManagedKeys	boolean	—	no	—	▸ false
dataResidency · advanced	enum	us \| eu \| asia \| global	no	—	inherited
dataRetentionDays	integer	—	no	—	▸ 0
embedding · component property	enum	iframe	no	iframe	inherited
keyStore	boolean	—	no	false	inherited
managed	boolean	—	no	false	▸ true
modality	enum	text \| vision \| speech \| multimodal \| structured \| image \| video \| audio \| embedding \| rerank	no	—	▸ text
pictureDictionary · component property	boolean	—	no	true	inherited
publicEndpoint	boolean	—	no	—	▸ true
quotaUnitsPerMinute	integer	—	no	—	inherited
rateLimitRpm · advanced	integer	—	no	—	inherited
rateLimitTpm · advanced	integer	—	no	—	inherited
readAloud · component property	boolean	—	no	true	inherited
translation · component property	boolean	—	no	true	inherited
viaGateway	boolean	—	no	false	inherited

Rules that apply · 2

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

AI API key not managedwarning

ai-api-key-unmanaged

This AI vendor is reached with an API key, and nothing in the design holds or rotates that key. It ends up in environment files or code, every caller shares it, and a single leak runs up the vendor bill until someone notices. Put the key in a key-management component, or say it is held there with keyStore.

— all of these hold:
— the node's `auth` is "api-key"
— the node's `keyStore` is false
— the node has at least one incoming edge from an app-server, worker or client
— this does not hold:
— the design contains a node of kind key-management

Stateful node without zone redundancyerror

stateful-node-without-zone-redundancy

A stateful compute node pinned to exactly one availability zone disappears with that zone, and its state goes with it. Nodes inside a cell are exempt, because there the cell is deliberately single-zone and redundancy comes from the other cells.

— all of these hold:
— the node's `stateless` is false
— the node sits inside exactly 1 availability-zone group
— this does not hold:
— the node sits inside at least one cell group

Use it in a design

nodes:
  - { id: "immersive-reader", component: "azure-immersive-reader" }

Other AI service products · 125

and 85 more → AI service page

Source

1# yaml-language-server: $schema=../../schema/component.schema.json
2# Azure AI Immersive Reader: a hosted reading surface embedded in your web app as an iframe, with read-aloud, translation, syllabification and parts of speech.
3# "What is Azure AI Immersive Reader?" states it is a standalone web application rendered in an iframe by the client library and that "Immersive reader doesn't store any customer data".
4schemaVersion: "1"
5type: "component"
6id: "azure-immersive-reader"
7kind: "ai-service"
8provider: "azure"
9docs: "https://learn.microsoft.com/en-us/azure/ai-services/immersive-reader/overview"
10defaults:
11  auth: "iam"
12  managed: true
13  modality: "text"
14  publicEndpoint: true
15  customerManagedKeys: false
16  dataRetentionDays: 0
17properties:
18  embedding:
19    type: "enum"
20    values: ["iframe"]
21    default: "iframe"
22  readAloud:
23    type: "boolean"
24    default: true
25  translation:
26    type: "boolean"
27    default: true
28  pictureDictionary:
29    type: "boolean"
30    default: true

The same page as markdown, for an agent: /catalogue/components/azure-immersive-reader.md