foundryR/_pkgdown.yml at main · farach/foundryR · GitHub

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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
url: https://farach.github.io/foundryR/

template:
  package: foundryR


  bootstrap: 5
  bootswatch: cosmo
  light-switch: true
  bslib:
    primary: "#0078D4"
    border-radius: 0.25rem
    btn-border-radius: 0.25rem
  includes:
    in_header: |
      <link rel="preconnect" href="https://fonts.googleapis.com">
      <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
      <link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
  assets: pkgdown

home:
  title: foundryR - Tidy Interface to Azure AI Foundry
  description: >
    A tidy, API-first R interface to Microsoft Azure AI Foundry.
    Build AI-powered applications with chat completions, embeddings,
    content safety, and image generation - all returning tibbles.
  sidebar:
    structure: [links, license, community, citation, authors, dev]
    components:
      links:
        title: Links
        text: |
          - [Azure AI Foundry](https://azure.microsoft.com/products/ai-foundry/)
          - [Azure OpenAI Documentation](https://learn.microsoft.com/azure/ai-services/openai/)
          - [Azure AI Content Safety](https://azure.microsoft.com/products/ai-services/ai-content-safety/)

navbar:
  bg: primary
  type: dark
  structure:
    left: [intro, reference, articles, news]
    right: [search, lightswitch, github]
  components:
    intro:
      text: Get Started
      href: articles/getting-started.html
    articles:
      text: Articles
      menu:
        - text: "Core Functionality"
        - text: Getting Started
          href: articles/getting-started.html
        - text: Text Embeddings
          href: articles/embeddings.html
        - text: "---"
        - text: "Responsible AI"
        - text: Content Safety
          href: articles/content-safety.html
        - text: "---"
        - text: "Advanced Topics"
        - text: Image Generation
          href: articles/image-generation.html
        - text: tidymodels Integration
          href: articles/tidymodels.html
        - text: "---"
        - text: "Integrations"
        - text: onet2r Integration
          href: articles/onet2r-integration.html
    github:
      icon: fa-github
      href: https://github.com/farach/foundryR
      aria-label: GitHub repository

reference:
  - title: Setup & Configuration
    desc: >
      Configure your Azure AI Foundry credentials and verify your setup.
      These functions manage authentication for all API calls.
    contents:
      - foundry_check_setup
      - foundry_set_key
      - foundry_set_endpoint
      - foundry_get_endpoint

  - title: Chat Completions
    desc: >

      Interact with large language models like GPT-4, Claude, Llama, and more.
      Send messages and receive AI-generated responses as tidy tibbles.
    contents:
      - foundry_chat

  - title: Text Embeddings
    desc: >
      Generate vector embeddings for semantic search, clustering, and
      machine learning. Includes batch processing and similarity computation.
    contents:
      - foundry_embed
      - foundry_embed_batch
      - foundry_similarity

  - title: tidymodels Integration
    desc: >
      Seamlessly integrate text embeddings into your tidymodels workflows
      using recipe steps.
    contents:
      - step_foundry_embed
      - bake.step_foundry_embed
      - prep.step_foundry_embed
      - print.step_foundry_embed
      - required_pkgs.step_foundry_embed

  - title: Content Safety
    desc: >
      Azure AI Content Safety features for responsible AI deployment.
      Moderate content, detect hallucinations, and protect against prompt injection.
    contents:
      - foundry_moderate
      - foundry_groundedness
      - foundry_shield
      - foundry_set_content_safety_key
      - foundry_set_content_safety_endpoint

  - title: Image Generation
    desc: >
      Create images with DALL-E models. Generate, customize, and save
      AI-generated artwork and visualizations.
    contents:
      - foundry_image
      - foundry_save_image
      - foundry_set_image_endpoint
      - foundry_set_image_key

  - title: Model Discovery
    desc: >
      Explore available model deployments in your Azure AI Foundry resource.
    contents:
      - foundry_models

articles:
  - title: Core Functionality
    navbar: ~
    contents:
      - getting-started
      - embeddings

  - title: Responsible AI
    navbar: ~
    contents:
      - content-safety

  - title: Advanced Topics
    navbar: ~
    contents:
      - image-generation
      - tidymodels

  - title: Integrations
    navbar: ~
    contents:
      - onet2r-integration

footer:
  structure:
    left: [package]
    right: [built_with, azure]
  components:
    package: >
      foundryR is developed by [Alex Farach](https://github.com/farach)
    azure: >
      Powered by [Azure AI Foundry](https://azure.microsoft.com/products/ai-foundry/)