@promptbook/azure-openai 0.105.0-3 → 0.105.0-4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -259,19 +259,20 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
259
259
 
260
260
  ## 📖 The Book Whitepaper
261
261
 
262
- For most business applications nowadays, the biggest challenge isn't about the raw capabilities of AI models. Large language models like GPT-5 or Claude-4.1 are extremely capable.
262
+ Nowadays, the biggest challenge for most business applications isn't the raw capabilities of AI models. Large language models such as GPT-5.2 and Claude-4.5 are incredibly capable.
263
263
 
264
- The main challenge is to narrow it down, constrain it, set the proper **context, rules, knowledge, and personality**. There are a lot of tools which can do exactly this. On one side, there are no-code platforms which can launch your agent in seconds. On the other side, there are heavy frameworks like Langchain or Semantic Kernel, which can give you deep control.
264
+ The main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.
265
265
 
266
- Promptbook takes the best from both worlds. You are defining your AI behavior by simple **books**, which are very explicit. They are automatically enforced, but they are very easy to understand, very easy to write, and very reliable and portable.
266
+ In Promptbook, you can define your context **using simple Books** that are very explicit, easy to understand and write, reliable, and highly portable.
267
267
 
268
268
  <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
269
269
 
270
- **<ins>Paul Smith & Associés</ins>**<br/>
270
+ **<ins>Paul Smith</ins>**<br/>
271
271
  <br/>
272
272
  **PERSONA** You are a company lawyer.<br/>
273
273
  Your job is to provide legal advice and support to the company and its employees.<br/>
274
- You are knowledgeable, professional, and detail-oriented.<br/>
274
+ **RULE** You are knowledgeable, professional, and detail-oriented.<br/>
275
+ TEAM You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
275
276
 
276
277
  </td></tr></table>
277
278
 
@@ -281,7 +282,9 @@ You are knowledgeable, professional, and detail-oriented.<br/>
281
282
 
282
283
  We have created a language called **Book**, which allows you to write AI agents in their native language and create your own AI persona. Book provides a guide to define all the traits and commitments.
283
284
 
284
- You can look at it as prompting (or writing a system message), but decorated by **commitments**.
285
+ You can look at it as "prompting" _(or writing a system message)_, but decorated by **commitments**.
286
+
287
+ **Commitments** are special syntax elements that define contracts between you and the AI agent. They are transformed by Promptbook Engine into low-level parameters like which model to use, its temperature, system message, RAG index, MCP servers, and many other parameters. For some commitments _(for example `RULE` commitment)_ Promptbook Engine can even create adversary agents and extra checks to enforce the rules.
285
288
 
286
289
  #### `Persona` commitment
287
290
 
@@ -292,8 +295,6 @@ Personas define the character of your AI persona, its role, and how it should in
292
295
  **<ins>Paul Smith & Associés</ins>**<br/>
293
296
  <br/>
294
297
  **PERSONA** You are a company lawyer.<br/>
295
- Your job is to provide legal advice and support to the company and its employees.<br/>
296
- You are knowledgeable, professional, and detail-oriented.<br/>
297
298
 
298
299
  </td></tr></table>
299
300
 
@@ -313,7 +314,7 @@ Promptbook Engine will automatically enforce this knowledge during interactions.
313
314
  Your job is to provide legal advice and support to the company and its employees.<br/>
314
315
  You are knowledgeable, professional, and detail-oriented.<br/>
315
316
  <br/>
316
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
317
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
317
318
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
318
319
 
319
320
  </td></tr></table>
@@ -335,14 +336,14 @@ You are knowledgeable, professional, and detail-oriented.<br/>
335
336
  **RULE** Always ensure compliance with laws and regulations.<br/>
336
337
  **RULE** Never provide legal advice outside your area of expertise.<br/>
337
338
  **RULE** Never provide legal advice about criminal law.<br/>
338
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
339
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
339
340
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
340
341
 
341
342
  </td></tr></table>
342
343
 
343
- #### `Action` commitment
344
+ #### `Team` commitment
344
345
 
345
- Action Commitment allows you to define specific actions that the AI can take during interactions. This can include things like posting on a social media platform, sending emails, creating calendar events, or interacting with your internal systems.
346
+ Team commitment allows you to define the team structure and advisory fellow members the AI can consult with. This allows the AI to simulate collaboration and consultation with other experts, enhancing the quality of its responses.
346
347
 
347
348
  <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
348
349
 
@@ -355,81 +356,36 @@ You are knowledgeable, professional, and detail-oriented.<br/>
355
356
  **RULE** Always ensure compliance with laws and regulations.<br/>
356
357
  **RULE** Never provide legal advice outside your area of expertise.<br/>
357
358
  **RULE** Never provide legal advice about criminal law.<br/>
358
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
359
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
359
360
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
360
- **ACTION** When a user asks about an issue that could be treated as a crime, notify legal@company.com.<br/>
361
+ TEAM You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
361
362
 
362
363
  </td></tr></table>
363
364
 
364
- [Read more about the language](./BLUEPRINT.md)
365
-
366
- <div style="page-break-after: always;"></div>
367
-
368
- ### Where to use your AI agent in book
369
-
370
- Books can be useful in various applications and scenarios. Here are some examples:
371
-
372
- #### Chat apps:
373
365
 
374
- Create your own chat shopping assistant and place it in your eShop.
375
- You will be able to answer customer questions, help them find products, and provide personalized recommendations. Everything is tightly controlled by the book you have written.
376
366
 
377
- #### Reply Agent:
367
+ ### Promptbook Ecosystem
378
368
 
379
- Create your own AI agent, which will look at your emails and reply to them. It can even create drafts for you to review before sending.
369
+ !!!@@@
380
370
 
381
- #### Coding Agent:
382
-
383
- Do you love Vibecoding, but the AI code is not always aligned with your coding style and architecture, rules, security, etc.? Create your own coding agent to help enforce your specific coding standards and practices.
384
-
385
- This can be integrated to almost any Vibecoding platform, like GitHub Copilot, Amazon CodeWhisperer, Cursor, Cline, Kilocode, Roocode,...
386
-
387
- They will work the same as you are used to, but with your specific rules written in book.
388
-
389
- #### Internal Expertise
390
-
391
- Do you have an app written in TypeScript, Python, C#, Java, or any other language, and you are integrating the AI.
392
-
393
- You can avoid struggle with choosing the best model, its settings like temperature, max tokens, etc., by writing a book agent and using it as your AI expertise.
394
-
395
- Doesn't matter if you do automations, data analysis, customer support, sentiment analysis, classification, or any other task. Your AI agent will be tailored to your specific needs and requirements.
396
-
397
- Even works in no-code platforms!
398
-
399
- <div style="page-break-after: always;"></div>
371
+ #### Promptbook Server
400
372
 
401
- ### How to create your AI agent in book
373
+ !!!@@@
402
374
 
403
- Now you want to use it. There are several ways how to write your first book:
375
+ #### Promptbook Engine
404
376
 
405
- #### From scratch with help from Paul
377
+ !!!@@@
406
378
 
407
- We have written ai asistant in book who can help you with writing your first book.
408
379
 
409
- #### Your AI twin
410
380
 
411
- Copy your own behavior, personality, and knowledge into book and create your AI twin. It can help you with your work, personal life, or any other task.
412
381
 
413
- #### AI persona workpool
414
382
 
415
- Or you can pick from our library of pre-written books for various roles and tasks. You can find books for customer support, coding, marketing, sales, HR, legal, and many other roles.
416
383
 
417
384
 
418
385
 
419
386
 
420
387
 
421
388
 
422
- ## 🚀 Get started
423
-
424
- Take a look at the simple starter kit with books integrated into the **Hello World** sample applications:
425
-
426
- - [Hello Book](https://github.com/webgptorg/hello-world)
427
- - [Hello Book in Node.js](https://github.com/webgptorg/hello-world-node-js)
428
- - [Hello Book in Next.js](https://github.com/webgptorg/hello-world-next-js)
429
-
430
-
431
-
432
-
433
389
 
434
390
 
435
391
  ## 💜 The Promptbook Project
@@ -445,33 +401,32 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
445
401
  </thead>
446
402
  <tbody>
447
403
  <tr>
448
- <td><a href="https://github.com/webgptorg/book">Book language</a></td>
404
+ <td><a href="https://gallery.ptbk.io/">Agents Server</a></td>
449
405
  <td>
450
- Book is a human-understandable markup language for writing AI applications such as chatbots, knowledge bases, agents, avarars, translators, automations and more.
451
- <hr>
452
- There is also <a href="https://github.com/webgptorg/book-extension">a plugin for VSCode</a> to support <code>.book</code> file extension
406
+ Place where you "AI agents live". It allows to create, manage, deploy, and interact with AI agents created in Book language.
453
407
  </td>
454
408
  </tr>
455
409
  <tr>
456
- <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
410
+ <td><a href="https://github.com/webgptorg/book">Book language</a></td>
457
411
  <td>
458
- Promptbook engine can run applications written in Book language. It is released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a> and <a href="https://hub.docker.com/r/hejny/promptbook">Docker HUB</a>
412
+ Human-friendly, high-level language that abstracts away low-level details of AI. It allows to focus on personality, behavior, knowledge, and rules of AI agents rather than on models, parameters, and prompt engineering.
413
+ <hr>
414
+ There is also <a href="https://github.com/webgptorg/book-extension">a plugin for VSCode</a> to support <code>.book</code> file extension
459
415
  </td>
460
416
  </tr>
461
417
  <tr>
462
- <td><a href="https://promptbook.studio">Promptbook Studio</a></td>
418
+ <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
463
419
  <td>
464
- Promptbook.studio is a web-based editor and runner for book applications. It is still in the experimental MVP stage.
420
+ Promptbook engine can run AI agents based on Book language.
421
+ It is released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a> and <a href="https://hub.docker.com/r/hejny/promptbook">Promptbook Agent Server as Docker Package</a>
422
+ Agent Server is based on Promptbook Engine.
465
423
  </td>
466
424
  </tr>
425
+
467
426
  </tbody>
468
427
  </table>
469
428
 
470
- Hello world examples:
471
429
 
472
- - [Hello world](https://github.com/webgptorg/hello-world)
473
- - [Hello world in Node.js](https://github.com/webgptorg/hello-world-node-js)
474
- - [Hello world in Next.js](https://github.com/webgptorg/hello-world-next-js)
475
430
 
476
431
  ### 🌐 Community & Social Media
477
432
 
@@ -529,6 +484,8 @@ Join our growing community of developers and users:
529
484
 
530
485
 
531
486
 
487
+
488
+
532
489
  ## 📚 Documentation
533
490
 
534
491
  See detailed guides and API reference in the [docs](https://github.com/webgptorg/promptbook/discussions/categories/concepts) or [online](https://discord.gg/x3QWNaa89N).
@@ -605,6 +562,8 @@ The following glossary is used to clarify certain concepts:
605
562
 
606
563
  _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
607
564
 
565
+
566
+
608
567
  ### 💯 Core concepts
609
568
 
610
569
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
package/esm/index.es.js CHANGED
@@ -18,7 +18,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
18
18
  * @generated
19
19
  * @see https://github.com/webgptorg/promptbook
20
20
  */
21
- const PROMPTBOOK_ENGINE_VERSION = '0.105.0-3';
21
+ const PROMPTBOOK_ENGINE_VERSION = '0.105.0-4';
22
22
  /**
23
23
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
24
24
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.105.0-2`).
18
+ * It follows semantic versioning (e.g., `0.105.0-3`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/azure-openai",
3
- "version": "0.105.0-3",
3
+ "version": "0.105.0-4",
4
4
  "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -105,7 +105,7 @@
105
105
  "module": "./esm/index.es.js",
106
106
  "typings": "./esm/typings/src/_packages/azure-openai.index.d.ts",
107
107
  "peerDependencies": {
108
- "@promptbook/core": "0.105.0-3"
108
+ "@promptbook/core": "0.105.0-4"
109
109
  },
110
110
  "dependencies": {
111
111
  "@azure/openai": "1.0.0-beta.13",
package/umd/index.umd.js CHANGED
@@ -24,7 +24,7 @@
24
24
  * @generated
25
25
  * @see https://github.com/webgptorg/promptbook
26
26
  */
27
- const PROMPTBOOK_ENGINE_VERSION = '0.105.0-3';
27
+ const PROMPTBOOK_ENGINE_VERSION = '0.105.0-4';
28
28
  /**
29
29
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
30
30
  * Note: [💞] Ignore a discrepancy between file name and entity name