@azure/openai package

Referentie

Klassen

Een referentie op basis van statische sleutels die ondersteuning biedt voor het bijwerken van de onderliggende sleutelwaarde.

OpenAIClient

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);

OpenAIKeyCredential

De klasse OpenAIKeyCredential vertegenwoordigt een OpenAI API-sleutel en wordt gebruikt voor verificatie bij een OpenAI-client voor een OpenAI-eindpunt.

Interfaces

AudioResultSimpleJson	Eenvoudig transcriptieantwoord
AudioResultVerboseJson	Transcriptieantwoord.
AudioSegment	Transcriptiesegment.
AzureChatEnhancementConfiguration	Een weergave van de beschikbare Azure OpenAI-uitbreidingsconfiguraties.
AzureChatEnhancements	Vertegenwoordigt de uitvoerresultaten van Azure-verbeteringen voor het voltooien van chats, zoals geconfigureerd via de overeenkomende invoer die in de aanvraag is opgegeven.
AzureChatExtensionConfiguration	Een weergave van configuratiegegevens voor één Azure OpenAI-chatextensie. Dit wordt gebruikt door een aanvraag voor het voltooien van chats die Azure OpenAI-chatextensies moeten gebruiken om het reactiegedrag te verbeteren. Het gebruik van deze configuratie is alleen compatibel met Azure OpenAI.
AzureChatExtensionDataSourceResponseCitation	Eén exemplaar van aanvullende contextinformatie die beschikbaar is wanneer Azure OpenAI-chatextensies betrokken zijn bij het genereren van een corresponderend chat-voltooiingsantwoord. Deze contextinformatie wordt alleen ingevuld wanneer u een Azure OpenAI-aanvraag gebruikt die is geconfigureerd voor het gebruik van een overeenkomende extensie.
AzureChatExtensionsMessageContext	Een weergave van de aanvullende contextinformatie die beschikbaar is wanneer Azure OpenAI-chatextensies betrokken zijn bij het genereren van een corresponderend chat-voltooiingsantwoord. Deze contextinformatie wordt alleen ingevuld wanneer u een Azure OpenAI-aanvraag gebruikt die is geconfigureerd voor het gebruik van een overeenkomende extensie.
AzureChatGroundingEnhancementConfiguration	Een weergave van de beschikbare opties voor de azure OpenAI-basisverbetering.
AzureChatOCREnhancementConfiguration	Een weergave van de beschikbare opties voor de uitbreiding optische tekenherkenning (OCR) van Azure OpenAI.
AzureCosmosDBChatExtensionConfiguration	Een specifieke weergave van configureerbare opties voor Azure Cosmos DB wanneer u deze gebruikt als een Azure OpenAI-chatextensie.
AzureCosmosDBFieldMappingOptions	Optionele instellingen om te bepalen hoe velden worden verwerkt wanneer u een geconfigureerde Azure Cosmos DB-resource gebruikt.
AzureExtensionsOptions	Opties voor Azure OpenAI-chatextensies.
AzureGroundingEnhancement	De aardingsverbetering die het begrenzingsvak retourneert van de objecten die in de afbeelding zijn gedetecteerd.
AzureGroundingEnhancementCoordinatePoint	Een weergave van één veelhoekpunt zoals gebruikt door de Azure-aardingsverbetering.
AzureGroundingEnhancementLine	Een inhoudslijnobject dat bestaat uit een aangrenzende reeks inhoudselementen, zoals woorden en selectiemarkeringen.
AzureGroundingEnhancementLineSpan	Een span-object dat een gedetecteerd object en de informatie van het begrenzingsvak vertegenwoordigt.
AzureMachineLearningIndexChatExtensionConfiguration	Een specifieke weergave van configureerbare opties voor de Azure Machine Learning-vectorindex wanneer deze wordt gebruikt als een Azure OpenAI-chatextensie.
AzureSearchChatExtensionConfiguration	Een specifieke weergave van configureerbare opties voor Azure Search wanneer u deze gebruikt als een Azure OpenAI-chatextensie.
AzureSearchIndexFieldMappingOptions	Optionele instellingen om te bepalen hoe velden worden verwerkt wanneer u een geconfigureerde Azure Search-resource gebruikt.
ChatChoice	De weergave van één promptvoltooiing als onderdeel van een aanvraag voor het voltooien van een chat. Over het algemeen `n` worden keuzes gegenereerd per opgegeven prompt met een standaardwaarde van 1. Tokenlimieten en andere instellingen kunnen het aantal gegenereerde keuzes beperken.
ChatChoiceLogProbabilityInfo	Registreer waarschijnlijkheidsinformatie voor een keuze, zoals aangevraagd via 'logprobs' en 'top_logprobs'.
ChatCompletions	Weergave van de antwoordgegevens van een chat-voltooiingsaanvraag. Voltooiingen ondersteunen een breed scala aan taken en genereren tekst die wordt voortgezet op basis van of 'voltooit' verstrekte promptgegevens.
ChatCompletionsFunctionToolCall	Een hulpprogramma-aanroep naar een functiehulpprogramma, uitgegeven door het model ter evaluatie van een geconfigureerd functiehulpprogramma, dat een functie-aanroep vertegenwoordigt die nodig is om een volgende aanvraag voor chatvoltooiing op te lossen.
ChatCompletionsFunctionToolDefinition	De definitie-informatie voor een functietool voor chat voltooid, waarmee een functie kan worden aangeroepen als reactie op een tool-aanroep.
ChatCompletionsFunctionToolSelection	Een hulpprogrammaselectie van een specifiek functiehulpprogramma met de naam waarmee chat-voltooiingen worden beperkt tot het gebruik van de benoemde functie.
ChatCompletionsJsonResponseFormat	Een antwoordindeling voor chatvoltooiingen die reacties beperkt tot het verzenden van geldige JSON-objecten.
ChatCompletionsNamedFunctionToolSelection	Een hulpprogrammaselectie van een specifiek functiehulpprogramma met de naam waarmee chat-voltooiingen worden beperkt tot het gebruik van de benoemde functie.
ChatCompletionsNamedToolSelection	Een abstracte weergave van een expliciete, benoemde toolselectie die moet worden gebruikt voor een aanvraag voor voltooiing van een chat.
ChatCompletionsResponseFormat	Een abstracte weergave van de configuratie van een antwoordindeling die kan worden gebruikt door Chat-voltooiingen. Kan worden gebruikt om de JSON-modus in te schakelen.
ChatCompletionsTextResponseFormat	De standaardindeling voor chatvoltooiingen die vrijelijk tekst kan genereren en die niet gegarandeerd antwoordinhoud produceert die voldoet aan een specifiek schema.
ChatCompletionsToolCall	Een abstracte weergave van een hulpprogrammaaanroep die in een volgende aanvraag moet worden opgelost om de aangevraagde chat te voltooien.
ChatCompletionsToolDefinition	Een abstracte weergave van een hulpprogramma dat door het model kan worden gebruikt om een antwoord op voltooiing van een chat te verbeteren.
ChatFinishDetails	Een abstracte weergave van gestructureerde informatie over waarom een chat-voltooiingsreactie is beëindigd.
ChatMessageContentItem	Een abstracte weergave van een gestructureerd inhoudsitem in een chatbericht.
ChatMessageImageContentItem	Een inhoudsitem voor gestructureerde chat met een afbeeldingsreferentie.
ChatMessageImageUrl	Een internetlocatie van waaruit het model een afbeelding kan ophalen.
ChatMessageTextContentItem	Een inhoudsitem voor gestructureerde chat met tekst zonder opmaak.
ChatRequestAssistantMessage	Een chatbericht voor aanvragen dat het antwoord of de actie van de assistent vertegenwoordigt.
ChatRequestFunctionMessage	Een chatbericht voor aanvragen dat de aangevraagde uitvoer van een geconfigureerde functie vertegenwoordigt.
ChatRequestMessage	Een abstracte weergave van een chatbericht zoals opgegeven in een aanvraag.
ChatRequestSystemMessage	Een chatbericht voor aanvragen met systeeminstructies die van invloed zijn op de wijze waarop het model een antwoord op voltooiing van de chat genereert.
ChatRequestToolMessage	Een chatbericht voor aanvragen dat de aangevraagde uitvoer van een geconfigureerd hulpprogramma vertegenwoordigt.
ChatRequestUserMessage	Een chatbericht voor aanvragen dat gebruikersinvoer vertegenwoordigt voor de assistent.
ChatResponseMessage	Een weergave van een chatbericht zoals ontvangen in een antwoord.
ChatTokenLogProbabilityInfo	Een weergave van de informatie over de logboekkans voor één berichtinhoudstoken.
ChatTokenLogProbabilityResult	Een weergave van de waarschijnlijkheidsinformatie in het logboek voor één inhoudstoken, inclusief een lijst met meest waarschijnlijke tokens als 'top_logprobs' zijn aangevraagd.
Choice	De weergave van één promptvoltooiing als onderdeel van een algemene voltooiingsaanvraag. Over het algemeen `n` worden keuzes gegenereerd per opgegeven prompt met een standaardwaarde van 1. Tokenlimieten en andere instellingen kunnen het aantal gegenereerde keuzes beperken.
Completions	Weergave van de antwoordgegevens van een voltooiingsaanvraag. Voltooiingen ondersteunen een breed scala aan taken en genereren tekst die wordt voortgezet op basis van of 'voltooit' verstrekte promptgegevens.
CompletionsLogProbabilityModel	Weergave van een logboekkansmodel voor het genereren van voltooiingen.
CompletionsUsage	Weergave van het aantal tokens dat is verwerkt voor een voltooiingsaanvraag. Bij tellingen wordt rekening gehouden met alle tokens voor prompts, keuzes, alternatieve opties, best_of generaties en andere consumenten.
ContentFilterBlocklistIdResult	Vertegenwoordigt het resultaat van een evaluatie op basis van een aangepaste blokkeringslijst die wordt uitgevoerd door inhoudsfilters.
ContentFilterCitedDetectionResult	Vertegenwoordigt het resultaat van een detectiebewerking voor beveiligde resources zoals uitgevoerd door inhoudsfiltering.
ContentFilterDetectionResult	Vertegenwoordigt het resultaat van een detectiebewerking die wordt uitgevoerd door inhoudsfiltering.
ContentFilterErrorResults	Informatie over het foutresultaat bij het filteren van inhoud.
ContentFilterResult	Informatie over het ernstniveau van gefilterde inhoud en of deze is gefilterd of niet.
ContentFilterResultsForPrompt	Resultaten van het filteren van inhoud voor één prompt in de aanvraag.
ContentFilterSuccessResultDetailsForPrompt	Informatie over het succesresultaat van het filteren van inhoud.
ContentFilterSuccessResultsForChoice	Informatie over inhoudsfilters geëvalueerd op basis van gegenereerde modeluitvoer.
ElasticsearchChatExtensionConfiguration	Een specifieke weergave van configureerbare opties voor Elasticsearch wanneer u deze gebruikt als een Azure OpenAI-chatextensie.
ElasticsearchIndexFieldMappingOptions	Optionele instellingen om te bepalen hoe velden worden verwerkt wanneer u een geconfigureerde Elasticsearch-resource® gebruikt.
EmbeddingItem	Weergave van een vergelijking van één insluitingsvergelijkingsvergelijking.
Embeddings	Weergave van de antwoordgegevens van een insluitingsaanvraag. Embeddings meten de verwantschap van teksttekenreeksen en worden vaak gebruikt voor zoeken, clustering, aanbevelingen en andere vergelijkbare scenario's.
EmbeddingsUsage	Meting van het aantal tokens dat in deze aanvraag en reactie wordt gebruikt.
EventStream	Een leesbare stroom die kan worden itereerbaar en wegwerpbaar is.
FunctionCall	De naam en argumenten van een functie die moet worden aangeroepen, zoals gegenereerd door het model.
FunctionDefinition	De definitie van een door de beller opgegeven functie die chats kunnen aanroepen als reactie op overeenkomende gebruikersinvoer.
FunctionName	Een structuur die de exacte naam specificeert van een specifieke, op aanvraag verstrekte functie die moet worden gebruikt bij het verwerken van een bewerking voor het voltooien van een chat.
GetAudioTranscriptionOptions	De opties voor een aanvraag voor audiotranscriptie
GetAudioTranslationOptions	De opties voor een audioomzettingsaanvraag
GetChatCompletionsOptions	Deze module bevat modellen die we naast de bijbehorende gegenereerde modellen willen gebruiken. Dit is handig voor het leveren van klantgerichte modellen met andere namen/typen dan de gegenereerde modellen.
GetCompletionsOptions	De configuratiegegevens voor een voltooiingsaanvraag. Voltooiingen ondersteunen een breed scala aan taken en genereren tekst die voortduurt op basis van of 'voltooit' opgegeven promptgegevens.
GetEmbeddingsOptions	Opties voor aanvraag voor aangepaste insluitingen
GetImagesOptions	Vertegenwoordigt de aanvraaggegevens die worden gebruikt voor het genereren van afbeeldingen.
ImageGenerationContentFilterResults	Beschrijft het inhoudsfilterresultaat voor de aanvraag voor het genereren van afbeeldingen.
ImageGenerationData	Een weergave van één gegenereerde afbeelding, opgegeven als base64-gecodeerde gegevens of als een URL waaruit de afbeelding kan worden opgehaald.
ImageGenerationPromptFilterResults	Beschrijft de resultaten van het filteren van inhoud voor de prompt van een aanvraag voor het genereren van een installatiekopieën.
ImageGenerations	Het resultaat van een geslaagde bewerking voor het genereren van installatiekopieën.
MaxTokensFinishDetails	Een gestructureerde weergave van een stopreden die een tokenlimiet aangeeft, is bereikt voordat het model op natuurlijke wijze kon worden voltooid.
OnYourDataAccessTokenAuthenticationOptions	De verificatieopties voor Azure OpenAI op uw gegevens bij het gebruik van een toegangstoken.
OnYourDataApiKeyAuthenticationOptions	De verificatieopties voor Azure OpenAI op uw gegevens bij gebruik van een API-sleutel.
OnYourDataAuthenticationOptions	De verificatieopties voor Azure OpenAI op uw gegevens.
OnYourDataConnectionStringAuthenticationOptions	De verificatieopties voor Azure OpenAI op uw gegevens bij het gebruik van een verbindingsreeks.
OnYourDataDeploymentNameVectorizationSource	De details van een vectorisatiebron, die door Azure OpenAI op uw gegevens wordt gebruikt bij het toepassen van vectorzoekopdrachten, die is gebaseerd op de implementatienaam van een intern insluitingsmodel in dezelfde Azure OpenAI-resource.
OnYourDataEncodedApiKeyAuthenticationOptions	De verificatieopties voor Azure OpenAI On Your Data bij gebruik van een met Elasticsearch gecodeerde API-sleutel.
OnYourDataEndpointVectorizationSource	De details van een vectorisatiebron, die door Azure OpenAI op uw gegevens wordt gebruikt bij het toepassen van vectorzoekopdrachten, die is gebaseerd op een openbaar Azure OpenAI-eindpunt roept insluitingen aan.
OnYourDataKeyAndKeyIdAuthenticationOptions	De verificatieopties voor Azure OpenAI op uw gegevens bij het gebruik van een Elasticsearch-sleutel en sleutel-id-paar.
OnYourDataModelIdVectorizationSource	De details van een vectorisatiebron, die door Azure OpenAI op uw gegevens wordt gebruikt bij het toepassen van vectorzoekopdrachten, die is gebaseerd op een model-id van een zoekservice. Momenteel alleen ondersteund door Elasticsearch®.
OnYourDataSystemAssignedManagedIdentityAuthenticationOptions	De verificatieopties voor Azure OpenAI op uw gegevens bij gebruik van een door het systeem toegewezen beheerde identiteit.
OnYourDataUserAssignedManagedIdentityAuthenticationOptions	De verificatieopties voor Azure OpenAI op uw gegevens bij gebruik van een door de gebruiker toegewezen beheerde identiteit.
OnYourDataVectorizationSource	Een abstracte weergave van een vectorisatiebron voor Azure OpenAI op uw gegevens met vectorzoekopdrachten.
OpenAIClientOptions
PineconeChatExtensionConfiguration	Een specifieke weergave van configureerbare opties voor Pinecone wanneer u deze gebruikt als een Azure OpenAI-chatextensie.
PineconeFieldMappingOptions	Optionele instellingen om te bepalen hoe velden worden verwerkt wanneer u een geconfigureerde Pinecone-resource gebruikt.
StopFinishDetails	Een gestructureerde weergave van een stopreden die natuurlijke beëindiging door het model aangeeft.

Type-aliassen

AudioResult	Het type resultaat van de transcriptie op basis van de aangevraagde antwoordindeling
AudioResultFormat	De resultaatindeling van een audiotaak
AudioTranscriptionTask	"transcriberen", "vertalen"
AzureChatExtensionConfigurationUnion	Alias voor AzureChatExtensionConfigurationUnion
AzureChatExtensionType	"azure_search", "azure_ml_index", "azure_cosmos_db", "elasticsearch", "pinecone"
AzureSearchQueryType	"simple", "semantic", "vector", "vector_simple_hybrid", "vector_semantic_hybrid"
ChatCompletionsNamedToolSelectionUnion	Alias voor ChatCompletionsNamedToolSelectionUnion
ChatCompletionsResponseFormatUnion	Alias voor ChatCompletionsResponseFormatUnion
ChatCompletionsToolCallUnion	Alias voor ChatCompletionsToolCallUnion
ChatCompletionsToolDefinitionUnion	Alias voor ChatCompletionsToolDefinitionUnion
ChatCompletionsToolSelectionPreset	"auto", "none"
ChatFinishDetailsUnion	Alias voor ChatFinishDetailsUnion
ChatMessageContentItemUnion	Alias voor ChatMessageContentItemUnion
ChatMessageImageDetailLevel	"auto", "low", "high"
ChatRequestMessageUnion	Alias voor ChatRequestMessageUnion
ChatRole	"system", "assistent", "user", "function", "tool"
CompletionsFinishReason	"stop", "length", "content_filter", "function_call", "tool_calls"
ContentFilterResultDetailsForPrompt	Informatie over de inhoudsfiltercategorie, als deze is gedetecteerd.
ContentFilterResultsForChoice	Informatie over de resultaten van het filteren van inhoud, als deze is gedetecteerd.
ContentFilterSeverity	"safe", "low", "medium", "high"
ElasticsearchQueryType	"simple", "vector"
FunctionCallPreset	"auto", "none"
ImageGenerationQuality	"standard", "hd"
ImageGenerationResponseFormat	"url", "b64_json"
ImageGenerationStyle	"natuurlijk", "levendig"
ImageSize	"256x256", "512x512", "1024x1024", "1792x1024", "1024x1792"
OnYourDataAuthenticationOptionsUnion	Alias voor OnYourDataAuthenticationOptionsUnion
OnYourDataAuthenticationType	"api_key", "connection_string", "key_and_key_id", "encoded_api_key", "access_token", "system_assigned_managed_identity", "user_assigned_managed_identity"
OnYourDataVectorizationSourceType	"eindpunt", "deployment_name", "model_id"
OnYourDataVectorizationSourceUnion	Alias voor OnYourDataVectorizationSourceUnion

Delen via