Class Job

Job details which contain input document details on which prediction need to run, features (which and all language services ) need to run and where to store results

Inheritance

object

Job

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.AilanguageService.Models

Assembly: OCI.DotNetSDK.Ailanguage.dll

Syntax

public class Job

Properties

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment where you want to create the job.

Remarks

Required

CompletedDocuments

Declaration

[JsonProperty(PropertyName = "completedDocuments")]
public int? CompletedDocuments { get; set; }

Property Value

Type	Description
int?	Number of documents processed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.

CreatedBy

Declaration

[JsonProperty(PropertyName = "createdBy")]
public string CreatedBy { get; set; }

Property Value

Type	Description
string	The OCID of the user who created the job.

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	A short description of the job.

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly display name for the job.

FailedDocuments

Declaration

[JsonProperty(PropertyName = "failedDocuments")]
public int? FailedDocuments { get; set; }

Property Value

Type	Description
int?	Number of documents failed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the job.

Remarks

Required

InputConfiguration

Declaration

[JsonProperty(PropertyName = "inputConfiguration")]
public InputConfiguration InputConfiguration { get; set; }

Property Value

Type	Description
InputConfiguration

InputLocation

Declaration

[Required(ErrorMessage = "InputLocation is required.")]
[JsonProperty(PropertyName = "inputLocation")]
public InputLocation InputLocation { get; set; }

Property Value

Type	Description
InputLocation

Remarks

Required

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Job.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
Job.LifecycleStateEnum?	The current state of the Job.

ModelMetadataDetails

Declaration

[Required(ErrorMessage = "ModelMetadataDetails is required.")]
[JsonProperty(PropertyName = "modelMetadataDetails")]
public List<ModelMetadataDetails> ModelMetadataDetails { get; set; }

Property Value

Type	Description
List<ModelMetadataDetails>	training model details For this release only one model is allowed to be input here. One of the three modelType, ModelId, endpointId should be given other wise error will be thrown from API

Remarks

Required

OutputLocation

Declaration

[Required(ErrorMessage = "OutputLocation is required.")]
[JsonProperty(PropertyName = "outputLocation")]
public ObjectPrefixOutputLocation OutputLocation { get; set; }

Property Value

Type	Description
ObjectPrefixOutputLocation

Remarks

Required

PendingDocuments

Declaration

[JsonProperty(PropertyName = "pendingDocuments")]
public int? PendingDocuments { get; set; }

Property Value

Type	Description
int?	Number of documents still to process. For CSV this signifies number of rows and for TXT this signifies number of files.

PercentComplete

Declaration

[JsonProperty(PropertyName = "percentComplete")]
public int? PercentComplete { get; set; }

Property Value

Type	Description
int?	How much progress the operation has made, vs the total amount of work that must be performed.

TimeAccepted

Declaration

[JsonProperty(PropertyName = "timeAccepted")]
public DateTime? TimeAccepted { get; set; }

Property Value

Type	Description
DateTime?	Job accepted time.

TimeCompleted

Declaration

[JsonProperty(PropertyName = "timeCompleted")]
public DateTime? TimeCompleted { get; set; }

Property Value

Type	Description
DateTime?	Job finished time.

TimeStarted

Declaration

[JsonProperty(PropertyName = "timeStarted")]
public DateTime? TimeStarted { get; set; }

Property Value

Type	Description
DateTime?	Job started time.

TotalDocuments

Declaration

[JsonProperty(PropertyName = "totalDocuments")]
public int? TotalDocuments { get; set; }

Property Value

Type	Description
int?	Total number of documents given as input for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.

TtlInDays

Declaration

[JsonProperty(PropertyName = "ttlInDays")]
public int? TtlInDays { get; set; }

Property Value

Type	Description
int?	Time to live duration in days for Job. Job will be available till max 90 days.

WarningsCount

Declaration

[JsonProperty(PropertyName = "warningsCount")]
public int? WarningsCount { get; set; }

Property Value

Type	Description
int?	warnings count