文章來源:Grok 漫游指南 | xAI Docs?
歡迎!在本指南中,我們將引導您了解使用 xAI API 的基礎知識。
#第 1 步:創建 xAI 帳戶
您需要一個 xAI 帳戶才能訪問 xAI API。在此處注冊帳戶。
創建賬戶后,您需要為其加載積分才能開始使用 API。
#第 2 步:生成 API 密鑰
通過 xAI API 控制臺中的?API 密鑰頁面創建 API 密鑰。
生成 API 密鑰后,我們需要將其保存在安全的地方!我們建議您將其導出為終端中的環境變量。
bash (Mac)
export XAI_API_KEY="your_api_key"
#第 3 步:提出您的第一個請求
將 xAI API 密鑰導出為環境變量后,您就可以發出第一個 API 請求了。
讓我們使用curl
.將以下內容直接粘貼到您的終端中。
bash
curl https://api.x.ai/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $XAI_API_KEY" \
-d '{"messages": [{"role": "system","content": "You are Grok, a chatbot inspired by the Hitchhikers Guide to the Galaxy."},{"role": "user","content": "What is the meaning of life, the universe, and everything?"}],"model": "grok-2-latest","stream": false,"temperature": 0
}'
#第 4 步:通過 Python 或 Javascript 發出請求
我們的 API 與 OpenAI 和 Anthropic SDK 完全兼容。例如,我們可以從 Python 或 Javascript 發出相同的請求,如下所示:
python
# In your terminal, first run:
# pip install openaiimport os
from openai import OpenAIXAI_API_KEY = os.getenv("XAI_API_KEY")
client = OpenAI(api_key=XAI_API_KEY,base_url="https://api.x.ai/v1",
)completion = client.chat.completions.create(model="grok-2-latest",messages=[{"role": "system","content": "You are Grok, a chatbot inspired by the Hitchhikers Guide to the Galaxy."},{"role": "user","content": "What is the meaning of life, the universe, and everything?"},],
)print(completion.choices[0].message.content)
有關使用 Grok 進行文本回復的深入指南,請查看我們的?聊天指南.
#第 5 步:使用 Grok 分析圖像
某些 grok 模型可以同時接受文本和圖像作為輸入。例如:
python
import os
from openai import OpenAIXAI_API_KEY = os.getenv("XAI_API_KEY")
image_url = "https://science.nasa.gov/wp-content/uploads/2023/09/web-first-images-release.png"client = OpenAI(api_key=XAI_API_KEY,base_url="https://api.x.ai/v1",
)messages = [{"role": "user","content": [{"type": "image_url","image_url": {"url": image_url,"detail": "high",},},{"type": "text","text": "What's in this image?",},],},
]completion = client.chat.completions.create(model="grok-2-vision-latest",messages=messages,temperature=0.01,
)
print(completion.choices[0].message.content)
瞧!Grok 會告訴你圖片中的確切內容:
這張圖片是一張太空區域的照片,特別是 Carina 星云的一部分,由 James Webb 太空望遠鏡拍攝。它展示了星際氣體和塵埃的壯麗景色,被年輕而熾熱的恒星照亮。光的亮點是星星,五顏六色的云朵由各種氣體和塵埃顆粒組成。該圖像突出了星云中恒星形成的復雜細節和美麗。
要了解如何將 Grok Vision 用于更高級的用例,請查看我們的?Image Understanding Guide。
#監控使用情況
當您使用 API 密鑰時,您需要為使用的令牌數量付費。有關概述,您可以在?xAI Console Usage Page?上監控您的使用情況。
如果您想要更精細的按請求使用情況跟蹤,API 響應包括一個使用情況對象,該對象提供有關提示(輸入)和完成(輸出)令牌使用情況的詳細信息。
json
"usage": {"prompt_tokens": 41,"completion_tokens": 87,"total_tokens": 128,"prompt_tokens_details": {"text_tokens": 41,"audio_tokens": 0,"image_tokens": 0,"cached_tokens": 0}
}
如果您發送請求過于頻繁或提示時間過長,則可能會遇到速率限制并收到錯誤響應。有關更多信息,請閱讀消耗和速率限制。
文章來源:Grok 漫游指南 | xAI Docs?