commit 317c35f0cb760a99acbe7f4f79bdfd888e28fc77 Author: zehish Date: Wed May 6 13:36:39 2026 +0330 Upload files to "Embeddings" diff --git a/Embeddings/developer_guidance.md b/Embeddings/developer_guidance.md new file mode 100644 index 0000000..6da46b3 --- /dev/null +++ b/Embeddings/developer_guidance.md @@ -0,0 +1,40 @@ +# Developer Guidance: OpenAI-Compatible Embeddings + +## Overview +This project uses the OpenAI Python SDK with a compatible base URL to call embeddings. + +## Example Usage +```python +from openai import OpenAI + +client = OpenAI( + base_url="https://api.gapgpt.app/v1", + api_key="YOUR_SECRET_KEY_HERE" +) + +response = client.embeddings.create( + model="text-embedding-3-small", + input="متن برای تبدیل به بردار" +) + +print(response.data[0].embedding[:5]) +``` + +## Secret Key Placeholder +Replace `YOUR_SECRET_KEY_HERE` with your actual secret key. + +### Recommended: Use an environment variable +```python +import os +from openai import OpenAI + +client = OpenAI( + base_url="https://api.gapgpt.app/v1", + api_key=os.getenv("OPENAI_API_KEY") +) +``` + +## Notes +- Do **not** commit your secret key to source control. +- Store secrets in `.env` files or your deployment secret manager. +- Use the embedding output as needed in your application.