@azure/openai package
클래스
AzureKeyCredential |
기본 키 값 업데이트를 지원하는 정적 키 기반 자격 증명입니다. |
OpenAIClient |
Azure OpenAI와 상호 작용하기 위한 클라이언트입니다. 클라이언트에는 OpenAI 리소스의 엔드포인트와 API 키 또는 토큰과 같은 인증 방법이 필요합니다. API 키 및 엔드포인트는 OpenAI 리소스 페이지에서 찾을 수 있습니다. 리소스의 키 및 엔드포인트 페이지에 있습니다. 인증 예제:API 키
Azure Active Directory
|
OpenAIKeyCredential |
OpenAIKeyCredential 클래스는 OpenAI API 키를 나타내며 OpenAI 엔드포인트에 대한 OpenAI 클라이언트에 인증하는 데 사용됩니다. |
인터페이스
AudioResultSimpleJson |
간단한 전사 응답 |
AudioResultVerboseJson |
전사 응답. |
AudioSegment |
전사 세그먼트. |
AzureChatEnhancementConfiguration |
사용 가능한 Azure OpenAI 향상된 구성의 표현입니다. |
AzureChatEnhancements |
요청에 제공된 일치 입력을 통해 구성된 대로 채팅 완료에 대한 Azure 개선 사항의 출력 결과를 나타냅니다. |
AzureChatExtensionConfiguration |
단일 Azure OpenAI 채팅 확장에 대한 구성 데이터의 표현입니다. 이는 Azure OpenAI 채팅 확장을 사용하여 응답 동작을 보강해야 하는 채팅 완료 요청에 사용됩니다. 이 구성의 사용은 Azure OpenAI와만 호환됩니다. |
AzureChatExtensionDataSourceResponseCitation |
Azure OpenAI 채팅 확장 프로그램이 해당 채팅 완료 응답 생성에 관련된 경우 사용할 수 있는 추가 컨텍스트 정보의 단일 instance. 이 컨텍스트 정보는 일치하는 확장을 사용하도록 구성된 Azure OpenAI 요청을 사용하는 경우에만 채워집니다. |
AzureChatExtensionsMessageContext |
Azure OpenAI 채팅 확장이 해당 채팅 완료 응답 생성에 관련될 때 사용할 수 있는 추가 컨텍스트 정보의 표현입니다. 이 컨텍스트 정보는 일치하는 확장을 사용하도록 구성된 Azure OpenAI 요청을 사용하는 경우에만 채워집니다. |
AzureChatGroundingEnhancementConfiguration |
Azure OpenAI 접지 향상에 사용할 수 있는 옵션의 표현입니다. |
AzureChatOCREnhancementConfiguration |
Azure OpenAI OCR(광학 문자 인식) 향상에 사용할 수 있는 옵션의 표현입니다. |
AzureCosmosDBChatExtensionConfiguration |
Azure OpenAI 채팅 확장으로 사용할 때 Azure Cosmos DB에 대한 구성 가능한 옵션의 특정 표현입니다. |
AzureCosmosDBFieldMappingOptions |
구성된 Azure Cosmos DB 리소스를 사용할 때 필드가 처리되는 방식을 제어하는 선택적 설정입니다. |
AzureExtensionsOptions |
Azure OpenAI 채팅 확장에 대한 옵션입니다. |
AzureGroundingEnhancement |
이미지에서 검색된 개체의 경계 상자를 반환하는 접지 향상 기능입니다. |
AzureGroundingEnhancementCoordinatePoint |
Azure 접지 향상에서 사용하는 단일 다각형 지점의 표현입니다. |
AzureGroundingEnhancementLine |
단어 및 선택 표시와 같은 인접한 콘텐츠 요소 시퀀스로 구성된 콘텐츠 줄 개체입니다. |
AzureGroundingEnhancementLineSpan |
검색된 개체 및 경계 상자 정보를 나타내는 span 개체입니다. |
AzureMachineLearningIndexChatExtensionConfiguration |
Azure OpenAI 채팅 확장으로 사용할 때 Azure Machine Learning 벡터 인덱스의 구성 가능한 옵션에 대한 특정 표현입니다. |
AzureSearchChatExtensionConfiguration |
Azure OpenAI 채팅 확장으로 사용할 때 Azure Search 구성 가능한 옵션의 특정 표현입니다. |
AzureSearchIndexFieldMappingOptions |
구성된 Azure Search 리소스를 사용할 때 필드가 처리되는 방식을 제어하는 선택적 설정입니다. |
ChatChoice |
전체 채팅 완료 요청의 일부로 단일 프롬프트 완료의 표현입니다.
일반적으로 |
ChatChoiceLogProbabilityInfo |
'logprobs' 및 'top_logprobs'을 통해 요청된 선택 항목에 대한 확률 정보를 기록합니다. |
ChatCompletions |
채팅 완료 요청의 응답 데이터 표현입니다. 완료는 다양한 작업을 지원하고 제공된 프롬프트 데이터에서 계속되거나 "완료"되는 텍스트를 생성합니다. |
ChatCompletionsFunctionToolCall |
구성된 함수 도구를 평가하여 모델에서 실행한 함수 도구에 대한 도구 호출로, 후속 채팅 완료 요청이 resolve 데 필요한 함수 호출을 나타냅니다. |
ChatCompletionsFunctionToolDefinition |
도구 호출에 대한 응답으로 함수를 호출할 수 있는 채팅 완료 함수 도구에 대한 정의 정보입니다. |
ChatCompletionsFunctionToolSelection |
채팅 완료를 명명된 함수 사용으로 제한하는 명명된 특정 함수 도구의 도구 선택입니다. |
ChatCompletionsJsonResponseFormat |
응답을 유효한 JSON 개체 내보내기로 제한하는 채팅 완료에 대한 응답 형식입니다. |
ChatCompletionsNamedFunctionToolSelection |
채팅 완료를 명명된 함수 사용으로 제한하는 명명된 특정 함수 도구의 도구 선택입니다. |
ChatCompletionsNamedToolSelection |
채팅 완료 요청에 사용할 명시적 명명된 도구 선택의 추상 표현입니다. |
ChatCompletionsResponseFormat |
채팅 완료에서 사용할 수 있는 응답 형식 구성의 추상 표현입니다. JSON 모드를 사용하도록 설정하는 데 사용할 수 있습니다. |
ChatCompletionsTextResponseFormat |
텍스트를 자유롭게 생성할 수 있고 특정 스키마를 준수하는 응답 콘텐츠를 생성하도록 보장되지 않는 표준 채팅 완료 응답 형식입니다. |
ChatCompletionsToolCall |
요청된 채팅 완료를 수행하기 위해 후속 요청에서 해결해야 하는 도구 호출의 추상 표현입니다. |
ChatCompletionsToolDefinition |
모델에서 채팅 완료 응답을 개선하는 데 사용할 수 있는 도구의 추상 표현입니다. |
ChatFinishDetails |
채팅 완료 응답이 종료된 이유에 대한 구조화된 정보의 추상 표현입니다. |
ChatMessageContentItem |
채팅 메시지 내에서 구조화된 콘텐츠 항목의 추상 표현입니다. |
ChatMessageImageContentItem |
이미지 참조를 포함하는 구조적 채팅 콘텐츠 항목입니다. |
ChatMessageImageUrl |
모델이 이미지를 검색할 수 있는 인터넷 위치입니다. |
ChatMessageTextContentItem |
일반 텍스트를 포함하는 구조화된 채팅 콘텐츠 항목입니다. |
ChatRequestAssistantMessage |
도우미 응답 또는 작업을 나타내는 요청 채팅 메시지입니다. |
ChatRequestFunctionMessage |
구성된 함수에서 요청된 출력을 나타내는 요청 채팅 메시지입니다. |
ChatRequestMessage |
요청에 제공된 채팅 메시지의 추상 표현입니다. |
ChatRequestSystemMessage |
모델이 채팅 완료 응답을 생성하는 방법에 영향을 주는 시스템 지침이 포함된 요청 채팅 메시지입니다. |
ChatRequestToolMessage |
구성된 도구에서 요청된 출력을 나타내는 요청 채팅 메시지입니다. |
ChatRequestUserMessage |
도우미 대한 사용자 입력을 나타내는 요청 채팅 메시지입니다. |
ChatResponseMessage |
응답에서 받은 채팅 메시지의 표현입니다. |
ChatTokenLogProbabilityInfo |
단일 메시지 콘텐츠 토큰에 대한 로그 확률 정보의 표현입니다. |
ChatTokenLogProbabilityResult |
'top_logprobs'이 요청된 경우 가장 가능성이 높은 토큰 목록을 포함하여 단일 콘텐츠 토큰에 대한 로그 확률 정보의 표현입니다. |
Choice |
전체 완료 요청의 일부로 단일 프롬프트 완료의 표현입니다.
일반적으로 |
Completions |
완료 요청에서 응답 데이터의 표현입니다. 완료는 다양한 작업을 지원하고 제공된 프롬프트 데이터에서 계속되거나 "완료"되는 텍스트를 생성합니다. |
CompletionsLogProbabilityModel |
완료 생성에 대한 로그 확률 모델의 표현입니다. |
CompletionsUsage |
완료 요청에 대해 처리된 토큰 수의 표현입니다. 개수는 프롬프트, 선택 항목, 선택 대체 항목, best_of 세대 및 기타 소비자의 모든 토큰을 고려합니다. |
ContentFilterBlocklistIdResult |
콘텐츠 필터링에서 수행하는 사용자 지정 차단 목록에 대한 평가 결과를 나타냅니다. |
ContentFilterCitedDetectionResult |
콘텐츠 필터링에 의해 수행되는 보호된 리소스에 대한 검색 작업의 결과를 나타냅니다. |
ContentFilterDetectionResult |
콘텐츠 필터링에 의해 수행된 검색 작업의 결과를 나타냅니다. |
ContentFilterErrorResults |
콘텐츠 필터링 오류 결과에 대한 정보입니다. |
ContentFilterResult |
필터링된 콘텐츠 심각도 수준 및 필터링되었는지 여부에 대한 정보입니다. |
ContentFilterResultsForPrompt |
요청의 단일 프롬프트에 대한 콘텐츠 필터링 결과입니다. |
ContentFilterSuccessResultDetailsForPrompt |
콘텐츠 필터링 성공 결과에 대한 정보입니다. |
ContentFilterSuccessResultsForChoice |
생성된 모델 출력에 대해 평가된 콘텐츠 필터링에 대한 정보입니다. |
ElasticsearchChatExtensionConfiguration |
Azure OpenAI 채팅 확장으로 사용할 때 Elasticsearch에 대한 구성 가능한 옵션의 특정 표현입니다. |
ElasticsearchIndexFieldMappingOptions |
구성된 Elasticsearch® 리소스를 사용할 때 필드가 처리되는 방식을 제어하는 선택적 설정입니다. |
EmbeddingItem |
단일 포함 관련 비교의 표현입니다. |
Embeddings |
포함 요청의 응답 데이터 표현입니다. 포함은 텍스트 문자열의 관련성을 측정하며 검색, 클러스터링, 권장 사항 및 기타 유사한 시나리오에 일반적으로 사용됩니다. |
EmbeddingsUsage |
이 요청 및 응답에 사용되는 토큰의 양을 측정합니다. |
EventStream |
반복 가능하고 삭제 가능한 읽기 가능한 스트림입니다. |
FunctionCall |
모델에 의해 생성된 대로 호출되어야 하는 함수의 이름과 인수입니다. |
FunctionDefinition |
일치하는 사용자 입력에 대한 응답으로 채팅 완료가 호출될 수 있는 호출자 지정 함수의 정의입니다. |
FunctionName |
채팅 완료 작업을 처리할 때 사용할 특정 요청 제공 함수의 정확한 이름을 지정하는 구조체입니다. |
GetAudioTranscriptionOptions |
오디오 전사 요청에 대한 옵션 |
GetAudioTranslationOptions |
오디오 번역 요청에 대한 옵션 |
GetChatCompletionsOptions |
이 모듈에는 생성된 해당 모델과 나란히 살려는 모델이 포함되어 있습니다. 이는 생성된 모델과 이름/유형이 다른 고객 지향 모델을 제공하는 데 유용합니다. |
GetCompletionsOptions |
완료 요청에 대한 구성 정보입니다. 완료는 다양한 작업을 지원하고 제공된 프롬프트 데이터에서 계속되거나 "완료"되는 텍스트를 생성합니다. |
GetEmbeddingsOptions |
사용자 지정 포함 요청에 대한 옵션 |
GetImagesOptions |
이미지를 생성하는 데 사용되는 요청 데이터를 나타냅니다. |
ImageGenerationContentFilterResults |
이미지 생성 요청에 대한 콘텐츠 필터링 결과를 설명합니다. |
ImageGenerationData |
base64로 인코딩된 데이터 또는 이미지를 검색할 수 있는 URL로 제공되는 생성된 단일 이미지의 표현입니다. |
ImageGenerationPromptFilterResults |
이미지 생성 요청의 프롬프트에 대한 콘텐츠 필터링 결과를 설명합니다. |
ImageGenerations |
성공적인 이미지 생성 작업의 결과입니다. |
MaxTokensFinishDetails |
모델이 자연스럽게 완료되기 전에 토큰 제한에 도달했음을 나타내는 중지 이유의 구조화된 표현입니다. |
OnYourDataAccessTokenAuthenticationOptions |
액세스 토큰을 사용할 때 Azure OpenAI On Your Data에 대한 인증 옵션입니다. |
OnYourDataApiKeyAuthenticationOptions |
API 키를 사용할 때 Azure OpenAI On Your Data에 대한 인증 옵션입니다. |
OnYourDataAuthenticationOptions |
Azure OpenAI On Your Data에 대한 인증 옵션입니다. |
OnYourDataConnectionStringAuthenticationOptions |
연결 문자열 사용할 때 Azure OpenAI On Your Data에 대한 인증 옵션입니다. |
OnYourDataDeploymentNameVectorizationSource |
벡터 검색을 적용할 때 Azure OpenAI On Your Data에서 사용하는 벡터화 원본의 세부 정보는 동일한 Azure OpenAI 리소스의 내부 포함 모델 배포 이름을 기반으로 합니다. |
OnYourDataEncodedApiKeyAuthenticationOptions |
Elasticsearch로 인코딩된 API 키를 사용하는 경우 Azure OpenAI On Your Data에 대한 인증 옵션입니다. |
OnYourDataEndpointVectorizationSource |
벡터 검색을 적용할 때 Azure OpenAI On Your Data에서 사용하는 벡터화 원본의 세부 정보는 포함에 대한 공용 Azure OpenAI 엔드포인트 호출을 기반으로 합니다. |
OnYourDataKeyAndKeyIdAuthenticationOptions |
Elasticsearch 키 및 키 ID 쌍을 사용하는 경우 Azure OpenAI On Your Data에 대한 인증 옵션입니다. |
OnYourDataModelIdVectorizationSource |
검색 서비스 모델 ID를 기반으로 하는 벡터 검색을 적용할 때 Azure OpenAI On Your Data에서 사용하는 벡터화 원본의 세부 정보입니다. 현재 Elasticsearch®에서만 지원됩니다. |
OnYourDataSystemAssignedManagedIdentityAuthenticationOptions |
시스템 할당 관리 ID를 사용하는 경우 Azure OpenAI On Your Data에 대한 인증 옵션입니다. |
OnYourDataUserAssignedManagedIdentityAuthenticationOptions |
사용자가 할당한 관리 ID를 사용할 때 Azure OpenAI On Your Data에 대한 인증 옵션입니다. |
OnYourDataVectorizationSource |
벡터 검색을 사용하여 Azure OpenAI On Your Data에 대한 벡터화 원본의 추상 표현입니다. |
OpenAIClientOptions | |
PineconeChatExtensionConfiguration |
Azure OpenAI 채팅 확장으로 사용할 때 Pinecone에 대한 구성 가능한 옵션의 특정 표현입니다. |
PineconeFieldMappingOptions |
구성된 Pinecone 리소스를 사용할 때 필드가 처리되는 방식을 제어하는 선택적 설정입니다. |
StopFinishDetails |
모델에 의한 자연스러운 종료를 나타내는 중지 이유의 구조화된 표현입니다. |
형식 별칭
AudioResult |
요청된 응답 형식을 기반으로 하는 전사 결과 형식입니다. |
AudioResultFormat |
오디오 작업의 결과 형식 |
AudioTranscriptionTask |
"transcribe", "translate" |
AzureChatExtensionConfigurationUnion |
AzureChatExtensionConfigurationUnion에 대한 별칭 |
AzureChatExtensionType |
"azure_search", "azure_ml_index", "azure_cosmos_db", "elasticsearch", "pinecone" |
AzureSearchQueryType |
"simple", "semantic", "vector", "vector_simple_hybrid", "vector_semantic_hybrid" |
ChatCompletionsNamedToolSelectionUnion |
ChatCompletionsNamedToolSelectionUnion의 별칭 |
ChatCompletionsResponseFormatUnion |
ChatCompletionsResponseFormatUnion의 별칭 |
ChatCompletionsToolCallUnion |
ChatCompletionsToolCallUnion에 대한 별칭 |
ChatCompletionsToolDefinitionUnion |
ChatCompletionsToolDefinitionUnion에 대한 별칭 |
ChatCompletionsToolSelectionPreset |
"auto", "none" |
ChatFinishDetailsUnion |
ChatFinishDetailsUnion의 별칭 |
ChatMessageContentItemUnion |
ChatMessageContentItemUnion의 별칭 |
ChatMessageImageDetailLevel |
"auto", "low", "high" |
ChatRequestMessageUnion |
ChatRequestMessageUnion의 별칭 |
ChatRole |
"system", "도우미", "user", "function", "tool" |
CompletionsFinishReason |
"stop", "length", "content_filter", "function_call", "tool_calls" |
ContentFilterResultDetailsForPrompt |
콘텐츠 필터링 범주(검색된 경우)에 대한 정보입니다. |
ContentFilterResultsForChoice |
콘텐츠 필터링 결과가 검색된 경우의 정보입니다. |
ContentFilterSeverity |
"safe", "low", "medium", "high" |
ElasticsearchQueryType |
"simple", "vector" |
FunctionCallPreset |
"auto", "none" |
ImageGenerationQuality |
"standard", "hd" |
ImageGenerationResponseFormat |
"url", "b64_json" |
ImageGenerationStyle |
"natural", "vivid" |
ImageSize |
"256x256", "512x512", "1024x1024", "1792x1024", "1024x1792" |
OnYourDataAuthenticationOptionsUnion |
OnYourDataAuthenticationOptionsUnion에 대한 별칭 |
OnYourDataAuthenticationType |
"api_key", "connection_string", "key_and_key_id", "encoded_api_key", "access_token", "system_assigned_managed_identity", "user_assigned_managed_identity" |
OnYourDataVectorizationSourceType |
"endpoint", "deployment_name", "model_id" |
OnYourDataVectorizationSourceUnion |
OnYourDataVectorizationSourceUnion에 대한 별칭 |
Azure SDK for JavaScript