更新接入azure的说明
This commit is contained in:
505030475
parent
cd1e4e1ba7
commit
d87f1eb171
11
README.md
11
README.md
@ -186,16 +186,19 @@ docker-compose up
|
||||
2. 使用docker-compose运行。
|
||||
请阅读docker-compose.yml后，按照其中的提示操作即可
|
||||
|
||||
3. 如何使用反代URL/微软云AzureAPI。
|
||||
3. 如何使用反代URL
|
||||
按照`config.py`中的说明配置API_URL_REDIRECT即可。
|
||||
|
||||
4. 远程云服务器部署（需要云服务器知识与经验）。
|
||||
4. 微软云AzureAPI
|
||||
按照`config.py`中的说明配置即可（AZURE_ENDPOINT等四个配置）
|
||||
|
||||
5. 远程云服务器部署（需要云服务器知识与经验）。
|
||||
请访问[部署wiki-1](https://github.com/binary-husky/gpt_academic/wiki/%E4%BA%91%E6%9C%8D%E5%8A%A1%E5%99%A8%E8%BF%9C%E7%A8%8B%E9%83%A8%E7%BD%B2%E6%8C%87%E5%8D%97)
|
||||
|
||||
5. 使用WSL2（Windows Subsystem for Linux 子系统）。
|
||||
6. 使用WSL2（Windows Subsystem for Linux 子系统）。
|
||||
请访问[部署wiki-2](https://github.com/binary-husky/gpt_academic/wiki/%E4%BD%BF%E7%94%A8WSL2%EF%BC%88Windows-Subsystem-for-Linux-%E5%AD%90%E7%B3%BB%E7%BB%9F%EF%BC%89%E9%83%A8%E7%BD%B2)
|
||||
|
||||
6. 如何在二级网址（如`http://localhost/subpath`）下运行。
|
||||
7. 如何在二级网址（如`http://localhost/subpath`）下运行。
|
||||
请访问[FastAPI运行说明](docs/WithFastapi.md)
|
||||
|
||||
---
|
||||
|
||||
13
config.py
13
config.py
@ -1,12 +1,6 @@
|
||||
# [step 1]>> 例如： API_KEY = "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" （此key无效）
|
||||
API_KEY = "sk-此处填API密钥" # 可同时填写多个API-KEY，用英文逗号分割，例如API_KEY = "sk-openaikey1,sk-openaikey2,fkxxxx-api2dkey1,fkxxxx-api2dkey2"
|
||||
|
||||
#增加关于AZURE的配置信息， 可以在AZURE网页中找到
|
||||
AZURE_ENDPOINT = "https://你的api名称.openai.azure.com/"
|
||||
AZURE_API_KEY = "填入azure openai api的密钥"
|
||||
AZURE_API_VERSION = "填入api版本"
|
||||
AZURE_ENGINE = "填入ENGINE"
|
||||
|
||||
|
||||
# [step 2]>> 改为True应用代理，如果直接在海外服务器部署，此处不修改
|
||||
USE_PROXY = False
|
||||
@ -88,3 +82,10 @@ your bing cookies here
|
||||
# 如果需要使用Slack Claude，使用教程详情见 request_llm/README.md
|
||||
SLACK_CLAUDE_BOT_ID = ''
|
||||
SLACK_CLAUDE_USER_TOKEN = ''
|
||||
|
||||
|
||||
# 如果需要使用AZURE 详情请见额外文档 docs\use_azure.md
|
||||
AZURE_ENDPOINT = "https://你的api名称.openai.azure.com/"
|
||||
AZURE_API_KEY = "填入azure openai api的密钥"
|
||||
AZURE_API_VERSION = "填入api版本"
|
||||
AZURE_ENGINE = "填入ENGINE"
|
||||
|
||||
143
docs/use_azure.md
Normal file
143
docs/use_azure.md
Normal file
@ -0,0 +1,143 @@
|
||||
# 通过微软Azure云服务申请 Openai API
|
||||
|
||||
由于Openai和微软的关系，现在是可以通过微软的Azure云计算服务直接访问openai的api，免去了注册和网络的问题。
|
||||
|
||||
快速入门的官方文档的链接是：[快速入门 - 开始通过 Azure OpenAI 服务使用 ChatGPT 和 GPT-4 - Azure OpenAI Service | Microsoft Learn](https://learn.microsoft.com/zh-cn/azure/cognitive-services/openai/chatgpt-quickstart?pivots=programming-language-python)
|
||||
|
||||
# 申请API
|
||||
|
||||
按文档中的“先决条件”的介绍，出了编程的环境以外，还需要以下三个条件：
|
||||
|
||||
1. Azure账号并创建订阅
|
||||
|
||||
2. 为订阅添加Azure OpenAI 服务
|
||||
|
||||
3. 部署模型
|
||||
|
||||
## Azure账号并创建订阅
|
||||
|
||||
### Azure账号
|
||||
|
||||
创建Azure的账号时最好是有微软的账号，这样似乎更容易获得免费额度（第一个月的200美元，实测了一下，如果用一个刚注册的微软账号登录Azure的话，并没有这一个月的免费额度）。
|
||||
|
||||
创建Azure账号的网址是：[立即创建 Azure 免费帐户 | Microsoft Azure](https://azure.microsoft.com/zh-cn/free/)
|
||||
|
||||
|
||||
|
||||
打开网页后，点击 “免费开始使用” 会跳转到登录或注册页面，如果有微软的账户，直接登录即可，如果没有微软账户，那就需要到微软的网页再另行注册一个。
|
||||
|
||||
注意，Azure的页面和政策时不时会变化，已实际最新显示的为准就好。
|
||||
|
||||
### 创建订阅
|
||||
|
||||
注册好Azure后便可进入主页：
|
||||
|
||||
|
||||
|
||||
首先需要在订阅里进行添加操作，点开后即可进入订阅的页面：
|
||||
|
||||
|
||||
|
||||
第一次进来应该是空的，点添加即可创建新的订阅（可以是“免费”或者“即付即用”的订阅），其中订阅ID是后面申请Azure OpenAI需要使用的。
|
||||
|
||||
## 为订阅添加Azure OpenAI服务
|
||||
|
||||
之后回到首页，点Azure OpenAI即可进入OpenAI服务的页面（如果不显示的话，则在首页上方的搜索栏里搜索“openai”即可）。
|
||||
|
||||
|
||||
|
||||
不过现在这个服务还不能用。在使用前，还需要在这个网址申请一下：
|
||||
|
||||
[Request Access to Azure OpenAI Service (microsoft.com)](https://customervoice.microsoft.com/Pages/ResponsePage.aspx?id=v4j5cvGGr0GRqy180BHbR7en2Ais5pxKtso_Pz4b1_xUOFA5Qk1UWDRBMjg0WFhPMkIzTzhKQ1dWNyQlQCN0PWcu)
|
||||
|
||||
这里有二十来个问题，按照要求和自己的实际情况填写即可。
|
||||
|
||||
其中需要注意的是
|
||||
|
||||
1. 千万记得填对"订阅ID"
|
||||
|
||||
2. 需要填一个公司邮箱（可以不是注册用的邮箱）和公司网址
|
||||
|
||||
之后，在回到上面那个页面，点创建，就会进入创建页面了：
|
||||
|
||||
|
||||
|
||||
需要填入“资源组”和“名称”，按照自己的需要填入即可。
|
||||
|
||||
完成后，在主页的“资源”里就可以看到刚才创建的“资源”了，点击进入后，就可以进行最后的部署了。
|
||||
|
||||
|
||||
|
||||
## 部署模型
|
||||
|
||||
进入资源页面后，在部署模型前，可以先点击“开发”，把密钥和终结点记下来。
|
||||
|
||||
|
||||
|
||||
之后，就可以去部署模型了，点击“部署”即可，会跳转到 Azure OpenAI Stuido 进行下面的操作：
|
||||
|
||||
|
||||
|
||||
进入 Azure OpenAi Studio 后，点击新建部署，会弹出如下对话框：
|
||||
|
||||
|
||||
|
||||
在这里选 gpt-35-turbo 或需要的模型并按需要填入“部署名”即可完成模型的部署。
|
||||
|
||||
|
||||
|
||||
这个部署名需要记下来。
|
||||
|
||||
到现在为止，申请操作就完成了，需要记下来的有下面几个东西：
|
||||
|
||||
● 密钥（1或2都可以）
|
||||
|
||||
● 终结点
|
||||
|
||||
● 部署名（不是模型名）
|
||||
|
||||
# API的使用
|
||||
|
||||
接下来就是具体怎么使用API了，还是可以参考官方文档：[快速入门 - 开始通过 Azure OpenAI 服务使用 ChatGPT 和 GPT-4 - Azure OpenAI Service | Microsoft Learn](https://learn.microsoft.com/zh-cn/azure/cognitive-services/openai/chatgpt-quickstart?pivots=programming-language-python)
|
||||
|
||||
和openai自己的api调用有点类似，都需要安装openai库，不同的是调用方式
|
||||
|
||||
```
|
||||
import openai
|
||||
openai.api_type = "azure" #固定格式，无需修改
|
||||
openai.api_base = os.getenv("AZURE_OPENAI_ENDPOINT") #这里填入“终结点”
|
||||
openai.api_version = "2023-05-15" #固定格式，无需修改
|
||||
openai.api_key = os.getenv("AZURE_OPENAI_KEY") #这里填入“密钥1”或“密钥2”
|
||||
|
||||
response = openai.ChatCompletion.create(
|
||||
engine="gpt-35-turbo", #这里填入的不是模型名，是部署名
|
||||
messages=[
|
||||
{"role": "system", "content": "You are a helpful assistant."},
|
||||
{"role": "user", "content": "Does Azure OpenAI support customer managed keys?"},
|
||||
{"role": "assistant", "content": "Yes, customer managed keys are supported by Azure OpenAI."},
|
||||
{"role": "user", "content": "Do other Azure Cognitive Services support this too?"}
|
||||
]
|
||||
)
|
||||
|
||||
print(response)
|
||||
print(response['choices'][0]['message']['content'])
|
||||
|
||||
```
|
||||
|
||||
需要注意的是：
|
||||
|
||||
1. engine那里填入的是部署名，不是模型名
|
||||
|
||||
2. 通过openai库获得的这个 response 和通过 request 库访问 url 获得的 response 不同，不需要 decode，已经是解析好的 json 了，直接根据键值读取即可。
|
||||
|
||||
更细节的使用方法，详见官方API文档。
|
||||
|
||||
# 关于费用
|
||||
|
||||
Azure OpenAI API 还是需要一些费用的（免费订阅只有1个月有效期），费用如下：
|
||||
|
||||
|
||||
|
||||
具体可以可以看这个网址 ：[Azure OpenAI 服务 - 定价| Microsoft Azure](https://azure.microsoft.com/zh-cn/pricing/details/cognitive-services/openai-service/?cdn=disable)
|
||||
|
||||
并非网上说的什么“一年白嫖”，但注册方法以及网络问题都比直接使用openai的api要简单一些。
|
||||
Loading…
x
Reference in New Issue
Block a user