Models - List Custom Models

참조

서비스:: Azure AI Services

API 버전:: v3.1

인증된 구독에 대한 사용자 지정 모델 목록을 가져옵니다.

GET {endpoint}/speechtotext/v3.1/models

선택적 매개 변수:

GET {endpoint}/speechtotext/v3.1/models?skip={skip}&top={top}&filter={filter}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string	지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름( 예: https://westus.api.cognitive.microsoft.com).
filter	query		string	사용 가능한 모델의 하위 집합을 선택하기 위한 필터링 식입니다. `- Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=status eq 'NotStarted' or status eq 'Running'`
skip	query		integer int32	건너뛸 데이터 세트 수입니다.
top	query		integer int32	건너뛴 후 포함할 데이터 세트 수입니다.

응답

Name	형식	Description
200 OK	PaginatedCustomModels	정상 헤더 Retry-After: integer
Other Status Codes	Error	오류가 발생했습니다.

Name

형식

Description

200 OK

PaginatedCustomModels

정상

헤더

Retry-After: integer

Other Status Codes

Error

오류가 발생했습니다.

보안

Ocp-Apim-Subscription-Key

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

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

Authorization

이 지역의 STS에서 반환된 JWT에서 액세스 토큰을 제공합니다. STS URL에 다음 쿼리 문자열을 추가하여 관리 scope 토큰에 추가해야 합니다. ?scope=speechservicesmanagement

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

예제

Get all models in state 'Running'

샘플 요청

HTTP

GET {endpoint}/speechtotext/v3.1/models?skip=0&top=2&filter=status%20eq%20'Running'

샘플 응답

상태 코드:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b",
      "baseModel": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "datasets": [
        {
          "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
        }
      ],
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
        "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b:copyto",
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b/files"
      },
      "properties": {
        "deprecationDates": {
          "transcriptionDateTime": "2023-05-04T00:00:00Z"
        },
        "customModelWeightPercent": 30,
        "features": {
          "supportsTranscriptions": true,
          "supportsEndpoints": true,
          "supportsTranscriptionsOnSpeechContainers": false
        }
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Running",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Language model",
      "description": "This is a language model"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b",
      "baseModel": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "datasets": [
        {
          "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
        }
      ],
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b",
        "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copyto",
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/files"
      },
      "properties": {
        "deprecationDates": {
          "transcriptionDateTime": "2023-05-04T00:00:00Z"
        },
        "customModelWeightPercent": 30,
        "features": {
          "supportsTranscriptions": true,
          "supportsEndpoints": true,
          "supportsTranscriptionsOnSpeechContainers": false
        }
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Running",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Acoustic model",
      "description": "Example for an acoustic model"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models?skip=2&top=2&filter=status%20eq%20'Running'"
}

정의

Name	Description
CustomModel	CustomModel
CustomModelDeprecationDates	CustomModelDeprecationDates
CustomModelFeatures	CustomModelFeatures
CustomModelLinks	CustomModelLinks
CustomModelProperties	CustomModelProperties
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	오류
ErrorCode	오류 코드
InnerError	InnerError
PaginatedCustomModels	페이지가 매겨진CustomModels
Status	상태

CustomModel

Name	형식	Description
baseModel	EntityReference	EntityReference
createdDateTime	string	개체를 만들 때의 타임스탬프를 지정합니다. 타임스탬프는 ISO 8601 날짜 및 시간 형식으로 인코딩됩니다("YYYY-MM-DDThh:mm:ssZ", 참조 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	이 엔터티의 사용자 지정 속성입니다. 허용되는 최대 키 길이는 64자, 허용되는 최대 값 길이는 256자, 허용되는 항목 수는 10자입니다.
datasets	EntityReference[]	적응에 사용되는 데이터 세트입니다.
description	string	개체에 대한 설명입니다.
displayName	string	개체의 표시 이름입니다.
lastActionDateTime	string	현재 상태 입력한 타임스탬프를 지정합니다. 타임스탬프는 ISO 8601 날짜 및 시간 형식으로 인코딩됩니다("YYYY-MM-DDThh:mm:ssZ", 참조 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	CustomModelLinks	CustomModelLinks
locale	string	포함된 데이터의 로캘입니다.
project	EntityReference	EntityReference
properties	CustomModelProperties	CustomModelProperties
self	string	이 엔터티의 위치입니다.
status	Status	상태 API의 현재 상태 설명
text	string	이 언어 모델을 조정하는 데 사용되는 텍스트입니다.

CustomModelDeprecationDates

Name	형식	Description
transcriptionDateTime	string	전사가 더 이상 사용되지 않는 날짜입니다.

CustomModelFeatures

Name	형식	Description
supportsEndpoints	boolean	라이브 전사에 대한 엔드포인트 만들기가 지원되는지 여부를 나타내는 값입니다.
supportsTranscriptions	boolean	일괄 처리 전사가 지원되는지 여부를 나타내는 값입니다.
supportsTranscriptionsOnSpeechContainers	boolean	이 모델을 음성 컨테이너의 전사에 사용할 수 있는지 여부를 나타내는 값입니다. 이 기능은 음성 컨테이너에서 사용할 수 있게 되면 기존 모델에 추가할 수 있습니다.

CustomModelLinks

Name	형식	Description
copyTo	string	모델 복사 작업의 위치입니다. 자세한 내용은 "Models_CopyTo" 작업을 참조하세요.
files	string	이 엔터티의 모든 파일을 가져올 위치입니다. 자세한 내용은 "Models_ListFiles" 작업을 참조하세요.
manifest	string	온-프레미스 컨테이너에서 사용할 이 모델의 매니페스트를 가져올 위치입니다. 자세한 내용은 "Models_GetCustomModelManifest" 작업을 참조하세요.

CustomModelProperties

Name	형식	Description
customModelWeightPercent	integer	1(1% 사용자 지정 모델과 99% 기본 모델) 및 100(100% 사용자 지정 모델 및 0% 기본 모델) 사이의 사용자 지정 모델의 가중치입니다. 이 속성이 설정되지 않은 경우 서비스는 적절한 값을 선택합니다(선택한 가중치를 검색할 모델 가져오기). 이 속성을 사용하지 않고 시작합니다. 필요한 경우 더 크거나 작은 가중치를 선택하여 사용자 지정 모델의 영향을 늘리거나 줄입니다.
deprecationDates	CustomModelDeprecationDates	CustomModelDeprecationDates
email	string	작업이 완료되는 경우 메일 알림 보낼 이메일 주소입니다. 전자 메일을 성공적으로 보낸 후 값이 제거됩니다.
error	EntityError	EntityError
features	CustomModelFeatures	CustomModelFeatures 모델에서 지원하는 기능입니다.

DetailedErrorCode

Name	형식	Description
DataImportFailed	string	데이터 가져오기에 실패했습니다.
DeleteNotAllowed	string	삭제할 수 없습니다.
DeployNotAllowed	string	배포가 허용되지 않습니다.
DeployingFailedModel	string	실패한 모델 배포.
EmptyRequest	string	빈 요청입니다.
EndpointCannotBeDefault	string	엔드포인트는 기본값일 수 없습니다.
EndpointNotUpdatable	string	엔드포인트를 사용할 수 없습니다.
EndpointWithoutLogging	string	로깅이 없는 엔드포인트입니다.
ExceededNumberOfRecordingsUris	string	기록 URI 수를 초과했습니다.
FailedDataset	string	실패한 데이터 세트입니다.
Forbidden	string	사용할 수 없습니다.
InUseViolation	string	사용 위반.
InaccessibleCustomerStorage	string	액세스할 수 없는 고객 스토리지.
InvalidAdaptationMapping	string	잘못된 적응 매핑입니다.
InvalidBaseModel	string	잘못된 기본 모델입니다.
InvalidCallbackUri	string	콜백 URI가 잘못되었습니다.
InvalidCollection	string	컬렉션이 잘못되었습니다.
InvalidDataset	string	데이터 세트가 잘못되었습니다.
InvalidDocument	string	잘못된 문서입니다.
InvalidDocumentBatch	string	문서 일괄 처리가 잘못되었습니다.
InvalidLocale	string	잘못된 로캘입니다.
InvalidLogDate	string	잘못된 로그 날짜입니다.
InvalidLogEndTime	string	로그 종료 시간이 잘못되었습니다.
InvalidLogId	string	잘못된 로그 ID입니다.
InvalidLogStartTime	string	로그 시작 시간이 잘못되었습니다.
InvalidModel	string	잘못된 모델입니다.
InvalidModelUri	string	모델 URI가 잘못되었습니다.
InvalidParameter	string	잘못된 매개 변수입니다.
InvalidParameterValue	string	매개 변수 값이 잘못되었습니다.
InvalidPayload	string	잘못된 페이로드입니다.
InvalidPermissions	string	권한이 잘못되었습니다.
InvalidPrerequisite	string	필수 구성 요소가 잘못되었습니다.
InvalidProductId	string	잘못된 제품 ID입니다.
InvalidProject	string	프로젝트가 잘못되었습니다.
InvalidProjectKind	string	프로젝트 종류가 잘못되었습니다.
InvalidRecordingsUri	string	잘못된 녹음/녹화 URI입니다.
InvalidRequestBodyFormat	string	요청 본문 형식이 잘못되었습니다.
InvalidSasValidityDuration	string	sas 유효 기간이 잘못되었습니다.
InvalidSkipTokenForLogs	string	로그에 대한 건너뛰기 토큰이 잘못되었습니다.
InvalidSubscription	string	잘못된 구독입니다.
InvalidTest	string	테스트가 잘못되었습니다.
InvalidTimeToLive	string	유효하지 않은 TL(Time to Live)
InvalidTopForLogs	string	로그의 위쪽이 잘못되었습니다.
InvalidTranscription	string	잘못된 전사입니다.
InvalidWebHookEventKind	string	웹 후크 이벤트 종류가 잘못되었습니다.
MissingInputRecords	string	입력 레코드가 없습니다.
ModelDeploymentNotCompleteState	string	모델 배포가 완료되지 않은 상태입니다.
ModelDeprecated	string	모델이 더 이상 사용되지 않습니다.
ModelExists	string	모델이 있습니다.
ModelMismatch	string	모델 불일치.
ModelNotDeployable	string	모델을 배포할 수 없습니다.
ModelVersionIncorrect	string	모델 버전이 잘못되었습니다.
NoUtf8WithBom	string	bom과 함께 utf8이 없습니다.
OnlyOneOfUrlsOrContainerOrDataset	string	URL 또는 컨테이너 또는 데이터 세트 중 하나만.
ProjectGenderMismatch	string	프로젝트 성별 불일치.
QuotaViolation	string	할당량 위반.
SingleDefaultEndpoint	string	단일 기본 엔드포인트입니다.
SkuLimitsExist	string	SKU 제한이 있습니다.
SubscriptionNotFound	string	구독을 찾을 수 없습니다.
UnexpectedError	string	예기치 않은 오류입니다.
UnsupportedClassBasedAdaptation	string	지원되지 않는 클래스 기반 적응입니다.
UnsupportedDelta	string	지원되지 않는 델타입니다.
UnsupportedDynamicConfiguration	string	지원되지 않는 동적 구성입니다.
UnsupportedFilter	string	지원되지 않는 필터입니다.
UnsupportedLanguageCode	string	지원되지 않는 언어 코드입니다.
UnsupportedOrderBy	string	지원되지 않는 순서 기준입니다.
UnsupportedPagination	string	지원되지 않는 페이지 매김.
UnsupportedTimeRange	string	지원되지 않는 시간 범위입니다.

EntityError

Name	형식	Description
code	string	이 오류의 코드입니다.
message	string	이 오류에 대한 메시지입니다.

EntityReference

Name	형식	Description
self	string	참조된 엔터티의 위치입니다.

Error

오류

Name	형식	Description
code	ErrorCode	오류 코드 높은 수준의 오류 코드입니다.
details	Error[]	오류 및/또는 예상 정책에 대한 추가 지원 세부 정보입니다.
innerError	InnerError	InnerError 에서 https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow사용할 수 있는 Cognitive Services API 지침을 준수하는 새로운 내부 오류 형식입니다. 여기에는 필수 속성 ErrorCode, 메시지 및 선택적 속성 대상, 세부 정보(키 값 쌍), 내부 오류(중첩될 수 있음)가 포함됩니다.
message	string	높은 수준의 오류 메시지입니다.
target	string	오류의 출처입니다. 예를 들어 잘못된 문서의 경우 "documents" 또는 "document id"가 됩니다.

ErrorCode

오류 코드

Name	형식	Description
Conflict	string	충돌 오류 코드를 나타냅니다.
Forbidden	string	사용할 수 없는 오류 코드를 나타냅니다.
InternalCommunicationFailed	string	내부 통신 실패 오류 코드를 나타냅니다.
InternalServerError	string	내부 서버 오류 코드를 나타냅니다.
InvalidArgument	string	잘못된 인수 오류 코드를 나타냅니다.
InvalidRequest	string	잘못된 요청 오류 코드를 나타냅니다.
NotAllowed	string	허용되지 않는 오류 코드를 나타냅니다.
NotFound	string	찾을 수 없는 오류 코드를 나타냅니다.
PipelineError	string	파이프라인 오류 코드를 나타냅니다.
ServiceUnavailable	string	서비스를 사용할 수 없음 오류 코드를 나타냅니다.
TooManyRequests	string	너무 많은 요청 오류 코드를 나타냅니다.
Unauthorized	string	권한 없는 오류 코드를 나타냅니다.
UnprocessableEntity	string	처리할 수 없는 엔터티 오류 코드를 나타냅니다.
UnsupportedMediaType	string	지원되지 않는 미디어 형식 오류 코드를 나타냅니다.

InnerError

Name	형식	Description
code	DetailedErrorCode	DetailedErrorCode 자세한 오류 코드 열거형입니다.
details	object	오류 및/또는 예상 정책에 대한 추가 지원 세부 정보입니다.
innerError	InnerError	InnerError 에서 https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow사용할 수 있는 Cognitive Services API 지침을 준수하는 새로운 내부 오류 형식입니다. 여기에는 필수 속성 ErrorCode, 메시지 및 선택적 속성 대상, 세부 정보(키 값 쌍), 내부 오류(중첩될 수 있음)가 포함됩니다.
message	string	높은 수준의 오류 메시지입니다.
target	string	오류의 출처입니다. 예를 들어 잘못된 문서의 경우 "documents" 또는 "document id"가 됩니다.

PaginatedCustomModels

페이지가 매겨진CustomModels

Name	형식	Description
@nextLink	string	사용할 수 있는 엔터티가 더 있는 경우 페이지를 매긴 다음 결과 집합에 대한 링크입니다. 그렇지 않으면 null입니다.
values	CustomModel[]	전달된 쿼리 매개 변수 'skip' 및 'top' 또는 해당 기본값으로 제한되는 엔터티 목록입니다. 페이지 매김을 사용하여 목록을 반복하고 엔터티를 병렬로 삭제하면 일부 엔터티가 결과에서 건너뛰게 됩니다. 클라이언트에서 목록을 빌드하고 전체 목록을 페치한 후 삭제하는 것이 좋습니다.

Name

형식

Description

@nextLink

string

사용할 수 있는 엔터티가 더 있는 경우 페이지를 매긴 다음 결과 집합에 대한 링크입니다. 그렇지 않으면 null입니다.

values

CustomModel[]

전달된 쿼리 매개 변수 'skip' 및 'top' 또는 해당 기본값으로 제한되는 엔터티 목록입니다.

페이지 매김을 사용하여 목록을 반복하고 엔터티를 병렬로 삭제하면 일부 엔터티가 결과에서 건너뛰게 됩니다. 클라이언트에서 목록을 빌드하고 전체 목록을 페치한 후 삭제하는 것이 좋습니다.

Status

상태

Name	형식	Description
Failed	string	장기 실행 작업이 실패했습니다.
NotStarted	string	장기 실행 작업이 아직 시작되지 않았습니다.
Running	string	장기 실행 작업은 현재 처리 중입니다.
Succeeded	string	장기 실행 작업이 성공적으로 완료되었습니다.

다음을 통해 공유

Models - List Custom Models

URI 매개 변수

응답

보안

Ocp-Apim-Subscription-Key

Authorization

예제

Get all models in state 'Running'

샘플 요청

샘플 응답

정의

CustomModel

CustomModelDeprecationDates

CustomModelFeatures

CustomModelLinks

CustomModelProperties

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

PaginatedCustomModels

Status

추가 리소스