Models - List

참조

서비스:: Azure AI Services

API 버전:: 2024-10-21

Azure OpenAI 리소스에서 액세스할 수 있는 모든 모델 목록을 가져옵니다. 여기에는 기본 모델뿐만 아니라 Azure OpenAI 리소스가 소유한 모든 미세 조정된 모델이 포함됩니다.

GET {endpoint}/openai/models?api-version=2024-10-21

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string url	지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름( 예: https://aoairesource.openai.azure.com. "aoairesource"를 Azure OpenAI 계정 이름으로 대체).
api-version	query	True	string	요청된 API 버전입니다.

요청 헤더

Name	필수	형식	Description
api-key	True	string	여기에서 Cognitive Services Azure OpenAI 계정 키를 제공합니다.

응답

Name	형식	Description
200 OK	ModelList	성공
Other Status Codes	ErrorResponse	오류가 발생했습니다.

보안

api-key

여기에서 Cognitive Services Azure OpenAI 계정 키를 제공합니다.

형식: apiKey
In(다음 안에): header

예제

Getting all models owned by account.

샘플 요청

HTTP

GET https://aoairesource.openai.azure.com/openai/models?api-version=2024-10-21

샘플 응답

상태 코드:: 200

{
  "data": [
    {
      "status": "succeeded",
      "capabilities": {
        "fine_tune": true,
        "inference": true,
        "completion": true,
        "chat_completion": false,
        "embeddings": false
      },
      "lifecycle_status": "generally-available",
      "deprecation": {
        "fine_tune": 1677662127,
        "inference": 1709284527
      },
      "id": "curie",
      "created_at": 1646126127,
      "object": "model"
    },
    {
      "status": "succeeded",
      "model": "curie",
      "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
      "capabilities": {
        "fine_tune": false,
        "inference": true,
        "completion": true,
        "chat_completion": false,
        "embeddings": false
      },
      "lifecycle_status": "generally-available",
      "deprecation": {
        "inference": 1709284527
      },
      "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
      "created_at": 1646126127,
      "object": "model"
    }
  ],
  "object": "list"
}

정의

Name	Description
Capabilities	기능
Deprecation	사용 중단
Error	오류
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
LifeCycleStatus	LifeCycleStatus
Model	모델
ModelList	ModelList
TypeDiscriminator	TypeDiscriminator

Capabilities

기능

Name	형식	Description
chat_completion	boolean	모델에서 채팅 완료를 지원하는지 여부를 나타내는 값입니다.
completion	boolean	모델에서 완성을 지원하는지 여부를 나타내는 값입니다.
embeddings	boolean	모델이 포함을 지원하는지 여부를 나타내는 값입니다.
fine_tune	boolean	모델을 미세 조정에 사용할 수 있는지 여부를 나타내는 값입니다.
inference	boolean	모델을 배포할 수 있는지 여부를 나타내는 값입니다.

Deprecation

사용 중단

Name	형식	Description
fine_tune	integer	이 모델의 미세 조정 지원 종료 날짜입니다. 미세 조정 모델에 대한 `null`.
inference	integer	이 모델의 유추 지원 종료 날짜입니다.

Error

오류

Name	형식	Description
code	ErrorCode	ErrorCode Microsoft REST 지침(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)에 정의된 오류 코드입니다.
details	Error[]	사용 가능한 경우 오류 세부 정보입니다.
innererror	InnerError	InnerError Microsoft REST 지침(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)에 정의된 내부 오류입니다.
message	string	이 오류의 메시지입니다.
target	string	사용 가능한 경우 오류가 발생한 위치입니다.

ErrorCode

Name	형식	Description
conflict	string	요청된 작업이 현재 리소스 상태와 충돌합니다.
contentFilter	string	안전 시스템의 결과로 이미지 생성에 실패했습니다.
fileImportFailed	string	파일을 가져오지 못했습니다.
forbidden	string	현재 사용자/api 키에는 작업이 금지되어 있습니다.
internalFailure	string	내부 오류입니다. 다시 시도하세요.
invalidPayload	string	요청 데이터가 이 작업에 유효하지 않습니다.
itemDoesAlreadyExist	string	항목이 이미 있습니다.
jsonlValidationFailed	string	jsonl 데이터의 유효성 검사에 실패했습니다.
notFound	string	리소스를 찾을 수 없습니다.
quotaExceeded	string	할당량을 초과했습니다.
serviceUnavailable	string	현재 서비스를 사용할 수 없습니다.
tooManyRequests	string	요청이 너무 많습니다. 나중에 다시 시도하세요.
unauthorized	string	현재 사용자/api 키는 작업에 대한 권한이 없습니다.
unexpectedEntityState	string	현재 리소스의 상태에서는 작업을 실행할 수 없습니다.

ErrorResponse

Name	형식	Description
error	Error	오류 Microsoft REST 지침(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)에 정의된 오류 콘텐츠입니다.

FineTuningState

Name	형식	Description
cancelled	string	작업이 취소되었으며 불완전합니다. 터미널 상태로 분류할 수 있습니다.
created	string	작업이 만들어졌습니다. 이 상태는 Azure OpenAI에서 반환되지 않으며 호환성을 위해만 노출됩니다. 비활성 상태로 분류할 수 있습니다.
failed	string	작업이 실패와 함께 처리를 완료했으며 더 이상 사용할 수 없습니다. 터미널 상태로 분류할 수 있습니다.
pending	string	작업은 나중에 처리될 큐에 대기되지 않습니다. 비활성 상태로 분류할 수 있습니다.
running	string	작업이 처리되기 시작했습니다. 활성 상태로 분류할 수 있습니다.
succeeded	string	작업이 성공적으로 처리되었으며 사용할 준비가 되었습니다. 터미널 상태로 분류할 수 있습니다.

InnerError

Name	형식	Description
code	InnerErrorCode	InnerErrorCode Microsoft REST 지침(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)에 정의된 내부 오류 코드입니다.
innererror	InnerError	InnerError Microsoft REST 지침(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses)에 정의된 내부 오류입니다.

InnerErrorCode

Name	형식	Description
invalidPayload	string	요청 데이터가 이 작업에 유효하지 않습니다.

LifeCycleStatus

Name	형식	Description
generally-available	string	모델은 일반적으로 사용할 수 있습니다.
preview	string	모델은 미리 보기 상태이며 서비스 미리 보기 조건에 포함됩니다.

Model

모델

Name	형식	Description
capabilities	Capabilities	기능 기본 또는 미세 조정 모델의 기능입니다.
created_at	integer	이 작업 또는 항목이 만들어진 타임스탬프입니다(unix epoch).
deprecation	Deprecation	사용 중단 모델의 다양한 사용 사례에 대한 사용 중단 날짜를 정의합니다. 일반적으로 기본 모델은 만든 후 1년의 미세 조정을 지원합니다. 유추는 일반적으로 기본 또는 미세 조정된 모델을 만든 후 2년 후에 지원됩니다. 속성에 정확한 날짜가 지정됩니다.
fine_tune	string	미세 조정 모델인 경우 미세 조정 작업 ID(미세 조정 ID)입니다. 그렇지 않으면 `null`.
id	string	이 항목의 ID입니다.
lifecycle_status	LifeCycleStatus	LifeCycleStatus 모델의 수명 주기 상태입니다. 참고: 모델은 "미리 보기"에서 "일반 공급"으로 승격할 수 있지만 "일반 공급"에서 "미리 보기"로 승격할 수는 없습니다.
model	string	기본 모델 ID(model-id)(미세 조정 모델인 경우)입니다. 그렇지 않으면 `null`.
object	TypeDiscriminator	TypeDiscriminator 개체의 형식을 정의합니다.
status	FineTuningState	FineTuningState 미세한 개체 또는 미세 조정 작업의 상태입니다.

ModelList

Name	형식	Description
data	Model[]	항목 목록입니다.
object	TypeDiscriminator	TypeDiscriminator 개체의 형식을 정의합니다.

TypeDiscriminator

Name	형식	Description
batch	string	이 개체는 일괄 처리를 나타냅니다.
file	string	이 개체는 파일을 나타냅니다.
fine_tuning.job	string	이 개체는 미세 조정 작업을 나타냅니다.
fine_tuning.job.checkpoint	string	이 개체는 미세 조정 작업의 검사점을 나타냅니다.
fine_tuning.job.event	string	이 개체는 미세 조정 작업의 이벤트를 나타냅니다.
list	string	이 개체는 다른 개체의 목록을 나타냅니다.
model	string	이 개체는 모델을 나타냅니다(기본 모델 또는 미세 조정 작업 결과일 수 있습니다).
upload	string	이 개체는 파일 업로드를 나타냅니다.
upload.part	string	이 개체는 파일 업로드의 일부를 나타냅니다.

다음을 통해 공유

Models - List

URI 매개 변수

요청 헤더

응답

보안

api-key

예제

Getting all models owned by account.

샘플 요청

샘플 응답

정의

Capabilities

Deprecation

Error

ErrorCode

ErrorResponse

FineTuningState

InnerError

InnerErrorCode

LifeCycleStatus

Model

ModelList

TypeDiscriminator

추가 리소스