OpenAIClient class
Azure OpenAI와 상호 작용하기 위한 클라이언트입니다.
클라이언트에는 OpenAI 리소스의 엔드포인트와 API 키 또는 토큰과 같은 인증 방법이 필요합니다. API 키 및 엔드포인트는 OpenAI 리소스 페이지에서 찾을 수 있습니다. 리소스의 키 및 엔드포인트 페이지에 있습니다.
인증 예제:
API 키
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);
생성자
| Open |
비 Azure OpenAI 엔드포인트에 사용할 OpenAIClient의 instance 초기화합니다. |
| Open |
Azure OpenAI 리소스에 사용할 OpenAIClient instance 초기화합니다. |
| Open |
Azure OpenAI 리소스에 사용할 OpenAIClient instance 초기화합니다. |
메서드
생성자 세부 정보
OpenAIClient(KeyCredential, OpenAIClientOptions)
비 Azure OpenAI 엔드포인트에 사용할 OpenAIClient의 instance 초기화합니다.
new OpenAIClient(openAiApiKey: KeyCredential, options?: OpenAIClientOptions)매개 변수
- openAiApiKey
- KeyCredential
비 Azure OpenAI 엔드포인트에 연결할 때 사용할 API 키입니다.
- options
- OpenAIClientOptions
클라이언트를 구성하는 옵션입니다.
설명
이 생성자로 초기화된 OpenAIClient 개체는 비 Azure OpenAI 유추 엔드포인트에서만 사용할 수 있습니다. Azure OpenAI 리소스와 함께 OpenAIClient를 사용하려면 리소스 URI 및 Azure 인증 자격 증명을 허용하는 생성자를 대신 사용합니다.
OpenAIClient(string, KeyCredential, OpenAIClientOptions)
Azure OpenAI 리소스에 사용할 OpenAIClient instance 초기화합니다.
new OpenAIClient(endpoint: string, credential: KeyCredential, options?: OpenAIClientOptions)매개 변수
- endpoint
-
string
프로토콜 및 호스트 이름을 포함한 Azure OpenAI 리소스에 대한 URI입니다. 예: https://my-resource.openai.azure.com
- credential
- KeyCredential
Azure OpenAI 리소스에 인증하는 데 사용되는 키 자격 증명입니다.
- options
- OpenAIClientOptions
클라이언트를 구성하는 옵션입니다.
설명
이 생성자는 Azure OpenAI 리소스에서만 사용할 수 있는 OpenAIClient 개체를 초기화합니다. 비 Azure OpenAI 유추 엔드포인트와 함께 OpenAIClient를 사용하려면 비 Azure OpenAI API 키를 허용하는 생성자를 대신 사용합니다.
OpenAIClient(string, TokenCredential, OpenAIClientOptions)
Azure OpenAI 리소스에 사용할 OpenAIClient instance 초기화합니다.
new OpenAIClient(endpoint: string, credential: TokenCredential, options?: OpenAIClientOptions)매개 변수
- endpoint
-
string
프로토콜 및 호스트 이름을 포함한 Azure OpenAI 리소스에 대한 URI입니다. 예: https://my-resource.openai.azure.com
- credential
- TokenCredential
Azure OpenAI 리소스로 인증하는 데 사용되는 토큰 자격 증명입니다.
- options
- OpenAIClientOptions
클라이언트를 구성하는 옵션입니다.
메서드 세부 정보
getAudioTranscription(string, Uint8Array, GetAudioTranscriptionOptions)
간단한 JSON 형식으로 오디오 파일의 전사를 반환합니다.
function getAudioTranscription(deploymentName: string, fileContent: Uint8Array, options?: GetAudioTranscriptionOptions): Promise<AudioResultSimpleJson>매개 변수
- deploymentName
-
string
이 요청에 사용할 모델 배포의 이름(Azure OpenAI를 사용하는 경우) 또는 모델 이름(비 Azure OpenAI를 사용하는 경우)입니다.
- fileContent
-
Uint8Array
기록할 오디오 파일의 콘텐츠입니다.
- options
- GetAudioTranscriptionOptions
이 오디오 전사 요청에 대한 옵션입니다.
반환
Promise<AudioResultSimpleJson>
오디오 전사는 간단한 JSON 형식으로 생성됩니다.
getAudioTranscription<Format>(string, Uint8Array, Format, GetAudioTranscriptionOptions)
오디오 파일의 전사를 반환합니다.
function getAudioTranscription<Format>(deploymentName: string, fileContent: Uint8Array, format: Format, options?: GetAudioTranscriptionOptions): Promise<AudioResult<Format>>매개 변수
- deploymentName
-
string
이 요청에 사용할 모델 배포의 이름(Azure OpenAI를 사용하는 경우) 또는 모델 이름(비 Azure OpenAI를 사용하는 경우)입니다.
- fileContent
-
Uint8Array
기록할 오디오 파일의 콘텐츠입니다.
- format
-
Format
결과 개체의 형식입니다. 가능한 값 은 AudioResultFormat 을 참조하세요.
- options
- GetAudioTranscriptionOptions
이 오디오 전사 요청에 대한 옵션입니다.
반환
Promise<AudioResult<Format>>
오디오 전사는 선택한 형식으로 생성됩니다.
getAudioTranslation(string, Uint8Array, GetAudioTranslationOptions)
오디오 파일의 번역을 반환합니다.
function getAudioTranslation(deploymentName: string, fileContent: Uint8Array, options?: GetAudioTranslationOptions): Promise<AudioResultSimpleJson>매개 변수
- deploymentName
-
string
이 요청에 사용할 모델 배포의 이름(Azure OpenAI를 사용하는 경우) 또는 모델 이름(비 Azure OpenAI를 사용하는 경우)입니다.
- fileContent
-
Uint8Array
번역할 오디오 파일의 콘텐츠입니다.
- options
- GetAudioTranslationOptions
이 오디오 번역 요청에 대한 옵션입니다.
반환
Promise<AudioResultSimpleJson>
오디오 번역 결과입니다.
getAudioTranslation<Format>(string, Uint8Array, Format, GetAudioTranslationOptions)
오디오 파일의 번역을 반환합니다.
function getAudioTranslation<Format>(deploymentName: string, fileContent: Uint8Array, format: Format, options?: GetAudioTranslationOptions): Promise<AudioResult<Format>>매개 변수
- deploymentName
-
string
이 요청에 사용할 모델 배포의 이름(Azure OpenAI를 사용하는 경우) 또는 모델 이름(비 Azure OpenAI를 사용하는 경우)입니다.
- fileContent
-
Uint8Array
번역할 오디오 파일의 콘텐츠입니다.
- format
-
Format
결과 개체의 형식입니다. 가능한 값 은 AudioResultFormat 을 참조하세요.
- options
- GetAudioTranslationOptions
이 오디오 번역 요청에 대한 옵션입니다.
반환
Promise<AudioResult<Format>>
오디오 번역 결과입니다.
getChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)
제공된 채팅 메시지에 대한 채팅 완료를 가져옵니다. 완료는 다양한 작업을 지원하고 제공된 프롬프트 데이터에서 계속되거나 "완료"되는 텍스트를 생성합니다.
function getChatCompletions(deploymentName: string, messages: ChatRequestMessageUnion[], options?: GetChatCompletionsOptions): Promise<ChatCompletions>매개 변수
- deploymentName
-
string
- messages
- options
- GetChatCompletionsOptions
반환
Promise<ChatCompletions>
getCompletions(string, string[], GetCompletionsOptions)
제공된 입력 프롬프트에 대한 완료를 가져옵니다. 완료는 다양한 작업을 지원하고 제공된 프롬프트 데이터에서 계속되거나 "완료"되는 텍스트를 생성합니다.
function getCompletions(deploymentName: string, prompt: string[], options?: GetCompletionsOptions): Promise<Completions>매개 변수
- deploymentName
-
string
- prompt
-
string[]
- options
- GetCompletionsOptions
반환
Promise<Completions>
getEmbeddings(string, string[], GetEmbeddingsOptions)
지정된 프롬프트에 대한 포함을 반환합니다.
function getEmbeddings(deploymentName: string, input: string[], options?: GetEmbeddingsOptions): Promise<Embeddings>매개 변수
- deploymentName
-
string
- input
-
string[]
- options
- GetEmbeddingsOptions
반환
Promise<Embeddings>
getImages(string, string, GetImagesOptions)
프롬프트가 지정된 이미지를 만듭니다.
function getImages(deploymentName: string, prompt: string, options?: GetImagesOptions): Promise<ImageGenerations>매개 변수
- deploymentName
-
string
- prompt
-
string
- options
- GetImagesOptions
반환
Promise<ImageGenerations>
streamChatCompletions(string, ChatRequestMessageUnion[], GetChatCompletionsOptions)
채팅 완료 토큰을 채팅 컨텍스트에 사용할 수 있게 되면 Lists.
function streamChatCompletions(deploymentName: string, messages: ChatRequestMessageUnion[], options?: GetChatCompletionsOptions): Promise<EventStream<ChatCompletions>>매개 변수
- deploymentName
-
string
이 요청에 사용할 모델 배포의 이름(Azure OpenAI를 사용하는 경우) 또는 모델 이름(비 Azure OpenAI를 사용하는 경우)입니다.
- messages
이 요청에 사용할 채팅 컨텍스트 메시지입니다.
- options
- GetChatCompletionsOptions
이 채팅 완료 요청에 대한 채팅 완료 옵션입니다.
반환
Promise<EventStream<ChatCompletions>>
채팅 완료 토큰의 비동기 반복 가능
streamCompletions(string, string[], GetCompletionsOptions)
지정된 프롬프트에 사용할 수 있게 되면 완료 토큰을 Lists.
function streamCompletions(deploymentName: string, prompt: string[], options?: GetCompletionsOptions): Promise<EventStream<Omit<Completions, "usage">>>매개 변수
- deploymentName
-
string
이 요청에 사용할 모델 배포의 이름(Azure OpenAI를 사용하는 경우) 또는 모델 이름(비 Azure OpenAI를 사용하는 경우)입니다.
- prompt
-
string[]
이 요청에 사용할 프롬프트입니다.
- options
- GetCompletionsOptions
이 완료 요청에 대한 완료 옵션입니다.
반환
Promise<EventStream<Omit<Completions, "usage">>>
완료 토큰의 비동기 반복 가능
Azure SDK for JavaScript