-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy path404.html
2635 lines (2594 loc) · 261 KB
/
404.html
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<base href="https://opea-project.github.io/latest/">
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Page Not Found — OPEA™ 1.3 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
<link rel="stylesheet" type="text/css" href="_static/opea-custom.css?v=0eef7f70" />
<link rel="stylesheet" type="text/css" href="_static/tabs.css?v=a5c4661c" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
<link rel="shortcut icon" href="_static/OPEA-favicon-32x32.png"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=c55cb9cb"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/opea-custom.js?v=32c45995"></script>
<script src="_static/design-tabs.js?v=f930bc37"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
OPEA™
<img src="_static/opea-horizontal-white-w200.png" class="logo" alt="Logo"/>
</a>
<div class="version">
latest
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> OPEA Project</span>
v: latest
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Document Versions</dt>
<dd><a href="/latest/">latest</a></dd>
<dd><a href="/1.0/">1.0</a></dd>
<dd><a href="/1.1/">1.1</a></dd>
<dd><a href="/1.2/">1.2</a></dd>
<dd><a href="/1.3/">1.3</a></dd>
</dl>
<dl>
<dt>OPEA Project links</dt>
<dd>
<a href="https://opea.dev">Project Home</a>
</dd>
<dd>
<a href="https://github.com/opea-project/docs/wiki">Wiki</a>
</dd>
</dl>
</div>
</div>
<ul>
<li class="toctree-l1"><a class="reference internal" href="index.html">Documentation Home</a></li>
<li class="toctree-l1"><a class="reference internal" href="introduction/index.html">OPEA Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="introduction/index.html#opea-project-architecture">OPEA Project Architecture</a><ul>
<li class="toctree-l3"><a class="reference internal" href="introduction/index.html#microservices-flexible-and-scalable-architecture">Microservices: Flexible and Scalable Architecture</a></li>
<li class="toctree-l3"><a class="reference internal" href="introduction/index.html#megaservices-a-comprehensive-solution">Megaservices: A Comprehensive Solution</a></li>
<li class="toctree-l3"><a class="reference internal" href="introduction/index.html#gateways-customized-access-to-mega-and-microservices">Gateways: Customized Access to Mega- and Microservices</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="introduction/index.html#next-step">Next Step</a><ul>
<li class="toctree-l3"><a class="reference internal" href="framework/framework.html">Open Platform for Enterprise AI (OPEA) Framework Draft Proposal</a><ul>
<li class="toctree-l4"><a class="reference internal" href="framework/framework.html#summary">1. Summary</a></li>
<li class="toctree-l4"><a class="reference internal" href="framework/framework.html#introduction">2. Introduction</a></li>
<li class="toctree-l4"><a class="reference internal" href="framework/framework.html#framework-components-architecture-and-flow">3. Framework Components, Architecture and Flow</a></li>
<li class="toctree-l4"><a class="reference internal" href="framework/framework.html#assessing-genai-components-and-flows">4. Assessing GenAI components and flows</a></li>
<li class="toctree-l4"><a class="reference internal" href="framework/framework.html#grading-structure">5. Grading Structure</a></li>
<li class="toctree-l4"><a class="reference internal" href="framework/framework.html#reference-flows">6. Reference flows</a></li>
<li class="toctree-l4"><a class="reference internal" href="framework/framework.html#appendix-a-draft-opea-specifications">Appendix A – Draft OPEA Specifications</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="getting-started/README.html">Getting Started with OPEA</a><ul>
<li class="toctree-l2"><a class="reference internal" href="getting-started/README.html#understanding-opea-s-core-components">Understanding OPEA’s Core Components</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting-started/README.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting-started/README.html#create-and-configure-a-virtual-server">Create and Configure a Virtual Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting-started/README.html#deploy-the-chatqna-solution">Deploy the ChatQnA Solution</a><ul>
<li class="toctree-l3"><a class="reference internal" href="getting-started/README.html#interact-with-chatqna">Interact with ChatQnA</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="getting-started/README.html#whats-next">What’s Next</a><ul>
<li class="toctree-l3"><a class="reference internal" href="getting-started/README.html#get-involved">Get Involved</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorial/index.html">OPEA Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorial/AgentQnA/AgentQnA_Guide.html">AgentQnA</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorial/AgentQnA/AgentQnA_Guide.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/AgentQnA/AgentQnA_Guide.html#purpose">Purpose</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/AgentQnA/AgentQnA_Guide.html#how-it-works">How It Works</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/AgentQnA/AgentQnA_Guide.html#deployment">Deployment</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tutorial/AgentQnA/AgentQnA_Guide.html#single-node">Single Node</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tutorial/AudioQnA/AudioQnA_Guide.html">AudioQnA</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorial/AudioQnA/AudioQnA_Guide.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/AudioQnA/AudioQnA_Guide.html#purpose">Purpose</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/AudioQnA/AudioQnA_Guide.html#key-implementation-details">Key Implementation Details</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/AudioQnA/AudioQnA_Guide.html#how-it-works">How It Works</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/AudioQnA/AudioQnA_Guide.html#deployment">Deployment</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tutorial/AudioQnA/AudioQnA_Guide.html#single-node">Single Node</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tutorial/ChatQnA/ChatQnA_Guide.html">ChatQnA</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorial/ChatQnA/ChatQnA_Guide.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/ChatQnA/ChatQnA_Guide.html#purpose">Purpose</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/ChatQnA/ChatQnA_Guide.html#key-implementation-details">Key Implementation Details</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/ChatQnA/ChatQnA_Guide.html#how-it-works">How It Works</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tutorial/ChatQnA/ChatQnA_Guide.html#customize-with-new-vectordb">Customize with new VectorDB</a></li>
<li class="toctree-l4"><a class="reference internal" href="tutorial/ChatQnA/ChatQnA_Guide.html#expected-output">Expected Output</a></li>
<li class="toctree-l4"><a class="reference internal" href="tutorial/ChatQnA/ChatQnA_Guide.html#validation-matrix-and-prerequisites">Validation Matrix and Prerequisites</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/ChatQnA/ChatQnA_Guide.html#architecture">Architecture</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tutorial/ChatQnA/ChatQnA_Guide.html#microservice-outline-and-diagram">Microservice Outline and Diagram</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/ChatQnA/ChatQnA_Guide.html#deployment">Deployment</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/ChatQnA/ChatQnA_Guide.html#single-node">Single Node</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tutorial/ChatQnA/deploy/xeon.html">Xeon Scalable Processor</a></li>
<li class="toctree-l4"><a class="reference internal" href="tutorial/ChatQnA/deploy/gaudi.html">Gaudi AI Accelerator</a></li>
<li class="toctree-l4"><a class="reference internal" href="tutorial/ChatQnA/deploy/nvidia.html">Nvidia GPU</a></li>
<li class="toctree-l4"><a class="reference internal" href="tutorial/ChatQnA/deploy/aipc.html">AI PC</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/ChatQnA/ChatQnA_Guide.html#kubernetes">Kubernetes</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tutorial/ChatQnA/deploy/k8s_getting_started.html">Getting Started</a></li>
<li class="toctree-l4"><a class="reference internal" href="tutorial/ChatQnA/deploy/k8s_helm.html">Kubernetes Deployment with Helm on Xeon</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/ChatQnA/ChatQnA_Guide.html#cloud-native">Cloud Native</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/ChatQnA/ChatQnA_Guide.html#troubleshooting">Troubleshooting</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/ChatQnA/ChatQnA_Guide.html#monitoring">Monitoring</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tutorial/ChatQnA/ChatQnA_Guide.html#set-up-the-prometheus-server">Set Up the Prometheus Server</a></li>
<li class="toctree-l4"><a class="reference internal" href="tutorial/ChatQnA/ChatQnA_Guide.html#set-up-the-grafana-dashboard">Set Up the Grafana Dashboard</a></li>
<li class="toctree-l4"><a class="reference internal" href="tutorial/ChatQnA/ChatQnA_Guide.html#summary-and-next-steps">Summary and Next Steps</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tutorial/CodeGen/CodeGen_Guide.html">CodeGen</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorial/CodeGen/CodeGen_Guide.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/CodeGen/CodeGen_Guide.html#purpose">Purpose</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/CodeGen/CodeGen_Guide.html#how-it-works">How It Works</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/CodeGen/CodeGen_Guide.html#deployment">Deployment</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tutorial/CodeGen/deploy/xeon.html">Intel® Xeon® Scalable processor</a></li>
<li class="toctree-l4"><a class="reference internal" href="tutorial/CodeGen/deploy/gaudi.html">Gaudi AI Accelerator</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tutorial/CodeTrans/CodeTrans_Guide.html">Code Translation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorial/CodeTrans/CodeTrans_Guide.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/CodeTrans/CodeTrans_Guide.html#purpose">Purpose</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/CodeTrans/CodeTrans_Guide.html#how-it-works">How It Works</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/CodeTrans/CodeTrans_Guide.html#deployment">Deployment</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tutorial/CodeTrans/CodeTrans_Guide.html#single-node">Single Node</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tutorial/DocSum/DocSum_Guide.html">DocSum</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorial/DocSum/DocSum_Guide.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/DocSum/DocSum_Guide.html#purpose">Purpose</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/DocSum/DocSum_Guide.html#how-it-works">How It Works</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/DocSum/DocSum_Guide.html#deployment">Deployment</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tutorial/DocSum/deploy/xeon.html">Intel® Xeon® Scalable processor</a></li>
<li class="toctree-l4"><a class="reference internal" href="tutorial/DocSum/deploy/gaudi.html">Gaudi AI Accelerator</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tutorial/DocIndexRetriever/DocIndexRetriever_Guide.html">DocIndexRetriever</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorial/DocIndexRetriever/DocIndexRetriever_Guide.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/DocIndexRetriever/DocIndexRetriever_Guide.html#purpose">Purpose</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/DocIndexRetriever/DocIndexRetriever_Guide.html#key-implementation-details">Key Implementation Details</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/DocIndexRetriever/DocIndexRetriever_Guide.html#how-it-works">How It Works</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/DocIndexRetriever/DocIndexRetriever_Guide.html#deployment">Deployment</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tutorial/DocIndexRetriever/DocIndexRetriever_Guide.html#single-node">Single Node</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tutorial/VideoQnA/VideoQnA_Guide.html">VideoQnA</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorial/VideoQnA/VideoQnA_Guide.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/VideoQnA/VideoQnA_Guide.html#purpose">Purpose</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/VideoQnA/VideoQnA_Guide.html#how-it-works">How It Works</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/VideoQnA/VideoQnA_Guide.html#deployment">Deployment</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tutorial/OpenTelemetry/OpenTelemetry_OPEA_Guide.html">OpenTelemetry on OPEA Guide</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tutorial/OpenTelemetry/OpenTelemetry_OPEA_Guide.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/OpenTelemetry/OpenTelemetry_OPEA_Guide.html#how-it-works">How It Works</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/OpenTelemetry/OpenTelemetry_OPEA_Guide.html#how-to-monitor">How to Monitor</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tutorial/OpenTelemetry/OpenTelemetry_OPEA_Guide.html#prometheus">1. Prometheus</a></li>
<li class="toctree-l4"><a class="reference internal" href="tutorial/OpenTelemetry/OpenTelemetry_OPEA_Guide.html#grafana">2. Grafana</a></li>
<li class="toctree-l4"><a class="reference internal" href="tutorial/OpenTelemetry/OpenTelemetry_OPEA_Guide.html#jaeger">3. Jaeger</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/OpenTelemetry/OpenTelemetry_OPEA_Guide.html#code-instrumentations-for-opea-tracing">Code Instrumentations for OPEA Tracing</a></li>
<li class="toctree-l3"><a class="reference internal" href="tutorial/OpenTelemetry/OpenTelemetry_OPEA_Guide.html#opentelemetry-on-genaiexamples">OpenTelemetry on GenAIExamples</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tutorial/OpenTelemetry/deploy/ChatQnA.html">ChatQnA</a></li>
<li class="toctree-l4"><a class="reference internal" href="tutorial/OpenTelemetry/deploy/AgentQnA.html">AgentQnA</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples/index.html">GenAI Examples</a><ul>
<li class="toctree-l2"><a class="reference internal" href="GenAIExamples/README.html">Generative AI Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/README.html#introduction">Introduction</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/README.html#architecture">Architecture</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/README.html#use-cases">Use Cases</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/README.html#documentation">Documentation</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/README.html#getting-started">Getting Started</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/README.html#deployment-guide">Deployment Guide</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/README.html#supported-examples">Supported Examples</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/README.html#contributing-to-opea">Contributing to OPEA</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/README.html#additional-content">Additional Content</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="examples/examples.html">Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#agentqna-application">AgentQnA Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/AgentQnA/README.html">Agents for Question Answering</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/AgentQnA/docker_compose/amd/gpu/rocm/README.html">Build Mega Service of AgentQnA on AMD ROCm GPU</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/AgentQnA/docker_compose/intel/cpu/xeon/README.html">Single node on-prem deployment with Docker Compose on Xeon Scalable processors</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/AgentQnA/docker_compose/intel/hpu/gaudi/README.html">Single node on-prem deployment AgentQnA on Gaudi</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/AgentQnA/kubernetes/helm/README.html">Deploy AgentQnA on Kubernetes cluster</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/AgentQnA/retrieval_tool/README.html">Retrieval tool for agent</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#audioqna-application">AudioQnA Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/AudioQnA/README.html">AudioQnA Application</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/AudioQnA/README_miscellaneous.html">AudioQnA Docker Image Build</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/AudioQnA/benchmark/accuracy/README.html">AudioQnA Accuracy</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/AudioQnA/benchmark/performance/README.html">AudioQnA Benchmarking</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/AudioQnA/docker_compose/amd/gpu/rocm/README.html">Deploying AudioQnA on AMD ROCm GPU</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/AudioQnA/docker_compose/intel/cpu/xeon/README.html">Deploying AudioQnA on Intel® Xeon® Processors</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/AudioQnA/docker_compose/intel/cpu/xeon/README_vllm.html">Deploy AudioQnA application</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/AudioQnA/docker_compose/intel/hpu/gaudi/README.html">Deploying AudioQnA on Intel® Gaudi® Processors</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/AudioQnA/kubernetes/gmc/README.html">Deploy AudioQnA in Kubernetes Cluster on Xeon and Gaudi</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/AudioQnA/kubernetes/helm/README.html">Deploy AudioQnA on Kubernetes cluster</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/AudioQnA/ui/svelte/README.html">AudioQnA</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#avatarchatbot-application">AvatarChatbot Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/AvatarChatbot/README.html">AvatarChatbot Application</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/AvatarChatbot/docker_compose/amd/gpu/rocm/README.html">Build Mega Service of AvatarChatbot on AMD GPU</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/AvatarChatbot/docker_compose/intel/cpu/xeon/README.html">Build Mega Service of AvatarChatbot on Xeon</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/AvatarChatbot/docker_compose/intel/hpu/gaudi/README.html">Build Mega Service of AvatarChatbot on Gaudi</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#chatqna-application">ChatQnA Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ChatQnA/README.html">ChatQnA Application</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ChatQnA/README_miscellaneous.html">ChatQnA Docker Image Build</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ChatQnA/benchmark/accuracy/README.html">ChatQnA Accuracy</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ChatQnA/benchmark/accuracy_faqgen/README.html">FaqGen Accuracy</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ChatQnA/benchmark/performance_faqgen/README.html">FaqGen Benchmarking</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ChatQnA/docker_compose/amd/gpu/rocm/README.html">Deploying ChatQnA on AMD ROCm GPU</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ChatQnA/docker_compose/intel/cpu/aipc/README.html">Build Mega Service of ChatQnA on AIPC</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ChatQnA/docker_compose/intel/cpu/xeon/README.html">Deploying ChatQnA on Intel® Xeon® Processors</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ChatQnA/docker_compose/intel/cpu/xeon/README_faqgen.html">Deploying FAQ Generation on Intel® Xeon® Processors</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ChatQnA/docker_compose/intel/cpu/xeon/README_pinecone.html">Deploying ChatQnA with Pinecone on Intel® Xeon® Processors</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ChatQnA/docker_compose/intel/cpu/xeon/README_qdrant.html">Deploying ChatQnA with Qdrant on Intel® Xeon® Processors</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ChatQnA/docker_compose/intel/hpu/gaudi/README.html">Example ChatQnA deployments on an Intel® Gaudi® Platform</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ChatQnA/docker_compose/intel/hpu/gaudi/how_to_validate_service.html">How to Check and Validate Micro Service in the GenAI Example</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ChatQnA/docker_compose/nvidia/gpu/README.html">Build MegaService of ChatQnA on NVIDIA GPU</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ChatQnA/kubernetes/gmc/README.html">Deploy ChatQnA in Kubernetes Cluster on Xeon and Gaudi</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ChatQnA/kubernetes/helm/README.html">Deploy ChatQnA on Kubernetes cluster</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ChatQnA/ui/react/README.html">ChatQnA Conversational UI</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ChatQnA/ui/svelte/README.html">ChatQnA Customized UI</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#codegen-application">CodeGen Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeGen/README.html">Code Generation Example (CodeGen)</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeGen/benchmark/accuracy/README.html">CodeGen Accuracy Benchmark</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeGen/benchmark/performance/README.html">CodeGen Performance Benchmark</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeGen/docker_compose/amd/gpu/rocm/README.html">Deploy CodeGen Application on AMD GPU (ROCm) with Docker Compose</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeGen/docker_compose/amd/gpu/rocm/README.html#to-deploy-the-codegen-services-execute-the-docker-compose-up-command-with-the-appropriate-arguments-for-a-tgi-deployment-execute">To deploy the CodeGen services, execute the <code class="docutils literal notranslate"><span class="pre">docker</span> <span class="pre">compose</span> <span class="pre">up</span></code> command with the appropriate arguments. For a TGI deployment, execute:</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeGen/docker_compose/intel/cpu/xeon/README.html">Deploy CodeGen Application on Intel Xeon CPU with Docker Compose</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeGen/docker_compose/intel/hpu/gaudi/README.html">Deploy CodeGen Application on Intel Gaudi HPU with Docker Compose</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeGen/kubernetes/gmc/README.html">Deploy CodeGen using Kubernetes Microservices Connector (GMC)</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeGen/kubernetes/helm/README.html">Deploy CodeGen on Kubernetes using Helm</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeGen/ui/gradio/README.html">Document Summary</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeGen/ui/react/README.html">Code Gen</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeGen/ui/svelte/README.html">Code Gen</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#codetrans-application">CodeTrans Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeTrans/README.html">Code Translation Application</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeTrans/README_miscellaneous.html">CodeTrans Docker Image Build</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeTrans/benchmark/performance/README.html">CodeTrans Benchmarking</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeTrans/docker_compose/amd/gpu/rocm/README.html">Deploying CodeTrans on AMD ROCm GPU</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeTrans/docker_compose/intel/cpu/xeon/README.html">Deploying CodeTrans on Intel® Xeon® Processors</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeTrans/docker_compose/intel/hpu/gaudi/README.html">Deploying CodeTrans on Intel® Gaudi® Processors</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeTrans/kubernetes/gmc/README.html">Deploy CodeTrans in a Kubernetes Cluster</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeTrans/kubernetes/helm/README.html">Deploy CodeTrans on Kubernetes cluster</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeTrans/tests/README.html">CodeTrans E2E test scripts</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/CodeTrans/ui/svelte/README.html">Code Translation</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#dbqna-application">DBQnA Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/DBQnA/README.html">DBQnA Application</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/DBQnA/docker_compose/amd/gpu/rocm/README.html">Deploy on AMD GPU</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/DBQnA/docker_compose/intel/cpu/xeon/README.html">Deploy on Intel Xeon Processor</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/DBQnA/ui/react/README.html">DBQnA React Application</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#docindexretriever-application">DocIndexRetriever Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/DocIndexRetriever/README.html">DocRetriever Application</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/DocIndexRetriever/docker_compose/intel/cpu/xeon/README.html">DocRetriever Application with Docker</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/DocIndexRetriever/docker_compose/intel/hpu/gaudi/README.html">DocRetriever Application with Docker</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#docsum-application">DocSum Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/DocSum/README.html">Document Summarization Application</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/DocSum/README_miscellaneous.html">Table of Contents</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/DocSum/docker_compose/amd/gpu/rocm/README.html">Example DocSum deployments on AMD GPU (ROCm)</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/DocSum/docker_compose/intel/cpu/xeon/README.html">Example DocSum deployments on Intel Xeon Processor</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/DocSum/docker_compose/intel/hpu/gaudi/README.html">Example DocSum deployments on Intel® Gaudi® Platform</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/DocSum/kubernetes/gmc/README.html">Deploy DocSum in Kubernetes Cluster</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/DocSum/kubernetes/helm/README.html">Deploy DocSum on Kubernetes cluster</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/DocSum/tests/README.html">DocSum E2E test scripts</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/DocSum/ui/gradio/README.html">Document Summary</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/DocSum/ui/react/README.html">Doc Summary React</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/DocSum/ui/svelte/README.html">Doc Summary</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#edgecraftrag-application">EdgeCraftRAG Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/EdgeCraftRAG/README.html">Edge Craft Retrieval-Augmented Generation</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#financeagent-application">FinanceAgent Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/FinanceAgent/README.html">Finance Agent</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#graphrag-application">GraphRAG Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/GraphRAG/README.html">GraphRAG Application</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/GraphRAG/ui/react/README.html">ChatQnA Conversational UI</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/GraphRAG/ui/svelte/README.html">ChatQnA Customized UI</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#instructiontuning-application">InstructionTuning Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/InstructionTuning/README.html">Instruction Tuning</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/InstructionTuning/README.html#table-of-contents">Table of contents</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/InstructionTuning/docker_compose/intel/cpu/xeon/README.html">Deploy Instruction Tuning Service on Intel® Xeon® Processors</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/InstructionTuning/docker_compose/intel/cpu/xeon/README.html#table-of-contents">Table of contents</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/InstructionTuning/docker_compose/intel/hpu/gaudi/README.html">Deploy Instruction Tuning Service on Intel® Gaudi® Platform</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/InstructionTuning/docker_compose/intel/hpu/gaudi/README.html#table-of-contents">Table of contents</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/InstructionTuning/tests/README.html">Translation E2E test scripts</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#multimodalqna-application">MultimodalQnA Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/MultimodalQnA/README.html">MultimodalQnA Application</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/MultimodalQnA/docker_compose/amd/gpu/rocm/README.html">Build and Deploy MultimodalQnA Application on AMD GPU (ROCm)</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/MultimodalQnA/docker_compose/intel/cpu/xeon/README.html">Build Mega Service of MultimodalQnA on Xeon</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/MultimodalQnA/docker_compose/intel/hpu/gaudi/README.html">Build Mega Service of MultimodalQnA on Gaudi</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#productivitysuite-application">ProductivitySuite Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ProductivitySuite/README.html">Productivity Suite Application</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ProductivitySuite/docker_compose/intel/cpu/xeon/README.html">Build Mega Service of Productivity Suite on Xeon</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ProductivitySuite/docker_compose/intel/cpu/xeon/keycloak_setup_guide.html">🔐 Keycloak Configuration Setup</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/ProductivitySuite/ui/react/README.html">Productivity Suite React UI</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#rerankfinetuning-application">RerankFinetuning Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/RerankFinetuning/README.html">Rerank Model Finetuning</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/RerankFinetuning/docker_compose/intel/cpu/xeon/README.html">Deploy Rerank Model Finetuning Service on Xeon</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/RerankFinetuning/docker_compose/intel/hpu/gaudi/README.html">Deploy Rerank Model Finetuning Service on Gaudi</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#searchqna-application">SearchQnA Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/SearchQnA/README.html">SearchQnA Application</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/SearchQnA/README_miscellaneous.html">SearchQnA Docker Image Build</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/SearchQnA/docker_compose/amd/gpu/rocm/README.html">Deploying SearchQnA on AMD ROCm Platform</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/SearchQnA/docker_compose/intel/cpu/xeon/README.html">Deploying SearchQnA on Intel® Xeon® Processors</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/SearchQnA/docker_compose/intel/hpu/gaudi/README.html">Deploying searchqna on Intel® Gaudi® Processors</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/SearchQnA/kubernetes/gmc/README.html">Deploy SearchQnA in a Kubernetes Cluster</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/SearchQnA/kubernetes/helm/README.html">Deploy SearchQnA on Kubernetes cluster</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/SearchQnA/ui/svelte/README.html">Neural Chat</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#text2image-application">Text2Image Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/Text2Image/README.html">Text-to-Image Microservice</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/Text2Image/docker_compose/intel/cpu/xeon/README.html">Deploy Text-to-Image Service on Xeon</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/Text2Image/docker_compose/intel/hpu/gaudi/README.html">Deploy Text-to-Image Service on Gaudi</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/Text2Image/kubernetes/helm/README.html">Deploy txt2img on Kubernetes cluster</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/Text2Image/ui/svelte/README.html">Text2Image Customized UI</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#translation-application">Translation Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/Translation/README.html">Translation Application</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/Translation/docker_compose/amd/gpu/rocm/README.html">Example Translation Deployment on AMD GPU (ROCm)</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/Translation/docker_compose/intel/cpu/xeon/README.html">Example Translation Deployment on Intel® Xeon® Platform</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/Translation/docker_compose/intel/hpu/gaudi/README.html">Example Translation Deployment on Intel® Gaudi® Platform</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/Translation/kubernetes/gmc/README.html">Deploy Translation in a Kubernetes Cluster</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/Translation/tests/README.html">Translation E2E test scripts</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/Translation/ui/svelte/README.html">Language Translation</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#videoqna-application">VideoQnA Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/VideoQnA/README.html">VideoQnA Application</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/VideoQnA/docker_compose/intel/cpu/xeon/README.html">Build Mega Service of VideoQnA on Xeon</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#visualqna-application">VisualQnA Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/VisualQnA/README.html">Visual Question and Answering</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/VisualQnA/benchmark/performance/README.html">VisualQnA Benchmarking</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/VisualQnA/docker_compose/amd/gpu/rocm/README.html">Build and Deploy VisualQnA Application on AMD GPU (ROCm)</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/VisualQnA/docker_compose/intel/cpu/xeon/README.html">Build Mega Service of VisualQnA on Xeon</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/VisualQnA/docker_compose/intel/hpu/gaudi/README.html">Build MegaService of VisualQnA on Gaudi</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/VisualQnA/kubernetes/gmc/README.html">Deploy VisualQnA in a Kubernetes Cluster</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/VisualQnA/kubernetes/helm/README.html">Deploy VisualQnA on Kubernetes cluster</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="examples/examples.html#workflowexecagent-application">WorkflowExecAgent Application</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/WorkflowExecAgent/README.html">Workflow Executor Agent</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/WorkflowExecAgent/tests/README.html">Validate Workflow Agent Microservice</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="GenAIExamples/LEGAL_INFORMATION.html">Legal Information</a><ul>
<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/LEGAL_INFORMATION.html#license">License</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/LEGAL_INFORMATION.html#citation">Citation</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="GenAIExamples/README-deploy-benchmark.html">Deploy and Benchmark</a><ul>
<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/README-deploy-benchmark.html#purpose">Purpose</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/README-deploy-benchmark.html#support-example-list">Support Example List</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/README-deploy-benchmark.html#table-of-contents">Table of Contents</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/README-deploy-benchmark.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/README-deploy-benchmark.html#data-preparation">Data Preparation</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/README-deploy-benchmark.html#running-deploy-and-benchmark-tests">Running Deploy and Benchmark Tests</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/README-deploy-benchmark.html#running-the-tests">Running the Tests</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/README-deploy-benchmark.html#test-modes">Test Modes</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/README-deploy-benchmark.html#troubleshooting">Troubleshooting</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="GenAIExamples/docker_images_list.html">Docker Images</a><ul>
<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/docker_images_list.html#example-images">Example images</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/docker_images_list.html#microservice-images">Microservice images</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="GenAIExamples/supported_examples.html">Supported Examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="GenAIExamples/supported_examples.html#chatqna">ChatQnA</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/supported_examples.html#codegen">CodeGen</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/supported_examples.html#codetrans">CodeTrans</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/supported_examples.html#docsum">DocSum</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/supported_examples.html#language-translation">Language Translation</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/supported_examples.html#searchqna">SearchQnA</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/supported_examples.html#visualqna">VisualQnA</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/supported_examples.html#videoqna">VideoQnA</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/supported_examples.html#rerankfinetuning">RerankFinetuning</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/supported_examples.html#instructiontuning">InstructionTuning</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/supported_examples.html#docindexretriever">DocIndexRetriever</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/supported_examples.html#agentqna">AgentQnA</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/supported_examples.html#audioqna">AudioQnA</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/supported_examples.html#multimodalqna">MultimodalQnA</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/supported_examples.html#productivitysuite">ProductivitySuite</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/supported_examples.html#dbqna">DBQnA</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/supported_examples.html#text2image">Text2Image</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIExamples/supported_examples.html#avatarchatbot">AvatarChatbot</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="microservices/index.html">GenAI Microservices</a><ul>
<li class="toctree-l2"><a class="reference internal" href="GenAIComps/README.html">Generative AI Components (GenAIComps)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/README.html#genaicomps">GenAIComps</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/README.html#installation">Installation</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/README.html#microservice">MicroService</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/README.html#megaservice">MegaService</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/README.html#contributing-to-opea">Contributing to OPEA</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/README.html#additional-content">Additional Content</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="GenAIComps/LEGAL_INFORMATION.html">Legal Information</a><ul>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/LEGAL_INFORMATION.html#license">License</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/LEGAL_INFORMATION.html#citation">Citation</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="microservices/index.html#agent-microservice">Agent Microservice</a><ul>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/agent/deployment/kubernetes/README.html">Deploy Agent microservice on Kubernetes cluster</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/agent/deployment/kubernetes/README.html#deploy-on-kubernetes">Deploy on Kubernetes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/agent/src/README.html">Agent Microservice</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/agent/src/README.html#overview">1. Overview</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/agent/src/README.html#start-agent-microservice">🚀2. Start Agent Microservice</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/agent/src/README.html#validate-microservice">🚀 3. Validate Microservice</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/agent/src/README.html#provide-your-own-tools">🚀 4. Provide your own tools</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/agent/src/README.html#customize-agent-strategy">5. Customize agent strategy</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/agent/src/integrations/strategy/planexec/README.html">Plan Execute</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/agent/src/integrations/strategy/ragagent/README.html">RAG Agent</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/agent/src/integrations/strategy/sqlagent/README.html">SQL Agents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/agent/src/integrations/strategy/sqlagent/README.html#overview-of-sql-agent-llama">Overview of sql_agent_llama</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/agent/src/integrations/strategy/sqlagent/README.html#overview-of-sql-agent">Overview of sql_agent</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/agent/src/integrations/strategy/sqlagent/README.html#limitations">Limitations</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="microservices/index.html#animation-microservice">Animation Microservice</a><ul>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/animation/src/README.html">Avatar Animation Microservice</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/animation/src/README.html#start-microservice-with-docker-option-1">🚀1. Start Microservice with Docker (option 1)</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/animation/src/README.html#build-the-docker-images">1.1 Build the Docker images</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/animation/src/README.html#set-environment-variables">1.2. Set environment variables</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/animation/src/README.html#run-the-docker-container">🚀2. Run the Docker container</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/animation/src/README.html#run-wav2lip-microservice">2.1 Run Wav2Lip Microservice</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/animation/src/README.html#run-animation-microservice">2.2 Run Animation Microservice</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/animation/src/README.html#start-microservice-with-docker-compose">🚀3. Start Microservice with Docker Compose</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/animation/src/README.html#validate-microservice">🚀4. Validate Microservice</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/animation/src/README.html#validate-wav2lip-service">4.1 Validate Wav2Lip service</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/animation/src/README.html#validate-animation-service">4.2 Validate Animation service</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="microservices/index.html#asr-microservice">Asr Microservice</a><ul>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/asr/deployment/kubernetes/README.html">Deploy ASR microservice on Kubernetes cluster</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/asr/deployment/kubernetes/README.html#deploy-on-kubernetes">Deploy on Kubernetes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/asr/src/README.html">ASR Microservice</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/asr/src/README.html#start-microservice-with-python-option-1">🚀1. Start Microservice with Python (Option 1)</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/asr/src/README.html#start-microservice-with-docker-option-2">🚀2. Start Microservice with Docker (Option 2)</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/asr/src/README.html#start-microservice-with-docker-compose-option-3">🚀3. Start Microservice with Docker Compose (Option 3)</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="microservices/index.html#chathistory-microservice">Chathistory Microservice</a><ul>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/chathistory/README.html">📝 Chat History Microservice</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/chathistory/README.html#features">🛠️ Features</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/chathistory/README.html#implementation">⚙️ Implementation</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/chathistory/deployment/kubernetes/README.html">Deploy chathistory microservice on Kubernetes cluster</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/chathistory/deployment/kubernetes/README.html#deploy-on-kubernetes">Deploy on Kubernetes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/chathistory/src/README.html">📝 Chat History Microservice with MongoDB</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/chathistory/src/README.html#setup-environment-variables">Setup Environment Variables</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/chathistory/src/README.html#start-microservice-with-docker-option-1">🚀 Start Microservice with Docker (Option 1)</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/chathistory/src/README.html#start-microservice-with-docker-compose-option-2">🚀 Start Microservice with Docker Compose (Option 2)</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/chathistory/src/README.html#invoke-microservice">✅ Invoke Microservice</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="microservices/index.html#cores-microservice">Cores Microservice</a><ul>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/cores/storages/developer.html">Contributing to Storage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/cores/storages/developer.html#storage">Storage</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/cores/storages/developer.html#adding-a-new-storage-backend">Adding a New Storage Backend</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/cores/storages/developer.html#example">Example</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/cores/telemetry/README.html">Telemetry for OPEA</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/cores/telemetry/README.html#metrics">Metrics</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/cores/telemetry/README.html#statistics">Statistics</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/cores/telemetry/README.html#tracing">Tracing</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/cores/telemetry/README.html#visualization">Visualization</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="microservices/index.html#dataprep-microservice">Dataprep Microservice</a><ul>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/dataprep/README.html">Dataprep Microservice</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/README.html#install-requirements">Install Requirements</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/README.html#use-lvm-large-vision-model-for-summarizing-image-data">Use LVM (Large Vision Model) for Summarizing Image Data</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/README.html#dataprep-microservice-with-redis">Dataprep Microservice with Redis</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/README.html#dataprep-microservice-with-milvus">Dataprep Microservice with Milvus</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/README.html#dataprep-microservice-with-qdrant">Dataprep Microservice with Qdrant</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/README.html#dataprep-microservice-with-pinecone">Dataprep Microservice with Pinecone</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/README.html#dataprep-microservice-with-pgvector">Dataprep Microservice with PGVector</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/README.html#dataprep-microservice-with-vdms">Dataprep Microservice with VDMS</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/README.html#dataprep-microservice-with-multimodal">Dataprep Microservice with Multimodal</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/README.html#dataprep-microservice-with-elasticsearch">Dataprep Microservice with ElasticSearch</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/README.html#dataprep-microservice-with-opensearch">Dataprep Microservice with OpenSearch</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/README.html#dataprep-microservice-with-neo4j">Dataprep Microservice with neo4j</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/README.html#dataprep-microservice-for-financial-domain-data">Dataprep Microservice for financial domain data</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/dataprep/deployment/kubernetes/README.html">Deploy dataprep microservice on Kubernetes cluster</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/deployment/kubernetes/README.html#deploy-on-kubernetes-with-redis-vectordb">Deploy on Kubernetes with redis VectorDB</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/deployment/kubernetes/README.html#deploy-on-kubernetes-with-milvus-vectordb">Deploy on Kubernetes with milvus VectorDB</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_arangodb.html">Dataprep Microservice with ArangoDB</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_arangodb.html#start-microservice-with-docker">🚀Start Microservice with Docker</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_arangodb.html#consume-dataprep-service">🚀3. Consume Dataprep Service</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_elasticsearch.html">Dataprep Microservice with Elasticsearch</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_elasticsearch.html#start-microservice-with-docker">🚀1. Start Microservice with Docker</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_elasticsearch.html#consume-microservice">🚀2. Consume Microservice</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_finance.html">Dataprep microservice for financial domain data</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_finance.html#overview">1. Overview</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_finance.html#deploy-with-docker">2. Deploy with docker</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_finance.html#consume-microservice">3. Consume Microservice</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_milvus.html">Dataprep Microservice with Milvus</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_milvus.html#start-microservice-with-docker">🚀1. Start Microservice with Docker</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_milvus.html#consume-microservice">🚀2. Consume Microservice</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_milvus.html#troubleshooting">🚀3. Troubleshooting</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_multimodal.html">Dataprep Microservice for Multimodal Data with Redis</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_multimodal.html#start-microservice-with-docker">🚀1. Start Microservice with Docker</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_multimodal.html#status-microservice">🚀2. Status Microservice</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_multimodal.html#consume-microservice">🚀3. Consume Microservice</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_neo4j_langchain.html">Dataprep Microservice with Neo4J</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_neo4j_langchain.html#start-microservice-with-docker">🚀Start Microservice with Docker</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_neo4j_langchain.html#invoke-microservice">Invoke Microservice</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_neo4j_llamaindex.html">Dataprep Microservice with Neo4J</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_neo4j_llamaindex.html#start-microservice-with-docker">🚀Start Microservice with Docker</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_neo4j_llamaindex.html#setup-environment-variables">2. Setup Environment Variables</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_neo4j_llamaindex.html#invoke-microservice">Invoke Microservice</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_opensearch.html">Dataprep Microservice with OpenSearch</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_opensearch.html#start-microservice-with-docker">🚀1. Start Microservice with Docker</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_opensearch.html#status-microservice">🚀2. Status Microservice</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_opensearch.html#consume-microservice">🚀3. Consume Microservice</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_pgvector.html">Dataprep Microservice with PGVector</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_pgvector.html#start-microservice-with-docker">🚀1. Start Microservice with Docker</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_pgvector.html#consume-microservice">🚀2. Consume Microservice</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_pinecone.html">Dataprep Microservice with Pinecone</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_pinecone.html#start-microservice-with-docker">🚀Start Microservice with Docker</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_pinecone.html#invoke-microservice">Invoke Microservice</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_qdrant.html">Dataprep Microservice with Qdrant</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_qdrant.html#start-microservice-with-docker">🚀Start Microservice with Docker</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_qdrant.html#invoke-microservice">Invoke Microservice</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_redis.html">Dataprep Microservice with Redis</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_redis.html#start-microservice-with-docker">🚀1. Start Microservice with Docker</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_redis.html#status-microservice">🚀2. Status Microservice</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_redis.html#consume-microservice">🚀3. Consume Microservice</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_vdms.html">Dataprep Microservice with VDMS</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_vdms.html#start-microservice-with-docker-option-2">🚀1. Start Microservice with Docker (Option 2)</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_vdms.html#status-microservice">🚀2. Status Microservice</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/dataprep/src/README_vdms.html#consume-microservice">🚀3. Consume Microservice</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="microservices/index.html#embeddings-microservice">Embeddings Microservice</a><ul>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/embeddings/deployment/kubernetes/README.html">Deploy Embedding microservice on Kubernetes cluster</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/deployment/kubernetes/README.html#deploy-on-kubernetes">Deploy on Kubernetes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README.html">Embeddings Microservice</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README.html#embeddings-microservice-with-ovms">Embeddings Microservice with OVMS</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README.html#embeddings-microservice-with-tei">Embeddings Microservice with TEI</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README.html#embeddings-microservice-with-prediction-guard">Embeddings Microservice with Prediction Guard</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README.html#embeddings-microservice-with-multimodal-clip">Embeddings Microservice with Multimodal Clip</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README.html#embeddings-microservice-with-multimodal">Embeddings Microservice with Multimodal</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README_bridgetower.html">Multimodal Embeddings Microservice</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README_bridgetower.html#start-microservice">📦 1. Start Microservice</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README_bridgetower.html#consume-embedding-service">📦 2. Consume Embedding Service</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README_clip.html">Multimodal CLIP Embedding Microservice</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README_clip.html#key-features">✨ Key Features</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README_clip.html#quick-start">🚀 Quick Start</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README_ovms.html">🌟 Embedding Microservice with OpenVINO Model Server</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README_ovms.html#start-microservice-with-docker-run">📦 1. Start Microservice with <code class="docutils literal notranslate"><span class="pre">docker</span> <span class="pre">run</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README_ovms.html#start-microservice-with-docker-compose">📦 2. Start Microservice with docker compose</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README_ovms.html#consume-embedding-service">📦 3. Consume Embedding Service</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README_ovms.html#tips-for-better-understanding">✨ Tips for Better Understanding:</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README_predictionguard.html">Embedding Microservice with Prediction Guard</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README_predictionguard.html#start-microservice-with-docker-run">📦 1. Start Microservice with <code class="docutils literal notranslate"><span class="pre">docker</span> <span class="pre">run</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README_predictionguard.html#start-microservice-with-docker-compose">📦 2. Start Microservice with docker compose</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README_predictionguard.html#consume-embedding-service">📦 3. Consume Embedding Service</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README_predictionguard.html#additional-notes">✨ Additional Notes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README_tei.html">🌟 Embedding Microservice with TEI</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README_tei.html#start-microservice-with-docker-run">📦 1. Start Microservice with <code class="docutils literal notranslate"><span class="pre">docker</span> <span class="pre">run</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README_tei.html#start-microservice-with-docker-compose">📦 2. Start Microservice with docker compose</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README_tei.html#consume-embedding-service">📦 3. Consume Embedding Service</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/embeddings/src/README_tei.html#tips-for-better-understanding">✨ Tips for Better Understanding:</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="microservices/index.html#feedback-management-microservice">Feedback_management Microservice</a><ul>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/feedback_management/README.html">🗨 Feedback Management Microservice</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/feedback_management/README.html#features">🛠️ Features</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/feedback_management/README.html#implementation">⚙️ Implementation</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/feedback_management/src/README.html">🗨 Feedback Management Microservice with MongoDB</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/feedback_management/src/README.html#setup-environment-variables">Setup Environment Variables</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/feedback_management/src/README.html#start-microservice-with-docker-option-1">🚀 Start Microservice with Docker (Option 1)</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/feedback_management/src/README.html#start-microservice-with-docker-compose-option-2">🚀 Start Microservice with Docker Compose (Option 2)</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="microservices/index.html#finetuning-microservice">Finetuning Microservice</a><ul>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/finetuning/src/README.html">Fine-tuning Microservice</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/README.html#start-microservice-with-python-option-1">🚀1. Start Microservice with Python (Option 1)</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/README.html#start-microservice-with-docker-option-2">🚀2. Start Microservice with Docker (Option 2)</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/README.html#consume-finetuning-service">🚀3. Consume Finetuning Service</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/README.html#descriptions-for-finetuning-parameters">🚀4. Descriptions for Finetuning parameters</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/README.html">XTune - Model finetune tool for Intel GPU</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/README.html#installation">Installation</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/README.html#data-preparation">Data Preparation</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/README.html#fine-tuning-with-llama-board-gui-powered-by-gradio">Fine-Tuning with LLaMA Board GUI (powered by Gradio)</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/README.html#fine-tuning-with-shell-instead-of-gui">Fine-Tuning with Shell instead of GUI</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/README.html#xtune-examples"><code class="docutils literal notranslate"><span class="pre">Xtune</span></code> Examples</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/README.html#citation">Citation</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/README.html#acknowledgement">Acknowledgement</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/Prepare_dataset.html">Dataset</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/Prepare_dataset.html#dataset-for-clip">Dataset for CLIP</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/Prepare_dataset.html#dataset-for-adaclip">Dataset for AdaCLIP</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/Prepare_dataset.html#preprocessing">Preprocessing</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/adaclip_readme.html">AdaCLIP-Finetune</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/adaclip_readme.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/adaclip_readme.html#how-to-install">How to Install</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/adaclip_readme.html#install-on-nvidia">Install on NVIDIA</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/adaclip_readme.html#install-on-arc-a770">Install on Arc A770</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/adaclip_readme.html#prepare-datasets">Prepare Datasets</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/adaclip_readme.html#datasets">Datasets</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/adaclip_readme.html#frame-extraction">Frame Extraction</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/adaclip_readme.html#dataset-json-prepare">Dataset JSON prepare</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/adaclip_readme.html#implemented-finetune-methods">Implemented finetune methods</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/adaclip_readme.html#bitfit-ssf">BitFit & SSF</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/adaclip_readme.html#importance-based-selection-ibs">Importance Based Selection (IBS)</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/adaclip_readme.html#performance-of-different-finetune-methods">Performance of different finetune methods</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/adaclip_readme.html#how-to-finetune">How to Finetune</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/adaclip_readme.html#finetune-on-nvidia">Finetune on NVIDIA</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/adaclip_readme.html#finetune-on-arc-a770">Finetune on Arc A770</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/adaclip_readme.html#use-optuna-to-automatic-get-the-best-param">Use optuna to automatic get the best param</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/adaclip_readme.html#visualization">Visualization</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/install_dependency.html">Install linux kernel</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/install_dependency.html#install-driver">Install Driver</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/install_dependency.html#optional">Optional:</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/key_features_for_clip_finetune_tool.html">The core features for clip finetune tool:</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/key_features_for_clip_finetune_tool.html#how-to-config-features-for-clip-finetune-tool">How to config features for clip finetune tool:</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/key_features_for_clip_finetune_tool.html#basic-yaml-for-vit-b16-yaml">Basic yaml for vit_b16.yaml</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/key_features_for_clip_finetune_tool.html#angle-based-selection-for-full-finetune">Angle-Based Selection for full-finetune</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/key_features_for_clip_finetune_tool.html#customize-trained-layer-for-partial-finetune">customize trained layer for partial-finetune</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/finetuning/src/integrations/xtune/doc/key_features_for_clip_finetune_tool.html#fixed-cache-size-for-tip-adapter">fixed cache size for tip-adapter</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="microservices/index.html#guardrails-microservice">Guardrails Microservice</a><ul>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/README.html">Trust and Safety with LLM</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/deployment/kubernetes/README.html">Deploy guardrails microservice on Kubernetes cluster</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/deployment/kubernetes/README.html#deploy-on-kubernetes">Deploy on Kubernetes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/src/bias_detection/README.html">Bias Detection Microservice</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/bias_detection/README.html#introduction">Introduction</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/bias_detection/README.html#future-development">Future Development</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/bias_detection/README.html#start-microservice-with-python-option-1">🚀1. Start Microservice with Python（Option 1）</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/bias_detection/README.html#start-microservice-with-docker-option-2">🚀2. Start Microservice with Docker (Option 2)</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/bias_detection/README.html#get-status-of-microservice">🚀3. Get Status of Microservice</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/bias_detection/README.html#consume-microservice-pre-llm-post-llm">🚀4. Consume Microservice Pre-LLM/Post-LLM</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/src/factuality_alignment/README.html">Factuality Check Prediction Guard Microservice</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/src/factuality_alignment/README.html#start-microservice-with-docker">🚀 Start Microservice with Docker</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/factuality_alignment/README.html#setup-environment-variables">Setup Environment Variables</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/factuality_alignment/README.html#build-docker-images">Build Docker Images</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/factuality_alignment/README.html#start-service">Start Service</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/src/factuality_alignment/README.html#consume-factuality-check-service">🚀 Consume Factuality Check Service</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/src/guardrails/README.html">Guardrails Microservice</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/guardrails/README.html#llama-guard">Llama Guard</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/guardrails/README.html#wildguard">WildGuard</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/guardrails/README.html#clone-opea-genaicomps-and-set-initial-environment-variables">Clone OPEA GenAIComps and set initial environment variables</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/guardrails/README.html#start-up-the-huggingface-text-generation-inference-tgi-server">Start up the HuggingFace Text Generation Inference (TGI) Server</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/src/hallucination_detection/README.html">Hallucination Detection Microservice</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/hallucination_detection/README.html#introduction">Introduction</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/hallucination_detection/README.html#start-microservice-based-on-vllm-endpoint-on-intel-gaudi-accelerator">🚀1. Start Microservice based on vLLM endpoint on Intel Gaudi Accelerator</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/hallucination_detection/README.html#set-up-hallucination-microservice">2. Set up Hallucination Microservice</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/hallucination_detection/README.html#get-status-of-hallucination-microservice">🚀3. Get Status of Hallucination Microservice</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/hallucination_detection/README.html#consume-guardrail-micorservice-post-llm">🚀4. Consume Guardrail Micorservice Post-LLM</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/src/pii_detection/README.html">PII Detection Prediction Guard Microservice</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/src/pii_detection/README.html#start-microservice-with-docker">🚀 Start Microservice with Docker</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/pii_detection/README.html#setup-environment-variables">Setup Environment Variables</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/pii_detection/README.html#build-docker-images">Build Docker Images</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/pii_detection/README.html#start-service">Start Service</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/src/pii_detection/README.html#consume-pii-detection-service">🚀 Consume PII Detection Service</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/src/prompt_injection/README.html">Prompt Injection and Jailbreak Detection Microservice</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/prompt_injection/README.html#introduction">Introduction</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/prompt_injection/README.html#prompt-guard-microservice">Prompt Guard Microservice</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/prompt_injection/README.html#prompt-injection-detection-prediction-guard-microservice">Prompt Injection Detection Prediction Guard Microservice</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/prompt_injection/README.html#environment-setup">Environment Setup</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/prompt_injection/README.html#setup-environment-variables">Setup Environment Variables</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/prompt_injection/README.html#start-microservice-with-docker">🚀1. Start Microservice with Docker</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/guardrails/src/toxicity_detection/README.html">Toxicity Detection Microservice</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/toxicity_detection/README.html#introduction">Introduction</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/toxicity_detection/README.html#environment-setup">Environment Setup</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/toxicity_detection/README.html#start-microservice-with-python-option-1">🚀1. Start Microservice with Python（Option 1）</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/toxicity_detection/README.html#start-microservice-with-docker-option-2">🚀2. Start Microservice with Docker (Option 2)</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/toxicity_detection/README.html#get-status-of-microservice">🚀3. Get Status of Microservice</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/guardrails/src/toxicity_detection/README.html#consume-microservice-pre-llm-post-llm">🚀4. Consume Microservice Pre-LLM/Post-LLM</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="microservices/index.html#image2image-microservice">Image2image Microservice</a><ul>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/image2image/src/README.html">Image-to-Image Microservice</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/image2image/src/README.html#start-microservice-with-python-option-1">🚀1. Start Microservice with Python (Option 1)</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/image2image/src/README.html#install-requirements">1.1 Install Requirements</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/image2image/src/README.html#start-image-to-image-microservice">1.2 Start Image-to-Image Microservice</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/image2image/src/README.html#start-microservice-with-docker-option-2">🚀2. Start Microservice with Docker (Option 2)</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/image2image/src/README.html#build-images">2.1 Build Images</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/image2image/src/README.html#start-image-to-image-service-with-docker">2.2 Start Image-to-Image Service with Docker</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/image2image/src/README.html#start-image-to-image-with-docker-compose">🚀3. Start Image-to-Image with Docker Compose</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/image2image/src/README.html#test-image-to-image-service">4 Test Image-to-Image Service</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="microservices/index.html#image2video-microservice">Image2video Microservice</a><ul>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/image2video/src/README.html">Image-to-Video Microservice</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/image2video/src/README.html#start-microservice-with-python-option-1">🚀1. Start Microservice with Python (Option 1)</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/image2video/src/README.html#install-requirements">1.1 Install Requirements</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/image2video/src/README.html#start-image-to-video-microservice">1.2 Start Image-to-Video Microservice</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/image2video/src/README.html#start-microservice-with-docker-option-2">🚀2. Start Microservice with Docker (Option 2)</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/image2video/src/README.html#build-images">2.1 Build Images</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/image2video/src/README.html#start-image-to-video-service">2.2 Start Image-to-Video Service</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/image2video/src/README.html#test">2.3 Test</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="microservices/index.html#llms-microservice">Llms Microservice</a><ul>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/llms/deployment/kubernetes/README.html">Deploy LLM microservice on Kubernetes cluster</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/deployment/kubernetes/README.html#deploy-on-kubernetes">Deploy on Kubernetes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/llms/src/doc-summarization/README.html">Document Summary LLM Microservice</a></li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/llms/src/doc-summarization/README.html#quick-start-guide">Quick Start Guide</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/doc-summarization/README.html#deployment-options">Deployment options</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/doc-summarization/README.html#start-microservice-with-docker">🚀1. Start Microservice with Docker 🐳</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/doc-summarization/README.html#start-microservice-with-kubernetes">🚀2. Start Microservice with Kubernetes</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/doc-summarization/README.html#consume-llm-service">🚀3. Consume LLM Service</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/llms/src/faq-generation/README.html">FAQGen LLM Microservice</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/faq-generation/README.html#start-microservice-with-docker">🚀1. Start Microservice with Docker</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/faq-generation/README.html#consume-llm-service">🚀2. Consume LLM Service</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README.html">LLM text generation Microservice</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README.html#validated-llm-models">Validated LLM Models</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README.html#support-integrations">Support integrations</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README.html#clone-opea-genaicomps">Clone OPEA GenAIComps</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README.html#start-microservice-with-docker">🚀Start Microservice with Docker</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README.html#consume-llm-service">🚀3. Consume LLM Service</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README_bedrock.html">Introduction</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README_bedrock.html#get-started">Get Started</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README_bedrock.html#setup-environment-variables">Setup Environment Variables</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README_bedrock.html#build-docker-image">Build Docker Image</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README_bedrock.html#run-the-bedrock-microservice">Run the Bedrock Microservice</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README_bedrock.html#consume-the-bedrock-microservice">Consume the Bedrock Microservice</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README_native.html">LLM Native Microservice</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README_native.html#start-microservice">🚀1. Start Microservice</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README_native.html#consume-llm-service">🚀2. Consume LLM Service</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README_ovms.html">LLM OVMS Microservice</a><ul>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README_ovms.html#start-ovms-microservice">🚀1. Start OVMS Microservice</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README_ovms.html#starting-opea-llm-microservice">🚀2. Starting OPEA LLM microservice</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README_ovms.html#consume-llm-service">🚀2. Consume LLM Service</a></li>
<li class="toctree-l4"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README_ovms.html#tips-for-better-understanding">✨ Tips for Better Understanding:</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="GenAIComps/comps/llms/src/text-generation/README_predictionguard.html">Prediction Guard Introduction</a><ul>