ProjectConversationsClient.GetProjectConversationItemAsync Method

Definition

Asynchronously gets a single item from a project conversation.

public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Extensions.OpenAI.AgentResponseItem>> GetProjectConversationItemAsync(string conversationId, string itemId, System.Collections.Generic.IEnumerable<OpenAI.Conversations.IncludedConversationItemProperty> include = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetProjectConversationItemAsync : string * string * seq<OpenAI.Conversations.IncludedConversationItemProperty> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Extensions.OpenAI.AgentResponseItem>>
override this.GetProjectConversationItemAsync : string * string * seq<OpenAI.Conversations.IncludedConversationItemProperty> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Extensions.OpenAI.AgentResponseItem>>
Public Overridable Function GetProjectConversationItemAsync (conversationId As String, itemId As String, Optional include As IEnumerable(Of IncludedConversationItemProperty) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientResult(Of AgentResponseItem))

Parameters

conversationId
String

The ID of the conversation that contains the item.

itemId
String

The ID of the item to retrieve.

include
IEnumerable<OpenAI.Conversations.IncludedConversationItemProperty>

The additional item properties to include in the response.

cancellationToken
CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

The requested project conversation item.

Applies to