Knowledge Retrieval - Retrieve

서비스:
Search Service
API 버전:
2026-04-01

기술 자료는 백업 저장소에서 관련 데이터를 검색합니다.

POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?api-version=2026-04-01

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
endpoint
 path True

string (uri)

검색 서비스의 엔드포인트 URL입니다.
knowledgeBaseName
 path True

string

기술 자료의 이름.
api-version
 query True

string

minLength: 1

이 작업에 사용할 API 버전입니다.

요청 헤더

Name 필수 형식 Description
Accept

Accept

Accept 헤더입니다.
x-ms-client-request-id

string (uuid)

요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

요청 본문

Name 형식 Description
includeActivity

boolean

검색 결과에 활동 정보가 포함되어야 함을 나타냅니다.
intents KnowledgeRetrievalIntent[]:

KnowledgeRetrievalSemanticIntent[]

모델 쿼리 계획 없이 실행할 의도된 쿼리 목록입니다.
knowledgeSourceParams KnowledgeSourceParams[]:

지식 원본에 대한 런타임 매개 변수 목록입니다.
maxOutputSizeInTokens

integer (int32)

출력에 있는 콘텐츠의 최대 크기를 제한합니다.
maxRuntimeInSeconds

integer (int32)

최대 런타임(초)입니다.

응답

Name 형식 Description
200 OK

KnowledgeBaseRetrievalResponse

성공적인 회수 반응.
Other Status Codes

KnowledgeBaseRetrievalResponse

부분 검색 반응.
Other Status Codes

ErrorResponse

예기치 않은 오류 응답입니다.

보안

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

예제

KnowledgeBaseRetrieve
KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieve

샘플 요청

POST https://exampleservice.search.windows.net/knowledgebases('base-example-index')/retrieve?api-version=2026-04-01


{
  "maxRuntimeInSeconds": 60,
  "maxOutputSizeInTokens": 100000,
  "includeActivity": true,
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-example-index",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex"
    }
  ]
}

샘플 응답

상태 코드:
200 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}
상태 코드:
206 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "web",
      "id": 2,
      "knowledgeSourceName": "ks-preview-web",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 10,
      "elapsedMs": 2345,
      "error": {
        "code": "403",
        "message": "The error message",
        "details": [],
        "additionalInfo": [
          {
            "type": "SomeErrorType",
            "info": {
              "someProperty": "Some value"
            }
          }
        ]
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

KnowledgeBaseRetrieveWithIntents

샘플 요청

POST https://exampleservice.search.windows.net/knowledgebases('base-example-index')/retrieve?api-version=2026-04-01


{
  "intents": [
    {
      "search": "foo",
      "type": "semantic"
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSizeInTokens": 100000,
  "includeActivity": true,
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-example-index",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex"
    }
  ]
}

샘플 응답

상태 코드:
200 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "reasoningTokens": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}
상태 코드:
206 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "web",
      "id": 1,
      "knowledgeSourceName": "ks-preview-web",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 10,
      "elapsedMs": 2345,
      "error": {
        "code": "403",
        "message": "The error message",
        "details": [],
        "additionalInfo": [
          {
            "type": "SomeErrorType",
            "info": {
              "someProperty": "Some value"
            }
          }
        ]
      }
    },
    {
      "type": "agenticReasoning",
      "id": 2,
      "reasoningTokens": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

정의

Name Description
Accept

Accept 헤더입니다.
AzureBlobKnowledgeSourceParams

Azure Blob 지식 원본에 대한 런타임 매개 변수를 지정합니다.
ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.
ErrorDetail

오류 세부 정보입니다.
ErrorResponse

실패한 작업에 대한 오류 세부 정보를 반환하는 모든 Azure Resource Manager API에 대한 일반적인 오류 응답입니다. 또한 OData 오류 응답 형식을 따릅니다.
IndexedOneLakeKnowledgeSourceParams

인덱싱된 OneLake 기술 자료 원본에 대한 런타임 매개 변수를 지정합니다.
KnowledgeBaseActivityRecordType

활동 기록의 유형.
KnowledgeBaseAgenticReasoningActivityRecord

에이전트 추론 활동 레코드를 나타냅니다.
KnowledgeBaseAzureBlobActivityArguments

Azure Blob 검색 작업이 실행된 인수를 나타냅니다.
KnowledgeBaseAzureBlobActivityRecord

Azure Blob 검색 활동 레코드를 나타냅니다.
KnowledgeBaseAzureBlobReference

Azure Blob Storage 문서 참조를 나타냅니다.
KnowledgeBaseErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.
KnowledgeBaseErrorDetail

오류 세부 정보입니다.
KnowledgeBaseImageContent

이미지 내용.
KnowledgeBaseIndexedOneLakeActivityArguments

인덱스된 OneLake 검색 활동이 실행된 인수들을 나타냅니다.
KnowledgeBaseIndexedOneLakeActivityRecord

인덱스된 OneLake 검색 활동 기록을 나타냅니다.
KnowledgeBaseIndexedOneLakeReference

색인화된 OneLake 문서 참조를 나타냅니다.
KnowledgeBaseMessage

자연어 메시지 스타일 개체입니다.
KnowledgeBaseMessageContentType

메시지 콘텐츠의 유형입니다.
KnowledgeBaseMessageImageContent

이미지 메시지 유형입니다.
KnowledgeBaseMessageTextContent

문자 메시지 유형.
KnowledgeBaseModelWebSummarizationActivityRecord

LLM 웹 요약 활동 기록을 나타냅니다.
KnowledgeBaseReferenceType

참조 형식입니다.
KnowledgeBaseRetrievalRequest

검색 요청에 대한 입력 계약입니다.
KnowledgeBaseRetrievalResponse

검색 응답에 대한 출력 계약입니다.
KnowledgeBaseSearchIndexActivityArguments

검색 인덱스 검색 활동이 실행된 인수를 나타냅니다.
KnowledgeBaseSearchIndexActivityRecord

검색 인덱스 검색 활동 레코드를 나타냅니다.
KnowledgeBaseSearchIndexReference

Azure 검색 문서 참조를 나타냅니다.
KnowledgeBaseWebActivityArguments

웹 검색 활동이 실행된 논증들을 나타냅니다.
KnowledgeBaseWebActivityRecord

웹 검색 활동 기록을 나타냅니다.
KnowledgeBaseWebReference

웹 문서 참조를 나타냅니다.
KnowledgeRetrievalIntentType

사용할 기술 자료 구성의 종류입니다.
KnowledgeRetrievalMinimalReasoningEffort

최소한의 추론 노력으로 지식 검색을 실행합니다.
KnowledgeRetrievalReasoningEffortKind

검색 중에 사용할 작업량입니다.
KnowledgeRetrievalSemanticIntent

의미론적 쿼리 의도입니다.
KnowledgeSourceKind

지식 소스의 종류.
SearchIndexFieldReference

검색 색인을 위한 필드 참조.
SearchIndexKnowledgeSourceParams

검색 인덱스 지식 원본에 대한 런타임 매개 변수를 지정합니다.
WebKnowledgeSourceParams

웹 지식 원본에 대한 런타임 매개 변수를 지정합니다

Accept

열거형

Accept 헤더입니다.

값 Description
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

Object

Azure Blob 지식 원본에 대한 런타임 매개 변수를 지정합니다.

Name 형식 Description
includeReferenceSourceData

boolean

참조가 검색 중에 얻은 구조화된 데이터를 페이로드에 포함해야 하는지 여부를 나타냅니다.
includeReferences

boolean

이 원본에서 검색된 데이터에 대해 참조를 포함해야 하는지 여부를 나타냅니다.
kind string:

azureBlob

지식 소스의 유형입니다.
knowledgeSourceName

string

매개 변수가 적용되는 인덱스의 이름입니다.
rerankerThreshold

number (float)

검색된 모든 문서가 응답에 포함되기 위해 충족해야 하는 순위 조정 임계값입니다.

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name 형식 Description
info

추가 정보.
type

string

추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name 형식 Description
additionalInfo

ErrorAdditionalInfo[]

오류 추가 정보입니다.
code

string

오류 코드입니다.
details

ErrorDetail[]

오류 세부 정보입니다.
message

string

오류 메시지입니다.
target

string

오류 대상입니다.

ErrorResponse

Object

실패한 작업에 대한 오류 세부 정보를 반환하는 모든 Azure Resource Manager API에 대한 일반적인 오류 응답입니다. 또한 OData 오류 응답 형식을 따릅니다.

Name 형식 Description
error

ErrorDetail

오류 개체입니다.

IndexedOneLakeKnowledgeSourceParams

Object

인덱싱된 OneLake 기술 자료 원본에 대한 런타임 매개 변수를 지정합니다.

Name 형식 Description
includeReferenceSourceData

boolean

참조가 검색 중에 얻은 구조화된 데이터를 페이로드에 포함해야 하는지 여부를 나타냅니다.
includeReferences

boolean

이 원본에서 검색된 데이터에 대해 참조를 포함해야 하는지 여부를 나타냅니다.
kind string:

indexedOneLake

지식 소스의 유형입니다.
knowledgeSourceName

string

매개 변수가 적용되는 인덱스의 이름입니다.
rerankerThreshold

number (float)

검색된 모든 문서가 응답에 포함되기 위해 충족해야 하는 순위 조정 임계값입니다.

KnowledgeBaseActivityRecordType

열거형

활동 기록의 유형.

값 Description
searchIndex

인덱스 검색 활동.
azureBlob

Azure Blob retrieval activity.
indexedOneLake

인덱스된 OneLake 검색 활동.
web

웹 검색 활동.
modelWebSummarization

LLM 웹 요약 활동.
agenticReasoning

행위적 추론 활동.

KnowledgeBaseAgenticReasoningActivityRecord

Object

에이전트 추론 활동 레코드를 나타냅니다.

Name 형식 Description
elapsedMs

integer (int32)

검색 활동에 대한 경과 시간(밀리초)입니다.
error

KnowledgeBaseErrorDetail

작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다.
id

integer (int32)

활동 레코드의 ID입니다.
reasoningTokens

integer (int32)

에이전트 추론을 위한 입력 토큰의 수입니다.
retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

KnowledgeRetrievalMinimalReasoningEffort

검색 추론 노력 구성.
type string:

agenticReasoning

활동 레코드의 유형입니다.

KnowledgeBaseAzureBlobActivityArguments

Object

Azure Blob 검색 작업이 실행된 인수를 나타냅니다.

Name 형식 Description
search

string

Blob 콘텐츠를 쿼리하는 데 사용되는 검색 문자열입니다.

KnowledgeBaseAzureBlobActivityRecord

Object

Azure Blob 검색 활동 레코드를 나타냅니다.

Name 형식 Description
azureBlobArguments

KnowledgeBaseAzureBlobActivityArguments

검색 작업에 대한 azure blob 인수입니다.
count

integer (int32)

순위 변경 임계값을 통과하기에 충분히 관련성이 있는 검색된 문서 수입니다.
elapsedMs

integer (int32)

검색 활동에 대한 경과 시간(밀리초)입니다.
error

KnowledgeBaseErrorDetail

작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다.
id

integer (int32)

활동 레코드의 ID입니다.
knowledgeSourceName

string

검색 활동에 대한 지식 소스입니다.
queryTime

string (date-time)

이 검색 활동에 대한 쿼리 시간입니다.
type string:

azureBlob

활동 레코드의 유형입니다.

KnowledgeBaseAzureBlobReference

Object

Azure Blob Storage 문서 참조를 나타냅니다.

Name 형식 Description
activitySource

integer (int32)

참조의 원본 활동 ID입니다.
blobUrl

string

참조에 대한 Blob URL입니다.
id

string

참조의 ID입니다.
rerankerScore

number (float)

문서 참조에 대한 순위 변경기 점수입니다.
sourceData

참고문헌의 원본 데이터입니다.
type string:

azureBlob

참조의 유형입니다.

KnowledgeBaseErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name 형식 Description
info

추가 정보.
type

string

추가 정보 유형입니다.

KnowledgeBaseErrorDetail

Object

오류 세부 정보입니다.

Name 형식 Description
additionalInfo

KnowledgeBaseErrorAdditionalInfo[]

오류 추가 정보입니다.
code

string

오류 코드입니다.
details

KnowledgeBaseErrorDetail[]

오류 세부 정보입니다.
message

string

오류 메시지입니다.
target

string

오류 대상입니다.

KnowledgeBaseImageContent

Object

이미지 내용.

Name 형식 Description
url

string (uri)

이미지의 URL입니다.

KnowledgeBaseIndexedOneLakeActivityArguments

Object

인덱스된 OneLake 검색 활동이 실행된 인수들을 나타냅니다.

Name 형식 Description
search

string

OneLake 콘텐츠의 색인화된 내용을 쿼리하는 데 사용되는 검색 문자열입니다.

KnowledgeBaseIndexedOneLakeActivityRecord

Object

인덱스된 OneLake 검색 활동 기록을 나타냅니다.

Name 형식 Description
count

integer (int32)

순위 변경 임계값을 통과하기에 충분히 관련성이 있는 검색된 문서 수입니다.
elapsedMs

integer (int32)

검색 활동에 대한 경과 시간(밀리초)입니다.
error

KnowledgeBaseErrorDetail

작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다.
id

integer (int32)

활동 레코드의 ID입니다.
indexedOneLakeArguments

KnowledgeBaseIndexedOneLakeActivityArguments

검색된 OneLake 논증 자료.
knowledgeSourceName

string

검색 활동에 대한 지식 소스입니다.
queryTime

string (date-time)

이 검색 활동에 대한 쿼리 시간입니다.
type string:

indexedOneLake

활동 레코드의 유형입니다.

KnowledgeBaseIndexedOneLakeReference

Object

색인화된 OneLake 문서 참조를 나타냅니다.

Name 형식 Description
activitySource

integer (int32)

참조의 원본 활동 ID입니다.
docUrl

string

참조에 대한 문서 URL입니다.
id

string

참조의 ID입니다.
rerankerScore

number (float)

문서 참조에 대한 순위 변경기 점수입니다.
sourceData

참고문헌의 원본 데이터입니다.
type string:

indexedOneLake

참조의 유형입니다.

KnowledgeBaseMessage

Object

자연어 메시지 스타일 개체입니다.

Name 형식 Description
content KnowledgeBaseMessageContent[]:

메시지의 내용입니다.
role

string

도구 응답의 역할입니다.

KnowledgeBaseMessageContentType

열거형

메시지 콘텐츠의 유형입니다.

값 Description
text

문자 메시지 콘텐츠 종류입니다.
image

이미지 메시지 콘텐츠 종류입니다.

KnowledgeBaseMessageImageContent

Object

이미지 메시지 유형입니다.

Name 형식 Description
image

KnowledgeBaseImageContent

이미지 내용.
type string:

image

메시지 유형

KnowledgeBaseMessageTextContent

Object

문자 메시지 유형.

Name 형식 Description
text

string

텍스트 내용입니다.
type string:

text

메시지 유형

KnowledgeBaseModelWebSummarizationActivityRecord

Object

LLM 웹 요약 활동 기록을 나타냅니다.

Name 형식 Description
elapsedMs

integer (int32)

검색 활동에 대한 경과 시간(밀리초)입니다.
error

KnowledgeBaseErrorDetail

작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다.
id

integer (int32)

활동 레코드의 ID입니다.
inputTokens

integer (int32)

LLM 웹 요약 활동의 입력 토큰 수.
outputTokens

integer (int32)

LLM 웹 요약 활동의 출력 토큰 수.
type string:

modelWebSummarization

활동 레코드의 유형입니다.

KnowledgeBaseReferenceType

열거형

참조 형식입니다.

값 Description
searchIndex

문서 참고 색인을 검색하세요.
azureBlob

Azure Blob document reference.
indexedOneLake

색인화된 OneLake 문서 참조.
web

웹 문서 참조.

KnowledgeBaseRetrievalRequest

Object

검색 요청에 대한 입력 계약입니다.

Name 형식 Description
includeActivity

boolean

검색 결과에 활동 정보가 포함되어야 함을 나타냅니다.
intents KnowledgeRetrievalIntent[]:

KnowledgeRetrievalSemanticIntent[]

모델 쿼리 계획 없이 실행할 의도된 쿼리 목록입니다.
knowledgeSourceParams KnowledgeSourceParams[]:

지식 원본에 대한 런타임 매개 변수 목록입니다.
maxOutputSizeInTokens

integer (int32)

출력에 있는 콘텐츠의 최대 크기를 제한합니다.
maxRuntimeInSeconds

integer (int32)

최대 런타임(초)입니다.

KnowledgeBaseRetrievalResponse

Object

검색 응답에 대한 출력 계약입니다.

Name 형식 Description
activity KnowledgeBaseActivityRecord[]:

진행 상황 및 청구 영향을 추적하기 위한 활동 레코드입니다.
references KnowledgeBaseReference[]:

응답에 사용된 검색 데이터에 대한 참조입니다.
response

KnowledgeBaseMessage[]

답변 메시지들.

KnowledgeBaseSearchIndexActivityArguments

Object

검색 인덱스 검색 활동이 실행된 인수를 나타냅니다.

Name 형식 Description
filter

string

필터 문자열입니다.
search

string

검색 인덱스를 쿼리하는 데 사용되는 검색 문자열입니다.
searchFields

SearchIndexFieldReference[]

어떤 필드를 검색했는지.
semanticConfigurationName

string

검색 인덱스에서 사용된 의미 구성은 무엇이었나요?
sourceDataFields

SearchIndexFieldReference[]

검색을 위해 선택된 필드들.

KnowledgeBaseSearchIndexActivityRecord

Object

검색 인덱스 검색 활동 레코드를 나타냅니다.

Name 형식 Description
count

integer (int32)

순위 변경 임계값을 통과하기에 충분히 관련성이 있는 검색된 문서 수입니다.
elapsedMs

integer (int32)

검색 활동에 대한 경과 시간(밀리초)입니다.
error

KnowledgeBaseErrorDetail

작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다.
id

integer (int32)

활동 레코드의 ID입니다.
knowledgeSourceName

string

검색 활동에 대한 지식 소스입니다.
queryTime

string (date-time)

이 검색 활동에 대한 쿼리 시간입니다.
searchIndexArguments

KnowledgeBaseSearchIndexActivityArguments

검색 활동에 대한 검색 인덱스 인수입니다.
type string:

searchIndex

활동 레코드의 유형입니다.

KnowledgeBaseSearchIndexReference

Object

Azure 검색 문서 참조를 나타냅니다.

Name 형식 Description
activitySource

integer (int32)

참조의 원본 활동 ID입니다.
docKey

string

참조에 대한 문서 키입니다.
id

string

참조의 ID입니다.
rerankerScore

number (float)

문서 참조에 대한 순위 변경기 점수입니다.
sourceData

참고문헌의 원본 데이터입니다.
type string:

searchIndex

참조의 유형입니다.

KnowledgeBaseWebActivityArguments

Object

웹 검색 활동이 실행된 논증들을 나타냅니다.

Name 형식 Description
count

integer (int32)

반환된 웹 결과 수.
freshness

string

회수 활동을 위한 신선함.
language

string

검색 활동의 언어.
market

string

회수 활동 시장.
search

string

웹에 검색하는 데 사용되는 검색어입니다.

KnowledgeBaseWebActivityRecord

Object

웹 검색 활동 기록을 나타냅니다.

Name 형식 Description
count

integer (int32)

순위 변경 임계값을 통과하기에 충분히 관련성이 있는 검색된 문서 수입니다.
elapsedMs

integer (int32)

검색 활동에 대한 경과 시간(밀리초)입니다.
error

KnowledgeBaseErrorDetail

작업이 실패한 이유를 설명하는 오류 세부 정보입니다. 이 속성은 활동이 성공하지 못한 경우에만 포함됩니다.
id

integer (int32)

활동 레코드의 ID입니다.
knowledgeSourceName

string

검색 활동에 대한 지식 소스입니다.
queryTime

string (date-time)

이 검색 활동에 대한 쿼리 시간입니다.
type string:

web

활동 레코드의 유형입니다.
webArguments

KnowledgeBaseWebActivityArguments

검색 활동에 대한 웹 논거.

KnowledgeBaseWebReference

Object

웹 문서 참조를 나타냅니다.

Name 형식 Description
activitySource

integer (int32)

참조의 원본 활동 ID입니다.
id

string

참조의 ID입니다.
rerankerScore

number (float)

문서 참조에 대한 순위 변경기 점수입니다.
sourceData

참고문헌의 원본 데이터입니다.
title

string

웹 문서의 제목입니다.
type string:

web

참조의 유형입니다.
url

string (uri)

참조 데이터의 출처 URL입니다.

KnowledgeRetrievalIntentType

열거형

사용할 기술 자료 구성의 종류입니다.

값 Description
semantic

자연어 의미 체계 쿼리 의도입니다.

KnowledgeRetrievalMinimalReasoningEffort

Object

최소한의 추론 노력으로 지식 검색을 실행합니다.

Name 형식 Description
kind string:

minimal

추론 노력의 종류입니다.

KnowledgeRetrievalReasoningEffortKind

열거형

검색 중에 사용할 작업량입니다.

값 Description
minimal

원본 선택, 쿼리 계획 또는 반복 검색을 수행하지 않습니다.

KnowledgeRetrievalSemanticIntent

Object

의미론적 쿼리 의도입니다.

Name 형식 Description
search

string

실행할 의미 체계 쿼리
type string:

semantic

의도의 유형입니다.

KnowledgeSourceKind

열거형

지식 소스의 종류.

값 Description
searchIndex

검색 인덱스에서 데이터를 읽는 지식 소스입니다.
azureBlob

Azure Blob Storage에서 검색 인덱스로 데이터를 읽고 수집하는 기술 자료입니다.
indexedOneLake

색인화된 OneLake에서 데이터를 읽는 지식 소스입니다.
web

웹에서 데이터를 읽는 지식 소스입니다.

SearchIndexFieldReference

Object

검색 색인을 위한 필드 참조.

Name 형식 Description
name

string

@FSHO2@필드의 이름입니다.

SearchIndexKnowledgeSourceParams

Object

검색 인덱스 지식 원본에 대한 런타임 매개 변수를 지정합니다.

Name 형식 Description
filterAddOn

string

인덱스에 적용된 필터 조건(예: 'State eq VA').
includeReferenceSourceData

boolean

참조가 검색 중에 얻은 구조화된 데이터를 페이로드에 포함해야 하는지 여부를 나타냅니다.
includeReferences

boolean

이 원본에서 검색된 데이터에 대해 참조를 포함해야 하는지 여부를 나타냅니다.
kind string:

searchIndex

지식 소스의 유형입니다.
knowledgeSourceName

string

매개 변수가 적용되는 인덱스의 이름입니다.
rerankerThreshold

number (float)

검색된 모든 문서가 응답에 포함되기 위해 충족해야 하는 순위 조정 임계값입니다.

WebKnowledgeSourceParams

Object

웹 지식 원본에 대한 런타임 매개 변수를 지정합니다

Name 형식 Description
count

integer (int32)

반환할 웹 결과의 수입니다.
freshness

string

웹 결과의 신선함.
includeReferenceSourceData

boolean

참조가 검색 중에 얻은 구조화된 데이터를 페이로드에 포함해야 하는지 여부를 나타냅니다.
includeReferences

boolean

이 원본에서 검색된 데이터에 대해 참조를 포함해야 하는지 여부를 나타냅니다.
kind string:

web

지식 소스의 유형입니다.
knowledgeSourceName

string

매개 변수가 적용되는 인덱스의 이름입니다.
language

string

웹 결과의 언어입니다.
market

string

웹 결과의 시장.
rerankerThreshold

number (float)

검색된 모든 문서가 응답에 포함되기 위해 충족해야 하는 순위 조정 임계값입니다.