KnowledgeAgentRetrievalClient (preview:2025-05-01)

2025/12/05 • 1 new methods

KnowledgeRetrieval_Retrieve (new)
Description :  KnowledgeAgent retrieves relevant data from backing stores.
Reference :  Link ¶

⚼ Request

POST:  /retrieve
{
retrievalRequest:
{
Description: The retrieval request to process. ,
Required: True ,
}
{
messages:
{
Required: True ,
}
[
{
role:
{
Description: The role of the tool response. ,
Required: True ,
}
string ,
content:
{
Required: True ,
}
[
{
type:
{
Description: The type of the message ,
Enum:
{
text: Text message content kind. ,
image: Image message content kind. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
targetIndexParams:
{
Required: False ,
}
[
{
indexName:
{
Description: The name of the index the params apply to. ,
Required: False ,
}
string ,
filterAddOn:
{
Description: A filter condition applied to the index (e.g., 'State eq VA'). ,
Required: False ,
}
string ,
maxDocsForReranker:
{
Description: Limits the number of documents considered for ranking. ,
Format: int32 ,
Required: False ,
}
integer ,
rerankerThreshold:
{
Description: A threshold for reranking results (range: 0-4). ,
Format: float ,
Required: False ,
}
number ,
includeReferenceSourceData:
{
Description: Indicates whether reference source data should be included. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
x-ms-query-source-authorization:
{
Description: Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
response:
{
Required: False ,
}
[
{
role:
{
Description: The role of the tool response. ,
Required: True ,
}
string ,
content:
{
Required: True ,
}
[
{
type:
{
Description: The type of the message ,
Enum:
{
text: Text message content kind. ,
image: Image message content kind. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
activity:
{
Description: The activity records for tracking progress and billing implications. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the activity record. ,
Format: int32 ,
Required: True ,
}
integer ,
type:
{
Description: The type of the activity record. ,
Required: True ,
}
string ,
}
,
]
,
references:
{
Description: The references for the retrieval data used in the response. ,
Required: False ,
}
[
{
type:
{
Description: The type of the reference. ,
Required: True ,
}
string ,
id:
{
Description: The ID of the reference. ,
Required: True ,
}
string ,
activitySource:
{
Description: The source activity ID for the reference. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}