Skip to content

chore(docs): clean up README_sphynx.md #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
alpkom wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

chore(docs): clean up README_sphynx.md #161

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 0 additions & 105 deletions packages/gen/README_sphynx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ With this SDK you can leverage the power of generative models available in the g
This SDK provides LLM access by wrapping the native SDKs of the model providers (OpenAI, Amazon, Google),
through langchain, or through the orchestration service.

(installation)=
## Installation

Use the package name to install the SDK with support for all models (OpenAI, Amazon, Google)
Expand Down Expand Up @@ -167,110 +166,6 @@ For model access through the orchestration service, you need to create a deploym

In section "*Examples*" there are code snippets for each Large Language and Embedding model as well as for the orchestration service usage.

(supported_models)=
## Supported Models

The list of models in the Generative AI Hub of SAP AI Core can be found in [SAP note 343776](https://me.sap.com/notes/3437766).
Among these, the following models are currently supported in the SAP Cloud SDK for AI (Python) - generative:

### LLM Models

| Provider | Model Name | Streaming Support |
|------------|------------------------------------|-------------------|
| Amazon | amazon--nova-lite | No |
| | amazon--nova-micro | No |
| | amazon--nova-pro | No |
| | amazon--amazon--nova-premier | Yes |
| Anthropic | anthropic--claude-3-haiku | Yes |
| | anthropic--claude-3.5-sonnet | Yes |
| | anthropic--claude-3.7-sonnet | Yes |
| | anthropic--claude-4-sonnet | Yes |
| | anthropic--claude-4-opus | Yes |
| | anthropic--claude-4.5-sonnet | Yes |
| | anthropic--claude-4.5-haiku | Yes |
| | anthropic--claude-4.6-sonnet | Yes |
| | anthropic--claude-4.6-opus | Yes |
| Google | gemini-2.0-flash | Yes |
| | gemini-2.0-flash-lite | Yes |
| | gemini-2.5-flash | Yes |
| | gemini-2.5-pro | Yes |
| | gemini-2.5-flash-lite | Yes |
| MistralAI | mistralai--mistral-small-instruct | No |
| | mistralai--mistral-medium-instruct | No |
| | mistralai--mistral-large-instruct | No |
| OpenAI | gpt-4o | Yes |
| | gpt-4o-mini | Yes |
| | gpt-4.1 | Yes |
| | gpt-4.1-mini | Yes |
| | gpt-4.1-nano | Yes |
| | gpt-5 | Yes |
| | gpt-5-mini | Yes |
| | gpt-5-nano | Yes |
| | gpt-5.2 | Yes |
| | gpt-5.3-codex | Yes |
| | gpt-5.4 | Yes |
| | gpt-5.4-nano | Yes |
| | o1 | No |
| | o3 | Yes |
| | o3-mini | No |
| | o4-mini | Yes |
| Cohere | cohere--command-a-reasoning | Yes |
| | cohere--reranker | Yes |
| Perplexity | sonar | Yes |
| | sonar-pro | Yes |
| | sonar-deep-research | Yes |

### Embedding Models

| Provider | Model Name |
|----------|---------------------------------|
| Amazon | amazon--titan-embed-text |
| | amazon--titan-embed-image |
| Google | google--gemini-embedding |
| NVIDIA | nvidia--llama-3.2-nv-embedqa-1b |
| OpenAI | text-embedding-3-small |
| | text-embedding-3-large |
| | text-embedding-ada-002 |

### Notes on model usage

- ⚠️ **Anthropic & Amazon**:
- Currently, for `amazon--nova-lite`, `amazon--nova-micro`, and `amazon--nova-pro`, the supported method is `converse`. `invoke` and `invoke_model_with_response_stream` are not supported.
- ℹ️ **MistralAI:**
- This model only supports the following roles in the order implied: user/assistant/user/assistant/....
- ℹ️ **Perplexity:**
- The Perplexity Sonar models are also based on the OpenAI SDK and usage for these models is similar to that of GPT models.
- Search-API is not supported yet.
- ℹ️ **Cohere:**
- The cohere--command-a-reasoning model is also based on the OpenAI SDK and usage for this model is similar to that of GPT models.
- **Models not added to SDK yet**:
- You can also try using Generative AI Hub SDK for models that are already in Generative AI Hub, but not supported yet
by the SDK. This can be done by additionally specifying the model initialization: see [](unsupported_models).
Please note, that it's not guaranteed that it will work. Because there might be some new models, for which customization in the SDK
is needed.

(package_dependencies)=
## Package dependencies

Please note the following dependencies of sap-ai-sdk-gen:

```text
httpx>=0.27.0
h11>=0.16.0
dacite>=1.8.1
click>=8.1.7
overloading==0.5.0
packaging>=23.2
sap-ai-sdk-core>=3.1.0
pydantic~=2.12
openai>=1.58.1
google-genai~=1.60.0 # google
boto3>=1.40.61 # amazon
aiobotocore>=3.0.0 # amazon
langchain~=1.2.6
langchain_google_genai~=4.2.0 # google
langchain-classic~=1.0.0
langchain-community~=0.4.1
langchain-openai~=1.1.0
langchain-aws~=1.1.0 # amazon
```
Loading