Insights.GetAsync Method

Definition

Namespace:: Azure.AI.Projects

Assembly:: Azure.AI.Projects.dll

Package:: Azure.AI.Projects v1.2.0-beta.4

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.

Overloads

Name	Description
GetAsync(String, Nullable<Boolean>, RequestOptions)	[Protocol Method] Get a specific insight by Id. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetAsync(String, Nullable<Boolean>, CancellationToken)	Get a specific insight by Id.

Name

Description

GetAsync(String, Nullable<Boolean>, RequestOptions)

[Protocol Method] Get a specific insight by Id.

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

GetAsync(String, Nullable<Boolean>, CancellationToken)

Get a specific insight by Id.

GetAsync(String, Nullable<Boolean>, RequestOptions)

Source:: Insights.cs

[Protocol Method] Get a specific insight by Id.

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult> GetAsync(string id, bool? includeCoordinates, System.ClientModel.Primitives.RequestOptions options);

abstract member GetAsync : string * Nullable<bool> * System.ClientModel.Primitives.RequestOptions -> System.Threading.Tasks.Task<System.ClientModel.ClientResult>
override this.GetAsync : string * Nullable<bool> * System.ClientModel.Primitives.RequestOptions -> System.Threading.Tasks.Task<System.ClientModel.ClientResult>

Public Overridable Function GetAsync (id As String, includeCoordinates As Nullable(Of Boolean), options As RequestOptions) As Task(Of ClientResult)

Parameters

id: String

The unique identifier for the insights report.

includeCoordinates: Nullable<Boolean>

Whether to include coordinates for visualization in the response. Defaults to false.

options: RequestOptions

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

Returns

Task<ClientResult>

The response returned from the service.

Exceptions

ArgumentNullException

id is null.

ArgumentException

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

ClientResultException

Service returned a non-success status code.

Applies to

GetAsync(String, Nullable<Boolean>, CancellationToken)

Source:: Insights.cs

Get a specific insight by Id.

public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.Insight>> GetAsync(string id, bool? includeCoordinates = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetAsync : string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.Insight>>
override this.GetAsync : string * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.Insight>>

Public Overridable Function GetAsync (id As String, Optional includeCoordinates As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientResult(Of Insight))