Knowledge Retrieval - Retrieve

Hizmet:
Search Service
API Sürümü:
2026-04-01

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

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

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

integer (int32)

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

integer (int32)

Saniye cinsinden maksimum çalışma zamanı.

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
KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieve

Örnek isteği

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


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

Örnek yanıt

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

KnowledgeBaseRetrieveWithIntents

Örnek isteği

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


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

Örnek yanıt

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

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ı ek bilgileri.
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.).
IndexedOneLakeKnowledgeSourceParams

Dizinlenmiş OneLake bilgi kaynağı için çalışma zamanı parametrelerini belirtir
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ı ek bilgileri.
KnowledgeBaseErrorDetail

Hata ayrıntıları.
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.
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ü.
KnowledgeBaseModelWebSummarizationActivityRecord

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

Başvuru 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ü.
KnowledgeRetrievalMinimalReasoningEffort

Minimum muhakeme çabasıyla bilgi alımını çalıştırın.
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

Numaralandırma

Kabul Et başlığı.

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

AzureBlobKnowledgeSourceParams

Nesne

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

Name Tür Description
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ı.
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

Nesne

Kaynak yönetimi hatası ek bilgileri.

Name Tür Description
info

Ek bilgiler.
type

string

Ek bilgi türü.

ErrorDetail

Nesne

Hata ayrıntısı.

Name Tür Description
additionalInfo

ErrorAdditionalInfo[]

Hata ek bilgileri.
code

string

Hata kodu.
details

ErrorDetail[]

Hata ayrıntıları.
message

string

Hata iletisi.
target

string

Hata hedefi

ErrorResponse

Nesne

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.

IndexedOneLakeKnowledgeSourceParams

Nesne

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

Name Tür Description
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ı.
rerankerThreshold

number (float)

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

KnowledgeBaseActivityRecordType

Numaralandırma

Faaliyet kaydının türü.

Değer Description
searchIndex

Arama indeks alma faaliyeti.
azureBlob

Azure Blob retrieval activity.
indexedOneLake

OneLake toplama etkinliği indekslendi.
web

Web arama faaliyeti.
modelWebSummarization

LLM web özetleme etkinliği.
agenticReasoning

Ajanik akıl yürütme faaliyeti.

KnowledgeBaseAgenticReasoningActivityRecord

Nesne

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

Name Tür Description
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ı.
retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

KnowledgeRetrievalMinimalReasoningEffort

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

agenticReasoning

Etkinlik kaydının türü.

KnowledgeBaseAzureBlobActivityArguments

Nesne

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

Nesne

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.
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.
type string:

azureBlob

Etkinlik kaydının türü.

KnowledgeBaseAzureBlobReference

Nesne

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

Nesne

Kaynak yönetimi hatası ek bilgileri.

Name Tür Description
info

Ek bilgiler.
type

string

Ek bilgi türü.

KnowledgeBaseErrorDetail

Nesne

Hata ayrıntıları.

Name Tür Description
additionalInfo

KnowledgeBaseErrorAdditionalInfo[]

Hata ek bilgileri.
code

string

Hata kodu.
details

KnowledgeBaseErrorDetail[]

Hata ayrıntıları.
message

string

Hata iletisi.
target

string

Hata hedefi

KnowledgeBaseImageContent

Nesne

Görsel içeriği.

Name Tür Description
url

string (uri)

Resmin URL'si.

KnowledgeBaseIndexedOneLakeActivityArguments

Nesne

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

Nesne

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

Name Tür Description
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.
type string:

indexedOneLake

Etkinlik kaydının türü.

KnowledgeBaseIndexedOneLakeReference

Nesne

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

Name Tür Description
activitySource

integer (int32)

Başvuru için kaynak etkinlik kimliği.
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ü.

KnowledgeBaseMessage

Nesne

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

Numaralandırma

İ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

Nesne

Resim mesajı türü.

Name Tür Description
image

KnowledgeBaseImageContent

Görüntü içeriği.
type string:

image

Mesajın türü

KnowledgeBaseMessageTextContent

Nesne

Kısa mesaj türü.

Name Tür Description
text

string

Metin içeriği.
type string:

text

Mesajın türü

KnowledgeBaseModelWebSummarizationActivityRecord

Nesne

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

Name Tür Description
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ı.
outputTokens

integer (int32)

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

modelWebSummarization

Etkinlik kaydının türü.

KnowledgeBaseReferenceType

Numaralandırma

Başvuru türü.

Değer Description
searchIndex

İndeks belge referansını arayın.
azureBlob

Azure Blob document reference.
indexedOneLake

OneLake belge referansı indekslenmiştir.
web

Web belge referansı.

KnowledgeBaseRetrievalRequest

Nesne

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

integer (int32)

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

integer (int32)

Saniye cinsinden maksimum çalışma zamanı.

KnowledgeBaseRetrievalResponse

Nesne

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

KnowledgeBaseSearchIndexActivityArguments

Nesne

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

Nesne

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

Name Tür Description
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.
type string:

searchIndex

Etkinlik kaydının türü.

KnowledgeBaseSearchIndexReference

Nesne

Bir Azure Search belge başvurusunu temsil eder.

Name Tür Description
activitySource

integer (int32)

Başvuru için kaynak etkinlik kimliği.
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

Nesne

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

Nesne

Web alma faaliyet kaydını temsil eder.

Name Tür Description
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.
type string:

web

Etkinlik kaydının türü.
webArguments

KnowledgeBaseWebActivityArguments

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

KnowledgeBaseWebReference

Nesne

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.

KnowledgeRetrievalIntentType

Numaralandırma

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

Değer Description
semantic

Doğal dil anlamsal sorgu amacı.

KnowledgeRetrievalMinimalReasoningEffort

Nesne

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

KnowledgeRetrievalReasoningEffortKind

Numaralandırma

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.

KnowledgeRetrievalSemanticIntent

Nesne

Anlamsal bir sorgulama niyeti.

Name Tür Description
search

string

Yürütülecek anlamsal sorgu
type string:

semantic

Niyetin türü.

KnowledgeSourceKind

Numaralandırma

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

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

Web'den veri okuyan bir bilgi kaynağı.

SearchIndexFieldReference

Nesne

Arama dizini için alan referansı.

Name Tür Description
name

string

Alanın adı.

SearchIndexKnowledgeSourceParams

Nesne

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

Name Tür Description
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ı.
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

Nesne

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

Name Tür Description
count

integer (int32)

Döndürülecek web sonuçlarının sayısı.
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ı.
rerankerThreshold

number (float)

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