OpenAIClient class
Een client voor interactie met Azure OpenAI.
De client heeft het eindpunt van een OpenAI-resource en een verificatiemethode zoals een API-sleutel of token nodig. De API-sleutel en het eindpunt vindt u op de openAI-resourcepagina. Deze bevinden zich op de pagina Sleutels en eindpunten van de resource.
Voorbeelden voor verificatie:
API-sleutel
import { OpenAIClient } from "@azure/openai";
import { AzureKeyCredential } from "@azure/core-auth";
const endpoint = "<azure endpoint>";
const credential = new AzureKeyCredential("<api key>");
const client = new OpenAIClient(endpoint, credential);
Azure Active Directory
import { OpenAIClient } from "@azure/openai";
import { DefaultAzureCredential } from "@azure/identity";
const endpoint = "<azure endpoint>";
const credential = new DefaultAzureCredential();
const client = new OpenAIClient(endpoint, credential);
Constructors
| Open |
Initialiseert een exemplaar van OpenAIClient voor gebruik met het niet-Azure OpenAI-eindpunt. |
| Open |
Initialiseert een exemplaar van OpenAIClient voor gebruik met een Azure OpenAI-resource. |
| Open |
Initialiseert een exemplaar van OpenAIClient voor gebruik met een Azure OpenAI-resource. |
Methoden
| get |
Retourneert de transcriptie van een audiobestand in een eenvoudige JSON-indeling. |
| get |
Retourneert de transcriptie van een audiobestand. |
| get |
Retourneert de vertaling van een audiobestand. |
| get |
Retourneert de vertaling van een audiobestand. |
| get |
Hiermee haalt u de chatvoltooiingen voor de opgegeven chatberichten op. Voltooiingen ondersteunen een breed scala aan taken en genereren tekst die wordt voortgezet op basis van of 'voltooit' verstrekte promptgegevens. |
| get |
Hiermee worden de voltooiingen voor de opgegeven invoerprompts opgevraagd. Voltooiingen ondersteunen een breed scala aan taken en genereren tekst die wordt voortgezet op basis van of 'voltooit' verstrekte promptgegevens. |
| get |
Retourneer de insluitingen voor een bepaalde prompt. |
| get |
Hiermee maakt u een installatiekopieën op basis van een prompt. |
| stream |
Lijsten de tokens voor het voltooien van chats zodra deze beschikbaar komen voor een chatcontext. |
| stream |
Lijsten de voltooiingstokens zodra deze beschikbaar komen voor een bepaalde prompt. |
Constructordetails
OpenAIClient(KeyCredential, OpenAIClientOptions)
Initialiseert een exemplaar van OpenAIClient voor gebruik met het niet-Azure OpenAI-eindpunt.
new OpenAIClient(openAiApiKey: KeyCredential, options?: OpenAIClientOptions)Parameters
- openAiApiKey
- KeyCredential
De API-sleutel die moet worden gebruikt om verbinding te maken met het niet-Azure OpenAI-eindpunt.
- options
- OpenAIClientOptions
De opties voor het configureren van de client.
Opmerkingen
OpenAIClient-objecten die met deze constructor zijn geïnitialiseerd, kunnen alleen worden gebruikt met het niet-Azure OpenAI-deductieeindpunt. Als u OpenAIClient wilt gebruiken met een Azure OpenAI-resource, gebruikt u een constructor die in plaats daarvan een resource-URI en Azure-verificatiereferentie accepteert.
OpenAIClient(string, KeyCredential, OpenAIClientOptions)
Initialiseert een exemplaar van OpenAIClient voor gebruik met een Azure OpenAI-resource.
new OpenAIClient(endpoint: string, credential: KeyCredential, options?: OpenAIClientOptions)Parameters
- endpoint
-
string
De URI voor een Azure OpenAI-resource, inclusief protocol en hostnaam. Bijvoorbeeld: https://my-resource.openai.azure.com.
- credential
- KeyCredential
Een sleutelreferentie die wordt gebruikt voor verificatie bij een Azure OpenAI-resource.
- options
- OpenAIClientOptions
De opties voor het configureren van de client.
Opmerkingen
Met deze constructor wordt een OpenAIClient-object geïnitialiseerd dat alleen kan worden gebruikt met Azure OpenAI-resources. Als u OpenAIClient wilt gebruiken met een niet-Azure OpenAI-deductieeindpunt, gebruikt u een constructor die in plaats daarvan een niet-Azure OpenAI API-sleutel accepteert.
OpenAIClient(string, TokenCredential, OpenAIClientOptions)
Initialiseert een exemplaar van OpenAIClient voor gebruik met een Azure OpenAI-resource.
new OpenAIClient(endpoint: string, credential: TokenCredential, options?: OpenAIClientOptions)Parameters
- endpoint
-
string
De URI voor een Azure OpenAI-resource, inclusief protocol en hostnaam. Bijvoorbeeld: https://my-resource.openai.azure.com.
- credential
- TokenCredential
Een tokenreferentie die wordt gebruikt voor verificatie met een Azure OpenAI-resource.
- options
- OpenAIClientOptions
De opties voor het configureren van de client.
Methodedetails
getAudioTranscription(string, Uint8Array, GetAudioTranscriptionOptions)
Retourneert de transcriptie van een audiobestand in een eenvoudige JSON-indeling.
function getAudioTranscription(deploymentName: string, fileContent: Uint8Array, options?: GetAudioTranscriptionOptions): Promise<AudioResultSimpleJson>Parameters
- deploymentName
-
string
De naam van de modelimplementatie (bij gebruik van Azure OpenAI) of modelnaam (bij gebruik van niet-Azure OpenAI) die voor deze aanvraag moet worden gebruikt.
- fileContent
-
Uint8Array
De inhoud van het audiobestand dat moet worden getranscribeerd.
- options
- GetAudioTranscriptionOptions
De opties voor deze audiotranscriptieaanvraag.
Retouren
Promise<AudioResultSimpleJson>
De audiotranscriptie resulteert in een eenvoudige JSON-indeling.
getAudioTranscription<Format>(string, Uint8Array, Format, GetAudioTranscriptionOptions)
Retourneert de transcriptie van een audiobestand.
function getAudioTranscription<Format>(deploymentName: string, fileContent: Uint8Array, format: Format, options?: GetAudioTranscriptionOptions): Promise<AudioResult<Format>>Parameters
- deploymentName
-
string
De naam van de modelimplementatie (bij gebruik van Azure OpenAI) of modelnaam (bij gebruik van niet-Azure OpenAI) die voor deze aanvraag moet worden gebruikt.
- fileContent
-
Uint8Array
De inhoud van het audiobestand dat moet worden getranscribeerd.
- format
-
Format
De indeling van het resultaatobject. Zie AudioResultFormat voor mogelijke waarden.
- options
- GetAudioTranscriptionOptions
De opties voor deze audiotranscriptieaanvraag.
Retouren
Promise<AudioResult<Format>>
De audiotranscriptie resulteert in een indeling naar keuze.
getAudioTranslation(string, Uint8Array, GetAudioTranslationOptions)
Retourneert de vertaling van een audiobestand.
function getAudioTranslation(deploymentName: string, fileContent: Uint8Array, options?: GetAudioTranslationOptions): Promise<AudioResultSimpleJson>Parameters
- deploymentName
-
string
De naam van de modelimplementatie (bij gebruik van Azure OpenAI) of modelnaam (bij gebruik van niet-Azure OpenAI) die voor deze aanvraag moet worden gebruikt.
- fileContent
-
Uint8Array
De inhoud van het te vertalen audiobestand.
- options
- GetAudioTranslationOptions
De opties voor deze aanvraag voor audiovertaling.
Retouren
Promise<AudioResultSimpleJson>
Het audioomzettingsresultaat.
getAudioTranslation<Format>(string, Uint8Array, Format, GetAudioTranslationOptions)
Retourneert de vertaling van een audiobestand.
function getAudioTranslation<Format>(deploymentName: string, fileContent: Uint8Array, format: Format, options?: GetAudioTranslationOptions): Promise<AudioResult<Format>>Parameters
- deploymentName
-
string
De naam van de modelimplementatie (bij gebruik van Azure OpenAI) of modelnaam (bij gebruik van niet-Azure OpenAI) die voor deze aanvraag moet worden gebruikt.
- fileContent
-
Uint8Array
De inhoud van het te vertalen audiobestand.
- format
-
Format
De indeling van het resultaatobject. Zie AudioResultFormat voor mogelijke waarden.
- options
- GetAudioTranslationOptions
De opties voor deze aanvraag voor audiovertaling.
Retouren
Promise<AudioResult<Format>>
Het audioomzettingsresultaat.
getChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)
Hiermee haalt u de chatvoltooiingen voor de opgegeven chatberichten op. Voltooiingen ondersteunen een breed scala aan taken en genereren tekst die wordt voortgezet op basis van of 'voltooit' verstrekte promptgegevens.
function getChatCompletions(deploymentName: string, messages: ChatRequestMessageUnion[], options?: GetChatCompletionsOptions): Promise<ChatCompletions>Parameters
- deploymentName
-
string
- messages
- options
- GetChatCompletionsOptions
Retouren
Promise<ChatCompletions>
getCompletions(string, string[], GetCompletionsOptions)
Hiermee worden de voltooiingen voor de opgegeven invoerprompts opgevraagd. Voltooiingen ondersteunen een breed scala aan taken en genereren tekst die wordt voortgezet op basis van of 'voltooit' verstrekte promptgegevens.
function getCompletions(deploymentName: string, prompt: string[], options?: GetCompletionsOptions): Promise<Completions>Parameters
- deploymentName
-
string
- prompt
-
string[]
- options
- GetCompletionsOptions
Retouren
Promise<Completions>
getEmbeddings(string, string[], GetEmbeddingsOptions)
Retourneer de insluitingen voor een bepaalde prompt.
function getEmbeddings(deploymentName: string, input: string[], options?: GetEmbeddingsOptions): Promise<Embeddings>Parameters
- deploymentName
-
string
- input
-
string[]
- options
- GetEmbeddingsOptions
Retouren
Promise<Embeddings>
getImages(string, string, GetImagesOptions)
Hiermee maakt u een installatiekopieën op basis van een prompt.
function getImages(deploymentName: string, prompt: string, options?: GetImagesOptions): Promise<ImageGenerations>Parameters
- deploymentName
-
string
- prompt
-
string
- options
- GetImagesOptions
Retouren
Promise<ImageGenerations>
streamChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)
Lijsten de tokens voor het voltooien van chats zodra deze beschikbaar komen voor een chatcontext.
function streamChatCompletions(deploymentName: string, messages: ChatRequestMessageUnion[], options?: GetChatCompletionsOptions): Promise<EventStream<ChatCompletions>>Parameters
- deploymentName
-
string
De naam van de modelimplementatie (bij gebruik van Azure OpenAI) of modelnaam (bij gebruik van niet-Azure OpenAI) die voor deze aanvraag moet worden gebruikt.
- messages
De chatcontextberichten die voor deze aanvraag moeten worden gebruikt.
- options
- GetChatCompletionsOptions
De opties voor het voltooien van chats voor deze chat-voltooiingsaanvraag.
Retouren
Promise<EventStream<ChatCompletions>>
Een asynchrone iterable van tokens voor chat-voltooiingen.
streamCompletions(string, string[], GetCompletionsOptions)
Lijsten de voltooiingstokens zodra deze beschikbaar komen voor een bepaalde prompt.
function streamCompletions(deploymentName: string, prompt: string[], options?: GetCompletionsOptions): Promise<EventStream<Omit<Completions, "usage">>>Parameters
- deploymentName
-
string
De naam van de modelimplementatie (bij gebruik van Azure OpenAI) of modelnaam (bij gebruik van niet-Azure OpenAI) die voor deze aanvraag moet worden gebruikt.
- prompt
-
string[]
De prompt die moet worden gebruikt voor deze aanvraag.
- options
- GetCompletionsOptions
De voltooiingsopties voor deze voltooiingsaanvraag.
Retouren
Promise<EventStream<Omit<Completions, "usage">>>
Een asynchrone iterable van voltooiingstokens.
Azure SDK for JavaScript
Feedback
Binnenkort beschikbaar: In de loop van 2024 zullen we GitHub-problemen geleidelijk uitfaseren als het feedbackmechanisme voor inhoud en deze vervangen door een nieuw feedbacksysteem. Zie voor meer informatie: https://aka.ms/ContentUserFeedback.
Feedback verzenden en weergeven voor