Knowledge Retrieval - Retrieve
기술 자료는 백업 저장소에서 관련 데이터를 검색합니다.
POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?api-version=2026-08-01-preview
URI 매개 변수
| Name | In(다음 안에) | 필수 | 형식 | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
검색 서비스의 엔드포인트 URL입니다. |
|
knowledge
|
path | True |
string |
기술 자료의 이름. |
|
api-version
|
query | True |
string minLength: 1 |
이 작업에 사용할 API 버전입니다. |
요청 헤더
| Name | 필수 | 형식 | Description |
|---|---|---|---|
| Accept |
Accept 헤더입니다. |
||
| x-ms-query-source-authorization |
string |
쿼리가 실행되는 사용자를 식별하는 토큰입니다. 이 토큰은 문서에 보안 제한을 적용하는 데 사용됩니다. |
|
| x-ms-query-work-iq-source-authorization |
string (password) |
Work IQ 지식 소스에 설정된 고객 소유 Entra 앱 등록에 대한 사용자 주장 토큰. Work IQ API에 대한 대신 인증에 사용됩니다. |
|
| x-ms-client-request-id |
string (uuid) |
요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다. |
요청 본문
| Name | 형식 | Description |
|---|---|---|
| includeActivity |
boolean |
검색 결과에 활동 정보가 포함되어야 함을 나타냅니다. |
| intents | KnowledgeRetrievalIntent[]: |
모델 쿼리 계획 없이 실행할 의도된 쿼리 목록입니다. |
| knowledgeSourceParams |
KnowledgeSourceParams[]:
|
지식 원본에 대한 런타임 매개 변수 목록입니다. |
| maxOutputDocuments |
integer (int32) |
출력에 포함된 최대 문서 수를 제한합니다. |
| maxOutputSize |
integer (int32) |
출력에 있는 콘텐츠의 최대 크기를 제한합니다. |
| maxOutputSizeInTokens |
integer (int32) |
출력에 있는 콘텐츠의 최대 크기를 제한합니다. |
| maxRuntimeInSeconds |
integer (int32) |
최대 런타임(초)입니다. |
| messages |
채팅 메시지 스타일 입력 목록입니다. |
|
| outputMode |
이 검색에 대한 출력 구성입니다. |
|
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
검색 추론 노력 구성. |
응답
| Name | 형식 | Description |
|---|---|---|
| 200 OK |
성공적인 회수 반응. |
|
| Other Status Codes |
부분 검색 반응. |
|
| Other Status Codes |
예기치 않은 오류 응답입니다. |
보안
api-key
형식:
apiKey
In(다음 안에):
header
OAuth2Auth
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
범위
| Name | Description |
|---|---|
| https://search.azure.com/.default |
예제
|
Knowledge |
|
Knowledge |
|
Knowledge |
|
Knowledge |
KnowledgeBaseRetrieve
샘플 요청
POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-08-01-preview
{
"messages": [
{
"role": "user",
"content": [
{
"type": "text",
"text": "hello world"
}
]
}
],
"maxRuntimeInSeconds": 60,
"maxOutputSize": 100000,
"maxOutputDocuments": 50,
"retrievalReasoningEffort": {
"kind": "low"
},
"includeActivity": true,
"outputMode": "answerSynthesis",
"knowledgeSourceParams": [
{
"knowledgeSourceName": "ks-preview-test",
"includeReferences": true,
"includeReferenceSourceData": true,
"alwaysQuerySource": false,
"neverQuerySource": false,
"failOnError": false,
"rerankerThreshold": 2.1,
"resultsProcessing": "rerank",
"kind": "searchIndex",
"filterAddOn": "foo eq bar",
"queryHintOverrides": {
"filters": [
{
"field": "country",
"fieldValues": [
"United States",
"Japan",
"France",
"Germany"
],
"filterInstructions": "Country associated with the document."
}
],
"boosts": [
{
"kind": "fieldValue",
"boostInstructions": "Prefer documents matching the user's locale.",
"field": "language",
"fieldValues": [
"en-US",
"ja-JP",
"fr-FR",
"de-DE"
],
"boost": 1.5
}
]
}
}
]
}
샘플 응답
{
"response": [
{
"content": [
{
"type": "text",
"text": "[{...}]"
}
]
}
],
"activity": [
{
"type": "modelQueryPlanning",
"id": 0,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 10,
"model": {
"modelName": "gpt-4o",
"deploymentId": "gpt-4o-deployment"
}
},
{
"type": "searchIndex",
"id": 1,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "ks-preview-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"searchIndexArguments": {
"search": "hello world",
"filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
"semanticConfigurationName": "testconfig",
"queryType": "simple",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": []
},
"queryHintProcessing": {
"generatedFilter": "Key eq 'myDocKey1'"
}
},
{
"type": "searchIndex",
"id": 2,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "ks-preview-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"searchIndexArguments": {
"search": "hello world two",
"filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
"semanticConfigurationName": "testconfig",
"queryType": "simple",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": []
},
"queryHintProcessing": {
"generatedFilter": "Key eq 'myDocKey1'"
}
},
{
"type": "modelAnswerSynthesis",
"id": 3,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 10,
"model": {
"modelName": "gpt-4o",
"deploymentId": "gpt-4o-deployment"
}
},
{
"type": "agenticReasoning",
"id": 4,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"reasoningTokens": 78,
"retrievalReasoningEffort": {
"kind": "low"
},
"logicalReasoningEffort": {
"kind": "low"
}
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 1,
"rerankerScore": 4,
"docKey": "myDocKey1",
"citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world"
}
},
{
"type": "searchIndex",
"id": "83dd7d41",
"activitySource": 1,
"rerankerScore": 3.9,
"docKey": "myDocKey2",
"citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world"
}
}
]
}
{
"response": [
{
"content": [
{
"type": "text",
"text": "[{...}]"
}
]
}
],
"activity": [
{
"type": "modelQueryPlanning",
"id": 0,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 10,
"model": {
"modelName": "gpt-4o",
"deploymentId": "gpt-4o-deployment"
}
},
{
"type": "searchIndex",
"id": 1,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "ks-preview-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"searchIndexArguments": {
"search": "hello world",
"filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
"semanticConfigurationName": "testconfig",
"queryType": "simple",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": []
},
"queryHintProcessing": {
"generatedFilter": "Key eq 'myDocKey1'"
}
},
{
"type": "searchIndex",
"id": 2,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "ks-preview-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"searchIndexArguments": {
"search": "hello world two",
"filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
"semanticConfigurationName": "testconfig",
"queryType": "simple",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": []
},
"queryHintProcessing": {
"generatedFilter": "Key eq 'myDocKey1'"
}
},
{
"type": "modelAnswerSynthesis",
"id": 3,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 10,
"model": {
"modelName": "gpt-4o",
"deploymentId": "gpt-4o-deployment"
}
},
{
"type": "agenticReasoning",
"id": 4,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"reasoningTokens": 78,
"retrievalReasoningEffort": {
"kind": "low"
},
"logicalReasoningEffort": {
"kind": "low"
}
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 1,
"rerankerScore": 4,
"docKey": "myDocKey1",
"citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world"
}
},
{
"type": "searchIndex",
"id": "83dd7d41",
"activitySource": 1,
"rerankerScore": 3.9,
"docKey": "myDocKey2",
"citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world"
}
}
]
}
KnowledgeBaseRetrieveAzureBlobImageServing
샘플 요청
POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-azureblob-preview-test')/retrieve?api-version=2026-08-01-preview
{
"messages": [
{
"role": "user",
"content": [
{
"type": "text",
"text": "hello world"
}
]
}
],
"maxRuntimeInSeconds": 60,
"maxOutputSize": 100000,
"maxOutputDocuments": 50,
"retrievalReasoningEffort": {
"kind": "low"
},
"includeActivity": true,
"outputMode": "answerSynthesis",
"knowledgeSourceParams": [
{
"knowledgeSourceName": "azureblob-ks-preview-test",
"includeReferences": true,
"includeReferenceSourceData": true,
"alwaysQuerySource": false,
"failOnError": false,
"rerankerThreshold": 2.1,
"kind": "azureBlob",
"enableImageServing": true
}
]
}
샘플 응답
{
"response": [
{
"content": [
{
"type": "text",
"text": "[{...}]"
}
]
}
],
"activity": [
{
"type": "modelQueryPlanning",
"id": 0,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 10,
"model": {
"modelName": "gpt-4o",
"deploymentId": "gpt-4o-deployment"
}
},
{
"type": "azureBlob",
"id": 1,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "azureblob-ks-preview-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"azureBlobArguments": {
"search": "hello world"
},
"imageServing": {
"imagesRetrieved": 2,
"imagesSentToModel": 1,
"totalImageSizeBytes": 3,
"verbalizationUsed": true,
"servedImages": [
{
"imageId": "1.1",
"imagePath": "doc/normalized_images_0.jpg",
"sizeBytes": 3
}
]
}
},
{
"type": "azureBlob",
"id": 2,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "azureblob-ks-preview-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"azureBlobArguments": {
"search": "hello world two"
}
},
{
"type": "modelAnswerSynthesis",
"id": 3,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 10,
"model": {
"modelName": "gpt-4o",
"deploymentId": "gpt-4o-deployment"
}
},
{
"type": "agenticReasoning",
"id": 4,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"reasoningTokens": 78,
"retrievalReasoningEffort": {
"kind": "low"
},
"logicalReasoningEffort": {
"kind": "low"
}
}
],
"references": [
{
"type": "azureBlob",
"id": "83dd7d40",
"activitySource": 1,
"rerankerScore": 4,
"citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world",
"image_path": "1.1:doc/normalized_images_0.jpg"
}
},
{
"type": "azureBlob",
"id": "83dd7d41",
"activitySource": 1,
"rerankerScore": 3.9,
"citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world",
"image_path": "3.2:doc/normalized_images_1.jpg"
}
}
]
}
{
"response": [
{
"content": [
{
"type": "text",
"text": "[{...}]"
}
]
}
],
"activity": [
{
"type": "modelQueryPlanning",
"id": 0,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 10,
"model": {
"modelName": "gpt-4o",
"deploymentId": "gpt-4o-deployment"
}
},
{
"type": "azureBlob",
"id": 1,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "azureblob-ks-preview-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"azureBlobArguments": {
"search": "hello world"
},
"imageServing": {
"imagesRetrieved": 2,
"imagesSentToModel": 1,
"totalImageSizeBytes": 3,
"verbalizationUsed": true,
"servedImages": [
{
"imageId": "1.1",
"imagePath": "doc/normalized_images_0.jpg",
"sizeBytes": 3
}
]
}
},
{
"type": "azureBlob",
"id": 2,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "azureblob-ks-preview-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"azureBlobArguments": {
"search": "hello world two"
}
},
{
"type": "modelAnswerSynthesis",
"id": 3,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 10,
"model": {
"modelName": "gpt-4o",
"deploymentId": "gpt-4o-deployment"
}
},
{
"type": "agenticReasoning",
"id": 4,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"reasoningTokens": 78,
"retrievalReasoningEffort": {
"kind": "low"
},
"logicalReasoningEffort": {
"kind": "low"
}
}
],
"references": [
{
"type": "azureBlob",
"id": "83dd7d40",
"activitySource": 1,
"rerankerScore": 4,
"citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world",
"image_path": "1.1:doc/normalized_images_0.jpg"
}
},
{
"type": "azureBlob",
"id": "83dd7d41",
"activitySource": 1,
"rerankerScore": 3.9,
"citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world",
"image_path": "3.2:doc/normalized_images_1.jpg"
}
}
]
}
KnowledgeBaseRetrieveWithIntents
샘플 요청
POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-08-01-preview
{
"intents": [
{
"type": "semantic",
"search": "foo"
}
],
"maxRuntimeInSeconds": 60,
"maxOutputSize": 100000,
"maxOutputDocuments": 50,
"retrievalReasoningEffort": {
"kind": "minimal"
},
"includeActivity": true,
"outputMode": "extractiveData",
"knowledgeSourceParams": [
{
"knowledgeSourceName": "ks-preview-test",
"includeReferences": true,
"includeReferenceSourceData": true,
"alwaysQuerySource": true,
"failOnError": true,
"rerankerThreshold": 2.1,
"resultsProcessing": "rerank",
"kind": "searchIndex",
"filterAddOn": "foo eq bar",
"queryHintOverrides": {
"filters": [
{
"field": "country",
"fieldValues": [
"United States",
"Japan",
"France",
"Germany"
],
"filterInstructions": "Country associated with the document."
}
],
"boosts": [
{
"kind": "fieldValue",
"boostInstructions": "Prefer documents matching the user's locale.",
"field": "language",
"fieldValues": [
"en-US",
"ja-JP",
"fr-FR",
"de-DE"
],
"boost": 1.5
}
]
}
}
]
}
샘플 응답
{
"response": [
{
"content": [
{
"type": "text",
"text": "[{...}]"
}
]
}
],
"activity": [
{
"type": "searchIndex",
"id": 0,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "ks-preview-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"searchIndexArguments": {
"search": "foo",
"filter": "(category eq 'news') and (foo eq bar)",
"semanticConfigurationName": "testconfig",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": []
}
},
{
"type": "agenticReasoning",
"id": 1,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"reasoningTokens": 39,
"retrievalReasoningEffort": {
"kind": "minimal"
},
"logicalReasoningEffort": {
"kind": "minimal"
}
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 0,
"rerankerScore": 4,
"docKey": "myDocKey1",
"citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world"
}
},
{
"type": "searchIndex",
"id": "83dd7d41",
"activitySource": 0,
"rerankerScore": 3.9,
"docKey": "myDocKey2",
"citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world"
}
}
]
}
{
"response": [
{
"content": [
{
"type": "text",
"text": "[{...}]"
}
]
}
],
"activity": [
{
"type": "searchIndex",
"id": 0,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "ks-preview-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"searchIndexArguments": {
"search": "foo",
"filter": "(category eq 'news') and (foo eq bar)",
"semanticConfigurationName": "testconfig",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": []
}
},
{
"type": "agenticReasoning",
"id": 1,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"reasoningTokens": 39,
"retrievalReasoningEffort": {
"kind": "minimal"
},
"logicalReasoningEffort": {
"kind": "minimal"
}
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 0,
"rerankerScore": 4,
"docKey": "myDocKey1",
"citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world"
}
},
{
"type": "searchIndex",
"id": "83dd7d41",
"activitySource": 0,
"rerankerScore": 3.9,
"docKey": "myDocKey2",
"citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world"
}
}
]
}
KnowledgeBaseRetrieveWithSourceExclusion
샘플 요청
POST https://previewexampleservice.search.windows.net/knowledgebases('support-kb')/retrieve?api-version=2026-08-01-preview
{
"messages": [
{
"role": "user",
"content": [
{
"text": "Explain the SSO provisioning steps from the product documentation only.",
"type": "text"
}
]
}
],
"includeActivity": true,
"outputMode": "answerSynthesis",
"knowledgeSourceParams": [
{
"knowledgeSourceName": "product-docs-ks",
"includeReferences": true,
"includeReferenceSourceData": true,
"kind": "searchIndex"
},
{
"knowledgeSourceName": "troubleshooting-ks",
"neverQuerySource": true,
"kind": "searchIndex"
},
{
"knowledgeSourceName": "release-notes-web",
"neverQuerySource": true,
"kind": "web"
}
]
}
샘플 응답
{
"response": [
{
"content": [
{
"type": "text",
"text": "To provision SSO, register the enterprise application, configure the redirect URI, upload the signing certificate, and complete the tenant-specific identity settings described in the product documentation."
}
]
}
],
"activity": [
{
"type": "modelQueryPlanning",
"id": 0,
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 10
},
{
"type": "searchIndex",
"id": 1,
"knowledgeSourceName": "product-docs-ks",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 4,
"elapsedMs": 64,
"searchIndexArguments": {
"search": "SSO provisioning steps",
"sourceDataFields": [
{
"name": "title"
},
{
"name": "content"
},
{
"name": "id"
}
],
"searchFields": [],
"semanticConfigurationName": "testconfig"
}
},
{
"type": "agenticReasoning",
"id": 2,
"retrievalReasoningEffort": {
"kind": "low"
},
"reasoningTokens": 74
},
{
"type": "modelAnswerSynthesis",
"id": 3,
"inputTokens": 664,
"outputTokens": 1328,
"elapsedMs": 10
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 1,
"sourceData": {
"id": "sso-provisioning-guide",
"title": "SSO provisioning guide",
"content": "Register the enterprise application and configure the redirect URI."
},
"rerankerScore": 3.5,
"docKey": "sso-provisioning-guide"
}
]
}
{
"response": [
{
"content": [
{
"type": "text",
"text": "Partial results were returned before the retrieval completed."
}
]
}
],
"activity": [
{
"type": "modelQueryPlanning",
"id": 0,
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 10
},
{
"type": "searchIndex",
"id": 1,
"knowledgeSourceName": "product-docs-ks",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 1,
"elapsedMs": 64,
"searchIndexArguments": {
"search": "SSO provisioning steps",
"sourceDataFields": [
{
"name": "title"
},
{
"name": "content"
},
{
"name": "id"
}
],
"searchFields": [],
"semanticConfigurationName": "testconfig"
}
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 1,
"sourceData": {
"id": "sso-provisioning-guide",
"title": "SSO provisioning guide",
"content": "Register the enterprise application and configure the redirect URI."
},
"rerankerScore": 3.5,
"docKey": "sso-provisioning-guide"
}
]
}
정의
Accept
Accept 헤더입니다.
| 값 | Description |
|---|---|
| application/json;odata.metadata=minimal |
AzureBlobKnowledgeSourceParams
Azure Blob 지식 원본에 대한 런타임 매개 변수를 지정합니다.
| Name | 형식 | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다. |
| enableImageServing |
boolean |
이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다. |
| failOnError |
boolean |
이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다. |
| includeReferenceSourceData |
boolean |
참조가 검색 중에 얻은 구조화된 데이터를 페이로드에 포함해야 하는지 여부를 나타냅니다. |
| includeReferences |
boolean |
이 원본에서 검색된 데이터에 대해 참조를 포함해야 하는지 여부를 나타냅니다. |
| kind |
string:
azure |
지식 소스의 유형입니다. |
| knowledgeSourceName |
string |
매개 변수가 적용되는 인덱스의 이름입니다. |
| maxOutputDocuments |
integer (int32) |
이 지식 출처에서 반환되는 문서 최대 수를 제한합니다. |
| neverQuerySource |
boolean |
이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다. |
| queryHintOverrides |
쿼리 계획을 유용한 필터와 부스트로 안내하는 힌트들. 명시되어 있을 경우, 이 객체는 지식 소스에 설정된 전체 쿼리 힌트 세트를 대체합니다. |
|
| rerankerThreshold |
number (float) |
검색된 모든 문서가 응답에 포함되기 위해 충족해야 하는 순위 조정 임계값입니다. |
| resultsProcessing |
이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다. |
ErrorAdditionalInfo
리소스 관리 오류 추가 정보
| Name | 형식 | Description |
|---|---|---|
| info |
추가 정보입니다. |
|
| type |
string |
추가 정보 유형입니다. |
ErrorDetail
오류 세부 정보입니다.
| Name | 형식 | Description |
|---|---|---|
| additionalInfo |
오류 추가 정보 |
|
| code |
string |
오류 코드입니다. |
| details |
오류 세부 정보입니다. |
|
| message |
string |
오류 메시지입니다. |
| target |
string |
오류 대상. |
ErrorResponse
실패한 작업에 대한 오류 세부 정보를 반환하는 모든 Azure Resource Manager API에 대한 일반적인 오류 응답입니다. 또한 OData 오류 응답 형식을 따릅니다.
| Name | 형식 | Description |
|---|---|---|
| error |
오류 개체입니다. |
FabricDataAgentKnowledgeSourceParams
Fabric Data Agent 지식 소스의 런타임 매개변수를 지정합니다
| Name | 형식 | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다. |
| enableImageServing |
boolean |
이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다. |
| failOnError |
boolean |
이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다. |
| includeReferenceSourceData |
boolean |
참조가 검색 중에 얻은 구조화된 데이터를 페이로드에 포함해야 하는지 여부를 나타냅니다. |
| includeReferences |
boolean |
이 원본에서 검색된 데이터에 대해 참조를 포함해야 하는지 여부를 나타냅니다. |
| kind |
string:
fabric |
지식 소스의 유형입니다. |
| knowledgeSourceName |
string |
매개 변수가 적용되는 인덱스의 이름입니다. |
| maxOutputDocuments |
integer (int32) |
이 지식 출처에서 반환되는 문서 최대 수를 제한합니다. |
| neverQuerySource |
boolean |
이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다. |
| rerankerThreshold |
number (float) |
검색된 모든 문서가 응답에 포함되기 위해 충족해야 하는 순위 조정 임계값입니다. |
| resultsProcessing |
이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다. |
FabricOntologyKnowledgeSourceParams
Fabric 온톨로지 지식 소스의 런타임 매개변수를 명시합니다
| Name | 형식 | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다. |
| enableImageServing |
boolean |
이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다. |
| failOnError |
boolean |
이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다. |
| includeReferenceSourceData |
boolean |
참조가 검색 중에 얻은 구조화된 데이터를 페이로드에 포함해야 하는지 여부를 나타냅니다. |
| includeReferences |
boolean |
이 원본에서 검색된 데이터에 대해 참조를 포함해야 하는지 여부를 나타냅니다. |
| kind |
string:
fabric |
지식 소스의 유형입니다. |
| knowledgeSourceName |
string |
매개 변수가 적용되는 인덱스의 이름입니다. |
| maxOutputDocuments |
integer (int32) |
이 지식 출처에서 반환되는 문서 최대 수를 제한합니다. |
| neverQuerySource |
boolean |
이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다. |
| rerankerThreshold |
number (float) |
검색된 모든 문서가 응답에 포함되기 위해 충족해야 하는 순위 조정 임계값입니다. |
| resultsProcessing |
이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다. |
FileKnowledgeSourceParams
파일 지식 소스의 런타임 매개변수를 지정합니다
| Name | 형식 | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다. |
| enableImageServing |
boolean |
이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다. |
| failOnError |
boolean |
이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다. |
| includeReferenceSourceData |
boolean |
참조가 검색 중에 얻은 구조화된 데이터를 페이로드에 포함해야 하는지 여부를 나타냅니다. |
| includeReferences |
boolean |
이 원본에서 검색된 데이터에 대해 참조를 포함해야 하는지 여부를 나타냅니다. |
| kind |
string:
file |
지식 소스의 유형입니다. |
| knowledgeSourceName |
string |
매개 변수가 적용되는 인덱스의 이름입니다. |
| maxOutputDocuments |
integer (int32) |
이 지식 출처에서 반환되는 문서 최대 수를 제한합니다. |
| neverQuerySource |
boolean |
이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다. |
| queryHintOverrides |
쿼리 계획을 유용한 필터와 부스트로 안내하는 힌트들. 명시되어 있을 경우, 이 객체는 지식 소스에 설정된 전체 쿼리 힌트 세트를 대체합니다. |
|
| rerankerThreshold |
number (float) |
검색된 모든 문서가 응답에 포함되기 위해 충족해야 하는 순위 조정 임계값입니다. |
| resultsProcessing |
이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다. |
ImageServingStatistics
검색 활동 중 이미지 서빙에 관한 통계.
| Name | 형식 | Description |
|---|---|---|
| imagesRetrieved |
integer (int32) |
자산 저장소에서 가져온 이미지 수. |
| imagesSentToModel |
integer (int32) |
하위 모델로 전송된 이미지 수. |
| servedImages |
이 회수 활동에 대해 모델이 하위 모델에 제공하도록 선택한 이미지 집합입니다. |
|
| totalImageSizeBytes |
integer (int64) |
모델에 전송되는 이미지의 총 바이트 크기입니다. |
| verbalizationUsed |
boolean |
이미지 언어화가 직접 이미지 서빙 대신 사용되었는지를 나타냅니다. |
IndexedOneLakeKnowledgeSourceParams
인덱싱된 OneLake 기술 자료 원본에 대한 런타임 매개 변수를 지정합니다.
| Name | 형식 | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다. |
| enableImageServing |
boolean |
이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다. |
| failOnError |
boolean |
이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다. |
| includeReferenceSourceData |
boolean |
참조가 검색 중에 얻은 구조화된 데이터를 페이로드에 포함해야 하는지 여부를 나타냅니다. |
| includeReferences |
boolean |
이 원본에서 검색된 데이터에 대해 참조를 포함해야 하는지 여부를 나타냅니다. |
| kind |
string:
indexed |
지식 소스의 유형입니다. |
| knowledgeSourceName |
string |
매개 변수가 적용되는 인덱스의 이름입니다. |
| maxOutputDocuments |
integer (int32) |
이 지식 출처에서 반환되는 문서 최대 수를 제한합니다. |
| neverQuerySource |
boolean |
이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다. |
| queryHintOverrides |
쿼리 계획을 유용한 필터와 부스트로 안내하는 힌트들. 명시되어 있을 경우, 이 객체는 지식 소스에 설정된 전체 쿼리 힌트 세트를 대체합니다. |
|
| rerankerThreshold |
number (float) |
검색된 모든 문서가 응답에 포함되기 위해 충족해야 하는 순위 조정 임계값입니다. |
| resultsProcessing |
이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다. |
IndexedSharePointKnowledgeSourceParams
인덱싱된 SharePoint 기술 자료에 대한 런타임 매개 변수를 지정합니다.
| Name | 형식 | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다. |
| enableImageServing |
boolean |
이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다. |
| failOnError |
boolean |
이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다. |
| includeReferenceSourceData |
boolean |
참조가 검색 중에 얻은 구조화된 데이터를 페이로드에 포함해야 하는지 여부를 나타냅니다. |
| includeReferences |
boolean |
이 원본에서 검색된 데이터에 대해 참조를 포함해야 하는지 여부를 나타냅니다. |
| kind |
string:
indexed |
지식 소스의 유형입니다. |
| knowledgeSourceName |
string |
매개 변수가 적용되는 인덱스의 이름입니다. |
| maxOutputDocuments |
integer (int32) |
이 지식 출처에서 반환되는 문서 최대 수를 제한합니다. |
| neverQuerySource |
boolean |
이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다. |
| queryHintOverrides |
쿼리 계획을 유용한 필터와 부스트로 안내하는 힌트들. 명시되어 있을 경우, 이 객체는 지식 소스에 설정된 전체 쿼리 힌트 세트를 대체합니다. |
|
| rerankerThreshold |
number (float) |
검색된 모든 문서가 응답에 포함되기 위해 충족해야 하는 순위 조정 임계값입니다. |
| resultsProcessing |
이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다. |
IndexedSqlKnowledgeSourceParams
인덱스된 SQL 지식 소스의 런타임 매개변수를 지정합니다
| Name | 형식 | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다. |
| enableImageServing |
boolean |
이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다. |
| failOnError |
boolean |
이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다. |
| includeReferenceSourceData |
boolean |
참조가 검색 중에 얻은 구조화된 데이터를 페이로드에 포함해야 하는지 여부를 나타냅니다. |
| includeReferences |
boolean |
이 원본에서 검색된 데이터에 대해 참조를 포함해야 하는지 여부를 나타냅니다. |
| kind |
string:
indexed |
지식 소스의 유형입니다. |
| knowledgeSourceName |
string |
매개 변수가 적용되는 인덱스의 이름입니다. |
| maxOutputDocuments |
integer (int32) |
이 지식 출처에서 반환되는 문서 최대 수를 제한합니다. |
| neverQuerySource |
boolean |
이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다. |
| queryHintOverrides |
쿼리 계획을 유용한 필터와 부스트로 안내하는 힌트들. 명시되어 있을 경우, 이 객체는 지식 소스에 설정된 전체 쿼리 힌트 세트를 대체합니다. |
|
| rerankerThreshold |
number (float) |
검색된 모든 문서가 응답에 포함되기 위해 충족해야 하는 순위 조정 임계값입니다. |
| resultsProcessing |
이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다. |
KnowledgeBaseActivityRecordModel
지식 기반 LLM 활동에 사용되는 모델을 나타내며, 모델명과 배포 식별자를 포함합니다.
| Name | 형식 | Description |
|---|---|---|
| deploymentId |
string |
활동에 사용되는 모델의 배포 식별자입니다. |
| modelName |
string |
이 활동에 사용된 모델명입니다. |
KnowledgeBaseActivityRecordType
활동 기록의 유형.
| 값 | Description |
|---|---|
| searchIndex |
인덱스 검색 활동. |
| azureBlob |
Azure Blob retrieval activity. |
| indexedSharePoint |
인덱스화된 SharePoint 검색 활동. |
| indexedOneLake |
인덱스된 OneLake 검색 활동. |
| web |
웹 검색 활동. |
| remoteSharePoint |
원격 SharePoint 검색 활동. |
| workIQ |
WorkIQ 검색 활동. |
| fabricDataAgent |
Fabric Data Agent 검색 활동. |
| fabricOntology |
Fabric Ontology 검색 활동. |
| mcpServer |
MCP 서버 검색 활동. |
| file |
파일 검색 활동. |
| indexedSql |
인덱스 SQL 검색 활동. |
| modelQueryPlanning |
LLM 쿼리 기획 활동. |
| modelAnswerSynthesis |
LLM 답변 합성 활동. |
| modelWebSummarization |
LLM 웹 요약 활동. |
| agenticReasoning |
행위적 추론 활동. |
KnowledgeBaseAgenticReasoningActivityRecord
에이전트 추론 활동 레코드를 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| completedAt |
string (date-time) |
활동이 완료된 시간. |
| elapsedMs |
integer (int32) |
검색 활동에 대한 경과 시간(밀리초)입니다. |
| error |
작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다. |
|
| id |
integer (int32) |
활동 레코드의 ID입니다. |
| logicalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
고객이 요청한 논리적 추론 노력. 이는 청구에 사용되는 추론 노력을 보고하는 것과 구 |
| reasoningTokens |
integer (int32) |
에이전트 추론을 위한 입력 토큰의 수입니다. |
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
검색 추론 노력 구성. |
| startedAt |
string (date-time) |
활동이 시작된 시간. |
| type |
string:
agentic |
활동 레코드의 유형입니다. |
| warning |
string |
경고 메시지는 활동 중 관찰된 문서 손실, 토큰 제한 절단, 타임아웃 조건 등 문서 손실 등 잠재적 구성 문제를 알리는 경고 메시지입니다. |
KnowledgeBaseAzureBlobActivityArguments
Azure Blob 검색 작업이 실행된 인수를 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| search |
string |
Blob 콘텐츠를 쿼리하는 데 사용되는 검색 문자열입니다. |
KnowledgeBaseAzureBlobActivityRecord
Azure Blob 검색 활동 레코드를 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| azureBlobArguments |
검색 작업에 대한 azure blob 인수입니다. |
|
| completedAt |
string (date-time) |
활동이 완료된 시간. |
| count |
integer (int32) |
순위 변경 임계값을 통과하기에 충분히 관련성이 있는 검색된 문서 수입니다. |
| elapsedMs |
integer (int32) |
검색 활동에 대한 경과 시간(밀리초)입니다. |
| error |
작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다. |
|
| id |
integer (int32) |
활동 레코드의 ID입니다. |
| imageServing |
이 검색 활동의 이미지 서빙에 관한 통계 |
|
| knowledgeSourceName |
string |
검색 활동에 대한 지식 소스입니다. |
| queryHintProcessing |
이 활동에 대한 쿼리 힌트에서 생성된 표현식에 대한 세부 정보입니다. |
|
| queryTime |
string (date-time) |
이 검색 활동에 대한 쿼리 시간입니다. |
| startedAt |
string (date-time) |
활동이 시작된 시간. |
| type |
string:
azure |
활동 레코드의 유형입니다. |
| warning |
string |
경고 메시지는 활동 중 관찰된 문서 손실, 토큰 제한 절단, 타임아웃 조건 등 문서 손실 등 잠재적 구성 문제를 알리는 경고 메시지입니다. |
KnowledgeBaseAzureBlobReference
Azure Blob Storage 문서 참조를 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| activitySource |
integer (int32) |
참조의 원본 활동 ID입니다. |
| blobUrl |
string |
참조에 대한 Blob URL입니다. |
| citationUrl |
string (uri) |
이 참조의 뒷문서를 가리키는 검색 소유 URL로, 인용 대상으로 사용할 수 있습니다. |
| id |
string |
참조의 ID입니다. |
| rerankerScore |
number (float) |
문서 참조에 대한 순위 변경기 점수입니다. |
| searchSensitivityLabelInfo |
참조 자료의 민감도 라벨 정보입니다. |
|
| sourceData |
참고문헌의 원본 데이터입니다. |
|
| type |
string:
azure |
참조의 유형입니다. |
KnowledgeBaseErrorAdditionalInfo
리소스 관리 오류 추가 정보
| Name | 형식 | Description |
|---|---|---|
| info |
추가 정보입니다. |
|
| type |
string |
추가 정보 유형입니다. |
KnowledgeBaseErrorDetail
오류 세부 정보입니다.
| Name | 형식 | Description |
|---|---|---|
| additionalInfo |
오류 추가 정보 |
|
| code |
string |
오류 코드입니다. |
| details |
오류 세부 정보입니다. |
|
| message |
string |
오류 메시지입니다. |
| target |
string |
오류 대상. |
KnowledgeBaseFabricDataAgentActivityArguments
는 Fabric Data Agent 검색 활동이 실행된 인수들을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| search |
string |
Fabric Data Agent 지식 소스를 쿼리하는 데 사용되는 검색 문자열입니다. |
KnowledgeBaseFabricDataAgentActivityRecord
Fabric Data Agent의 검색 활동 기록을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| completedAt |
string (date-time) |
활동이 완료된 시간. |
| count |
integer (int32) |
순위 변경 임계값을 통과하기에 충분히 관련성이 있는 검색된 문서 수입니다. |
| elapsedMs |
integer (int32) |
검색 활동에 대한 경과 시간(밀리초)입니다. |
| error |
작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다. |
|
| fabricDataAgentArguments |
Fabric Data Agent가 검색 활동에 대한 인자입니다. |
|
| id |
integer (int32) |
활동 레코드의 ID입니다. |
| imageServing |
이 검색 활동의 이미지 서빙에 관한 통계 |
|
| knowledgeSourceName |
string |
검색 활동에 대한 지식 소스입니다. |
| queryTime |
string (date-time) |
이 검색 활동에 대한 쿼리 시간입니다. |
| startedAt |
string (date-time) |
활동이 시작된 시간. |
| type |
string:
fabric |
활동 레코드의 유형입니다. |
| warning |
string |
경고 메시지는 활동 중 관찰된 문서 손실, 토큰 제한 절단, 타임아웃 조건 등 문서 손실 등 잠재적 구성 문제를 알리는 경고 메시지입니다. |
KnowledgeBaseFabricDataAgentReference
Fabric Data Agent 문서 참조를 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| activitySource |
integer (int32) |
참조의 원본 활동 ID입니다. |
| dataAgentId |
string |
Fabric 데이터 에이전트 ID입니다. |
| id |
string |
참조의 ID입니다. |
| rerankerScore |
number (float) |
문서 참조에 대한 순위 변경기 점수입니다. |
| sourceData |
참고문헌의 원본 데이터입니다. |
|
| type |
string:
fabric |
참조의 유형입니다. |
| workspaceId |
string |
Fabric 작업 영역 ID입니다. |
KnowledgeBaseFabricOntologyActivityArguments
Fabric Ontology 검색 활동이 실행된 논수들을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| search |
string |
Fabric Ontology 지식 소스를 쿼리할 때 사용된 검색 문자열입니다. |
KnowledgeBaseFabricOntologyActivityRecord
Fabric Ontology 검색 활동 기록을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| completedAt |
string (date-time) |
활동이 완료된 시간. |
| count |
integer (int32) |
순위 변경 임계값을 통과하기에 충분히 관련성이 있는 검색된 문서 수입니다. |
| elapsedMs |
integer (int32) |
검색 활동에 대한 경과 시간(밀리초)입니다. |
| error |
작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다. |
|
| fabricOntologyArguments |
검색 활동에 대한 Fabric Ontology 논증. |
|
| id |
integer (int32) |
활동 레코드의 ID입니다. |
| imageServing |
이 검색 활동의 이미지 서빙에 관한 통계 |
|
| knowledgeSourceName |
string |
검색 활동에 대한 지식 소스입니다. |
| queryTime |
string (date-time) |
이 검색 활동에 대한 쿼리 시간입니다. |
| startedAt |
string (date-time) |
활동이 시작된 시간. |
| type |
string:
fabric |
활동 레코드의 유형입니다. |
| warning |
string |
경고 메시지는 활동 중 관찰된 문서 손실, 토큰 제한 절단, 타임아웃 조건 등 문서 손실 등 잠재적 구성 문제를 알리는 경고 메시지입니다. |
KnowledgeBaseFabricOntologyReference
Fabric Ontology 문서 참조를 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| activitySource |
integer (int32) |
참조의 원본 활동 ID입니다. |
| id |
string |
참조의 ID입니다. |
| ontologyId |
string |
작업 공간 내의 온톨로지 ID입니다. |
| rerankerScore |
number (float) |
문서 참조에 대한 순위 변경기 점수입니다. |
| sourceData |
참고문헌의 원본 데이터입니다. |
|
| type |
string:
fabric |
참조의 유형입니다. |
| workspaceId |
string |
Fabric 작업 영역 ID입니다. |
KnowledgeBaseFileActivityArguments
파일 검색 활동이 실행된 인수들을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| search |
string |
파일 내용을 조회하는 데 사용되는 검색 문자열입니다. |
KnowledgeBaseFileActivityRecord
파일 검색 활동 기록을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| completedAt |
string (date-time) |
활동이 완료된 시간. |
| count |
integer (int32) |
순위 변경 임계값을 통과하기에 충분히 관련성이 있는 검색된 문서 수입니다. |
| elapsedMs |
integer (int32) |
검색 활동에 대한 경과 시간(밀리초)입니다. |
| error |
작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다. |
|
| fileArguments |
The File은 검색 활동을 지지하는 논거입니다. |
|
| id |
integer (int32) |
활동 레코드의 ID입니다. |
| imageServing |
이 검색 활동의 이미지 서빙에 관한 통계 |
|
| knowledgeSourceName |
string |
검색 활동에 대한 지식 소스입니다. |
| queryHintProcessing |
이 활동에 대한 쿼리 힌트에서 생성된 표현식에 대한 세부 정보입니다. |
|
| queryTime |
string (date-time) |
이 검색 활동에 대한 쿼리 시간입니다. |
| startedAt |
string (date-time) |
활동이 시작된 시간. |
| type |
string:
file |
활동 레코드의 유형입니다. |
| warning |
string |
경고 메시지는 활동 중 관찰된 문서 손실, 토큰 제한 절단, 타임아웃 조건 등 문서 손실 등 잠재적 구성 문제를 알리는 경고 메시지입니다. |
KnowledgeBaseFileReference
파일 문서 참조를 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| activitySource |
integer (int32) |
참조의 원본 활동 ID입니다. |
| citationUrl |
string (uri) |
이 참조의 뒷문서를 가리키는 검색 소유 URL로, 인용 대상으로 사용할 수 있습니다. |
| docName |
string |
참고문헌의 문서 이름입니다. |
| id |
string |
참조의 ID입니다. |
| rerankerScore |
number (float) |
문서 참조에 대한 순위 변경기 점수입니다. |
| sourceData |
참고문헌의 원본 데이터입니다. |
|
| type |
string:
file |
참조의 유형입니다. |
KnowledgeBaseImageContent
이미지 내용.
| Name | 형식 | Description |
|---|---|---|
| url |
string (uri) |
이미지의 URL입니다. |
KnowledgeBaseIndexedOneLakeActivityArguments
인덱스된 OneLake 검색 활동이 실행된 인수들을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| search |
string |
OneLake 콘텐츠의 색인화된 내용을 쿼리하는 데 사용되는 검색 문자열입니다. |
KnowledgeBaseIndexedOneLakeActivityRecord
인덱스된 OneLake 검색 활동 기록을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| completedAt |
string (date-time) |
활동이 완료된 시간. |
| count |
integer (int32) |
순위 변경 임계값을 통과하기에 충분히 관련성이 있는 검색된 문서 수입니다. |
| elapsedMs |
integer (int32) |
검색 활동에 대한 경과 시간(밀리초)입니다. |
| error |
작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다. |
|
| id |
integer (int32) |
활동 레코드의 ID입니다. |
| imageServing |
이 검색 활동의 이미지 서빙에 관한 통계 |
|
| indexedOneLakeArguments |
검색된 OneLake 논증 자료. |
|
| knowledgeSourceName |
string |
검색 활동에 대한 지식 소스입니다. |
| queryHintProcessing |
이 활동에 대한 쿼리 힌트에서 생성된 표현식에 대한 세부 정보입니다. |
|
| queryTime |
string (date-time) |
이 검색 활동에 대한 쿼리 시간입니다. |
| startedAt |
string (date-time) |
활동이 시작된 시간. |
| type |
string:
indexed |
활동 레코드의 유형입니다. |
| warning |
string |
경고 메시지는 활동 중 관찰된 문서 손실, 토큰 제한 절단, 타임아웃 조건 등 문서 손실 등 잠재적 구성 문제를 알리는 경고 메시지입니다. |
KnowledgeBaseIndexedOneLakeReference
색인화된 OneLake 문서 참조를 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| activitySource |
integer (int32) |
참조의 원본 활동 ID입니다. |
| citationUrl |
string (uri) |
이 참조의 뒷문서를 가리키는 검색 소유 URL로, 인용 대상으로 사용할 수 있습니다. |
| docUrl |
string |
참조에 대한 문서 URL입니다. |
| id |
string |
참조의 ID입니다. |
| rerankerScore |
number (float) |
문서 참조에 대한 순위 변경기 점수입니다. |
| searchSensitivityLabelInfo |
참조 자료의 민감도 라벨 정보입니다. |
|
| sourceData |
참고문헌의 원본 데이터입니다. |
|
| type |
string:
indexed |
참조의 유형입니다. |
KnowledgeBaseIndexedSharePointActivityArguments
인덱스된 SharePoint 검색 활동이 실행된 인수들을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| search |
string |
인덱스된 SharePoint 콘텐츠를 쿼리하는 데 사용된 검색 문자열입니다. |
KnowledgeBaseIndexedSharePointActivityRecord
인덱스된 SharePoint 검색 활동 기록을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| completedAt |
string (date-time) |
활동이 완료된 시간. |
| count |
integer (int32) |
순위 변경 임계값을 통과하기에 충분히 관련성이 있는 검색된 문서 수입니다. |
| elapsedMs |
integer (int32) |
검색 활동에 대한 경과 시간(밀리초)입니다. |
| error |
작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다. |
|
| id |
integer (int32) |
활동 레코드의 ID입니다. |
| imageServing |
이 검색 활동의 이미지 서빙에 관한 통계 |
|
| indexedSharePointArguments |
검색 활동에 대한 인덱스화된 SharePoint 논자입니다. |
|
| knowledgeSourceName |
string |
검색 활동에 대한 지식 소스입니다. |
| queryHintProcessing |
이 활동에 대한 쿼리 힌트에서 생성된 표현식에 대한 세부 정보입니다. |
|
| queryTime |
string (date-time) |
이 검색 활동에 대한 쿼리 시간입니다. |
| startedAt |
string (date-time) |
활동이 시작된 시간. |
| type |
string:
indexed |
활동 레코드의 유형입니다. |
| warning |
string |
경고 메시지는 활동 중 관찰된 문서 손실, 토큰 제한 절단, 타임아웃 조건 등 문서 손실 등 잠재적 구성 문제를 알리는 경고 메시지입니다. |
KnowledgeBaseIndexedSharePointReference
인덱스화된 SharePoint 문서 참조를 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| activitySource |
integer (int32) |
참조의 원본 활동 ID입니다. |
| citationUrl |
string (uri) |
이 참조의 뒷문서를 가리키는 검색 소유 URL로, 인용 대상으로 사용할 수 있습니다. |
| docUrl |
string |
참조에 대한 문서 URL입니다. |
| id |
string |
참조의 ID입니다. |
| rerankerScore |
number (float) |
문서 참조에 대한 순위 변경기 점수입니다. |
| searchSensitivityLabelInfo |
참조 자료의 민감도 라벨 정보입니다. |
|
| sourceData |
참고문헌의 원본 데이터입니다. |
|
| type |
string:
indexed |
참조의 유형입니다. |
KnowledgeBaseIndexedSqlActivityArguments
인덱스화된 SQL 검색 활동이 실행된 인자들을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| search |
string |
인덱스된 SQL 콘텐츠를 쿼리하는 데 사용되는 검색 문자열입니다. |
KnowledgeBaseIndexedSqlActivityRecord
인덱스화된 SQL 검색 활동 기록을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| completedAt |
string (date-time) |
활동이 완료된 시간. |
| count |
integer (int32) |
순위 변경 임계값을 통과하기에 충분히 관련성이 있는 검색된 문서 수입니다. |
| elapsedMs |
integer (int32) |
검색 활동에 대한 경과 시간(밀리초)입니다. |
| error |
작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다. |
|
| id |
integer (int32) |
활동 레코드의 ID입니다. |
| imageServing |
이 검색 활동의 이미지 서빙에 관한 통계 |
|
| indexedSqlArguments |
검색 활동에 대한 인덱스화된 SQL 인자입니다. |
|
| knowledgeSourceName |
string |
검색 활동에 대한 지식 소스입니다. |
| queryHintProcessing |
이 활동에 대한 쿼리 힌트에서 생성된 표현식에 대한 세부 정보입니다. |
|
| queryTime |
string (date-time) |
이 검색 활동에 대한 쿼리 시간입니다. |
| startedAt |
string (date-time) |
활동이 시작된 시간. |
| type |
string:
indexed |
활동 레코드의 유형입니다. |
| warning |
string |
경고 메시지는 활동 중 관찰된 문서 손실, 토큰 제한 절단, 타임아웃 조건 등 문서 손실 등 잠재적 구성 문제를 알리는 경고 메시지입니다. |
KnowledgeBaseIndexedSqlReference
Azure SQL 문서 참조를 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| activitySource |
integer (int32) |
참조의 원본 활동 ID입니다. |
| citationUrl |
string (uri) |
이 참조의 뒷문서를 가리키는 검색 소유 URL로, 인용 대상으로 사용할 수 있습니다. |
| docUrl |
string |
참조에 대한 문서 URL입니다. |
| id |
string |
참조의 ID입니다. |
| rerankerScore |
number (float) |
문서 참조에 대한 순위 변경기 점수입니다. |
| sourceData |
참고문헌의 원본 데이터입니다. |
|
| type |
string:
indexed |
참조의 유형입니다. |
KnowledgeBaseMcpServerActivityArguments
MCP 서버 검색 활동이 실행된 인수들을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| toolArguments |
인수들은 MCP 서버 도구로 전달되었습니다. |
|
| toolName |
string |
검색 활동에 사용된 MCP 서버 도구의 이름입니다. |
KnowledgeBaseMcpServerActivityRecord
MCP 서버 검색 활동 기록을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| completedAt |
string (date-time) |
활동이 완료된 시간. |
| count |
integer (int32) |
순위 변경 임계값을 통과하기에 충분히 관련성이 있는 검색된 문서 수입니다. |
| elapsedMs |
integer (int32) |
검색 활동에 대한 경과 시간(밀리초)입니다. |
| error |
작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다. |
|
| id |
integer (int32) |
활동 레코드의 ID입니다. |
| imageServing |
이 검색 활동의 이미지 서빙에 관한 통계 |
|
| knowledgeSourceName |
string |
검색 활동에 대한 지식 소스입니다. |
| mcpServerArguments |
MCP 서버가 검색 활동에 대해 인수합니다. |
|
| queryTime |
string (date-time) |
이 검색 활동에 대한 쿼리 시간입니다. |
| startedAt |
string (date-time) |
활동이 시작된 시간. |
| type |
string:
mcp |
활동 레코드의 유형입니다. |
| warning |
string |
경고 메시지는 활동 중 관찰된 문서 손실, 토큰 제한 절단, 타임아웃 조건 등 문서 손실 등 잠재적 구성 문제를 알리는 경고 메시지입니다. |
KnowledgeBaseMcpServerReference
MCP 서버 문서 참조를 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| activitySource |
integer (int32) |
참조의 원본 활동 ID입니다. |
| id |
string |
참조의 ID입니다. |
| rerankerScore |
number (float) |
문서 참조에 대한 순위 변경기 점수입니다. |
| sourceData |
참고문헌의 원본 데이터입니다. |
|
| title |
string |
MCP 서버 도구의 제목 결과. |
| toolName |
string |
참조를 생성한 MCP 서버 도구의 이름입니다. |
| type |
string:
mcp |
참조의 유형입니다. |
KnowledgeBaseMessage
자연어 메시지 스타일 개체입니다.
| Name | 형식 | Description |
|---|---|---|
| content | KnowledgeBaseMessageContent[]: |
메시지의 내용입니다. |
| role |
string |
도구 응답의 역할입니다. |
KnowledgeBaseMessageContentType
메시지 콘텐츠의 유형입니다.
| 값 | Description |
|---|---|
| text |
문자 메시지 콘텐츠 종류입니다. |
| image |
이미지 메시지 콘텐츠 종류입니다. |
KnowledgeBaseMessageImageContent
이미지 메시지 유형입니다.
| Name | 형식 | Description |
|---|---|---|
| image |
이미지 내용. |
|
| type |
string:
image |
메시지의 형식 |
KnowledgeBaseMessageTextContent
문자 메시지 유형.
| Name | 형식 | Description |
|---|---|---|
| text |
string |
텍스트 내용입니다. |
| type |
string:
text |
메시지의 형식 |
KnowledgeBaseModelAnswerSynthesisActivityRecord
LLM 답변 합성 활동 레코드를 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| completedAt |
string (date-time) |
활동이 완료된 시간. |
| elapsedMs |
integer (int32) |
검색 활동에 대한 경과 시간(밀리초)입니다. |
| error |
작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다. |
|
| id |
integer (int32) |
활동 레코드의 ID입니다. |
| inputTokens |
integer (int32) |
LLM 답변 합성 활동에 대한 입력 토큰 수입니다. |
| model |
LLM 답변 합성 활동에 사용된 모델입니다. |
|
| outputTokens |
integer (int32) |
LLM 답변 합성 활동에 대한 출력 토큰 수입니다. |
| startedAt |
string (date-time) |
활동이 시작된 시간. |
| type |
string:
model |
활동 레코드의 유형입니다. |
| warning |
string |
경고 메시지는 활동 중 관찰된 문서 손실, 토큰 제한 절단, 타임아웃 조건 등 문서 손실 등 잠재적 구성 문제를 알리는 경고 메시지입니다. |
KnowledgeBaseModelQueryPlanningActivityRecord
LLM 쿼리 계획 활동 레코드를 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| completedAt |
string (date-time) |
활동이 완료된 시간. |
| elapsedMs |
integer (int32) |
검색 활동에 대한 경과 시간(밀리초)입니다. |
| error |
작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다. |
|
| id |
integer (int32) |
활동 레코드의 ID입니다. |
| inputTokens |
integer (int32) |
LLM 쿼리 계획 활동에 대한 입력 토큰 수입니다. |
| model |
LLM 쿼리 계획 활동에 사용되는 모델입니다. |
|
| outputTokens |
integer (int32) |
LLM 쿼리 계획 활동에 대한 출력 토큰 수입니다. |
| startedAt |
string (date-time) |
활동이 시작된 시간. |
| type |
string:
model |
활동 레코드의 유형입니다. |
| warning |
string |
경고 메시지는 활동 중 관찰된 문서 손실, 토큰 제한 절단, 타임아웃 조건 등 문서 손실 등 잠재적 구성 문제를 알리는 경고 메시지입니다. |
KnowledgeBaseModelWebSummarizationActivityRecord
LLM 웹 요약 활동 기록을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| completedAt |
string (date-time) |
활동이 완료된 시간. |
| elapsedMs |
integer (int32) |
검색 활동에 대한 경과 시간(밀리초)입니다. |
| error |
작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다. |
|
| id |
integer (int32) |
활동 레코드의 ID입니다. |
| inputTokens |
integer (int32) |
LLM 웹 요약 활동의 입력 토큰 수. |
| model |
LLM 웹 요약 활동에 사용되는 모델입니다. |
|
| outputTokens |
integer (int32) |
LLM 웹 요약 활동의 출력 토큰 수. |
| startedAt |
string (date-time) |
활동이 시작된 시간. |
| type |
string:
model |
활동 레코드의 유형입니다. |
| warning |
string |
경고 메시지는 활동 중 관찰된 문서 손실, 토큰 제한 절단, 타임아웃 조건 등 문서 손실 등 잠재적 구성 문제를 알리는 경고 메시지입니다. |
KnowledgeBaseQueryHintProcessing
검색 활동에 대한 쿼리 힌트에서 생성된 표현식에 대한 세부 정보.
| Name | 형식 | Description |
|---|---|---|
| generatedBoost |
string |
이 활동에 대한 부스트 힌트에서 생성된 검색 조항입니다. |
| generatedFilter |
string |
이 활동에 대한 필터 힌트에서 생성된 필터 표현식입니다. |
KnowledgeBaseReferenceType
참조 형식입니다.
| 값 | Description |
|---|---|
| searchIndex |
문서 참고 색인을 검색하세요. |
| azureBlob |
Azure Blob document reference. |
| indexedSharePoint |
인덱스된 SharePoint 문서 참조. |
| indexedOneLake |
색인화된 OneLake 문서 참조. |
| web |
웹 문서 참조. |
| remoteSharePoint |
원격 SharePoint 문서 참조. |
| workIQ |
업무 IQ 문서 참조. |
| fabricDataAgent |
Fabric 데이터 에이전트 문서 참조. |
| fabricOntology |
Fabric Ontology 문서 참조. |
| mcpServer |
MCP 서버 문서 참조. |
| file |
파일 문서 참조. |
| indexedSql |
인덱스 SQL 문서 참조. |
KnowledgeBaseRemoteSharePointActivityArguments
원격 SharePoint 검색 활동이 실행된 인수들을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| filterExpressionAddOn |
string |
검색 활동을 위한 필터 표현식 애드온입니다. |
| search |
string |
원격 SharePoint 지식 소스를 쿼리하는 데 사용되는 검색 문자열입니다. |
KnowledgeBaseRemoteSharePointActivityRecord
원격 SharePoint 검색 활동 기록을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| completedAt |
string (date-time) |
활동이 완료된 시간. |
| count |
integer (int32) |
순위 변경 임계값을 통과하기에 충분히 관련성이 있는 검색된 문서 수입니다. |
| elapsedMs |
integer (int32) |
검색 활동에 대한 경과 시간(밀리초)입니다. |
| error |
작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다. |
|
| id |
integer (int32) |
활동 레코드의 ID입니다. |
| imageServing |
이 검색 활동의 이미지 서빙에 관한 통계 |
|
| knowledgeSourceName |
string |
검색 활동에 대한 지식 소스입니다. |
| queryTime |
string (date-time) |
이 검색 활동에 대한 쿼리 시간입니다. |
| remoteSharePointArguments |
원격 SharePoint 인수로 검색 활동에 대해 말이죠. |
|
| startedAt |
string (date-time) |
활동이 시작된 시간. |
| type |
string:
remote |
활동 레코드의 유형입니다. |
| warning |
string |
경고 메시지는 활동 중 관찰된 문서 손실, 토큰 제한 절단, 타임아웃 조건 등 문서 손실 등 잠재적 구성 문제를 알리는 경고 메시지입니다. |
KnowledgeBaseRemoteSharePointReference
원격 SharePoint 문서 참조를 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| activitySource |
integer (int32) |
참조의 원본 활동 ID입니다. |
| id |
string |
참조의 ID입니다. |
| rerankerScore |
number (float) |
문서 참조에 대한 순위 변경기 점수입니다. |
| searchSensitivityLabelInfo |
참조 자료의 민감도 라벨 정보입니다. |
|
| sourceData |
참고문헌의 원본 데이터입니다. |
|
| type |
string:
remote |
참조의 유형입니다. |
| webUrl |
string (uri) |
참조 데이터의 출처 URL입니다. |
KnowledgeBaseRetrievalRequest
검색 요청에 대한 입력 계약입니다.
| Name | 형식 | Description |
|---|---|---|
| includeActivity |
boolean |
검색 결과에 활동 정보가 포함되어야 함을 나타냅니다. |
| intents | KnowledgeRetrievalIntent[]: |
모델 쿼리 계획 없이 실행할 의도된 쿼리 목록입니다. |
| knowledgeSourceParams |
KnowledgeSourceParams[]:
|
지식 원본에 대한 런타임 매개 변수 목록입니다. |
| maxOutputDocuments |
integer (int32) |
출력에 포함된 최대 문서 수를 제한합니다. |
| maxOutputSize |
integer (int32) |
출력에 있는 콘텐츠의 최대 크기를 제한합니다. |
| maxOutputSizeInTokens |
integer (int32) |
출력에 있는 콘텐츠의 최대 크기를 제한합니다. |
| maxRuntimeInSeconds |
integer (int32) |
최대 런타임(초)입니다. |
| messages |
채팅 메시지 스타일 입력 목록입니다. |
|
| outputMode |
이 검색에 대한 출력 구성입니다. |
|
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
검색 추론 노력 구성. |
KnowledgeBaseRetrievalResponse
검색 응답에 대한 출력 계약입니다.
KnowledgeBaseSearchIndexActivityArguments
검색 인덱스 검색 활동이 실행된 인수를 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| filter |
string |
필터 문자열입니다. |
| queryType |
검색을 실행하는 데 사용된 쿼리 문법. 쿼리 힌트는 의미론적 쿼리가 전체 쿼리 문법을 사용하도록 유도할 수 있습니다. |
|
| search |
string |
검색 인덱스를 쿼리하는 데 사용되는 검색 문자열입니다. |
| searchFields |
어떤 필드를 검색했는지. |
|
| semanticConfigurationName |
string |
검색 인덱스에서 사용된 의미 구성은 무엇이었나요? |
| sourceDataFields |
검색을 위해 선택된 필드들. |
KnowledgeBaseSearchIndexActivityRecord
검색 인덱스 검색 활동 레코드를 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| completedAt |
string (date-time) |
활동이 완료된 시간. |
| count |
integer (int32) |
순위 변경 임계값을 통과하기에 충분히 관련성이 있는 검색된 문서 수입니다. |
| elapsedMs |
integer (int32) |
검색 활동에 대한 경과 시간(밀리초)입니다. |
| error |
작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다. |
|
| id |
integer (int32) |
활동 레코드의 ID입니다. |
| imageServing |
이 검색 활동의 이미지 서빙에 관한 통계 |
|
| knowledgeSourceName |
string |
검색 활동에 대한 지식 소스입니다. |
| queryHintProcessing |
이 활동에 대한 쿼리 힌트에서 생성된 표현식에 대한 세부 정보입니다. |
|
| queryTime |
string (date-time) |
이 검색 활동에 대한 쿼리 시간입니다. |
| searchIndexArguments |
검색 활동에 대한 검색 인덱스 인수입니다. |
|
| startedAt |
string (date-time) |
활동이 시작된 시간. |
| type |
string:
search |
활동 레코드의 유형입니다. |
| warning |
string |
경고 메시지는 활동 중 관찰된 문서 손실, 토큰 제한 절단, 타임아웃 조건 등 문서 손실 등 잠재적 구성 문제를 알리는 경고 메시지입니다. |
KnowledgeBaseSearchIndexReference
Azure 검색 문서 참조를 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| activitySource |
integer (int32) |
참조의 원본 활동 ID입니다. |
| citationUrl |
string (uri) |
이 참조의 뒷문서를 가리키는 검색 소유 URL로, 인용 대상으로 사용할 수 있습니다. |
| docKey |
string |
참조에 대한 문서 키입니다. |
| id |
string |
참조의 ID입니다. |
| rerankerScore |
number (float) |
문서 참조에 대한 순위 변경기 점수입니다. |
| searchSensitivityLabelInfo |
참조 자료의 민감도 라벨 정보입니다. |
|
| sourceData |
참고문헌의 원본 데이터입니다. |
|
| type |
string:
search |
참조의 유형입니다. |
KnowledgeBaseWebActivityArguments
웹 검색 활동이 실행된 논증들을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| count |
integer (int32) |
반환된 웹 결과 수. |
| freshness |
string |
회수 활동을 위한 신선함. |
| language |
string |
검색 활동의 언어. |
| market |
string |
회수 활동 시장. |
| search |
string |
웹에 검색하는 데 사용되는 검색어입니다. |
KnowledgeBaseWebActivityRecord
웹 검색 활동 기록을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| completedAt |
string (date-time) |
활동이 완료된 시간. |
| count |
integer (int32) |
순위 변경 임계값을 통과하기에 충분히 관련성이 있는 검색된 문서 수입니다. |
| elapsedMs |
integer (int32) |
검색 활동에 대한 경과 시간(밀리초)입니다. |
| error |
작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다. |
|
| id |
integer (int32) |
활동 레코드의 ID입니다. |
| imageServing |
이 검색 활동의 이미지 서빙에 관한 통계 |
|
| knowledgeSourceName |
string |
검색 활동에 대한 지식 소스입니다. |
| queryTime |
string (date-time) |
이 검색 활동에 대한 쿼리 시간입니다. |
| startedAt |
string (date-time) |
활동이 시작된 시간. |
| type |
string:
web |
활동 레코드의 유형입니다. |
| warning |
string |
경고 메시지는 활동 중 관찰된 문서 손실, 토큰 제한 절단, 타임아웃 조건 등 문서 손실 등 잠재적 구성 문제를 알리는 경고 메시지입니다. |
| webArguments |
검색 활동에 대한 웹 논거. |
KnowledgeBaseWebReference
웹 문서 참조를 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| activitySource |
integer (int32) |
참조의 원본 활동 ID입니다. |
| id |
string |
참조의 ID입니다. |
| rerankerScore |
number (float) |
문서 참조에 대한 순위 변경기 점수입니다. |
| sourceData |
참고문헌의 원본 데이터입니다. |
|
| title |
string |
웹 문서의 제목입니다. |
| type |
string:
web |
참조의 유형입니다. |
| url |
string (uri) |
참조 데이터의 출처 URL입니다. |
KnowledgeBaseWorkIQActivityArguments
WorkIQ 검색 활동이 실행된 논수들을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| search |
string |
WorkIQ 지식 소스를 쿼리하는 데 사용된 검색 문자열입니다. |
KnowledgeBaseWorkIQActivityRecord
WorkIQ 검색 활동 기록을 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| completedAt |
string (date-time) |
활동이 완료된 시간. |
| count |
integer (int32) |
순위 변경 임계값을 통과하기에 충분히 관련성이 있는 검색된 문서 수입니다. |
| elapsedMs |
integer (int32) |
검색 활동에 대한 경과 시간(밀리초)입니다. |
| error |
작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다. |
|
| id |
integer (int32) |
활동 레코드의 ID입니다. |
| imageServing |
이 검색 활동의 이미지 서빙에 관한 통계 |
|
| knowledgeSourceName |
string |
검색 활동에 대한 지식 소스입니다. |
| queryTime |
string (date-time) |
이 검색 활동에 대한 쿼리 시간입니다. |
| startedAt |
string (date-time) |
활동이 시작된 시간. |
| type |
string:
workIQ |
활동 레코드의 유형입니다. |
| warning |
string |
경고 메시지는 활동 중 관찰된 문서 손실, 토큰 제한 절단, 타임아웃 조건 등 문서 손실 등 잠재적 구성 문제를 알리는 경고 메시지입니다. |
| workIQArguments |
WorkIQ가 검색(retrieval) 활동에 대한 논증입니다. |
KnowledgeBaseWorkIQReference
WorkIQ 문서 참조를 나타냅니다.
| Name | 형식 | Description |
|---|---|---|
| activitySource |
integer (int32) |
참조의 원본 활동 ID입니다. |
| id |
string |
참조의 ID입니다. |
| rerankerScore |
number (float) |
문서 참조에 대한 순위 변경기 점수입니다. |
| searchSensitivityLabelInfo |
참조 자료의 민감도 라벨 정보입니다. |
|
| sourceData |
참고문헌의 원본 데이터입니다. |
|
| type |
string:
workIQ |
참조의 유형입니다. |
KnowledgeRetrievalAutoReasoningEffort
검색 시 자동으로 추론 노력을 선택하세요. 서비스는 모든 요청을 가장 저렴한 티어에서 시딩하고, 필요한 만큼만 서비스 최대 이용 가능한 티어까지 에스컬레이션합니다.
| Name | 형식 | Description |
|---|---|---|
| kind |
string:
auto |
추론 노력의 종류입니다. |
KnowledgeRetrievalIntentType
사용할 기술 자료 구성의 종류입니다.
| 값 | Description |
|---|---|
| semantic |
자연어 의미 체계 쿼리 의도입니다. |
KnowledgeRetrievalLowReasoningEffort
낮은 추론 노력으로 지식 검색을 실행합니다.
| Name | 형식 | Description |
|---|---|---|
| kind |
string:
low |
추론 노력의 종류입니다. |
KnowledgeRetrievalMediumReasoningEffort
중간 추론 노력으로 지식 검색을 실행합니다.
| Name | 형식 | Description |
|---|---|---|
| kind |
string:
medium |
추론 노력의 종류입니다. |
KnowledgeRetrievalMinimalReasoningEffort
최소한의 추론 노력으로 지식 검색을 실행합니다.
| Name | 형식 | Description |
|---|---|---|
| kind |
string:
minimal |
추론 노력의 종류입니다. |
KnowledgeRetrievalOutputMode
이 검색에 대한 출력 구성입니다.
| 값 | Description |
|---|---|
| extractiveData |
생성적 변경 없이 지식 소스에서 직접 데이터를 반환합니다. |
| answerSynthesis |
응답 페이로드에 대한 답변을 합성합니다. |
KnowledgeRetrievalReasoningEffortKind
검색 중에 사용할 작업량입니다.
| 값 | Description |
|---|---|
| minimal |
원본 선택, 쿼리 계획 또는 반복 검색을 수행하지 않습니다. |
| low |
검색 중에 낮은 추론을 사용합니다. |
| medium |
검색하는 동안 적당한 양의 추론을 사용하십시오. |
| auto |
검색 시 자동으로 추론 노력을 선택하며, 가장 저렴한 단계에서만 필요한 만큼만 점차 상승시킵니다. |
KnowledgeRetrievalSemanticIntent
의미론적 쿼리 의도입니다.
| Name | 형식 | Description |
|---|---|---|
| search |
string |
실행할 의미 체계 쿼리 |
| type |
string:
semantic |
의도의 유형입니다. |
KnowledgeSourceKind
지식 소스의 종류.
| 값 | Description |
|---|---|
| searchIndex |
검색 인덱스에서 데이터를 읽는 지식 소스입니다. |
| azureBlob |
Azure Blob Storage에서 검색 인덱스로 데이터를 읽고 수집하는 기술 자료입니다. |
| indexedSharePoint |
인덱스된 SharePoint에서 데이터를 읽는 지식 소스입니다. |
| indexedOneLake |
색인화된 OneLake에서 데이터를 읽는 지식 소스입니다. |
| indexedSql |
Azure SQL Database 또는 SQL Managed Instance에서 데이터를 검색 인덱스로 가져오고 인징하는 지식 소스입니다. |
| web |
웹에서 데이터를 읽는 지식 소스입니다. |
| remoteSharePoint |
원격 SharePoint에서 데이터를 읽는 지식 소스입니다. |
| workIQ |
Work IQ에서 데이터를 읽어내는 지식 소스 |
| file |
직접 파일 업로드와 인덱싱을 지원하는 지식 소스입니다. |
| mcpServer |
MCP(모델 컨텍스트 프로토콜) 서버가 지원하는 지식 소스입니다. |
| fabricDataAgent |
이는 Fabric 데이터 에이전트에서 데이터를 가져오는 지식 소스입니다. |
| fabricOntology |
Microsoft Fabric 온톨로지 온톨로지에서 데이터를 가져오는 지식 소스입니다. |
KnowledgeSourceResultsProcessing
지식 소스의 결과가 재순위화되는지 여부를 통제합니다.
| 값 | Description |
|---|---|
| rerank |
이 지식 소스의 결과는 재순위 파이프라인을 거칩니다. 기본 동작입니다. |
| none |
이 지식 소스의 결과는 재순위를 거치지 않고 기본 순서를 유지합니다. |
McpServerKnowledgeSourceParams
MCP 서버 지식 소스의 런타임 매개변수를 명시합니다
| Name | 형식 | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다. |
| enableImageServing |
boolean |
이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다. |
| failOnError |
boolean |
이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다. |
| includeReferenceSourceData |
boolean |
참조가 검색 중에 얻은 구조화된 데이터를 페이로드에 포함해야 하는지 여부를 나타냅니다. |
| includeReferences |
boolean |
이 원본에서 검색된 데이터에 대해 참조를 포함해야 하는지 여부를 나타냅니다. |
| kind |
string:
mcp |
지식 소스의 유형입니다. |
| knowledgeSourceName |
string |
매개 변수가 적용되는 인덱스의 이름입니다. |
| maxOutputDocuments |
integer (int32) |
이 지식 출처에서 반환되는 문서 최대 수를 제한합니다. |
| neverQuerySource |
boolean |
이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다. |
| rerankerThreshold |
number (float) |
검색된 모든 문서가 응답에 포함되기 위해 충족해야 하는 순위 조정 임계값입니다. |
| resultsProcessing |
이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다. |
PurviewSensitivityLabelInfo
문서에 적용되는 민감도 라벨에 관한 정보
| Name | 형식 | Description |
|---|---|---|
| color |
string |
구성된 경우 레이블에 대해 UI가 표시해야 하는 색입니다. |
| displayName |
string |
민감도 레이블의 표시 이름입니다. |
| isEncrypted |
boolean |
민감도 레이블이 암호화를 적용하는지 여부를 나타냅니다. |
| priority |
integer (int32) |
민감도 레이블이 적용되는 우선 순위입니다. |
| sensitivityLabelId |
string |
민감도 라벨의 ID입니다. |
| toolTip |
string |
UI의 레이블에 대해 표시해야 하는 도구 설명입니다. |
QueryType
검색 쿼리의 구문을 지정합니다. 기본값은 'simple'입니다. 쿼리에서 Lucene 쿼리 구문을 사용하는 경우 'full'을 사용하고 쿼리 구문이 필요하지 않은 경우 'semantic'을 사용합니다.
| 값 | Description |
|---|---|
| simple |
검색에 간단한 쿼리 구문을 사용합니다. 검색 텍스트는 +, * 및 ""와 같은 기호를 허용하는 간단한 쿼리 언어를 사용하여 해석됩니다. 쿼리는 기본적으로 searchFields 매개 변수를 지정하지 않는 한 검색 가능한 모든 필드에서 평가됩니다. |
| full |
검색에 전체 Lucene 쿼리 구문을 사용합니다. 검색 텍스트는 필드별 및 가중치 검색과 기타 고급 기능을 허용하는 Lucene 쿼리 언어를 사용하여 해석됩니다. |
| semantic |
키워드가 아닌 자연어로 표현된 쿼리에 가장 적합합니다. 웹 말뭉치에서 학습된 순위 모델을 사용하여 상위 검색 결과의 순위를 다시 지정하여 검색 결과의 정밀도를 향상시킵니다. |
RemoteSharePointKnowledgeSourceParams
원격 SharePoint 기술 자료 원본에 대한 런타임 매개 변수를 지정합니다.
| Name | 형식 | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다. |
| enableImageServing |
boolean |
이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다. |
| failOnError |
boolean |
이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다. |
| filterExpressionAddOn |
string |
SharePoint 데이터 원본에 적용되는 필터 조건입니다. 키워드 쿼리 언어 구문에 지정해야 합니다. 지식 소스 정의에 지정된 필터 식과 함께 결합됩니다. |
| includeReferenceSourceData |
boolean |
참조가 검색 중에 얻은 구조화된 데이터를 페이로드에 포함해야 하는지 여부를 나타냅니다. |
| includeReferences |
boolean |
이 원본에서 검색된 데이터에 대해 참조를 포함해야 하는지 여부를 나타냅니다. |
| kind |
string:
remote |
지식 소스의 유형입니다. |
| knowledgeSourceName |
string |
매개 변수가 적용되는 인덱스의 이름입니다. |
| maxOutputDocuments |
integer (int32) |
이 지식 출처에서 반환되는 문서 최대 수를 제한합니다. |
| neverQuerySource |
boolean |
이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다. |
| rerankerThreshold |
number (float) |
검색된 모든 문서가 응답에 포함되기 위해 충족해야 하는 순위 조정 임계값입니다. |
| resultsProcessing |
이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다. |
SearchIndexFieldReference
검색 색인을 위한 필드 참조.
| Name | 형식 | Description |
|---|---|---|
| name |
string |
@FSHO2@필드의 이름입니다. |
SearchIndexKnowledgeSourceBoostKind
검색 지수 지식 소스에 대한 부스트 팁 같은 것.
| 값 | Description |
|---|---|
| fieldValue |
필드 값을 기반으로 문서를 부스트하세요. |
| multiWordExpression |
여러 단어 표현식을 기반으로 문서를 강화하세요. |
SearchIndexKnowledgeSourceFieldValueBoost
필드 값에 따라 문서를 강화하는 힌트입니다.
| Name | 형식 | Description |
|---|---|---|
| boost |
number (double) |
문서 점수의 배수입니다. 1.0과 같지 않은 양수여야 합니다. |
| boostInstructions |
string |
부스트를 언제 어떻게 적용해야 하는지 설명하는 자연어 지침. |
| field |
string minLength: 1 |
검색 인덱스 필드의 이름입니다. |
| fieldValues |
string[] |
필드의 대표 값. |
| kind |
string:
field |
그런 종류의 부스트 힌트. |
SearchIndexKnowledgeSourceFilterHint
필드를 식별하는 힌트와 쿼리 플래너가 필터를 구성할 때 사용할 수 있는 대표 값입니다.
| Name | 형식 | Description |
|---|---|---|
| field |
string minLength: 1 |
필터링 가능한 검색 인덱스 필드의 이름입니다. |
| fieldValues |
string[] |
필드의 대표 값. |
| filterInstructions |
string |
필드에서 언제 어떻게 필터링할지 설명하는 자연어 지침. |
SearchIndexKnowledgeSourceMultiWordExpressionBoost
여러 단어 표현을 기반으로 문서를 강화하는 힌트입니다.
| Name | 형식 | Description |
|---|---|---|
| boost |
number (double) |
문서 점수의 배수입니다. 1.0과 같지 않은 양수여야 합니다. |
| boostInstructions |
string |
부스트를 언제 어떻게 적용해야 하는지 설명하는 자연어 지침. |
| fieldValues |
string[] |
부스트의 대표 값입니다. |
| kind |
string:
multi |
그런 종류의 부스트 힌트. |
SearchIndexKnowledgeSourceParams
검색 인덱스 지식 원본에 대한 런타임 매개 변수를 지정합니다.
| Name | 형식 | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다. |
| enableImageServing |
boolean |
이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다. |
| failOnError |
boolean |
이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다. |
| filterAddOn |
string |
인덱스에 적용된 필터 조건(예: 'State eq VA'). |
| includeReferenceSourceData |
boolean |
참조가 검색 중에 얻은 구조화된 데이터를 페이로드에 포함해야 하는지 여부를 나타냅니다. |
| includeReferences |
boolean |
이 원본에서 검색된 데이터에 대해 참조를 포함해야 하는지 여부를 나타냅니다. |
| kind |
string:
search |
지식 소스의 유형입니다. |
| knowledgeSourceName |
string |
매개 변수가 적용되는 인덱스의 이름입니다. |
| maxOutputDocuments |
integer (int32) |
이 지식 출처에서 반환되는 문서 최대 수를 제한합니다. |
| neverQuerySource |
boolean |
이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다. |
| queryHintOverrides |
쿼리 계획을 유용한 필터와 부스트로 안내하는 힌트들. 명시되어 있을 경우, 이 객체는 지식 소스에 설정된 전체 쿼리 힌트 세트를 대체합니다. |
|
| rerankerThreshold |
number (float) |
검색된 모든 문서가 응답에 포함되기 위해 충족해야 하는 순위 조정 임계값입니다. |
| resultsProcessing |
이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다. |
SearchIndexKnowledgeSourceQueryHints
검색 색인 지식 소스를 위한 유용한 필터와 향상을 위한 쿼리 계획을 안내하는 힌트들.
| Name | 형식 | Description |
|---|---|---|
| boosts | SearchIndexKnowledgeSourceBoost[]: |
쿼리 플래너가 문서 순위에 영향을 줄 수 있는 조건을 식별하는 힌트를 강화하세요. |
| filters |
쿼리 플래너가 필터를 구성할 때 사용할 수 있는 필드와 대표 값을 식별하는 필터 힌트. |
ServedImage
회수 활동 중 모델이 선택한 단일 이미지를 설명합니다.
| Name | 형식 | Description |
|---|---|---|
| imageId |
string |
Content Understanding Enrichment에서 추출한 이미지 라벨. 원본 문서의 숫자 번호와 일치합니다. |
| imagePath |
string |
에셋 스토어 내에서 이미지와의 상대적 경로입니다. |
| sizeBytes |
integer (int64) |
이 이미지의 바이트 크기 (모델에 전송됨). |
WebKnowledgeSourceParams
웹 지식 원본에 대한 런타임 매개 변수를 지정합니다
| Name | 형식 | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다. |
| count |
integer (int32) |
반환할 웹 결과의 수입니다. |
| enableImageServing |
boolean |
이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다. |
| failOnError |
boolean |
이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다. |
| freshness |
string |
웹 결과의 신선함. |
| includeReferenceSourceData |
boolean |
참조가 검색 중에 얻은 구조화된 데이터를 페이로드에 포함해야 하는지 여부를 나타냅니다. |
| includeReferences |
boolean |
이 원본에서 검색된 데이터에 대해 참조를 포함해야 하는지 여부를 나타냅니다. |
| kind |
string:
web |
지식 소스의 유형입니다. |
| knowledgeSourceName |
string |
매개 변수가 적용되는 인덱스의 이름입니다. |
| language |
string |
웹 결과의 언어입니다. |
| market |
string |
웹 결과의 시장. |
| maxOutputDocuments |
integer (int32) |
이 지식 출처에서 반환되는 문서 최대 수를 제한합니다. |
| neverQuerySource |
boolean |
이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다. |
| rerankerThreshold |
number (float) |
검색된 모든 문서가 응답에 포함되기 위해 충족해야 하는 순위 조정 임계값입니다. |
| resultsProcessing |
이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다. |
WorkIQKnowledgeSourceParams
WorkIQ 지식 소스의 런타임 매개변수를 지정합니다
| Name | 형식 | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다. |
| enableImageServing |
boolean |
이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다. |
| failOnError |
boolean |
이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다. |
| includeReferenceSourceData |
boolean |
참조가 검색 중에 얻은 구조화된 데이터를 페이로드에 포함해야 하는지 여부를 나타냅니다. |
| includeReferences |
boolean |
이 원본에서 검색된 데이터에 대해 참조를 포함해야 하는지 여부를 나타냅니다. |
| kind |
string:
workIQ |
지식 소스의 유형입니다. |
| knowledgeSourceName |
string |
매개 변수가 적용되는 인덱스의 이름입니다. |
| maxOutputDocuments |
integer (int32) |
이 지식 출처에서 반환되는 문서 최대 수를 제한합니다. |
| neverQuerySource |
boolean |
이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다. |
| rerankerThreshold |
number (float) |
검색된 모든 문서가 응답에 포함되기 위해 충족해야 하는 순위 조정 임계값입니다. |
| resultsProcessing |
이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다. |