ModelInference.CreateBiomassModelJobAsync Method

Reference

Definition

Namespace:: Azure.Verticals.AgriFood.Farming

Assembly:: Azure.Verticals.AgriFood.Farming.dll

Package:: Azure.Verticals.AgriFood.Farming v1.0.0-beta.2

Source:: ModelInference.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Create a Biomass Model job.

public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> CreateBiomassModelJobAsync (Azure.WaitUntil waitUntil, string jobId, Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member CreateBiomassModelJobAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.CreateBiomassModelJobAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>

Public Overridable Function CreateBiomassModelJobAsync (waitUntil As WaitUntil, jobId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Operation(Of BinaryData))

Parameters

waitUntil: WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

jobId: String

JobId provided by user.

content: RequestContent

The content to send as the body of the request. Details of the request body schema are in the Remarks section below.

context: RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Operation<BinaryData>>

The Operation<T> from the service that will contain a BinaryData object once the asynchronous operation on the service has completed. Details of the body schema for the operation's final value are in the Remarks section below.

Exceptions

ArgumentNullException

jobId or content is null.

ArgumentException

jobId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call CreateBiomassModelJobAsync with required parameters and request content, and how to parse the result.

var credential = new DefaultAzureCredential();
var client = new FarmBeatsClient(credential).GetModelInferenceClient(<2022-11-01-preview>);

var data = new {
    partyId = "<partyId>",
    boundaryId = "<boundaryId>",
    modelVersion = "<modelVersion>",
    cropName = "Corn",
    plantingStartDateTime = "2022-05-10T18:57:31.2311892Z",
    inferenceEndDateTime = "2022-05-10T18:57:31.2311892Z",
    weatherExtensionId = "<weatherExtensionId>",
    satelliteProvider = "Microsoft",
    satelliteSource = "Sentinel_2_L2A",
    imageResolution = 123.45d,
    imageFormat = "TIF",
};

var operation = await client.CreateBiomassModelJobAsync(WaitUntil.Completed, "<jobId>", RequestContent.Create(data));

BinaryData data = operation.Value;
JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("partyId").ToString());
Console.WriteLine(result.GetProperty("boundaryId").ToString());
Console.WriteLine(result.GetProperty("modelVersion").ToString());
Console.WriteLine(result.GetProperty("cropName").ToString());
Console.WriteLine(result.GetProperty("plantingStartDateTime").ToString());
Console.WriteLine(result.GetProperty("inferenceEndDateTime").ToString());
Console.WriteLine(result.GetProperty("weatherExtensionId").ToString());
Console.WriteLine(result.GetProperty("satelliteProvider").ToString());
Console.WriteLine(result.GetProperty("satelliteSource").ToString());
Console.WriteLine(result.GetProperty("imageResolution").ToString());
Console.WriteLine(result.GetProperty("imageFormat").ToString());

This sample shows how to call CreateBiomassModelJobAsync with all parameters and request content, and how to parse the result.

var credential = new DefaultAzureCredential();
var client = new FarmBeatsClient(credential).GetModelInferenceClient(<2022-11-01-preview>);

var data = new {
    partyId = "<partyId>",
    boundaryId = "<boundaryId>",
    modelVersion = "<modelVersion>",
    cropName = "Corn",
    plantingStartDateTime = "2022-05-10T18:57:31.2311892Z",
    inferenceEndDateTime = "2022-05-10T18:57:31.2311892Z",
    weatherExtensionId = "<weatherExtensionId>",
    satelliteProvider = "Microsoft",
    satelliteSource = "Sentinel_2_L2A",
    imageResolution = 123.45d,
    imageFormat = "TIF",
    name = "<name>",
    description = "<description>",
    properties = new {
        key = new {},
    },
};

var operation = await client.CreateBiomassModelJobAsync(WaitUntil.Completed, "<jobId>", RequestContent.Create(data));

BinaryData data = operation.Value;
JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("partyId").ToString());
Console.WriteLine(result.GetProperty("boundaryId").ToString());
Console.WriteLine(result.GetProperty("modelVersion").ToString());
Console.WriteLine(result.GetProperty("cropName").ToString());
Console.WriteLine(result.GetProperty("plantingStartDateTime").ToString());
Console.WriteLine(result.GetProperty("inferenceEndDateTime").ToString());
Console.WriteLine(result.GetProperty("weatherExtensionId").ToString());
Console.WriteLine(result.GetProperty("satelliteProvider").ToString());
Console.WriteLine(result.GetProperty("satelliteSource").ToString());
Console.WriteLine(result.GetProperty("imageResolution").ToString());
Console.WriteLine(result.GetProperty("imageFormat").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("durationInSeconds").ToString());
Console.WriteLine(result.GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("errorCode").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("lastActionDateTime").ToString());
Console.WriteLine(result.GetProperty("startTime").ToString());
Console.WriteLine(result.GetProperty("endTime").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("createdBy").ToString());
Console.WriteLine(result.GetProperty("modifiedBy").ToString());
Console.WriteLine(result.GetProperty("properties").GetProperty("<test>").ToString());

Remarks

Below is the JSON schema for the request and response payloads.

Request Body:

Schema for BiomassModelJob:

{
  partyId: string, # Required. Party Id.
  boundaryId: string, # Required. The id of the boundary object for which biomass is being calculated.
  modelVersion: string, # Required. The version of the biomass model to be run. Available Value: 1.0 .
  cropName: "Corn", # Required. Crop name for biomass model. Available Value: Corn.
  plantingStartDateTime: string (ISO 8601 Format), # Required. Planting datetime for biomass calculations. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  inferenceEndDateTime: string (ISO 8601 Format), # Required. End datetime till which biomass will be calculated. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  weatherExtensionId: string, # Required. ExtensionId of weather data. Available values: DTN.ClearAg, DTN.ContentServices.
  satelliteProvider: "Microsoft", # Required. Provider of satellite data. Available Value: Microsoft.
  satelliteSource: "Sentinel_2_L2A" | "Sentinel_2_L1C", # Required. Source of satellite data. Available Value: Sentinel_2_L2A.
  imageResolution: number, # Required. ImageResolution in meters. Available values: 10, 20, 60.
  imageFormat: "TIF", # Required. ImageFormat. Available value: TIF.
  id: string, # Optional. Unique job id.
  status: string, # Optional. Status of the job.
Possible values: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.
  durationInSeconds: number, # Optional. Duration of the job in seconds.
  message: string, # Optional. Status message to capture more details of the job.
  errorCode: string, # Optional. Error Code when job failed.
  createdDateTime: string (ISO 8601 Format), # Optional. Job created at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  lastActionDateTime: string (ISO 8601 Format), # Optional. Job was last acted upon at dateTime. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  startTime: string (ISO 8601 Format), # Optional. Job start time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  endTime: string (ISO 8601 Format), # Optional. Job end time when available. Sample format: yyyy-MM-ddTHH:mm:ssZ.
  name: string, # Optional. Name to identify resource.
  description: string, # Optional. Textual description of the resource.
  createdBy: string, # Optional. Created by user/tenant id.
  modifiedBy: string, # Optional. Modified by user/tenant id.
  properties: Dictionary<string, any>, # Optional. A collection of key value pairs that belongs to the resource.
Each pair must not have a key greater than 50 characters
and must not have a value greater than 150 characters.
Note: A maximum of 25 key value pairs can be provided for a resource and only string,
numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported.
}

Response Body: