Skip to content

Commit 1a8e674

Browse files
update documentation
1 parent e82b460 commit 1a8e674

File tree

2 files changed

+25
-22
lines changed

2 files changed

+25
-22
lines changed

ai-hub/ai-document-converter/README.md

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# AI Document Converter App
22

3+
## Overview
34

45
AI Document Converter is an AI-powered solution designed to transform complex PDF documents into clean, structured Markdown. It goes beyond simple text extraction by preserving headings, tables, lists, images, and semantic structure, making documents immediately usable for downstream applications.
56

@@ -15,29 +16,19 @@ Key capabilities include:
1516
In short, the AI Document Converter helps enterprises unlock the full value of their documents by making them searchable, analyzable, and AI-ready.
1617

1718

18-
## Deploy solution on OCI
19+
## Deployment
1920
This application can be deployed using an [Oracle Resource Manager](https://docs.oracle.com/en-us/iaas/Content/ResourceManager/Concepts/resourcemanager.htm) (ORM) stack as a solution on AI Hub. To create and deploy the solution, click the button below:
2021

2122
[![Deploy to Oracle Cloud][magic_button]][magic_stack]
2223

2324

24-
## Step-by-Step Deployment Process
25-
26-
todo:
27-
- add screenshots of the stack setup and describe the steps
28-
29-
## User Interface
30-
31-
todo:
32-
- add screenshot of UI and describe actions user can take
33-
34-
3525
## APIs
3626

37-
todo:
38-
- add instructions on where user can find the API swagger docs.
39-
- add examples of APIs that user can access
27+
The APIs include:
28+
* Converting a PDF from object storage to Markdown.
29+
* Converting a PDF file uploaded as file object to Markdown.
4030

31+
Please see the API reference `/api/docs` for more details to try them out.
4132

4233

4334
[magic_button]: https://oci-resourcemanager-plugin.plugins.oci.oraclecloud.com/latest/deploy-to-oracle-cloud.svg

ai-hub/ai-translation/README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,32 @@
1-
# AI Translation App
1+
# AI Translation
22

3-
todo: add high level details about the solution
3+
## Overview
44

5+
The AI Text Translation Solution delivers fast, accurate language translation powered by state-of-the-art Large Language Models (LLM). By default, it leverages the powerful meta.llama-3.3-70b-instruct model from the OCI Generative AI Service , but you can specify alternative LLMs or connect any OpenAI-compatible model endpoint.
56

6-
## Deploy solution on OCI
7-
This application can be deployed using an [Oracle Resource Manager](https://docs.oracle.com/en-us/iaas/Content/ResourceManager/Concepts/resourcemanager.htm) (ORM) stack as a solution on AI Hub. To create and deploy the solution, click the button below:
8-
9-
[![Deploy to Oracle Cloud][magic_button]][magic_stack]
10-
7+
The solution includes REST APIs and Playground UI for experimentation.
118

9+
## Features
1210

11+
🌐 APIs for translation and language management
12+
🎛️ Playground UI for rapid hands-on exploration
13+
📝 Single & Batch Translation support
14+
🚀 Streaming & Async translation modes
15+
🔗 Flexible model selection: supports OCI Generative AI and any OpenAI-compatible API
1316

17+
## Deployment
18+
This application can be deployed using an [Oracle Resource Manager](https://docs.oracle.com/en-us/iaas/Content/ResourceManager/Concepts/resourcemanager.htm) (ORM) stack as a solution on AI Hub. To create and deploy the solution, click the button below:
1419

20+
[![Deploy to Oracle Cloud][magic_button]][magic_stack]
1521

22+
## APIs
1623

24+
The APIs include:
25+
* Listing the supported languages
26+
* Text translation supporting streaming and async operations
27+
* Start batch Translation Job
1728

29+
Please see the API reference `/api/docs` for more details and try them out.
1830

1931
[magic_button]: https://oci-resourcemanager-plugin.plugins.oci.oraclecloud.com/latest/deploy-to-oracle-cloud.svg
2032
[magic_stack]: https://cloud.oracle.com/resourcemanager/stacks/create?zipUrl=https://github.com/oracle-samples/oci-data-science-ai-samples/releases/download/1.0/ai-translation.zip

0 commit comments

Comments
 (0)