Knowledge Retrieval - Retrieve

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

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

URI Parametreleri

Veri Akışı Adı İç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ığı

Veri Akışı Adı Gerekli Tür Description
Accept

Accept

Accept başlığı.

x-ms-query-source-authorization

string (password)

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

Veri Akışı Adı 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.

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

Veri Akışı Adı 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

Veri Akışı Adı Description
https://search.azure.com/.default

Örnekler

KnowledgeBaseRetrieve
KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieve

Örnek isteği

POST https://typespecstableexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-10-01



{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "hello world"
        }
      ]
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputDocuments": 5,
  "maxOutputSizeInTokens": 100000,
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "ks-stable-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex",
      "alwaysQuerySource": true,
      "filterAddOn": "foo eq bar"
    }
  ]
}

Ö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": 1234
    },
    {
      "type": "searchIndex",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-stable-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "warning": "6 additional documents were dropped because rerankerThreshold filtered them out during reranking. Adjust the threshold if higher recall is desired.",
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "(category eq 'news') and (foo eq bar)",
        "semanticConfigurationName": "testconfig",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-stable-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)",
        "semanticConfigurationName": "testconfig",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 1234
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 3.5,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 2.7,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
      "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": 1234
    },
    {
      "type": "searchIndex",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-stable-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "(category eq 'news') and (foo eq bar)",
        "semanticConfigurationName": "testconfig",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-stable-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)",
        "semanticConfigurationName": "testconfig",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 1234
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 3.5,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 2.7,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

KnowledgeBaseRetrieveWithIntents

Örnek isteği

POST https://typespecstableexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-10-01



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

Ö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-stable-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": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "rerankerScore": 3.5,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "rerankerScore": 2.7,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
      "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-stable-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": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "rerankerScore": 3.5,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "rerankerScore": 2.7,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

Tanımlar

Veri Akışı Adı Description
Accept

Accept 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.).

FileKnowledgeSourceParams

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

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ı.

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.

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.

KnowledgeBaseReferenceType

Başvurunun türü.

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.

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ü.

SearchIndexFieldReference

Arama dizini için alan referansı.

SearchIndexKnowledgeSourceParams

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

WebKnowledgeSourceParams

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

Accept

Accept başlığı.

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

AzureBlobKnowledgeSourceParams

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

Veri Akışı Adı 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.

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.

rerankerThreshold

number (float)

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

ErrorAdditionalInfo

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

Veri Akışı Adı Tür Description
info

Ek bilgiler.

type

string

Ek bilgi türü.

ErrorDetail

Hata ayrıntısı.

Veri Akışı Adı 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.).

Veri Akışı Adı Tür Description
error

ErrorDetail

Hata nesnesi.

FileKnowledgeSourceParams

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

Veri Akışı Adı 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.

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.

rerankerThreshold

number (float)

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

IndexedOneLakeKnowledgeSourceParams

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

Veri Akışı Adı 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.

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.

rerankerThreshold

number (float)

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

IndexedSharePointKnowledgeSourceParams

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

Veri Akışı Adı 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.

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.

rerankerThreshold

number (float)

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

IndexedSqlKnowledgeSourceParams

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

Veri Akışı Adı 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.

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.

rerankerThreshold

number (float)

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

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.

Veri Akışı Adı 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 geri alma etkinliği.

indexedSharePoint

Indekslenmiş SharePoint alma etkinliği.

indexedOneLake

OneLake toplama etkinliği indekslendi.

web

Web arama 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.

Veri Akışı Adı 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.

reasoningTokens

integer (int32)

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

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.

Veri Akışı Adı 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.

Veri Akışı Adı 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.

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:

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.

Veri Akışı Adı 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ı.

sourceData

Referans için kaynak veriler.

type string:

azureBlob

Başvurunun türü.

KnowledgeBaseErrorAdditionalInfo

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

Veri Akışı Adı Tür Description
info

Ek bilgiler.

type

string

Ek bilgi türü.

KnowledgeBaseErrorDetail

Hata ayrıntıları.

Veri Akışı Adı 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

KnowledgeBaseFileActivityArguments

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

Veri Akışı Adı Tür Description
search

string

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

KnowledgeBaseFileActivityRecord

Dosya alma faaliyet kaydını temsil eder.

Veri Akışı Adı 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.

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:

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.

Veri Akışı Adı 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.

Veri Akışı Adı Tür Description
url

string (uri)

Resmin URL'si.

KnowledgeBaseIndexedOneLakeActivityArguments

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

Veri Akışı Adı 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.

Veri Akışı Adı 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.

indexedOneLakeArguments

KnowledgeBaseIndexedOneLakeActivityArguments

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

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:

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.

Veri Akışı Adı 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:

indexedOneLake

Başvurunun türü.

KnowledgeBaseIndexedSharePointActivityArguments

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

Veri Akışı Adı 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.

Veri Akışı Adı 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.

indexedSharePointArguments

KnowledgeBaseIndexedSharePointActivityArguments

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

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:

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.

Veri Akışı Adı 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:

indexedSharePoint

Başvurunun türü.

KnowledgeBaseIndexedSqlActivityArguments

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

Veri Akışı Adı 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.

Veri Akışı Adı 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.

indexedSqlArguments

KnowledgeBaseIndexedSqlActivityArguments

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

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:

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.

Veri Akışı Adı 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ü.

KnowledgeBaseMessage

Doğal dil ileti stili nesnesi.

Veri Akışı Adı 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ü.

Veri Akışı Adı Tür Description
image

KnowledgeBaseImageContent

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

type string:

image

Mesajın türü

KnowledgeBaseMessageTextContent

Kısa mesaj türü.

Veri Akışı Adı 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.

Veri Akışı Adı 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.

Veri Akışı Adı 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.

Veri Akışı Adı 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.

KnowledgeBaseReferenceType

Başvurunun türü.

Değer Description
searchIndex

İndeks belge referansını arayın.

azureBlob

Azure Blob belge referansı.

indexedSharePoint

Indekslenmiş SharePoint belge referansı.

indexedOneLake

OneLake belge referansı indekslenmiştir.

web

Web belge referansı.

file

Dosya belge referansı.

indexedSql

Indekslenmiş SQL belge referansı.

KnowledgeBaseRetrievalRequest

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

Veri Akışı Adı 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.

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.

Veri Akışı Adı 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ı.

KnowledgeBaseSearchIndexActivityArguments

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

Veri Akışı Adı Tür Description
filter

string

Filtre dizesi.

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.

Veri Akışı Adı 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.

knowledgeSourceName

string

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

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.

Veri Akışı Adı 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ı.

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.

Veri Akışı Adı 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.

Veri Akışı Adı 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.

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.

Veri Akışı Adı 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.

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.

Veri Akışı Adı 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.

Veri Akışı Adı 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.

Veri Akışı Adı 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.

KnowledgeRetrievalSemanticIntent

Anlamsal bir sorgulama niyeti.

Veri Akışı Adı 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ğı.

file

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

SearchIndexFieldReference

Arama dizini için alan referansı.

Veri Akışı Adı Tür Description
name

string

Alanın adı.

SearchIndexKnowledgeSourceParams

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

Veri Akışı Adı 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.

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.

rerankerThreshold

number (float)

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

WebKnowledgeSourceParams

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

Veri Akışı Adı 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ı.

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.

rerankerThreshold

number (float)

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