ไลบรารีไคลเอนต์ OpenAI API สำหรับ. NET รองรับ Openai และ Azure-Openai APIs ห้องสมุดนี้ได้รับการพัฒนาเพื่อการใช้งานสาธารณะและใช้งานได้ฟรี รองรับ. NET เวอร์ชัน:
x> = v4.6.1
x> = netstandard 2.0
x> = dotnetcore 3.1
.NET 6.0
.NET 7.0
.NET 8.0
ทำงานร่วมกับ Blazor WebAssembly และ Blazor Server
ในการติดตั้งแพ็คเกจเพิ่มบรรทัดต่อไปนี้ไปยังไฟล์ CSPROJ แทนที่ XXX ด้วยหมายเลขเวอร์ชันล่าสุด:
<PackageReference Include="Forge.OpenAI" Version="x.x.x" />
คุณสามารถติดตั้งผ่าน. NET CLI ด้วยคำสั่งต่อไปนี้:
dotnet add package Forge.OpenAI
หากคุณใช้ Visual Studio คุณสามารถติดตั้งผ่านตัวจัดการแพ็คเกจ Nuget ในตัว
คุณควรสร้าง Apikey เพื่อทำงานกับ OpenAI API
หากคุณไม่มีบัญชีที่ OpenAI ให้สร้างที่นี่: https://platform.openai.com/
กว่าเส้นทางไปที่: https://platform.openai.com/account/api-keys
โดยค่าเริ่มต้นไลบรารีนี้ใช้การฉีดพึ่งพา Microsoft แต่ไม่จำเป็น
คุณสามารถลงทะเบียนบริการลูกค้าด้วยคอลเลกชันบริการในไฟล์ startup.cs / program.cs ของคุณในแอปพลิเคชันของคุณ
public void ConfigureServices ( IServiceCollection services )
{
services . AddForgeOpenAI ( options => {
options . AuthenticationInfo = Configuration [ " OpenAI:ApiKey " ] ! ;
} ) ;
}หรือในไฟล์ program.cs ของคุณ
public static async Task Main ( string [ ] args )
{
var builder = WebAssemblyHostBuilder . CreateDefault ( args ) ;
builder . RootComponents . Add < App > ( " app " ) ;
builder . Services . AddForgeOpenAI ( options => {
options . AuthenticationInfo = builder . Configuration [ " OpenAI:ApiKey " ] ! ;
} ) ;
await builder . Build ( ) . RunAsync ( ) ;
}หรือ
public static async Task Main ( string [ ] args )
{
using var host = Host . CreateDefaultBuilder ( args )
. ConfigureServices ( ( builder , services ) =>
{
services . AddForgeOpenAI ( options => {
options . AuthenticationInfo = builder . Configuration [ " OpenAI:ApiKey " ] ! ;
} ) ;
} )
. Build ( ) ;
}คุณควรจัดเตรียมคีย์ OpenAI API ของคุณและเป็นทางเลือกให้กับองค์กรของคุณในการบูตบริการ หากคุณไม่ได้ให้ไว้ในการกำหนดค่าบริการจะค้นหาข้อมูลที่จำเป็นในตัวแปรสภาพแวดล้อมของคุณโดยอัตโนมัติในไฟล์ JSON (.OPENAI) หรือในไฟล์สภาพแวดล้อม (.ENV)
ตัวอย่างสำหรับตัวแปรสภาพแวดล้อม:
openai_key หรือ openai_api_key หรือ openai_secret_key หรือ test_openai_secret_key ได้รับการตรวจสอบสำหรับคีย์ API
การตรวจสอบคีย์ขององค์กรสำหรับ organzation
ตัวอย่างสำหรับไฟล์ JSON:
{"Apikey": "your_api_key", "องค์กร": "organization_id"}
ไฟล์สภาพแวดล้อมต้องมีคู่คีย์/ค่าในรูปแบบนี้ {key} = {value}
สำหรับ ' คีย์ ' ให้ใช้หนึ่งในค่าเดียวกันซึ่งอธิบายไว้ในตัวแปรสภาพแวดล้อมด้านบน
ตัวอย่างสำหรับไฟล์สภาพแวดล้อม:
openai_key = your_api_key
organization = opturfally_your_organization
Openai และบริการที่ขึ้นอยู่กับต้องใช้ openaioptions ซึ่งสามารถให้ได้ด้วยตนเองหรือจะเกิดขึ้นถ้าคุณใช้การฉีดพึ่งพา หากคุณต้องการใช้อินสแตนซ์บริการ OpenAI หลายรายการในเวลาเดียวกันคุณควรให้ตัวเลือกนี้เป็นรายบุคคลด้วยการตั้งค่าที่แตกต่างกันและข้อมูลรับรองการรับรองความถูกต้อง
ในตัวเลือกมีการตั้งค่า URI จำนวนมากซึ่งไม่ได้สัมผัสตามปกติ ตัวเลือกที่สำคัญที่สุดคือคุณสมบัติ AuthenticationInfo ซึ่งมี APIKEY และ ID ขององค์กร
นอกจากนี้ยังมีตัวเลือกเพิ่มเติมที่เรียกว่า httpMessageHandlerFactory ซึ่งสร้าง httpmessageHandler สำหรับ httpClient ในบางกรณีพิเศษเช่นหากคุณต้องการแทนที่พฤติกรรมบางอย่างของ httpClient
มีคุณสมบัติการบันทึกในตัวเพื่อการทดสอบและการดีบักที่เรียกว่า LogRequestSandResponses ซึ่งยังคงมีคำขอและการตอบกลับทั้งหมดในโฟลเดอร์ (LogRequestSandResponsesFolder) ด้วยคุณสมบัตินี้คุณสามารถตรวจสอบข้อความระดับต่ำได้ ฉันไม่แนะนำให้ใช้ในสภาพแวดล้อมการผลิต
หากคุณต้องการเรียนรู้เพิ่มเติมเกี่ยวกับความสามารถของ API โปรดไปที่ https://platform.openai.com/docs/api-reference หากคุณต้องการสร้างคีย์ API โปรดไปที่: https://platform.openai.com/account/api-keys
ฉันได้สร้างสนามเด็กเล่นซึ่งเป็นส่วนหนึ่งของโซลูชันนี้ ครอบคลุมคุณสมบัติทั้งหมดซึ่งห้องสมุดนี้มีให้ อย่าลังเลที่จะวิ่งผ่านตัวอย่างเหล่านี้และเล่นกับการตั้งค่า
นอกจากนี้นี่คือสนามเด็กเล่น OpenAI ที่คุณสามารถหาตัวอย่างเกี่ยวกับการใช้งาน: https://platform.openai.com/playground/p/default-chat?lang=node.js&mode=complete&model=text-davinci-003
ตั้งค่าบริการกับผู้ให้บริการ Azure-Openai คุณต้องระบุชื่อทรัพยากร Azure OpenAI ของคุณรวมถึงรหัสการปรับใช้แบบจำลองของคุณ
วิชาบังคับก่อน: https://learn.microsoft.com/en-us/azure/cognitive-services/openai/quickstart?tabs=command-line&pivots=programming-lianguage-studio: https://learn.microsoft.com/azurefices
ตัวอย่าง: https://github.com/jzo001/forge.openai/blob/main/playgrounds/azure-openai_setup_example/program.cs