Knowledge Retrieval - Retrieve Stream

백업 저장소에서 관련 데이터를 가져오고, 진행 상황과 결과를 서버에서 전송한 이벤트로 스트리밍합니다.

서버에서 전송된 이벤트 프레이밍을 사용하여 응답을 점진적으로 처리합니다. 각 이벤트에는 이벤트 이름과 JSON으로 인코딩된 데이터 페이로드가 포함되어 있습니다. 스트림은 이벤트 error 나 이벤트로 response.completed 끝납니다. OpenAPI 2.0은 응답 본문을 문자열로 표현하므로, 생성된 클라이언트는 타입 이벤트 파싱 없이 원시 응답을 노출할 수 있습니다. 응답 본문을 단일 JSON 문서로 역직렬화하지 마십시오.

POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?_overload=retrieveStream&api-version=2026-11-01-preview

URI 매개 변수

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

string (uri)

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

knowledgeBaseName
path True

string

기술 자료의 이름.

api-version
query True

string

minLength: 1

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

요청 헤더

속성 필수 형식 Description
Accept True

Accept

Accept 헤더입니다.

x-ms-query-source-authorization

string (password)

쿼리가 실행되는 사용자를 식별하는 토큰입니다. 이 토큰은 문서에 보안 제한을 적용하는 데 사용됩니다.

x-ms-query-work-iq-source-authorization

string (password)

Work IQ 지식 소스에 설정된 고객 소유 Entra 앱 등록에 대한 사용자 주장 토큰. Work IQ API에 대한 대신 인증에 사용됩니다.

x-ms-client-request-id

string (uuid)

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

요청 본문

속성 형식 Description
includeActivity

boolean

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

intents KnowledgeRetrievalIntent[]:

KnowledgeRetrievalSemanticIntent[]

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

knowledgeSourceParams KnowledgeSourceParams[]:

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

maxOutputDocuments

integer (int32)

출력에 포함된 최대 문서 수를 제한합니다.

maxOutputSize

integer (int32)

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

maxOutputSizeInTokens

integer (int32)

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

maxRuntimeInSeconds

integer (int32)

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

messages

KnowledgeBaseMessage[]

채팅 메시지 스타일 입력 목록입니다.

outputMode

KnowledgeRetrievalOutputMode

이 검색에 대한 출력 구성입니다.

retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

검색 추론 노력 구성.

toolName

string

선택할 도구. KB 전체 검색에서는 생략합니다.

응답

속성 형식 Description
200 OK

string

요청이 성공했습니다.

Media Types: "text/event-stream", "application/json"

Other Status Codes

ErrorResponse

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

Media Types: "text/event-stream", "application/json"

보안

api-key

형식: apiKey
In(다음 안에): header

OAuth2Auth

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

범위

속성 Description
https://search.azure.com/.default

예제

KnowledgeBaseRetrieveStream

샘플 요청

POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?_overload=retrieveStream&api-version=2026-11-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
          }
        ]
      },
      "topicGraph": {
        "kind": "diverse",
        "diversityFactor": 0.1
      }
    }
  ],
  "toolName": "product-search"
}

샘플 응답

"event: retrieval.started\ndata: {\"requestId\":\"00000000-0000-0000-0000-000000000000\",\"knowledgeBaseName\":\"base-preview-test\",\"outputMode\":\"answerSynthesis\",\"reasoningEffort\":{\"kind\":\"low\"}}\n\nevent: activity.started\ndata: {\"id\":0,\"type\":\"modelQueryPlanning\",\"startedAt\":\"2025-01-01T00:08:45.045Z\"}\n\nevent: activity.completed\ndata: {\"type\":\"modelQueryPlanning\",\"id\":0,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"inputTokens\":11,\"outputTokens\":22,\"elapsedMs\":1234,\"model\":{\"modelName\":\"gpt-4o\",\"deploymentId\":\"gpt-4o-deployment\"}}\n\nevent: activity.started\ndata: {\"id\":1,\"type\":\"searchIndex\",\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"knowledgeSourceName\":\"ks-preview-test\"}\n\nevent: activity.completed\ndata: {\"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 ((id ne null) 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'\"}}\n\nevent: activity.started\ndata: {\"id\":2,\"type\":\"searchIndex\",\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"knowledgeSourceName\":\"ks-preview-test\"}\n\nevent: activity.completed\ndata: {\"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 ((id ne null) 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'\"}}\n\nevent: activity.started\ndata: {\"id\":3,\"type\":\"modelAnswerSynthesis\",\"startedAt\":\"2025-01-01T00:08:45.045Z\"}\n\nevent: activity.completed\ndata: {\"type\":\"modelAnswerSynthesis\",\"id\":3,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"inputTokens\":11,\"outputTokens\":22,\"elapsedMs\":1234,\"model\":{\"modelName\":\"gpt-4o\",\"deploymentId\":\"gpt-4o-deployment\"}}\n\nevent: activity.started\ndata: {\"id\":4,\"type\":\"agenticReasoning\",\"startedAt\":\"2025-01-01T00:08:45.045Z\"}\n\nevent: activity.completed\ndata: {\"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\"}}\n\nevent: answer.completed\ndata: {\"messageIndex\":0,\"message\":{\"content\":[{\"type\":\"text\",\"text\":\"[{...}]\"}]}}\n\nevent: references.completed\ndata: [{\"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-11-01-preview&allowUnsafeKeys=true\",\"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-11-01-preview&allowUnsafeKeys=true\",\"sourceData\":{\"id\":\"myDocKey2\",\"title\":\"low_doc\",\"content\":\"goodbye world\"}}]\n\nevent: response.completed\ndata: {\"statusCode\":200,\"response\":{\"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\":1234,\"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 ((id ne null) 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 ((id ne null) 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\":1234,\"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-11-01-preview&allowUnsafeKeys=true\",\"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-11-01-preview&allowUnsafeKeys=true\",\"sourceData\":{\"id\":\"myDocKey2\",\"title\":\"low_doc\",\"content\":\"goodbye world\"}}]}}\n\n"

정의

속성 Description
Accept

Accept 헤더입니다.

AgentRuntimeGraphHydrateDocumentsParams

지식 검색으로 반환된 수분 처리 원본 문서의 선택 및 카운트 제한.

AgentRuntimeGraphParams

그래프 활성화된 Azure Blob 지식 소스를 검색할 때 그래프별 재정의

AgentRuntimeGraphProvenanceParams

지식 검색 그래프 결과를 위한 소스-문서 수화 정책.

AzureBlobKnowledgeSourceParams

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

BalancedVectorQueryTopicGraph

순수 벡터 유사성과 다양성 인식 회상을 결합합니다. 다양성과 관련성을 균형 있게 맞추는 기본 설정을 권장합니다.

DiverseVectorQueryTopicGraph

주제 그래프를 사용하여 다양한 검색을 수행합니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보

ErrorDetail

오류 세부 정보입니다.

ErrorResponse

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

FabricDataAgentKnowledgeSourceParams

Fabric Data Agent 지식 소스의 런타임 매개변수를 지정합니다

FabricOntologyKnowledgeSourceParams

Fabric 온톨로지 지식 소스의 런타임 매개변수를 명시합니다

FileKnowledgeSourceParams

파일 지식 소스의 런타임 매개변수를 지정합니다

IndexedOneLakeKnowledgeSourceParams

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

IndexedSharePointKnowledgeSourceParams

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

IndexedSqlKnowledgeSourceParams

인덱스된 SQL 지식 소스의 런타임 매개변수를 지정합니다

KnowledgeBaseImageContent

이미지 내용.

KnowledgeBaseMessage

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

KnowledgeBaseMessageContentType

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

KnowledgeBaseMessageImageContent

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

KnowledgeBaseMessageTextContent

문자 메시지 유형.

KnowledgeBaseRetrievalRequest

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

KnowledgeRetrievalAutoReasoningEffort

검색 시 자동으로 추론 노력을 선택하세요. 서비스는 모든 요청을 가장 저렴한 티어에서 시딩하고, 필요한 만큼만 서비스 최대 이용 가능한 티어까지 에스컬레이션합니다.

KnowledgeRetrievalIntentType

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

KnowledgeRetrievalLowReasoningEffort

낮은 추론 노력으로 지식 검색을 실행합니다.

KnowledgeRetrievalMediumReasoningEffort

중간 추론 노력으로 지식 검색을 실행합니다.

KnowledgeRetrievalMinimalReasoningEffort

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

KnowledgeRetrievalOutputMode

이 검색에 대한 출력 구성입니다.

KnowledgeRetrievalReasoningEffortKind

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

KnowledgeRetrievalSemanticIntent

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

KnowledgeSourceGraphProvenanceKind

그래프 기반 지식 검색을 위한 소스-문서 동작.

KnowledgeSourceKind

지식 소스의 종류.

KnowledgeSourceResultsProcessing

지식 소스의 결과가 재순위화되는지 여부를 통제합니다.

McpServerKnowledgeSourceParams

MCP 서버 지식 소스의 런타임 매개변수를 명시합니다

NoneVectorQueryTopicGraph

주제 그래프 다양성 검색 없이 일반 벡터 탐색을 사용합니다.

RemoteSharePointKnowledgeSourceParams

원격 SharePoint 기술 자료 원본에 대한 런타임 매개 변수를 지정합니다.

SearchIndexKnowledgeSourceBoostKind

검색 지수 지식 소스에 대한 부스트 팁 같은 것.

SearchIndexKnowledgeSourceFieldValueBoost

필드 값에 따라 문서를 강화하는 힌트입니다.

SearchIndexKnowledgeSourceFilterHint

필드를 식별하는 힌트와 쿼리 플래너가 필터를 구성할 때 사용할 수 있는 포괄적인 근지 값입니다.

SearchIndexKnowledgeSourceFilterHintAutoConfiguration

대상 인덱스 측면에서 필터 힌트의 그라운딩 값을 자동으로 분해하도록 구성합니다.

SearchIndexKnowledgeSourceMultiWordExpressionBoost

여러 단어 표현을 기반으로 문서를 강화하는 힌트입니다.

SearchIndexKnowledgeSourceParams

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

SearchIndexKnowledgeSourceQueryHints

검색 색인 지식 소스를 위한 유용한 필터와 향상을 위한 쿼리 계획을 안내하는 힌트들.

VectorSearchTopicGraphKind

어떤 종류의 주제 그래프 벡터 검색을 사용해야 할지.

WebKnowledgeSourceParams

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

WorkIQKnowledgeSourceParams

WorkIQ 지식 소스의 런타임 매개변수를 지정합니다

Accept

Accept 헤더입니다.

값 Description
text/event-stream

AgentRuntimeGraphHydrateDocumentsParams

지식 검색으로 반환된 수분 처리 원본 문서의 선택 및 카운트 제한.

속성 형식 Default value Description
select

string

쉼표로 구분된 검색 가능한 소스 필드가 포함됩니다.

top

integer (int32)

minimum: 1
maximum: 100
50

반환할 최대 수중 문서. 기본값은 50입니다; 이는 그래프 행 수와는 무관합니다.

AgentRuntimeGraphParams

그래프 활성화된 Azure Blob 지식 소스를 검색할 때 그래프별 재정의

속성 형식 Default value Description
includeQuery

boolean

False

graphSearchArguments.gql에 생성된 GQL을 포함합니다. 생략되거나 거짓은 생성된 쿼리 텍스트를 노출하지 않습니다.

provenance

AgentRuntimeGraphProvenanceParams

그래프 결과를 지원하는 소스 문서가 반환되는지 여부를 제어합니다.

AgentRuntimeGraphProvenanceParams

지식 검색 그래프 결과를 위한 소스-문서 수화 정책.

속성 형식 Default value Description
hydrateDocuments

AgentRuntimeGraphHydrateDocumentsParams

원본 문서 옵션; 종류가 하이드레이트일 때만 유효합니다.

kind

KnowledgeSourceGraphProvenanceKind

none

그래프 검색이 그래프 행만을 반환하는지, 아니면 소스 문서와 수분을 함께 가져오는지.

AzureBlobKnowledgeSourceParams

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

속성 형식 Description
alwaysQuerySource

boolean

이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다.

enableImageServing

boolean

이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다.

failOnError

boolean

이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다.

graphParameters

AgentRuntimeGraphParams

그래프 활성화 소스의 그래프 쿼리 가시성 및 소스-문서 수분 옵션.

includeReferenceSourceData

boolean

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

includeReferences

boolean

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

kind string:

azureBlob

지식 소스의 유형입니다.

knowledgeSourceName

string

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

maxOutputDocuments

integer (int32)

이 지식 출처에서 반환되는 문서 최대 수를 제한합니다.

neverQuerySource

boolean

이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다.

rerankerThreshold

number (float)

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

resultsProcessing

KnowledgeSourceResultsProcessing

이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다.

topicGraph VectorQueryTopicGraph:

이 검색에서 지식 소스의 저장된 topicGraph를 덮어씁니다. 생략 시 저장된 지식 소스 값이 적용됩니다.

BalancedVectorQueryTopicGraph

순수 벡터 유사성과 다양성 인식 회상을 결합합니다. 다양성과 관련성을 균형 있게 맞추는 기본 설정을 권장합니다.

속성 형식 Description
kind string:

balanced

어떤 종류의 주제 그래프 벡터 검색을 사용해야 할지.

minDiversityPoolSize

integer (int32)

minimum: 250
maximum: 10000

주제 그래프 샘플링 전에 검색해야 할 최소 벡터 후보 수. 기본값은 1,000입니다.

DiverseVectorQueryTopicGraph

주제 그래프를 사용하여 다양한 검색을 수행합니다.

속성 형식 Description
diversityFactor

number (float)

minimum: 0
maximum: 1

주제 그래프 다양성 검색에 사용되는 다양성 계수. 생략하면 주제 그래프 프로필에 설정된 기본값이 사용됩니다.

kind string:

diverse

어떤 종류의 주제 그래프 벡터 검색을 사용해야 할지.

minDiversityPoolSize

integer (int32)

minimum: 250
maximum: 10000

주제 그래프 샘플링 전에 검색해야 할 최소 벡터 후보 수. 기본값은 1,000입니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보

속성 형식 Description
info

추가 정보입니다.

type

string

추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

속성 형식 Description
additionalInfo

ErrorAdditionalInfo[]

오류 추가 정보

code

string

오류 코드입니다.

details

ErrorDetail[]

오류 세부 정보입니다.

message

string

오류 메시지입니다.

target

string

오류 대상.

ErrorResponse

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

속성 형식 Description
error

ErrorDetail

오류 개체입니다.

FabricDataAgentKnowledgeSourceParams

Fabric Data Agent 지식 소스의 런타임 매개변수를 지정합니다

속성 형식 Description
alwaysQuerySource

boolean

이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다.

enableImageServing

boolean

이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다.

failOnError

boolean

이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다.

includeReferenceSourceData

boolean

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

includeReferences

boolean

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

kind string:

fabricDataAgent

지식 소스의 유형입니다.

knowledgeSourceName

string

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

maxOutputDocuments

integer (int32)

이 지식 출처에서 반환되는 문서 최대 수를 제한합니다.

neverQuerySource

boolean

이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다.

rerankerThreshold

number (float)

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

resultsProcessing

KnowledgeSourceResultsProcessing

이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다.

FabricOntologyKnowledgeSourceParams

Fabric 온톨로지 지식 소스의 런타임 매개변수를 명시합니다

속성 형식 Description
alwaysQuerySource

boolean

이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다.

enableImageServing

boolean

이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다.

failOnError

boolean

이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다.

includeReferenceSourceData

boolean

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

includeReferences

boolean

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

kind string:

fabricOntology

지식 소스의 유형입니다.

knowledgeSourceName

string

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

maxOutputDocuments

integer (int32)

이 지식 출처에서 반환되는 문서 최대 수를 제한합니다.

neverQuerySource

boolean

이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다.

rerankerThreshold

number (float)

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

resultsProcessing

KnowledgeSourceResultsProcessing

이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다.

FileKnowledgeSourceParams

파일 지식 소스의 런타임 매개변수를 지정합니다

속성 형식 Description
alwaysQuerySource

boolean

이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다.

enableImageServing

boolean

이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다.

failOnError

boolean

이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다.

includeReferenceSourceData

boolean

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

includeReferences

boolean

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

kind string:

file

지식 소스의 유형입니다.

knowledgeSourceName

string

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

maxOutputDocuments

integer (int32)

이 지식 출처에서 반환되는 문서 최대 수를 제한합니다.

neverQuerySource

boolean

이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다.

rerankerThreshold

number (float)

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

resultsProcessing

KnowledgeSourceResultsProcessing

이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다.

IndexedOneLakeKnowledgeSourceParams

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

속성 형식 Description
alwaysQuerySource

boolean

이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다.

enableImageServing

boolean

이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다.

failOnError

boolean

이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다.

includeReferenceSourceData

boolean

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

includeReferences

boolean

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

kind string:

indexedOneLake

지식 소스의 유형입니다.

knowledgeSourceName

string

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

maxOutputDocuments

integer (int32)

이 지식 출처에서 반환되는 문서 최대 수를 제한합니다.

neverQuerySource

boolean

이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다.

rerankerThreshold

number (float)

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

resultsProcessing

KnowledgeSourceResultsProcessing

이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다.

IndexedSharePointKnowledgeSourceParams

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

속성 형식 Description
alwaysQuerySource

boolean

이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다.

enableImageServing

boolean

이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다.

failOnError

boolean

이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다.

includeReferenceSourceData

boolean

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

includeReferences

boolean

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

kind string:

indexedSharePoint

지식 소스의 유형입니다.

knowledgeSourceName

string

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

maxOutputDocuments

integer (int32)

이 지식 출처에서 반환되는 문서 최대 수를 제한합니다.

neverQuerySource

boolean

이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다.

rerankerThreshold

number (float)

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

resultsProcessing

KnowledgeSourceResultsProcessing

이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다.

IndexedSqlKnowledgeSourceParams

인덱스된 SQL 지식 소스의 런타임 매개변수를 지정합니다

속성 형식 Description
alwaysQuerySource

boolean

이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다.

enableImageServing

boolean

이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다.

failOnError

boolean

이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다.

includeReferenceSourceData

boolean

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

includeReferences

boolean

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

kind string:

indexedSql

지식 소스의 유형입니다.

knowledgeSourceName

string

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

maxOutputDocuments

integer (int32)

이 지식 출처에서 반환되는 문서 최대 수를 제한합니다.

neverQuerySource

boolean

이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다.

rerankerThreshold

number (float)

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

resultsProcessing

KnowledgeSourceResultsProcessing

이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다.

KnowledgeBaseImageContent

이미지 내용.

속성 형식 Description
url

string (uri)

이미지의 URL입니다.

KnowledgeBaseMessage

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

속성 형식 Description
content KnowledgeBaseMessageContent[]:

메시지의 내용입니다.

role

string

도구 응답의 역할입니다.

KnowledgeBaseMessageContentType

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

값 Description
text

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

image

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

KnowledgeBaseMessageImageContent

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

속성 형식 Description
image

KnowledgeBaseImageContent

이미지 내용.

type string:

image

메시지의 형식

KnowledgeBaseMessageTextContent

문자 메시지 유형.

속성 형식 Description
text

string

텍스트 내용입니다.

type string:

text

메시지의 형식

KnowledgeBaseRetrievalRequest

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

속성 형식 Description
includeActivity

boolean

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

intents KnowledgeRetrievalIntent[]:

KnowledgeRetrievalSemanticIntent[]

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

knowledgeSourceParams KnowledgeSourceParams[]:

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

maxOutputDocuments

integer (int32)

출력에 포함된 최대 문서 수를 제한합니다.

maxOutputSize

integer (int32)

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

maxOutputSizeInTokens

integer (int32)

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

maxRuntimeInSeconds

integer (int32)

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

messages

KnowledgeBaseMessage[]

채팅 메시지 스타일 입력 목록입니다.

outputMode

KnowledgeRetrievalOutputMode

이 검색에 대한 출력 구성입니다.

retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

검색 추론 노력 구성.

toolName

string

선택할 도구. KB 전체 검색에서는 생략합니다.

KnowledgeRetrievalAutoReasoningEffort

검색 시 자동으로 추론 노력을 선택하세요. 서비스는 모든 요청을 가장 저렴한 티어에서 시딩하고, 필요한 만큼만 서비스 최대 이용 가능한 티어까지 에스컬레이션합니다.

속성 형식 Description
kind string:

auto

추론 노력의 종류입니다.

KnowledgeRetrievalIntentType

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

값 Description
semantic

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

KnowledgeRetrievalLowReasoningEffort

낮은 추론 노력으로 지식 검색을 실행합니다.

속성 형식 Description
kind string:

low

추론 노력의 종류입니다.

KnowledgeRetrievalMediumReasoningEffort

중간 추론 노력으로 지식 검색을 실행합니다.

속성 형식 Description
kind string:

medium

추론 노력의 종류입니다.

KnowledgeRetrievalMinimalReasoningEffort

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

속성 형식 Description
kind string:

minimal

추론 노력의 종류입니다.

KnowledgeRetrievalOutputMode

이 검색에 대한 출력 구성입니다.

값 Description
extractiveData

생성적 변경 없이 지식 소스에서 직접 데이터를 반환합니다.

answerSynthesis

응답 페이로드에 대한 답변을 합성합니다.

KnowledgeRetrievalReasoningEffortKind

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

값 Description
minimal

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

low

검색 중에 낮은 추론을 사용합니다.

medium

검색하는 동안 적당한 양의 추론을 사용하십시오.

auto

검색 시 자동으로 추론 노력을 선택하며, 가장 저렴한 단계에서만 필요한 만큼만 점차 상승시킵니다.

KnowledgeRetrievalSemanticIntent

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

속성 형식 Description
search

string

실행할 의미 체계 쿼리

type string:

semantic

의도의 유형입니다.

KnowledgeSourceGraphProvenanceKind

그래프 기반 지식 검색을 위한 소스-문서 동작.

값 Description
none

그래프 결과를 원본 문서의 하이드레이드 없이 반환합니다.

hydrate

또한 구성된 출처 인덱스에서 선택한 원본 문서를 반환합니다.

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 서버 지식 소스의 런타임 매개변수를 명시합니다

속성 형식 Description
alwaysQuerySource

boolean

이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다.

enableImageServing

boolean

이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다.

failOnError

boolean

이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다.

includeReferenceSourceData

boolean

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

includeReferences

boolean

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

kind string:

mcpServer

지식 소스의 유형입니다.

knowledgeSourceName

string

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

maxOutputDocuments

integer (int32)

이 지식 출처에서 반환되는 문서 최대 수를 제한합니다.

neverQuerySource

boolean

이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다.

rerankerThreshold

number (float)

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

resultsProcessing

KnowledgeSourceResultsProcessing

이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다.

NoneVectorQueryTopicGraph

주제 그래프 다양성 검색 없이 일반 벡터 탐색을 사용합니다.

속성 형식 Description
kind string:

none

어떤 종류의 주제 그래프 벡터 검색을 사용해야 할지.

RemoteSharePointKnowledgeSourceParams

원격 SharePoint 기술 자료 원본에 대한 런타임 매개 변수를 지정합니다.

속성 형식 Description
alwaysQuerySource

boolean

이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다.

enableImageServing

boolean

이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다.

failOnError

boolean

이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다.

filterExpressionAddOn

string

SharePoint 데이터 원본에 적용되는 필터 조건입니다. 키워드 쿼리 언어 구문에 지정해야 합니다. 지식 소스 정의에 지정된 필터 식과 함께 결합됩니다.

includeReferenceSourceData

boolean

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

includeReferences

boolean

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

kind string:

remoteSharePoint

지식 소스의 유형입니다.

knowledgeSourceName

string

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

maxOutputDocuments

integer (int32)

이 지식 출처에서 반환되는 문서 최대 수를 제한합니다.

neverQuerySource

boolean

이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다.

rerankerThreshold

number (float)

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

resultsProcessing

KnowledgeSourceResultsProcessing

이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다.

SearchIndexKnowledgeSourceBoostKind

검색 지수 지식 소스에 대한 부스트 팁 같은 것.

값 Description
fieldValue

필드 값을 기반으로 문서를 부스트하세요.

multiWordExpression

여러 단어 표현식을 기반으로 문서를 강화하세요.

SearchIndexKnowledgeSourceFieldValueBoost

필드 값에 따라 문서를 강화하는 힌트입니다.

속성 형식 Description
boost

number (double)

문서 점수의 배수입니다. 1.0과 같지 않은 양수여야 합니다.

boostInstructions

string

부스트를 언제 어떻게 적용해야 하는지 설명하는 자연어 지침.

field

string

minLength: 1

검색 인덱스 필드의 이름입니다.

fieldValues

string[]

필드의 대표 값.

kind string:

fieldValue

그런 종류의 부스트 힌트.

SearchIndexKnowledgeSourceFilterHint

필드를 식별하는 힌트와 쿼리 플래너가 필터를 구성할 때 사용할 수 있는 포괄적인 근지 값입니다.

속성 형식 Description
autoConfiguration

SearchIndexKnowledgeSourceFilterHintAutoConfiguration

필드의 측면에서 접지 값을 해결하도록 서비스를 구성합니다. 이 기능이 있으면 자동 구성을 가능하게 합니다. 필드는 필터링 가능하고 페이스팅 가능해야 합니다. 대상 인덱스에 문서 수준 권한이나 Purview 민감도 라벨이 활성화된 경우에는 지원되지 않습니다; 이 제한은 지식 소스 생성/업데이트 및 지식 기반 검색 시점에 검증됩니다. fieldValues와 상호 배타적입니다. 지식 소스가 저장된 queryHints경우에만 지원되며, 요청 시 queryHintOverrides점에서는 지원되지 않습니다.

field

string

minLength: 1

필터링 가능한 검색 인덱스 필드의 이름입니다.

fieldValues

string[]

해당 분야에 대한 포괄적인 값 집합. 최대 160개의 값, 값당 최대 128자, 합산 2048자까지. 를 지원하는 autoConfiguration버전에서는 명시되지 않는 한 autoConfiguration 필수이며, 상호 배타적이어야 합니다.

filterInstructions

string

필드에서 언제 어떻게 필터링할지 설명하는 자연어 지침.

SearchIndexKnowledgeSourceFilterHintAutoConfiguration

대상 인덱스 측면에서 필터 힌트의 그라운딩 값을 자동으로 분해하도록 구성합니다.

속성 형식 Description
cacheTtl

integer (int32)

minimum: 60
maximum: 3600

해결된 페이스트 값의 초수 수가 캐시됩니다. 허용 범위는 전용 서비스에서 60에서 3600까지, 서버리스 서비스에서는 60에서 900까지입니다. 생략 시 전용 서비스에서는 3600초, 서버리스 서비스에서는 900초로 기본 설정됩니다.

maxFacetValueCount

integer (int32)

minimum: 1
maximum: 64

접지로 사용할 최대 면(facet) 값 수. 기본값은 64입니다; 허용 범위는 1부터 64까지입니다. 값은 수제 필터 값과 동일한 2048자 결합 길이 제한과 값당 128자 제한을 적용받으며, 패셋 수 순서로 선택됩니다.

SearchIndexKnowledgeSourceMultiWordExpressionBoost

여러 단어 표현을 기반으로 문서를 강화하는 힌트입니다.

속성 형식 Description
boost

number (double)

문서 점수의 배수입니다. 1.0과 같지 않은 양수여야 합니다.

boostInstructions

string

부스트를 언제 어떻게 적용해야 하는지 설명하는 자연어 지침.

fieldValues

string[]

부스트의 대표 값입니다.

kind string:

multiWordExpression

그런 종류의 부스트 힌트.

SearchIndexKnowledgeSourceParams

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

속성 형식 Description
alwaysQuerySource

boolean

이 지식 원본은 원본 선택을 무시하고 검색 시 항상 쿼리되어야 함을 나타냅니다.

enableImageServing

boolean

이 지식 소스에 대해 검색 시 이미지 서빙을 활성화해야 하는지 여부를 나타냅니다. 사실일 경우, 인지시 중 추출된 이미지는 하위 모델에 전달됩니다.

failOnError

boolean

이 지식 소스에서 검색할 때 오류가 발생하면 전체 검색 요청이 실패해야 함을 나타냅니다. 기본값은 false입니다.

filterAddOn

string

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

includeReferenceSourceData

boolean

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

includeReferences

boolean

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

kind string:

searchIndex

지식 소스의 유형입니다.

knowledgeSourceName

string

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

maxOutputDocuments

integer (int32)

이 지식 출처에서 반환되는 문서 최대 수를 제한합니다.

neverQuerySource

boolean

이 지식 소스는 요청의 후보 집합에서 제외되어야 하며, 검색 시점에 절대 쿼리되지 않아야 함을 나타냅니다. 제외 방식은 요청-로컬이며 지식 기반 회원 자격을 변경하지 않습니다. 같은 지식 소스에서 alwaysQuerySource와 결합할 수 없습니다.

queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

쿼리 계획을 유용한 필터와 부스트로 안내하는 힌트들. 명시되어 있을 경우, 이 객체는 지식 소스에 설정된 전체 쿼리 힌트 세트를 대체합니다.

rerankerThreshold

number (float)

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

resultsProcessing

KnowledgeSourceResultsProcessing

이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다.

topicGraph VectorQueryTopicGraph:

이 검색에서 지식 소스의 저장된 topicGraph를 덮어씁니다. 생략 시 저장된 지식 소스 값이 적용됩니다.

SearchIndexKnowledgeSourceQueryHints

검색 색인 지식 소스를 위한 유용한 필터와 향상을 위한 쿼리 계획을 안내하는 힌트들.

속성 형식 Description
boosts SearchIndexKnowledgeSourceBoost[]:

쿼리 플래너가 문서 순위에 영향을 줄 수 있는 조건을 식별하는 힌트를 강화하세요.

filters

SearchIndexKnowledgeSourceFilterHint[]

쿼리 플래너가 필터를 구성할 때 사용할 수 있는 필드와 대표 값을 식별하는 필터 힌트.

VectorSearchTopicGraphKind

어떤 종류의 주제 그래프 벡터 검색을 사용해야 할지.

값 Description
none

주제 그래프 다양성 검색이 꺼져 있을 때는 일반 벡터 검색을 사용하세요.

diverse

주제 그래프 다양성 검색을 활용하세요.

balanced

순수 벡터 유사성과 다양성 인식 회상을 결합합니다. 다양성과 관련성을 균형 있게 맞추는 기본 설정을 권장합니다.

WebKnowledgeSourceParams

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

속성 형식 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

KnowledgeSourceResultsProcessing

이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다.

WorkIQKnowledgeSourceParams

WorkIQ 지식 소스의 런타임 매개변수를 지정합니다

속성 형식 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

KnowledgeSourceResultsProcessing

이 검색 호출에만 대해 지식 소스의 저장된 결과를 무시합니다. 생략 시 저장된 지식 소스 값이 적용됩니다.