Text Analysis Authoring - Get Load Snapshot Status

Service:

Azure AI Services

API Version:

2023-11-15-preview

Gets the status for loading a snapshot.

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}?api-version=2023-11-15-preview

URI Parameters

Name	In	Required	Type	Description
jobId	path	True	string	The job ID.
projectName	path	True	string maxLength: 100	The name of the project to use.
trainedModelLabel	path	True	string	The trained model label.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	TextAnalysisAuthoringLoadSnapshotJobState	The details of the long running operation.
Other Status Codes	ErrorResponse	Error response.

Security

AADToken

These are the Azure Active Directory OAuth2 Flows. When paired with Azure role-based access control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.

To implement scenarios, we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.

Notes

• This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.

The Authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. * The Azure role-based access control is configured from the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs. * Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.

• Currently, Azure Active Directory v1.0 or v2.0 supports Work, School, and Guests but does not support Personal accounts.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

A subscription key for a Language service resource.

Type: apiKey
In: header

Examples

Successful Get Load Snapshot Status

Sample request

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/models/model1/load-snapshot/jobs/8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000?api-version=2023-11-15-preview

Sample response

Status code:

200

{
  "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000",
  "createdDateTime": "2022-04-18T15:44:44Z",
  "lastUpdatedDateTime": "2022-04-18T15:45:48Z",
  "expirationDateTime": "2022-04-25T15:44:44Z",
  "status": "running"
}

Definitions

Name	Description
Error	The error object.
ErrorCode	Human-readable error code.
ErrorResponse	Error response.
InnerErrorCode	Human-readable error code.
InnerErrorModel	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus	The job status.
TextAnalysisAuthoringLoadSnapshotJobState	Represents the state of loading a snapshot job.
TextAnalysisAuthoringWarning	Represents a warning that was encountered while executing the request.

Error

Object

The error object.

Name	Type	Description
code	ErrorCode	One of a server-defined set of error codes.
details	Error[]	An array of details about specific errors that led to this reported error.
innererror	InnerErrorModel	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

ErrorCode

Enumeration

Human-readable error code.

Value	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

Error response.

Name	Type	Description
error	Error	The error object.

InnerErrorCode

Enumeration

Human-readable error code.

Value	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	InnerErrorCode	One of a server-defined set of error codes.
details	object	Error details.
innererror	InnerErrorModel	An object containing more specific information than the current object about the error.
message	string	Error message.
target	string	Error target.

JobStatus

Enumeration

The job status.

Value	Description
cancelled
cancelling
failed
notStarted
partiallyCompleted
running
succeeded

TextAnalysisAuthoringLoadSnapshotJobState

Object

Represents the state of loading a snapshot job.

Name	Type	Description
createdDateTime	string (date-time)	The creation date time of the job.
errors	Error[]	The errors encountered while executing the job.
expirationDateTime	string (date-time)	The expiration date time of the job.
jobId	string	The job ID.
lastUpdatedDateTime	string (date-time)	The last date time the job was updated.
status	JobStatus	The job status.
warnings	TextAnalysisAuthoringWarning[]	The warnings that were encountered while executing the job.

TextAnalysisAuthoringWarning

Object

Represents a warning that was encountered while executing the request.

Name	Type	Description
code	string	The warning code.
message	string	The warning message.