KnowledgeBaseRetrievalClient (preview:2025-11-01)

2025/12/12 • 1 deleted methods

KnowledgeRetrieval_Retrieve (removed)
Description :  KnowledgeBase retrieves relevant data from backing stores.
Reference :  Link ¶

⚼ Request

POST:  /retrieve
{
retrievalRequest:
{
Description: The retrieval request to process. ,
Required: True ,
}
{
messages:
{
Description: A list of chat message style input. ,
Required: False ,
}
[
{
role:
{
Description: The role of the tool response. ,
Required: False ,
}
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 ,
}
,
]
,
}
,
]
,
intents:
{
Description: A list of intended queries to execute without model query planning. ,
Required: False ,
}
[
{
type:
{
Description: The type of the intent. ,
Enum:
{
semantic: A natural language semantic query intent. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
maxRuntimeInSeconds:
{
Description: The maximum runtime in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxOutputSize:
{
Description: Limits the maximum size of the content in the output. ,
Format: int32 ,
Required: False ,
}
integer ,
retrievalReasoningEffort:
{
Required: False ,
}
{
kind:
{
Description: The kind of reasoning effort. ,
Enum:
{
minimal: Does not perform any source selections, query planning, or iterative search. ,
low: Use low reasoning during retrieval. ,
medium: Use a moderate amount of reasoning during retrieval. ,
}
,
Required: True ,
}
enum ,
}
,
includeActivity:
{
Description: Indicates retrieval results should include activity information. ,
Required: False ,
}
boolean ,
outputMode:
{
Description: The output configuration for this retrieval. ,
Enum:
{
extractiveData: Return data from the knowledge sources directly without generative alteration. ,
answerSynthesis: Synthesize an answer for the response payload. ,
}
,
Required: False ,
}
enum ,
knowledgeSourceParams:
{
Description: A list of runtime parameters for the knowledge sources. ,
Required: False ,
}
[
{
knowledgeSourceName:
{
Description: The name of the index the params apply to. ,
Required: True ,
}
string ,
includeReferences:
{
Description: Indicates whether references should be included for data retrieved from this source. ,
Required: False ,
}
boolean ,
includeReferenceSourceData:
{
Description: Indicates whether references should include the structured data obtained during retrieval in their payload. ,
Required: False ,
}
boolean ,
alwaysQuerySource:
{
Description: Indicates that this knowledge source should bypass source selection and always be queried at retrieval time. ,
Required: False ,
}
boolean ,
rerankerThreshold:
{
Description: The reranker threshold all retrieved documents must meet to be included in the response. ,
Format: float ,
Required: False ,
}
number ,
kind:
{
Description: The type of the knowledge source. ,
Enum:
{
searchIndex: A knowledge source that retrieves data from a Search Index. ,
azureBlob: A knowledge source that retrieves and ingests data from Azure Blob Storage to a Search Index. ,
web: A knowledge source that retrieves data from the web. ,
remoteSharePoint: A knowledge source that retrieves data from a remote SharePoint endpoint. ,
indexedSharePoint: A knowledge source that retrieves and ingests data from SharePoint to a Search Index. ,
indexedOneLake: A knowledge source that retrieves and ingests data from OneLake to a Search Index. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
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: False ,
}
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 ,
elapsedMs:
{
Description: The elapsed time in milliseconds for the retrieval activity. ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: The error detail explaining why the operation failed. This property is only included when the activity does not succeed. ,
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
sourceData:
{
Required: False ,
}
object ,
rerankerScore:
{
Description: The reranker score for the document reference. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}

⚐ Response (206)

{
response:
{
Required: False ,
}
[
{
role:
{
Description: The role of the tool response. ,
Required: False ,
}
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 ,
elapsedMs:
{
Description: The elapsed time in milliseconds for the retrieval activity. ,
Format: int32 ,
Required: False ,
}
integer ,
error:
{
Description: The error detail explaining why the operation failed. This property is only included when the activity does not succeed. ,
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 ,
}
,
]
,
}
,
}
,
]
,
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 ,
sourceData:
{
Required: False ,
}
object ,
rerankerScore:
{
Description: The reranker score for the document reference. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}