Knowledge Retrieval - Retrieve

Bilgi Bankası, yedekleme depolarından ilgili verileri alır.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
endpoint
path True

string (uri)

Arama hizmetinin uç nokta URL'si.

knowledgeBaseName
path True

string

Bilgi bankasının adı.

api-version
query True

string

minLength: 1

Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name Gerekli Tür Description
Accept

Accept

Kabul Et başlığı.

x-ms-query-source-authorization

string

Sorgunun yürütüldüğü kullanıcıyı tanımlayan belirteç. Bu belirteç, belgelerde güvenlik kısıtlamalarını zorlamak için kullanılır.

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

string (password)

Müşteri sahibi Entra uygulaması kaydı için kullanıcı doğrulama belirteci, Work IQ bilgi kaynağına yapılandırılmıştır. Work IQ API'sine kimlik doğrulama için kullanılır.

x-ms-client-request-id

string (uuid)

İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Gövdesi

Name Tür Description
includeActivity

boolean

Alma sonuçlarının etkinlik bilgilerini içermesi gerektiğini belirtir.

intents KnowledgeRetrievalIntent[]:

KnowledgeRetrievalSemanticIntent[]

Model sorgu planlaması olmadan yürütülecek amaçlanan sorguların listesi.

knowledgeSourceParams KnowledgeSourceParams[]:

Bilgi kaynakları için çalışma zamanı parametrelerinin listesi.

maxOutputDocuments

integer (int32)

Çıktıdaki maksimum belge sayısını sınırlar.

maxOutputSize

integer (int32)

Çıktıdaki içeriğin maksimum boyutunu sınırlar.

maxOutputSizeInTokens

integer (int32)

Çıktıdaki içeriğin maksimum boyutunu sınırlar.

maxRuntimeInSeconds

integer (int32)

Saniye cinsinden maksimum çalışma zamanı.

messages

KnowledgeBaseMessage[]

Sohbet iletisi stili girişlerinin listesi.

outputMode

KnowledgeRetrievalOutputMode

Bu alma için çıkış yapılandırması.

retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

Geri getirme amaç yürütme çabası yapılandırması.

Yanıtlar

Name Tür Description
200 OK

KnowledgeBaseRetrievalResponse

Başarılı geri alma tepkisi.

Other Status Codes

KnowledgeBaseRetrievalResponse

Kısmi geri alma tepkisi.

Other Status Codes

ErrorResponse

Beklenmeyen bir hata yanıtı.

Güvenlik

api-key

Tür: apiKey
İçinde: header

OAuth2Auth

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Kapsamlar

Name Description
https://search.azure.com/.default

Örnekler

KnowledgeBaseRetrieve
KnowledgeBaseRetrieveAzureBlobImageServing
KnowledgeBaseRetrieveWithIntents
KnowledgeBaseRetrieveWithSourceExclusion

KnowledgeBaseRetrieve

Örnek isteği

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

Örnek yanıt

{
  "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

Örnek isteği

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

Örnek yanıt

{
  "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

Örnek isteği

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

Örnek yanıt

{
  "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

Örnek isteği

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"
    }
  ]
}

Örnek yanıt

{
  "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"
    }
  ]
}

Tanımlar

Name Description
Accept

Kabul Et başlığı.

AzureBlobKnowledgeSourceParams

Azure blob bilgi kaynağı için çalışma zamanı parametrelerini belirtir

ErrorAdditionalInfo

Kaynak yönetimi hatasına ilişkin ek bilgiler.

ErrorDetail

Hata ayrıntısı.

ErrorResponse

Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıt biçimini de izler.).

FabricDataAgentKnowledgeSourceParams

Bir Fabric Data Agent bilgi kaynağı için çalışma zamanı parametrelerini belirtir

FabricOntologyKnowledgeSourceParams

Fabric Ontology bilgi kaynağı için çalışma zamanı parametrelerini belirtir

FileKnowledgeSourceParams

Bir Dosya bilgi kaynağı için çalışma zamanı parametrelerini belirtir

ImageServingStatistics

Bir geri alma etkinliği sırasında görüntü servisi hakkında istatistikler.

IndexedOneLakeKnowledgeSourceParams

Dizinlenmiş OneLake bilgi kaynağı için çalışma zamanı parametrelerini belirtir

IndexedSharePointKnowledgeSourceParams

Dizine alınmış SharePoint bilgi kaynağı için çalışma zamanı parametrelerini belirtir

IndexedSqlKnowledgeSourceParams

İndekslenmiş SQL bilgi kaynağı için çalışma zamanı parametrelerini belirtir

KnowledgeBaseActivityRecordModel

Bilgi tabanı LLM etkinliği için kullanılan modeli, model adı ve dağıtım tanımlayıcısı dahil olmak üzere temsil eder.

KnowledgeBaseActivityRecordType

Faaliyet kaydının türü.

KnowledgeBaseAgenticReasoningActivityRecord

Aracılı bir akıl yürütme etkinliği kaydını temsil eder.

KnowledgeBaseAzureBlobActivityArguments

Azure blob alma etkinliğinin çalıştırıldığı bağımsız değişkenleri temsil eder.

KnowledgeBaseAzureBlobActivityRecord

Azure blob alma etkinliği kaydını temsil eder.

KnowledgeBaseAzureBlobReference

Azure Blob Depolama belge başvurusunu temsil eder.

KnowledgeBaseErrorAdditionalInfo

Kaynak yönetimi hatasına ilişkin ek bilgiler.

KnowledgeBaseErrorDetail

Hata ayrıntıları.

KnowledgeBaseFabricDataAgentActivityArguments

Fabric Data Agent alma etkinliğinin çalıştırıldığı argümanları temsil eder.

KnowledgeBaseFabricDataAgentActivityRecord

Bir Fabric Veri Ajanı alma etkinlik kaydını temsil eder.

KnowledgeBaseFabricDataAgentReference

Bir Fabric Data Agent belge referansını temsil eder.

KnowledgeBaseFabricOntologyActivityArguments

Fabric Ontology geri alma etkinliğinin yürütüldiği argümanları temsil eder.

KnowledgeBaseFabricOntologyActivityRecord

Fabric Ontology geri alma faaliyet kaydını temsil eder.

KnowledgeBaseFabricOntologyReference

Fabric Ontology belge referansını temsil eder.

KnowledgeBaseFileActivityArguments

Dosya alma etkinliğinin çalıştırıldığı argümanları temsil eder.

KnowledgeBaseFileActivityRecord

Dosya alma faaliyet kaydını temsil eder.

KnowledgeBaseFileReference

Bir dosya belge referansını temsil eder.

KnowledgeBaseImageContent

Görsel içeriği.

KnowledgeBaseIndexedOneLakeActivityArguments

Indekslenmiş OneLake alma etkinliğinin çalıştırıldığı argümanları temsil eder.

KnowledgeBaseIndexedOneLakeActivityRecord

Indekslenmiş OneLake toplama aktivite kaydını temsil eder.

KnowledgeBaseIndexedOneLakeReference

Indekslenmiş bir OneLake belge referansını temsil eder.

KnowledgeBaseIndexedSharePointActivityArguments

Indekslenmiş SharePoint alma etkinliğinin çalıştırıldığı argümanları temsil eder.

KnowledgeBaseIndexedSharePointActivityRecord

Indekslenmiş SharePoint alma faaliyet kaydını temsil eder.

KnowledgeBaseIndexedSharePointReference

Indekslenmiş SharePoint belge referansını temsil eder.

KnowledgeBaseIndexedSqlActivityArguments

Indekslenmiş SQL alma etkinliğinin çalıştırıldığı argümanları temsil eder.

KnowledgeBaseIndexedSqlActivityRecord

Indekslenmiş SQL alma etkinlik kaydını temsil eder.

KnowledgeBaseIndexedSqlReference

Azure SQL belge referansını temsil eder.

KnowledgeBaseMcpServerActivityArguments

MCP sunucu alma etkinliğinin çalıştırıldığı argümanları temsil eder.

KnowledgeBaseMcpServerActivityRecord

MCP sunucu alma etkinliği kaydını temsil eder.

KnowledgeBaseMcpServerReference

MCP sunucu belge referansını temsil eder.

KnowledgeBaseMessage

Doğal dil ileti stili nesnesi.

KnowledgeBaseMessageContentType

İleti içeriğinin türü.

KnowledgeBaseMessageImageContent

Resim mesajı türü.

KnowledgeBaseMessageTextContent

Kısa mesaj türü.

KnowledgeBaseModelAnswerSynthesisActivityRecord

Bir LLM yanıt sentezi etkinlik kaydını temsil eder.

KnowledgeBaseModelQueryPlanningActivityRecord

Bir LLM sorgu planlama etkinliği kaydını temsil eder.

KnowledgeBaseModelWebSummarizationActivityRecord

LLM web özetleme faaliyet kaydını temsil eder.

KnowledgeBaseQueryHintProcessing

Bir alma etkinliği için sorgu ipuçlarından oluşturulan ifadelerle ilgili ayrıntılar.

KnowledgeBaseReferenceType

Başvurunun türü.

KnowledgeBaseRemoteSharePointActivityArguments

Uzak SharePoint alma etkinliğinin çalıştırıldığı argümanları temsil eder.

KnowledgeBaseRemoteSharePointActivityRecord

Uzak SharePoint alma etkinliği kaydını temsil eder.

KnowledgeBaseRemoteSharePointReference

Uzak SharePoint belge başvurusunu temsil eder.

KnowledgeBaseRetrievalRequest

Alma isteği için giriş sözleşmesi.

KnowledgeBaseRetrievalResponse

Alma yanıtı için çıkış sözleşmesi.

KnowledgeBaseSearchIndexActivityArguments

Arama dizini alma etkinliğinin çalıştırıldığı bağımsız değişkenleri temsil eder.

KnowledgeBaseSearchIndexActivityRecord

Bir arama dizini alma etkinliği kaydını temsil eder.

KnowledgeBaseSearchIndexReference

Bir Azure Search belge başvurusunu temsil eder.

KnowledgeBaseWebActivityArguments

Web alma etkinliğinin çalıştırıldığı argümanları temsil eder.

KnowledgeBaseWebActivityRecord

Web alma faaliyet kaydını temsil eder.

KnowledgeBaseWebReference

Bir web belgesi başvurusunu temsil eder.

KnowledgeBaseWorkIQActivityArguments

WorkIQ geri alma etkinliğinin çalıştırıldığı argümanları temsil eder.

KnowledgeBaseWorkIQActivityRecord

WorkIQ geri alma aktivite kaydını temsil eder.

KnowledgeBaseWorkIQReference

WorkIQ belge referansını temsil eder.

KnowledgeRetrievalAutoReasoningEffort

Geri alma sırasında otomatik olarak akıl yürütme çabasını seçin. Hizmet, her talebi en ucuz seviyeye ekliyor ve sadece ihtiyaç duyulduğu kadar, hizmetin maksimum mevcut seviyesine kadar yükseliyor.

KnowledgeRetrievalIntentType

Kullanılacak bilgi bankası yapılandırması türü.

KnowledgeRetrievalLowReasoningEffort

Düşük muhakeme çabasıyla bilgi alımını çalıştırın.

KnowledgeRetrievalMediumReasoningEffort

Orta düzeyde akıl yürütme çabasıyla bilgi erişimini çalıştırın.

KnowledgeRetrievalMinimalReasoningEffort

Minimum muhakeme çabasıyla bilgi alımını çalıştırın.

KnowledgeRetrievalOutputMode

Bu alma için çıkış yapılandırması.

KnowledgeRetrievalReasoningEffortKind

Alma sırasında kullanılacak çaba miktarı.

KnowledgeRetrievalSemanticIntent

Anlamsal bir sorgulama niyeti.

KnowledgeSourceKind

Bilgi kaynağının türü.

KnowledgeSourceResultsProcessing

Bir bilgi kaynağının sonuçlarının yeniden sıralanıp sıralanmadığını kontrol eder.

McpServerKnowledgeSourceParams

MCP sunucu bilgi kaynağı için çalışma zamanı parametrelerini belirtir

PurviewSensitivityLabelInfo

Bir belgeye uygulanan hassasiyet etiketi hakkında bilgi

QueryType

Arama sorgusunun sözdizimini belirtir. Varsayılan değer 'basit'tir. Sorgunuz Lucene sorgu sözdizimini kullanıyorsa 'tam' ve sorgu söz dizimi gerekmiyorsa 'semantic' kullanın.

RemoteSharePointKnowledgeSourceParams

Uzak SharePoint bilgi kaynağı için çalışma zamanı parametrelerini belirtir

SearchIndexFieldReference

Arama dizini için alan referansı.

SearchIndexKnowledgeSourceBoostKind

Arama indeks bilgi kaynağı için bir teşvik ipucu.

SearchIndexKnowledgeSourceFieldValueBoost

Bir alan değerine göre belgeleri güçlendiren bir ipucu.

SearchIndexKnowledgeSourceFilterHint

Bir alanı ve sorgu planlayıcısının filtre oluştururken kullanabileceği temsil eden değerleri tanımlayan bir ipucu.

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Çok kelimeli bir ifade temelinde belgeleri güçlendiren bir ipucu.

SearchIndexKnowledgeSourceParams

Arama dizini bilgi kaynağı için çalışma zamanı parametrelerini belirtir

SearchIndexKnowledgeSourceQueryHints

Arama indeksi bilgi kaynağı için faydalı filtreler ve güçlendirmeler için sorgu planlamasını yönlendiren ipuçları.

ServedImage

Modelin bir geri alma etkinliği sırasında sunulmak üzere seçtiği tek bir görüntüyü tanımlar.

WebKnowledgeSourceParams

Bir web bilgi kaynağı için çalışma zamanı parametrelerini belirtir

WorkIQKnowledgeSourceParams

WorkIQ bilgi kaynağı için çalışma zamanı parametrelerini belirtir

Accept

Kabul Et başlığı.

Değer Description
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

Azure blob bilgi kaynağı için çalışma zamanı parametrelerini belirtir

Name Tür Description
alwaysQuerySource

boolean

Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir.

enableImageServing

boolean

Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir.

failOnError

boolean

Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur.

includeReferenceSourceData

boolean

Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir.

includeReferences

boolean

Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir.

kind string:

azureBlob

Bilgi kaynağının türü.

knowledgeSourceName

string

Parametrelerin uygulandığı dizinin adı.

maxOutputDocuments

integer (int32)

Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar.

neverQuerySource

boolean

Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez.

queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Sorgu planlamasını faydalı filtreler ve güçlendirmeler için yönlendiren ipuçları. Belirtilirse, bu nesne bilgi kaynağında yapılandırılmış tüm sorgu ipuçları setinin yerini alır.

rerankerThreshold

number (float)

Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği.

resultsProcessing

KnowledgeSourceResultsProcessing

Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır.

ErrorAdditionalInfo

Kaynak yönetimi hatasına ilişkin ek bilgiler.

Name Tür Description
info

Ek bilgiler.

type

string

Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Name Tür Description
additionalInfo

ErrorAdditionalInfo[]

Hata ek bilgisi.

code

string

Hata kodu.

details

ErrorDetail[]

Hata ayrıntıları.

message

string

Hata iletisi.

target

string

Hata hedefi

ErrorResponse

Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıt biçimini de izler.).

Name Tür Description
error

ErrorDetail

Hata nesnesi.

FabricDataAgentKnowledgeSourceParams

Bir Fabric Data Agent bilgi kaynağı için çalışma zamanı parametrelerini belirtir

Name Tür Description
alwaysQuerySource

boolean

Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir.

enableImageServing

boolean

Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir.

failOnError

boolean

Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur.

includeReferenceSourceData

boolean

Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir.

includeReferences

boolean

Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir.

kind string:

fabricDataAgent

Bilgi kaynağının türü.

knowledgeSourceName

string

Parametrelerin uygulandığı dizinin adı.

maxOutputDocuments

integer (int32)

Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar.

neverQuerySource

boolean

Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez.

rerankerThreshold

number (float)

Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği.

resultsProcessing

KnowledgeSourceResultsProcessing

Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır.

FabricOntologyKnowledgeSourceParams

Fabric Ontology bilgi kaynağı için çalışma zamanı parametrelerini belirtir

Name Tür Description
alwaysQuerySource

boolean

Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir.

enableImageServing

boolean

Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir.

failOnError

boolean

Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur.

includeReferenceSourceData

boolean

Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir.

includeReferences

boolean

Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir.

kind string:

fabricOntology

Bilgi kaynağının türü.

knowledgeSourceName

string

Parametrelerin uygulandığı dizinin adı.

maxOutputDocuments

integer (int32)

Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar.

neverQuerySource

boolean

Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez.

rerankerThreshold

number (float)

Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği.

resultsProcessing

KnowledgeSourceResultsProcessing

Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır.

FileKnowledgeSourceParams

Bir Dosya bilgi kaynağı için çalışma zamanı parametrelerini belirtir

Name Tür Description
alwaysQuerySource

boolean

Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir.

enableImageServing

boolean

Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir.

failOnError

boolean

Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur.

includeReferenceSourceData

boolean

Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir.

includeReferences

boolean

Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir.

kind string:

file

Bilgi kaynağının türü.

knowledgeSourceName

string

Parametrelerin uygulandığı dizinin adı.

maxOutputDocuments

integer (int32)

Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar.

neverQuerySource

boolean

Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez.

queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Sorgu planlamasını faydalı filtreler ve güçlendirmeler için yönlendiren ipuçları. Belirtilirse, bu nesne bilgi kaynağında yapılandırılmış tüm sorgu ipuçları setinin yerini alır.

rerankerThreshold

number (float)

Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği.

resultsProcessing

KnowledgeSourceResultsProcessing

Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır.

ImageServingStatistics

Bir geri alma etkinliği sırasında görüntü servisi hakkında istatistikler.

Name Tür Description
imagesRetrieved

integer (int32)

Varlık mağazasından alınan görüntü sayısı.

imagesSentToModel

integer (int32)

Aşağı akış modeline gönderilen görüntü sayısı.

servedImages

ServedImage[]

Modelin seçtiği görüntü kümesi, bu geri alım etkinliği için aşağı akış modeline sunulur.

totalImageSizeBytes

integer (int64)

Modele gönderilen resimlerin bayt cinsinden toplam boyutu.

verbalizationUsed

boolean

Doğrudan görüntü servisi yerine görüntü sözlü kullanımının kullanılıp kullanılmadığını gösterir.

IndexedOneLakeKnowledgeSourceParams

Dizinlenmiş OneLake bilgi kaynağı için çalışma zamanı parametrelerini belirtir

Name Tür Description
alwaysQuerySource

boolean

Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir.

enableImageServing

boolean

Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir.

failOnError

boolean

Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur.

includeReferenceSourceData

boolean

Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir.

includeReferences

boolean

Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir.

kind string:

indexedOneLake

Bilgi kaynağının türü.

knowledgeSourceName

string

Parametrelerin uygulandığı dizinin adı.

maxOutputDocuments

integer (int32)

Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar.

neverQuerySource

boolean

Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez.

queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Sorgu planlamasını faydalı filtreler ve güçlendirmeler için yönlendiren ipuçları. Belirtilirse, bu nesne bilgi kaynağında yapılandırılmış tüm sorgu ipuçları setinin yerini alır.

rerankerThreshold

number (float)

Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği.

resultsProcessing

KnowledgeSourceResultsProcessing

Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır.

IndexedSharePointKnowledgeSourceParams

Dizine alınmış SharePoint bilgi kaynağı için çalışma zamanı parametrelerini belirtir

Name Tür Description
alwaysQuerySource

boolean

Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir.

enableImageServing

boolean

Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir.

failOnError

boolean

Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur.

includeReferenceSourceData

boolean

Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir.

includeReferences

boolean

Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir.

kind string:

indexedSharePoint

Bilgi kaynağının türü.

knowledgeSourceName

string

Parametrelerin uygulandığı dizinin adı.

maxOutputDocuments

integer (int32)

Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar.

neverQuerySource

boolean

Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez.

queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Sorgu planlamasını faydalı filtreler ve güçlendirmeler için yönlendiren ipuçları. Belirtilirse, bu nesne bilgi kaynağında yapılandırılmış tüm sorgu ipuçları setinin yerini alır.

rerankerThreshold

number (float)

Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği.

resultsProcessing

KnowledgeSourceResultsProcessing

Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır.

IndexedSqlKnowledgeSourceParams

İndekslenmiş SQL bilgi kaynağı için çalışma zamanı parametrelerini belirtir

Name Tür Description
alwaysQuerySource

boolean

Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir.

enableImageServing

boolean

Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir.

failOnError

boolean

Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur.

includeReferenceSourceData

boolean

Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir.

includeReferences

boolean

Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir.

kind string:

indexedSql

Bilgi kaynağının türü.

knowledgeSourceName

string

Parametrelerin uygulandığı dizinin adı.

maxOutputDocuments

integer (int32)

Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar.

neverQuerySource

boolean

Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez.

queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Sorgu planlamasını faydalı filtreler ve güçlendirmeler için yönlendiren ipuçları. Belirtilirse, bu nesne bilgi kaynağında yapılandırılmış tüm sorgu ipuçları setinin yerini alır.

rerankerThreshold

number (float)

Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği.

resultsProcessing

KnowledgeSourceResultsProcessing

Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır.

KnowledgeBaseActivityRecordModel

Bilgi tabanı LLM etkinliği için kullanılan modeli, model adı ve dağıtım tanımlayıcısı dahil olmak üzere temsil eder.

Name Tür Description
deploymentId

string

Etkinlik için kullanılan modelin dağıtım tanımlayıcısı.

modelName

string

Etkinlik için kullanılan modelin adı.

KnowledgeBaseActivityRecordType

Faaliyet kaydının türü.

Değer Description
searchIndex

Arama indeks alma faaliyeti.

azureBlob

Azure Blob retrieval activity.

indexedSharePoint

Indekslenmiş SharePoint alma etkinliği.

indexedOneLake

OneLake toplama etkinliği indekslendi.

web

Web arama faaliyeti.

remoteSharePoint

Uzaktan SharePoint alma etkinliği.

workIQ

WorkIQ geri alma etkinliği.

fabricDataAgent

Fabric Veri Ajanı alma etkinliği.

fabricOntology

Fabric Ontology geri alma etkinliği.

mcpServer

MCP sunucu alma faaliyeti.

file

Dosya alma faaliyeti.

indexedSql

Indekslenmiş SQL alma etkinliği.

modelQueryPlanning

LLM sorgulama planlama faaliyeti.

modelAnswerSynthesis

LLM cevap sentez aktivitesi.

modelWebSummarization

LLM web özetleme etkinliği.

agenticReasoning

Ajanik akıl yürütme faaliyeti.

KnowledgeBaseAgenticReasoningActivityRecord

Aracılı bir akıl yürütme etkinliği kaydını temsil eder.

Name Tür Description
completedAt

string (date-time)

Etkinliğin tamamlandığı zaman.

elapsedMs

integer (int32)

Alma etkinliği için milisaniye cinsinden geçen süre.

error

KnowledgeBaseErrorDetail

İşlemin neden başarısız olduğunu açıklayan hata ayrıntısı. Bu özellik yalnızca etkinlik başarılı olmadığında dahil edilir.

id

integer (int32)

Etkinlik kaydının kimliği.

logicalReasoningEffort KnowledgeRetrievalReasoningEffort:

Müşterinin talep ettiği mantıksal akıl yürütme çabası. Bu, faturalama için kullanılan mantık çabasını bildiren 'den farklıdır retrievalReasoningEffort.

reasoningTokens

integer (int32)

Aracılı akıl yürütme için giriş belirteçlerinin sayısı.

retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

Geri getirme amaç yürütme çabası yapılandırması.

startedAt

string (date-time)

Etkinliğin başladığı zaman.

type string:

agenticReasoning

Etkinlik kaydının türü.

warning

string

Etkinlik sırasında gözlemlenen olası yapılandırma sorunlarını ortaya çıkaran bir uyarı mesajı; örneğin skor eşiği belirleme, token sınırı kesintisi veya zaman aşımı koşulları nedeniyle düşen belgeler.

KnowledgeBaseAzureBlobActivityArguments

Azure blob alma etkinliğinin çalıştırıldığı bağımsız değişkenleri temsil eder.

Name Tür Description
search

string

Blob içeriğini sorgulamak için kullanılan arama dizesi.

KnowledgeBaseAzureBlobActivityRecord

Azure blob alma etkinliği kaydını temsil eder.

Name Tür Description
azureBlobArguments

KnowledgeBaseAzureBlobActivityArguments

Alma etkinliği için azure blob bağımsız değişkenleri.

completedAt

string (date-time)

Etkinliğin tamamlandığı zaman.

count

integer (int32)

Yeniden sıralama eşiğini geçmek için yeterince alakalı olan alınan belgelerin sayısı.

elapsedMs

integer (int32)

Alma etkinliği için milisaniye cinsinden geçen süre.

error

KnowledgeBaseErrorDetail

İşlemin neden başarısız olduğunu açıklayan hata ayrıntısı. Bu özellik yalnızca etkinlik başarılı olmadığında dahil edilir.

id

integer (int32)

Etkinlik kaydının kimliği.

imageServing

ImageServingStatistics

Bu arama etkinliği için görüntü hizmeti hakkında istatistikler

knowledgeSourceName

string

Alma etkinliği için bilgi kaynağı.

queryHintProcessing

KnowledgeBaseQueryHintProcessing

Bu etkinlik için sorgu ipuçlarından oluşturulan ifadelerle ilgili detaylar.

queryTime

string (date-time)

Bu alma etkinliği için sorgu süresi.

startedAt

string (date-time)

Etkinliğin başladığı zaman.

type string:

azureBlob

Etkinlik kaydının türü.

warning

string

Etkinlik sırasında gözlemlenen olası yapılandırma sorunlarını ortaya çıkaran bir uyarı mesajı; örneğin skor eşiği belirleme, token sınırı kesintisi veya zaman aşımı koşulları nedeniyle düşen belgeler.

KnowledgeBaseAzureBlobReference

Azure Blob Depolama belge başvurusunu temsil eder.

Name Tür Description
activitySource

integer (int32)

Başvuru için kaynak etkinlik kimliği.

blobUrl

string

Başvuru için blob URL'si.

citationUrl

string (uri)

Bu referans için destek belgesine işaret eden, atıf hedefi olarak kullanılabilir bir Arama kaynaklı URL.

id

string

Başvurunun kimliği.

rerankerScore

number (float)

Belge referansı için yeniden sıralayıcı puanı.

searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Referans için hassasiyet etiketi bilgisi.

sourceData

Referans için kaynak veriler.

type string:

azureBlob

Başvurunun türü.

KnowledgeBaseErrorAdditionalInfo

Kaynak yönetimi hatasına ilişkin ek bilgiler.

Name Tür Description
info

Ek bilgiler.

type

string

Ek bilgi türü.

KnowledgeBaseErrorDetail

Hata ayrıntıları.

Name Tür Description
additionalInfo

KnowledgeBaseErrorAdditionalInfo[]

Hata ek bilgisi.

code

string

Hata kodu.

details

KnowledgeBaseErrorDetail[]

Hata ayrıntıları.

message

string

Hata iletisi.

target

string

Hata hedefi

KnowledgeBaseFabricDataAgentActivityArguments

Fabric Data Agent alma etkinliğinin çalıştırıldığı argümanları temsil eder.

Name Tür Description
search

string

Fabric Data Agent bilgi kaynağını sorgulamak için kullanılan arama dizisi.

KnowledgeBaseFabricDataAgentActivityRecord

Bir Fabric Veri Ajanı alma etkinlik kaydını temsil eder.

Name Tür Description
completedAt

string (date-time)

Etkinliğin tamamlandığı zaman.

count

integer (int32)

Yeniden sıralama eşiğini geçmek için yeterince alakalı olan alınan belgelerin sayısı.

elapsedMs

integer (int32)

Alma etkinliği için milisaniye cinsinden geçen süre.

error

KnowledgeBaseErrorDetail

İşlemin neden başarısız olduğunu açıklayan hata ayrıntısı. Bu özellik yalnızca etkinlik başarılı olmadığında dahil edilir.

fabricDataAgentArguments

KnowledgeBaseFabricDataAgentActivityArguments

Fabric Data Agent erişim etkinliği için argümanlar.

id

integer (int32)

Etkinlik kaydının kimliği.

imageServing

ImageServingStatistics

Bu arama etkinliği için görüntü hizmeti hakkında istatistikler

knowledgeSourceName

string

Alma etkinliği için bilgi kaynağı.

queryTime

string (date-time)

Bu alma etkinliği için sorgu süresi.

startedAt

string (date-time)

Etkinliğin başladığı zaman.

type string:

fabricDataAgent

Etkinlik kaydının türü.

warning

string

Etkinlik sırasında gözlemlenen olası yapılandırma sorunlarını ortaya çıkaran bir uyarı mesajı; örneğin skor eşiği belirleme, token sınırı kesintisi veya zaman aşımı koşulları nedeniyle düşen belgeler.

KnowledgeBaseFabricDataAgentReference

Bir Fabric Data Agent belge referansını temsil eder.

Name Tür Description
activitySource

integer (int32)

Başvuru için kaynak etkinlik kimliği.

dataAgentId

string

Fabric Veri Ajanı ID'si.

id

string

Başvurunun kimliği.

rerankerScore

number (float)

Belge referansı için yeniden sıralayıcı puanı.

sourceData

Referans için kaynak veriler.

type string:

fabricDataAgent

Başvurunun türü.

workspaceId

string

Fabric çalışma alanı kimliği.

KnowledgeBaseFabricOntologyActivityArguments

Fabric Ontology geri alma etkinliğinin yürütüldiği argümanları temsil eder.

Name Tür Description
search

string

Fabric Ontology bilgi kaynağını sorgulamak için kullanılan arama dizisi.

KnowledgeBaseFabricOntologyActivityRecord

Fabric Ontology geri alma faaliyet kaydını temsil eder.

Name Tür Description
completedAt

string (date-time)

Etkinliğin tamamlandığı zaman.

count

integer (int32)

Yeniden sıralama eşiğini geçmek için yeterince alakalı olan alınan belgelerin sayısı.

elapsedMs

integer (int32)

Alma etkinliği için milisaniye cinsinden geçen süre.

error

KnowledgeBaseErrorDetail

İşlemin neden başarısız olduğunu açıklayan hata ayrıntısı. Bu özellik yalnızca etkinlik başarılı olmadığında dahil edilir.

fabricOntologyArguments

KnowledgeBaseFabricOntologyActivityArguments

Fabric Ontology, geri dönüş etkinliği için argümanlar.

id

integer (int32)

Etkinlik kaydının kimliği.

imageServing

ImageServingStatistics

Bu arama etkinliği için görüntü hizmeti hakkında istatistikler

knowledgeSourceName

string

Alma etkinliği için bilgi kaynağı.

queryTime

string (date-time)

Bu alma etkinliği için sorgu süresi.

startedAt

string (date-time)

Etkinliğin başladığı zaman.

type string:

fabricOntology

Etkinlik kaydının türü.

warning

string

Etkinlik sırasında gözlemlenen olası yapılandırma sorunlarını ortaya çıkaran bir uyarı mesajı; örneğin skor eşiği belirleme, token sınırı kesintisi veya zaman aşımı koşulları nedeniyle düşen belgeler.

KnowledgeBaseFabricOntologyReference

Fabric Ontology belge referansını temsil eder.

Name Tür Description
activitySource

integer (int32)

Başvuru için kaynak etkinlik kimliği.

id

string

Başvurunun kimliği.

ontologyId

string

Çalışma alanı içindeki ontoloji kimliği.

rerankerScore

number (float)

Belge referansı için yeniden sıralayıcı puanı.

sourceData

Referans için kaynak veriler.

type string:

fabricOntology

Başvurunun türü.

workspaceId

string

Fabric çalışma alanı kimliği.

KnowledgeBaseFileActivityArguments

Dosya alma etkinliğinin çalıştırıldığı argümanları temsil eder.

Name Tür Description
search

string

Dosya içeriğini sorgulamak için kullanılan arama dizisi.

KnowledgeBaseFileActivityRecord

Dosya alma faaliyet kaydını temsil eder.

Name Tür Description
completedAt

string (date-time)

Etkinliğin tamamlandığı zaman.

count

integer (int32)

Yeniden sıralama eşiğini geçmek için yeterince alakalı olan alınan belgelerin sayısı.

elapsedMs

integer (int32)

Alma etkinliği için milisaniye cinsinden geçen süre.

error

KnowledgeBaseErrorDetail

İşlemin neden başarısız olduğunu açıklayan hata ayrıntısı. Bu özellik yalnızca etkinlik başarılı olmadığında dahil edilir.

fileArguments

KnowledgeBaseFileActivityArguments

Dosya, alma etkinliği için argümanlar.

id

integer (int32)

Etkinlik kaydının kimliği.

imageServing

ImageServingStatistics

Bu arama etkinliği için görüntü hizmeti hakkında istatistikler

knowledgeSourceName

string

Alma etkinliği için bilgi kaynağı.

queryHintProcessing

KnowledgeBaseQueryHintProcessing

Bu etkinlik için sorgu ipuçlarından oluşturulan ifadelerle ilgili detaylar.

queryTime

string (date-time)

Bu alma etkinliği için sorgu süresi.

startedAt

string (date-time)

Etkinliğin başladığı zaman.

type string:

file

Etkinlik kaydının türü.

warning

string

Etkinlik sırasında gözlemlenen olası yapılandırma sorunlarını ortaya çıkaran bir uyarı mesajı; örneğin skor eşiği belirleme, token sınırı kesintisi veya zaman aşımı koşulları nedeniyle düşen belgeler.

KnowledgeBaseFileReference

Bir dosya belge referansını temsil eder.

Name Tür Description
activitySource

integer (int32)

Başvuru için kaynak etkinlik kimliği.

citationUrl

string (uri)

Bu referans için destek belgesine işaret eden, atıf hedefi olarak kullanılabilir bir Arama kaynaklı URL.

docName

string

Referans için belge adı.

id

string

Başvurunun kimliği.

rerankerScore

number (float)

Belge referansı için yeniden sıralayıcı puanı.

sourceData

Referans için kaynak veriler.

type string:

file

Başvurunun türü.

KnowledgeBaseImageContent

Görsel içeriği.

Name Tür Description
url

string (uri)

Resmin URL'si.

KnowledgeBaseIndexedOneLakeActivityArguments

Indekslenmiş OneLake alma etkinliğinin çalıştırıldığı argümanları temsil eder.

Name Tür Description
search

string

Arama dizisi, indekslenmiş OneLake içeriklerini sorgulamak için kullanılır.

KnowledgeBaseIndexedOneLakeActivityRecord

Indekslenmiş OneLake toplama aktivite kaydını temsil eder.

Name Tür Description
completedAt

string (date-time)

Etkinliğin tamamlandığı zaman.

count

integer (int32)

Yeniden sıralama eşiğini geçmek için yeterince alakalı olan alınan belgelerin sayısı.

elapsedMs

integer (int32)

Alma etkinliği için milisaniye cinsinden geçen süre.

error

KnowledgeBaseErrorDetail

İşlemin neden başarısız olduğunu açıklayan hata ayrıntısı. Bu özellik yalnızca etkinlik başarılı olmadığında dahil edilir.

id

integer (int32)

Etkinlik kaydının kimliği.

imageServing

ImageServingStatistics

Bu arama etkinliği için görüntü hizmeti hakkında istatistikler

indexedOneLakeArguments

KnowledgeBaseIndexedOneLakeActivityArguments

Geri alma etkinliği için indekslenmiş OneLake argümanları.

knowledgeSourceName

string

Alma etkinliği için bilgi kaynağı.

queryHintProcessing

KnowledgeBaseQueryHintProcessing

Bu etkinlik için sorgu ipuçlarından oluşturulan ifadelerle ilgili detaylar.

queryTime

string (date-time)

Bu alma etkinliği için sorgu süresi.

startedAt

string (date-time)

Etkinliğin başladığı zaman.

type string:

indexedOneLake

Etkinlik kaydının türü.

warning

string

Etkinlik sırasında gözlemlenen olası yapılandırma sorunlarını ortaya çıkaran bir uyarı mesajı; örneğin skor eşiği belirleme, token sınırı kesintisi veya zaman aşımı koşulları nedeniyle düşen belgeler.

KnowledgeBaseIndexedOneLakeReference

Indekslenmiş bir OneLake belge referansını temsil eder.

Name Tür Description
activitySource

integer (int32)

Başvuru için kaynak etkinlik kimliği.

citationUrl

string (uri)

Bu referans için destek belgesine işaret eden, atıf hedefi olarak kullanılabilir bir Arama kaynaklı URL.

docUrl

string

Başvuru için belge URL'si.

id

string

Başvurunun kimliği.

rerankerScore

number (float)

Belge referansı için yeniden sıralayıcı puanı.

searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Referans için hassasiyet etiketi bilgisi.

sourceData

Referans için kaynak veriler.

type string:

indexedOneLake

Başvurunun türü.

KnowledgeBaseIndexedSharePointActivityArguments

Indekslenmiş SharePoint alma etkinliğinin çalıştırıldığı argümanları temsil eder.

Name Tür Description
search

string

Indekslenmiş SharePoint içeriklerini sorgulamak için kullanılan arama dizisi.

KnowledgeBaseIndexedSharePointActivityRecord

Indekslenmiş SharePoint alma faaliyet kaydını temsil eder.

Name Tür Description
completedAt

string (date-time)

Etkinliğin tamamlandığı zaman.

count

integer (int32)

Yeniden sıralama eşiğini geçmek için yeterince alakalı olan alınan belgelerin sayısı.

elapsedMs

integer (int32)

Alma etkinliği için milisaniye cinsinden geçen süre.

error

KnowledgeBaseErrorDetail

İşlemin neden başarısız olduğunu açıklayan hata ayrıntısı. Bu özellik yalnızca etkinlik başarılı olmadığında dahil edilir.

id

integer (int32)

Etkinlik kaydının kimliği.

imageServing

ImageServingStatistics

Bu arama etkinliği için görüntü hizmeti hakkında istatistikler

indexedSharePointArguments

KnowledgeBaseIndexedSharePointActivityArguments

Alma etkinliği için indekslenmiş SharePoint argümanları.

knowledgeSourceName

string

Alma etkinliği için bilgi kaynağı.

queryHintProcessing

KnowledgeBaseQueryHintProcessing

Bu etkinlik için sorgu ipuçlarından oluşturulan ifadelerle ilgili detaylar.

queryTime

string (date-time)

Bu alma etkinliği için sorgu süresi.

startedAt

string (date-time)

Etkinliğin başladığı zaman.

type string:

indexedSharePoint

Etkinlik kaydının türü.

warning

string

Etkinlik sırasında gözlemlenen olası yapılandırma sorunlarını ortaya çıkaran bir uyarı mesajı; örneğin skor eşiği belirleme, token sınırı kesintisi veya zaman aşımı koşulları nedeniyle düşen belgeler.

KnowledgeBaseIndexedSharePointReference

Indekslenmiş SharePoint belge referansını temsil eder.

Name Tür Description
activitySource

integer (int32)

Başvuru için kaynak etkinlik kimliği.

citationUrl

string (uri)

Bu referans için destek belgesine işaret eden, atıf hedefi olarak kullanılabilir bir Arama kaynaklı URL.

docUrl

string

Başvuru için belge URL'si.

id

string

Başvurunun kimliği.

rerankerScore

number (float)

Belge referansı için yeniden sıralayıcı puanı.

searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Referans için hassasiyet etiketi bilgisi.

sourceData

Referans için kaynak veriler.

type string:

indexedSharePoint

Başvurunun türü.

KnowledgeBaseIndexedSqlActivityArguments

Indekslenmiş SQL alma etkinliğinin çalıştırıldığı argümanları temsil eder.

Name Tür Description
search

string

Indekslenmiş SQL içeriklerini sorgulamak için kullanılan arama dizisi.

KnowledgeBaseIndexedSqlActivityRecord

Indekslenmiş SQL alma etkinlik kaydını temsil eder.

Name Tür Description
completedAt

string (date-time)

Etkinliğin tamamlandığı zaman.

count

integer (int32)

Yeniden sıralama eşiğini geçmek için yeterince alakalı olan alınan belgelerin sayısı.

elapsedMs

integer (int32)

Alma etkinliği için milisaniye cinsinden geçen süre.

error

KnowledgeBaseErrorDetail

İşlemin neden başarısız olduğunu açıklayan hata ayrıntısı. Bu özellik yalnızca etkinlik başarılı olmadığında dahil edilir.

id

integer (int32)

Etkinlik kaydının kimliği.

imageServing

ImageServingStatistics

Bu arama etkinliği için görüntü hizmeti hakkında istatistikler

indexedSqlArguments

KnowledgeBaseIndexedSqlActivityArguments

Alma etkinliği için indekslenmiş SQL argümanları.

knowledgeSourceName

string

Alma etkinliği için bilgi kaynağı.

queryHintProcessing

KnowledgeBaseQueryHintProcessing

Bu etkinlik için sorgu ipuçlarından oluşturulan ifadelerle ilgili detaylar.

queryTime

string (date-time)

Bu alma etkinliği için sorgu süresi.

startedAt

string (date-time)

Etkinliğin başladığı zaman.

type string:

indexedSql

Etkinlik kaydının türü.

warning

string

Etkinlik sırasında gözlemlenen olası yapılandırma sorunlarını ortaya çıkaran bir uyarı mesajı; örneğin skor eşiği belirleme, token sınırı kesintisi veya zaman aşımı koşulları nedeniyle düşen belgeler.

KnowledgeBaseIndexedSqlReference

Azure SQL belge referansını temsil eder.

Name Tür Description
activitySource

integer (int32)

Başvuru için kaynak etkinlik kimliği.

citationUrl

string (uri)

Bu referans için destek belgesine işaret eden, atıf hedefi olarak kullanılabilir bir Arama kaynaklı URL.

docUrl

string

Başvuru için belge URL'si.

id

string

Başvurunun kimliği.

rerankerScore

number (float)

Belge referansı için yeniden sıralayıcı puanı.

sourceData

Referans için kaynak veriler.

type string:

indexedSql

Başvurunun türü.

KnowledgeBaseMcpServerActivityArguments

MCP sunucu alma etkinliğinin çalıştırıldığı argümanları temsil eder.

Name Tür Description
toolArguments

Argümanlar MCP sunucu aracına iletildi.

toolName

string

Alma etkinliği için kullanılan MCP sunucu aracının adı.

KnowledgeBaseMcpServerActivityRecord

MCP sunucu alma etkinliği kaydını temsil eder.

Name Tür Description
completedAt

string (date-time)

Etkinliğin tamamlandığı zaman.

count

integer (int32)

Yeniden sıralama eşiğini geçmek için yeterince alakalı olan alınan belgelerin sayısı.

elapsedMs

integer (int32)

Alma etkinliği için milisaniye cinsinden geçen süre.

error

KnowledgeBaseErrorDetail

İşlemin neden başarısız olduğunu açıklayan hata ayrıntısı. Bu özellik yalnızca etkinlik başarılı olmadığında dahil edilir.

id

integer (int32)

Etkinlik kaydının kimliği.

imageServing

ImageServingStatistics

Bu arama etkinliği için görüntü hizmeti hakkında istatistikler

knowledgeSourceName

string

Alma etkinliği için bilgi kaynağı.

mcpServerArguments

KnowledgeBaseMcpServerActivityArguments

MCP sunucusu, alma etkinliği için argümanlar.

queryTime

string (date-time)

Bu alma etkinliği için sorgu süresi.

startedAt

string (date-time)

Etkinliğin başladığı zaman.

type string:

mcpServer

Etkinlik kaydının türü.

warning

string

Etkinlik sırasında gözlemlenen olası yapılandırma sorunlarını ortaya çıkaran bir uyarı mesajı; örneğin skor eşiği belirleme, token sınırı kesintisi veya zaman aşımı koşulları nedeniyle düşen belgeler.

KnowledgeBaseMcpServerReference

MCP sunucu belge referansını temsil eder.

Name Tür Description
activitySource

integer (int32)

Başvuru için kaynak etkinlik kimliği.

id

string

Başvurunun kimliği.

rerankerScore

number (float)

Belge referansı için yeniden sıralayıcı puanı.

sourceData

Referans için kaynak veriler.

title

string

MCP sunucu aracının sonucunun başlığı.

toolName

string

Referansı üreten MCP sunucu aracının adı.

type string:

mcpServer

Başvurunun türü.

KnowledgeBaseMessage

Doğal dil ileti stili nesnesi.

Name Tür Description
content KnowledgeBaseMessageContent[]:

İletinin içeriği.

role

string

Araç yanıtının rolü.

KnowledgeBaseMessageContentType

İleti içeriğinin türü.

Değer Description
text

Kısa mesaj içerik türü.

image

Resimli mesaj içerik türü.

KnowledgeBaseMessageImageContent

Resim mesajı türü.

Name Tür Description
image

KnowledgeBaseImageContent

Görüntü içeriği.

type string:

image

Mesajın türü

KnowledgeBaseMessageTextContent

Kısa mesaj türü.

Name Tür Description
text

string

Metin içeriği.

type string:

text

Mesajın türü

KnowledgeBaseModelAnswerSynthesisActivityRecord

Bir LLM yanıt sentezi etkinlik kaydını temsil eder.

Name Tür Description
completedAt

string (date-time)

Etkinliğin tamamlandığı zaman.

elapsedMs

integer (int32)

Alma etkinliği için milisaniye cinsinden geçen süre.

error

KnowledgeBaseErrorDetail

İşlemin neden başarısız olduğunu açıklayan hata ayrıntısı. Bu özellik yalnızca etkinlik başarılı olmadığında dahil edilir.

id

integer (int32)

Etkinlik kaydının kimliği.

inputTokens

integer (int32)

LLM yanıt sentezi etkinliği için giriş belirteçlerinin sayısı.

model

KnowledgeBaseActivityRecordModel

LLM cevap sentezi aktivitesi için kullanılan model.

outputTokens

integer (int32)

LLM yanıt sentezi etkinliği için çıktı belirteçlerinin sayısı.

startedAt

string (date-time)

Etkinliğin başladığı zaman.

type string:

modelAnswerSynthesis

Etkinlik kaydının türü.

warning

string

Etkinlik sırasında gözlemlenen olası yapılandırma sorunlarını ortaya çıkaran bir uyarı mesajı; örneğin skor eşiği belirleme, token sınırı kesintisi veya zaman aşımı koşulları nedeniyle düşen belgeler.

KnowledgeBaseModelQueryPlanningActivityRecord

Bir LLM sorgu planlama etkinliği kaydını temsil eder.

Name Tür Description
completedAt

string (date-time)

Etkinliğin tamamlandığı zaman.

elapsedMs

integer (int32)

Alma etkinliği için milisaniye cinsinden geçen süre.

error

KnowledgeBaseErrorDetail

İşlemin neden başarısız olduğunu açıklayan hata ayrıntısı. Bu özellik yalnızca etkinlik başarılı olmadığında dahil edilir.

id

integer (int32)

Etkinlik kaydının kimliği.

inputTokens

integer (int32)

LLM sorgu planlama etkinliği için giriş belirteçlerinin sayısı.

model

KnowledgeBaseActivityRecordModel

LLM sorgu planlama etkinliği için kullanılan model.

outputTokens

integer (int32)

LLM sorgu planlama etkinliği için çıktı belirteçlerinin sayısı.

startedAt

string (date-time)

Etkinliğin başladığı zaman.

type string:

modelQueryPlanning

Etkinlik kaydının türü.

warning

string

Etkinlik sırasında gözlemlenen olası yapılandırma sorunlarını ortaya çıkaran bir uyarı mesajı; örneğin skor eşiği belirleme, token sınırı kesintisi veya zaman aşımı koşulları nedeniyle düşen belgeler.

KnowledgeBaseModelWebSummarizationActivityRecord

LLM web özetleme faaliyet kaydını temsil eder.

Name Tür Description
completedAt

string (date-time)

Etkinliğin tamamlandığı zaman.

elapsedMs

integer (int32)

Alma etkinliği için milisaniye cinsinden geçen süre.

error

KnowledgeBaseErrorDetail

İşlemin neden başarısız olduğunu açıklayan hata ayrıntısı. Bu özellik yalnızca etkinlik başarılı olmadığında dahil edilir.

id

integer (int32)

Etkinlik kaydının kimliği.

inputTokens

integer (int32)

LLM web özetleme etkinliği için giriş tokenlarının sayısı.

model

KnowledgeBaseActivityRecordModel

LLM web özetleme etkinliği için kullanılan model.

outputTokens

integer (int32)

LLM web özetleme etkinliği için çıktı tokenlarının sayısı.

startedAt

string (date-time)

Etkinliğin başladığı zaman.

type string:

modelWebSummarization

Etkinlik kaydının türü.

warning

string

Etkinlik sırasında gözlemlenen olası yapılandırma sorunlarını ortaya çıkaran bir uyarı mesajı; örneğin skor eşiği belirleme, token sınırı kesintisi veya zaman aşımı koşulları nedeniyle düşen belgeler.

KnowledgeBaseQueryHintProcessing

Bir alma etkinliği için sorgu ipuçlarından oluşturulan ifadelerle ilgili ayrıntılar.

Name Tür Description
generatedBoost

string

Bu etkinlik için ipuçlarından oluşturulan arama maddesi.

generatedFilter

string

Filtreden üretilen filtre ifadesi bu aktivite için ipuçları verir.

KnowledgeBaseReferenceType

Başvurunun türü.

Değer Description
searchIndex

İndeks belge referansını arayın.

azureBlob

Azure Blob document reference.

indexedSharePoint

Indekslenmiş SharePoint belge referansı.

indexedOneLake

OneLake belge referansı indekslenmiştir.

web

Web belge referansı.

remoteSharePoint

Uzaktan SharePoint belge referansı.

workIQ

İş IQ belge referansı.

fabricDataAgent

Fabric Data Agent belge referansı.

fabricOntology

Fabric Ontology belge referansı.

mcpServer

MCP sunucu belge referansı.

file

Dosya belge referansı.

indexedSql

Indekslenmiş SQL belge referansı.

KnowledgeBaseRemoteSharePointActivityArguments

Uzak SharePoint alma etkinliğinin çalıştırıldığı argümanları temsil eder.

Name Tür Description
filterExpressionAddOn

string

Alma etkinliği için filtre ifade eklentisi.

search

string

Arama dizisi, uzak SharePoint bilgi kaynağını sorgulamak için kullanılır.

KnowledgeBaseRemoteSharePointActivityRecord

Uzak SharePoint alma etkinliği kaydını temsil eder.

Name Tür Description
completedAt

string (date-time)

Etkinliğin tamamlandığı zaman.

count

integer (int32)

Yeniden sıralama eşiğini geçmek için yeterince alakalı olan alınan belgelerin sayısı.

elapsedMs

integer (int32)

Alma etkinliği için milisaniye cinsinden geçen süre.

error

KnowledgeBaseErrorDetail

İşlemin neden başarısız olduğunu açıklayan hata ayrıntısı. Bu özellik yalnızca etkinlik başarılı olmadığında dahil edilir.

id

integer (int32)

Etkinlik kaydının kimliği.

imageServing

ImageServingStatistics

Bu arama etkinliği için görüntü hizmeti hakkında istatistikler

knowledgeSourceName

string

Alma etkinliği için bilgi kaynağı.

queryTime

string (date-time)

Bu alma etkinliği için sorgu süresi.

remoteSharePointArguments

KnowledgeBaseRemoteSharePointActivityArguments

Alma etkinliği için uzak SharePoint argümanları.

startedAt

string (date-time)

Etkinliğin başladığı zaman.

type string:

remoteSharePoint

Etkinlik kaydının türü.

warning

string

Etkinlik sırasında gözlemlenen olası yapılandırma sorunlarını ortaya çıkaran bir uyarı mesajı; örneğin skor eşiği belirleme, token sınırı kesintisi veya zaman aşımı koşulları nedeniyle düşen belgeler.

KnowledgeBaseRemoteSharePointReference

Uzak SharePoint belge başvurusunu temsil eder.

Name Tür Description
activitySource

integer (int32)

Başvuru için kaynak etkinlik kimliği.

id

string

Başvurunun kimliği.

rerankerScore

number (float)

Belge referansı için yeniden sıralayıcı puanı.

searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Referans için hassasiyet etiketi bilgisi.

sourceData

Referans için kaynak veriler.

type string:

remoteSharePoint

Başvurunun türü.

webUrl

string (uri)

Referans verilerin kaynaklandığı url.

KnowledgeBaseRetrievalRequest

Alma isteği için giriş sözleşmesi.

Name Tür Description
includeActivity

boolean

Alma sonuçlarının etkinlik bilgilerini içermesi gerektiğini belirtir.

intents KnowledgeRetrievalIntent[]:

KnowledgeRetrievalSemanticIntent[]

Model sorgu planlaması olmadan yürütülecek amaçlanan sorguların listesi.

knowledgeSourceParams KnowledgeSourceParams[]:

Bilgi kaynakları için çalışma zamanı parametrelerinin listesi.

maxOutputDocuments

integer (int32)

Çıktıdaki maksimum belge sayısını sınırlar.

maxOutputSize

integer (int32)

Çıktıdaki içeriğin maksimum boyutunu sınırlar.

maxOutputSizeInTokens

integer (int32)

Çıktıdaki içeriğin maksimum boyutunu sınırlar.

maxRuntimeInSeconds

integer (int32)

Saniye cinsinden maksimum çalışma zamanı.

messages

KnowledgeBaseMessage[]

Sohbet iletisi stili girişlerinin listesi.

outputMode

KnowledgeRetrievalOutputMode

Bu alma için çıkış yapılandırması.

retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

Geri getirme amaç yürütme çabası yapılandırması.

KnowledgeBaseRetrievalResponse

Alma yanıtı için çıkış sözleşmesi.

Name Tür Description
activity KnowledgeBaseActivityRecord[]:

İlerlemeyi ve faturalandırma etkilerini izlemek için etkinlik kayıtları.

references KnowledgeBaseReference[]:

Yanıtta kullanılan alma verileri için başvurular.

response

KnowledgeBaseMessage[]

Yanıt mesajları.

responseSensitivityLabelInfo

PurviewSensitivityLabelInfo

Genel yanıt için duyarlılık etiketi bilgisi.

KnowledgeBaseSearchIndexActivityArguments

Arama dizini alma etkinliğinin çalıştırıldığı bağımsız değişkenleri temsil eder.

Name Tür Description
filter

string

Filtre dizesi.

queryType

QueryType

Aramayı çalıştırmak için kullanılan sorgu sözdizimi. Sorgu ipuçları, anlamsal sorguların tam sorgu sözdizimi kullanmasına neden olabilir.

search

string

Arama dizinini sorgulamak için kullanılan arama dizesi.

searchFields

SearchIndexFieldReference[]

Hangi alanlara karşı aranıyordu.

semanticConfigurationName

string

Arama dizininden hangi anlamsal yapılandırma kullanıldı.

sourceDataFields

SearchIndexFieldReference[]

Hangi alanlar arama için seçildi.

KnowledgeBaseSearchIndexActivityRecord

Bir arama dizini alma etkinliği kaydını temsil eder.

Name Tür Description
completedAt

string (date-time)

Etkinliğin tamamlandığı zaman.

count

integer (int32)

Yeniden sıralama eşiğini geçmek için yeterince alakalı olan alınan belgelerin sayısı.

elapsedMs

integer (int32)

Alma etkinliği için milisaniye cinsinden geçen süre.

error

KnowledgeBaseErrorDetail

İşlemin neden başarısız olduğunu açıklayan hata ayrıntısı. Bu özellik yalnızca etkinlik başarılı olmadığında dahil edilir.

id

integer (int32)

Etkinlik kaydının kimliği.

imageServing

ImageServingStatistics

Bu arama etkinliği için görüntü hizmeti hakkında istatistikler

knowledgeSourceName

string

Alma etkinliği için bilgi kaynağı.

queryHintProcessing

KnowledgeBaseQueryHintProcessing

Bu etkinlik için sorgu ipuçlarından oluşturulan ifadelerle ilgili detaylar.

queryTime

string (date-time)

Bu alma etkinliği için sorgu süresi.

searchIndexArguments

KnowledgeBaseSearchIndexActivityArguments

Arama dizini, alma etkinliği için bağımsız değişkenler oluşturur.

startedAt

string (date-time)

Etkinliğin başladığı zaman.

type string:

searchIndex

Etkinlik kaydının türü.

warning

string

Etkinlik sırasında gözlemlenen olası yapılandırma sorunlarını ortaya çıkaran bir uyarı mesajı; örneğin skor eşiği belirleme, token sınırı kesintisi veya zaman aşımı koşulları nedeniyle düşen belgeler.

KnowledgeBaseSearchIndexReference

Bir Azure Search belge başvurusunu temsil eder.

Name Tür Description
activitySource

integer (int32)

Başvuru için kaynak etkinlik kimliği.

citationUrl

string (uri)

Bu referans için destek belgesine işaret eden, atıf hedefi olarak kullanılabilir bir Arama kaynaklı URL.

docKey

string

Başvuru için belge anahtarı.

id

string

Başvurunun kimliği.

rerankerScore

number (float)

Belge referansı için yeniden sıralayıcı puanı.

searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Referans için hassasiyet etiketi bilgisi.

sourceData

Referans için kaynak veriler.

type string:

searchIndex

Başvurunun türü.

KnowledgeBaseWebActivityArguments

Web alma etkinliğinin çalıştırıldığı argümanları temsil eder.

Name Tür Description
count

integer (int32)

Geri dönen web sonuçlarının sayısı.

freshness

string

Toplama etkinliği için tazelik.

language

string

Geri alma etkinliği için dil.

market

string

Geri alma faaliyeti için pazar.

search

string

Web'i sorgulamak için kullanılan arama dizisi.

KnowledgeBaseWebActivityRecord

Web alma faaliyet kaydını temsil eder.

Name Tür Description
completedAt

string (date-time)

Etkinliğin tamamlandığı zaman.

count

integer (int32)

Yeniden sıralama eşiğini geçmek için yeterince alakalı olan alınan belgelerin sayısı.

elapsedMs

integer (int32)

Alma etkinliği için milisaniye cinsinden geçen süre.

error

KnowledgeBaseErrorDetail

İşlemin neden başarısız olduğunu açıklayan hata ayrıntısı. Bu özellik yalnızca etkinlik başarılı olmadığında dahil edilir.

id

integer (int32)

Etkinlik kaydının kimliği.

imageServing

ImageServingStatistics

Bu arama etkinliği için görüntü hizmeti hakkında istatistikler

knowledgeSourceName

string

Alma etkinliği için bilgi kaynağı.

queryTime

string (date-time)

Bu alma etkinliği için sorgu süresi.

startedAt

string (date-time)

Etkinliğin başladığı zaman.

type string:

web

Etkinlik kaydının türü.

warning

string

Etkinlik sırasında gözlemlenen olası yapılandırma sorunlarını ortaya çıkaran bir uyarı mesajı; örneğin skor eşiği belirleme, token sınırı kesintisi veya zaman aşımı koşulları nedeniyle düşen belgeler.

webArguments

KnowledgeBaseWebActivityArguments

Geri alma etkinliği için web argümanları.

KnowledgeBaseWebReference

Bir web belgesi başvurusunu temsil eder.

Name Tür Description
activitySource

integer (int32)

Başvuru için kaynak etkinlik kimliği.

id

string

Başvurunun kimliği.

rerankerScore

number (float)

Belge referansı için yeniden sıralayıcı puanı.

sourceData

Referans için kaynak veriler.

title

string

Web belgesinin başlığı.

type string:

web

Başvurunun türü.

url

string (uri)

Referans verilerin kaynaklandığı url.

KnowledgeBaseWorkIQActivityArguments

WorkIQ geri alma etkinliğinin çalıştırıldığı argümanları temsil eder.

Name Tür Description
search

string

WorkIQ bilgi kaynağını sorgulamak için kullanılan arama dizisi.

KnowledgeBaseWorkIQActivityRecord

WorkIQ geri alma aktivite kaydını temsil eder.

Name Tür Description
completedAt

string (date-time)

Etkinliğin tamamlandığı zaman.

count

integer (int32)

Yeniden sıralama eşiğini geçmek için yeterince alakalı olan alınan belgelerin sayısı.

elapsedMs

integer (int32)

Alma etkinliği için milisaniye cinsinden geçen süre.

error

KnowledgeBaseErrorDetail

İşlemin neden başarısız olduğunu açıklayan hata ayrıntısı. Bu özellik yalnızca etkinlik başarılı olmadığında dahil edilir.

id

integer (int32)

Etkinlik kaydının kimliği.

imageServing

ImageServingStatistics

Bu arama etkinliği için görüntü hizmeti hakkında istatistikler

knowledgeSourceName

string

Alma etkinliği için bilgi kaynağı.

queryTime

string (date-time)

Bu alma etkinliği için sorgu süresi.

startedAt

string (date-time)

Etkinliğin başladığı zaman.

type string:

workIQ

Etkinlik kaydının türü.

warning

string

Etkinlik sırasında gözlemlenen olası yapılandırma sorunlarını ortaya çıkaran bir uyarı mesajı; örneğin skor eşiği belirleme, token sınırı kesintisi veya zaman aşımı koşulları nedeniyle düşen belgeler.

workIQArguments

KnowledgeBaseWorkIQActivityArguments

Geri alma etkinliği için WorkIQ argümanları.

KnowledgeBaseWorkIQReference

WorkIQ belge referansını temsil eder.

Name Tür Description
activitySource

integer (int32)

Başvuru için kaynak etkinlik kimliği.

id

string

Başvurunun kimliği.

rerankerScore

number (float)

Belge referansı için yeniden sıralayıcı puanı.

searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Referans için hassasiyet etiketi bilgisi.

sourceData

Referans için kaynak veriler.

type string:

workIQ

Başvurunun türü.

KnowledgeRetrievalAutoReasoningEffort

Geri alma sırasında otomatik olarak akıl yürütme çabasını seçin. Hizmet, her talebi en ucuz seviyeye ekliyor ve sadece ihtiyaç duyulduğu kadar, hizmetin maksimum mevcut seviyesine kadar yükseliyor.

Name Tür Description
kind string:

auto

Bir tür akıl yürütme çabası.

KnowledgeRetrievalIntentType

Kullanılacak bilgi bankası yapılandırması türü.

Değer Description
semantic

Doğal dil anlamsal sorgu amacı.

KnowledgeRetrievalLowReasoningEffort

Düşük muhakeme çabasıyla bilgi alımını çalıştırın.

Name Tür Description
kind string:

low

Bir tür akıl yürütme çabası.

KnowledgeRetrievalMediumReasoningEffort

Orta düzeyde akıl yürütme çabasıyla bilgi erişimini çalıştırın.

Name Tür Description
kind string:

medium

Bir tür akıl yürütme çabası.

KnowledgeRetrievalMinimalReasoningEffort

Minimum muhakeme çabasıyla bilgi alımını çalıştırın.

Name Tür Description
kind string:

minimal

Bir tür akıl yürütme çabası.

KnowledgeRetrievalOutputMode

Bu alma için çıkış yapılandırması.

Değer Description
extractiveData

Üretimsel değişiklik yapmadan doğrudan bilgi kaynaklarından veri döndürün.

answerSynthesis

Yanıt yükü için bir yanıt sentezleyin.

KnowledgeRetrievalReasoningEffortKind

Alma sırasında kullanılacak çaba miktarı.

Değer Description
minimal

Herhangi bir kaynak seçimi, sorgu planlaması veya yinelemeli arama gerçekleştirmez.

low

Geri alma sırasında düşük akıl yürütme kullanın.

medium

Geri alma sırasında makul miktarda akıl yürütme kullanın.

auto

Geri alma sırasında otomatik olarak akıl yürütme çabasını seçin, en ucuz seviyeden sadece gerektiği kadar yükseltin.

KnowledgeRetrievalSemanticIntent

Anlamsal bir sorgulama niyeti.

Name Tür Description
search

string

Yürütülecek anlamsal sorgu

type string:

semantic

Niyetin türü.

KnowledgeSourceKind

Bilgi kaynağının türü.

Değer Description
searchIndex

Bir Arama Dizini'nden veri okuyan bir bilgi kaynağı.

azureBlob

Azure Blob Depolama'dan bir Arama Dizini'ne veri okuyan ve alan bir bilgi kaynağı.

indexedSharePoint

Indekslenmiş SharePoint'ten veri okuyan bir bilgi kaynağı.

indexedOneLake

Indekslenmiş OneLake'den veri okuyan bir bilgi kaynağı.

indexedSql

Azure SQL Veritabanı veya SQL Yönetilen Örneği'dan bir Arama İndeksine veri alan ve alan bir bilgi kaynağı.

web

Web'den veri okuyan bir bilgi kaynağı.

remoteSharePoint

Uzak SharePoint'ten veri okuyan bir bilgi kaynağı.

workIQ

İş IQ'sundan veri okuyan bir bilgi kaynağı

file

Doğrudan dosya yükleme ve indekslemeyi destekleyen bir bilgi kaynağı.

mcpServer

MCP (Model Context Protocol) sunucusu tarafından desteklenen bir bilgi kaynağı.

fabricDataAgent

Fabric Veri Ajanı'ndan veri alan bir bilgi kaynağı.

fabricOntology

Microsoft Fabric Ontology ontolojilerinden veri alan bir bilgi kaynağı.

KnowledgeSourceResultsProcessing

Bir bilgi kaynağının sonuçlarının yeniden sıralanıp sıralanmadığını kontrol eder.

Değer Description
rerank

Bu bilgi kaynağından elde edilen sonuçlar yeniden sıralama hattından geçer. Bu varsayılan davranıştır.

none

Bu bilgi kaynağından elde edilen sonuçlar, yeniden sıralamayı atlar ve temel sıralarını korur.

McpServerKnowledgeSourceParams

MCP sunucu bilgi kaynağı için çalışma zamanı parametrelerini belirtir

Name Tür Description
alwaysQuerySource

boolean

Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir.

enableImageServing

boolean

Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir.

failOnError

boolean

Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur.

includeReferenceSourceData

boolean

Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir.

includeReferences

boolean

Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir.

kind string:

mcpServer

Bilgi kaynağının türü.

knowledgeSourceName

string

Parametrelerin uygulandığı dizinin adı.

maxOutputDocuments

integer (int32)

Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar.

neverQuerySource

boolean

Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez.

rerankerThreshold

number (float)

Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği.

resultsProcessing

KnowledgeSourceResultsProcessing

Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır.

PurviewSensitivityLabelInfo

Bir belgeye uygulanan hassasiyet etiketi hakkında bilgi

Name Tür Description
color

string

Yapılandırılmışsa, kullanıcı arabiriminin etiket için görüntülemesi gereken renk.

displayName

string

Duyarlılık etiketinin görünen adı.

isEncrypted

boolean

Duyarlılık etiketinin şifrelemeyi zorunlu kılıp kılmadığını gösterir.

priority

integer (int32)

Duyarlılık etiketinin uygulandığı öncelik.

sensitivityLabelId

string

Duyarlılık etiketinin kimliği.

toolTip

string

Kullanıcı arabiriminde etiket için görüntülenmesi gereken araç ipucu.

QueryType

Arama sorgusunun sözdizimini belirtir. Varsayılan değer 'basit'tir. Sorgunuz Lucene sorgu sözdizimini kullanıyorsa 'tam' ve sorgu söz dizimi gerekmiyorsa 'semantic' kullanın.

Değer Description
simple

Aramalar için basit sorgu sözdizimini kullanır. Arama metni, +, * ve "" gibi sembollere izin veren basit bir sorgu dili kullanılarak yorumlanır. Sorgular, searchFields parametresi belirtilmediği sürece varsayılan olarak tüm aranabilir alanlarda değerlendirilir.

full

Aramalar için tam Lucene sorgu sözdizimini kullanır. Arama metni, alana özgü ve ağırlıklı aramaların yanı sıra diğer gelişmiş özelliklere izin veren Lucene sorgu dili kullanılarak yorumlanır.

semantic

Anahtar kelimelerin aksine doğal dilde ifade edilen sorgular için en uygunudur. Web külliyatı üzerinde eğitilmiş bir sıralama modeli kullanarak en iyi arama sonuçlarını yeniden sıralayarak arama sonuçlarının kesinliğini artırır.

RemoteSharePointKnowledgeSourceParams

Uzak SharePoint bilgi kaynağı için çalışma zamanı parametrelerini belirtir

Name Tür Description
alwaysQuerySource

boolean

Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir.

enableImageServing

boolean

Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir.

failOnError

boolean

Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur.

filterExpressionAddOn

string

SharePoint veri kaynağına uygulanan bir filtre koşulu. Anahtar Sözcük Sorgu Dili sözdiziminde belirtilmelidir. Bilgi kaynağı tanımında belirtilen filtre ifadesiyle birleşim olarak birleştirilir.

includeReferenceSourceData

boolean

Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir.

includeReferences

boolean

Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir.

kind string:

remoteSharePoint

Bilgi kaynağının türü.

knowledgeSourceName

string

Parametrelerin uygulandığı dizinin adı.

maxOutputDocuments

integer (int32)

Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar.

neverQuerySource

boolean

Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez.

rerankerThreshold

number (float)

Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği.

resultsProcessing

KnowledgeSourceResultsProcessing

Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır.

SearchIndexFieldReference

Arama dizini için alan referansı.

Name Tür Description
name

string

Alanın adı.

SearchIndexKnowledgeSourceBoostKind

Arama indeks bilgi kaynağı için bir teşvik ipucu.

Değer Description
fieldValue

Belgeleri bir alan değerine göre güçlendirin.

multiWordExpression

Çok kelimeli bir ifade temelinde belgeleri güçlendirin.

SearchIndexKnowledgeSourceFieldValueBoost

Bir alan değerine göre belgeleri güçlendiren bir ipucu.

Name Tür Description
boost

number (double)

Belge puanı için bir çarpan. 1,0'a eşit olmayan pozitif bir sayı olmalıdır.

boostInstructions

string

Boost'un ne zaman ve nasıl uygulanacağını açıklayan doğal dil talimatları.

field

string

minLength: 1

Arama dizin alanının adı.

fieldValues

string[]

Alan için temsil değerler.

kind string:

fieldValue

Böyle bir boost ipucu.

SearchIndexKnowledgeSourceFilterHint

Bir alanı ve sorgu planlayıcısının filtre oluştururken kullanabileceği temsil eden değerleri tanımlayan bir ipucu.

Name Tür Description
field

string

minLength: 1

Filtrelenebilir arama dizin alanının adı.

fieldValues

string[]

Alan için temsil değerler.

filterInstructions

string

Sahada ne zaman ve nasıl filtreleyeceğimizi açıklayan doğal dil talimatları.

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Çok kelimeli bir ifade temelinde belgeleri güçlendiren bir ipucu.

Name Tür Description
boost

number (double)

Belge puanı için bir çarpan. 1,0'a eşit olmayan pozitif bir sayı olmalıdır.

boostInstructions

string

Boost'un ne zaman ve nasıl uygulanacağını açıklayan doğal dil talimatları.

fieldValues

string[]

Artış için temsili değerler.

kind string:

multiWordExpression

Böyle bir boost ipucu.

SearchIndexKnowledgeSourceParams

Arama dizini bilgi kaynağı için çalışma zamanı parametrelerini belirtir

Name Tür Description
alwaysQuerySource

boolean

Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir.

enableImageServing

boolean

Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir.

failOnError

boolean

Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur.

filterAddOn

string

Dizine uygulanan bir filtre koşulu (ör. "State eq VA").

includeReferenceSourceData

boolean

Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir.

includeReferences

boolean

Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir.

kind string:

searchIndex

Bilgi kaynağının türü.

knowledgeSourceName

string

Parametrelerin uygulandığı dizinin adı.

maxOutputDocuments

integer (int32)

Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar.

neverQuerySource

boolean

Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez.

queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Sorgu planlamasını faydalı filtreler ve güçlendirmeler için yönlendiren ipuçları. Belirtilirse, bu nesne bilgi kaynağında yapılandırılmış tüm sorgu ipuçları setinin yerini alır.

rerankerThreshold

number (float)

Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği.

resultsProcessing

KnowledgeSourceResultsProcessing

Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır.

SearchIndexKnowledgeSourceQueryHints

Arama indeksi bilgi kaynağı için faydalı filtreler ve güçlendirmeler için sorgu planlamasını yönlendiren ipuçları.

Name Tür Description
boosts SearchIndexKnowledgeSourceBoost[]:

Sorgu planlayıcısının belge sıralamasını etkilemek için kullanabileceği koşulları belirleyen ipuçlarını güçlendirin.

filters

SearchIndexKnowledgeSourceFilterHint[]

Filtre ipuçları, sorgu planlayıcısının filtre oluştururken kullanabileceği alanları ve temsil eden değerleri belirler.

ServedImage

Modelin bir geri alma etkinliği sırasında sunulmak üzere seçtiği tek bir görüntüyü tanımlar.

Name Tür Description
imageId

string

Kaynak belgeden Content Understanding enrichment tarafından alınan görsel etiketi. Orijinal belgedeki şekil numaralandırmasına karşılık gelir.

imagePath

string

Asset store içindeki görüntüye olan göreli yol.

sizeBytes

integer (int64)

Bu görselin modele gönderilen bayt cinsinden boyutu.

WebKnowledgeSourceParams

Bir web bilgi kaynağı için çalışma zamanı parametrelerini belirtir

Name Tür Description
alwaysQuerySource

boolean

Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir.

count

integer (int32)

Döndürülecek web sonuçlarının sayısı.

enableImageServing

boolean

Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir.

failOnError

boolean

Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur.

freshness

string

Web sonuçlarının tazeliği.

includeReferenceSourceData

boolean

Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir.

includeReferences

boolean

Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir.

kind string:

web

Bilgi kaynağının türü.

knowledgeSourceName

string

Parametrelerin uygulandığı dizinin adı.

language

string

Web sonuçlarının dili.

market

string

Web sonuçlarının pazarı.

maxOutputDocuments

integer (int32)

Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar.

neverQuerySource

boolean

Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez.

rerankerThreshold

number (float)

Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği.

resultsProcessing

KnowledgeSourceResultsProcessing

Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır.

WorkIQKnowledgeSourceParams

WorkIQ bilgi kaynağı için çalışma zamanı parametrelerini belirtir

Name Tür Description
alwaysQuerySource

boolean

Bu bilgi kaynağının kaynak seçimini atlaması ve alma zamanında her zaman sorgulanması gerektiğini gösterir.

enableImageServing

boolean

Bu bilgi kaynağı için erişim sırasında görüntü servisi etkinleştirilip etkinleştirilmeyeceğini gösterir. Doğru olduğunda, alım sırasında çıkarılan görüntüler sonraki modellere teslim edilir.

failOnError

boolean

Bu bilgi kaynağından alınma hata ile karşılaşılırsa tüm alma talebinin başarısız olması gerektiğini gösterir. Varsayılan değer false'tur.

includeReferenceSourceData

boolean

Başvuruların, alma sırasında elde edilen yapılandırılmış verileri yüklerine dahil edip etmeyeceğini belirtir.

includeReferences

boolean

Bu kaynaktan alınan veriler için başvuruların dahil edilip edilmeyeceğini belirtir.

kind string:

workIQ

Bilgi kaynağının türü.

knowledgeSourceName

string

Parametrelerin uygulandığı dizinin adı.

maxOutputDocuments

integer (int32)

Bu bilgi kaynağından geri dönen maksimum belge sayısını sınırlar.

neverQuerySource

boolean

Bu bilgi kaynağının, talebin aday kümesinden çıkarılması ve alma sırasında sorgulanmaması gerektiğini gösterir. Bu istisna talebe yereldir ve bilgi tabanı üyeliğini değiştirmez. Aynı bilgi kaynağında alwaysQuerySource ile birleştirilemez.

rerankerThreshold

number (float)

Yanıta dahil edilmek için alınan tüm belgelerin karşılaması gereken yeniden sıralayıcı eşiği.

resultsProcessing

KnowledgeSourceResultsProcessing

Bilgi kaynağının depolanmış sonuçlarını geçersiz kılar. Yalnızca bu geri alma çağrısı için işleme. Atlandığında, depolanan bilgi kaynağı değeri uygulanır.