Knowledge Sources - Create Or Update

새 지식 소스를 만들거나 지식 소스가 이미 있는 경우 업데이트합니다.

PUT {endpoint}/knowledgesources('{sourceName}')?api-version=2026-10-01

URI 매개 변수

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

string (uri)

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

sourceName
path True

string

참조 자료의 이름입니다.

api-version
query True

string

minLength: 1

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

요청 헤더

속성 필수 형식 Description
x-ms-client-request-id

string (uuid)

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

Accept

Accept

Accept 헤더입니다.

If-Match

string

If-Match 조건을 정의합니다. 서버의 ETag가 이 값과 일치하는 경우에만 작업이 수행됩니다.

If-None-Match

string

If-None-Match 조건을 정의합니다. 서버의 ETag가 이 값과 일치하지 않는 경우에만 작업이 수행됩니다.

Prefer True

Prefer

HTTP PUT 요청의 경우 성공 시 생성/업데이트된 리소스를 반환하도록 서비스에 지시합니다.

요청 본문

요청 본문은 다음 중 하나가 될 수 있습니다.

속성 Description
AzureBlobKnowledgeSource

Azure Blob Storage 지식 원본에 대한 구성입니다.

FileKnowledgeSource

직접 파일 업로드 및 인덱싱을 지원하는 파일 지식 소스 설정.

IndexedOneLakeKnowledgeSource

OneLake 기술 자료에 대한 구성입니다.

IndexedSharePointKnowledgeSource

SharePoint 기술 자료에 대한 구성입니다.

IndexedSqlKnowledgeSource

인덱스화된 SQL 지식 소스 설정.

SearchIndexKnowledgeSource

검색 인덱스를 대상으로 하는 지식 소스입니다.

WebKnowledgeSource

웹 결과를 타겟팅하는 지식 소스.

AzureBlobKnowledgeSource

Azure Blob Storage 지식 원본에 대한 구성입니다.

속성 필수 형식 Description
azureBlobParameters True

AzureBlobKnowledgeSourceParameters

지식 소스의 유형입니다.

kind True string:

azureBlob

지식 소스의 유형입니다.

name True

string

참조 자료의 이름입니다.

@odata.etag

string

지식의 원천 ETag.

description

string

선택적 사용자 정의 설명입니다.

encryptionKey

SearchResourceEncryptionKey

Azure Key Vault에서 만드는 암호화 키에 대한 설명입니다. 이 키는 지식 소스 정의에 대해 아무도, 심지어 마이크로소프트도 복호화할 수 없다는 완전한 확신을 원할 때 추가적인 암호화 상태를 제공하는 데 사용됩니다. 지식 소스 정의를 암호화한 후에는 항상 암호화된 상태로 유지됩니다. 검색 서비스는 이 속성을 null로 설정하려는 시도를 무시합니다. 암호화 키를 회전시키고 싶을 때 필요에 따라 이 속성을 변경할 수 있습니다; 지식 소스 정의는 영향을 받지 않을 것입니다. 고객 관리형 키를 사용한 암호화는 무료 검색 서비스에 사용할 수 없으며 2019년 1월 1일 이후 생성된 유료 서비스에만 사용할 수 있습니다.

FileKnowledgeSource

직접 파일 업로드 및 인덱싱을 지원하는 파일 지식 소스 설정.

속성 필수 형식 Description
fileParameters True

FileKnowledgeSourceParameters

파일 지식 소스의 매개변수.

kind True string:

file

지식 소스의 유형입니다.

name True

string

참조 자료의 이름입니다.

@odata.etag

string

지식의 원천 ETag.

corsOptions

CorsOptions

파일 지식 소스의 파일 엔드포인트(업로드, 목록, 업데이트, 삭제)에 대한 교차 출처 자원 공유(CORS) 제어 옵션.

description

string

선택적 사용자 정의 설명입니다.

encryptionKey

SearchResourceEncryptionKey

Azure Key Vault에서 만드는 암호화 키에 대한 설명입니다. 이 키는 지식 소스 정의에 대해 아무도, 심지어 마이크로소프트도 복호화할 수 없다는 완전한 확신을 원할 때 추가적인 암호화 상태를 제공하는 데 사용됩니다. 지식 소스 정의를 암호화한 후에는 항상 암호화된 상태로 유지됩니다. 검색 서비스는 이 속성을 null로 설정하려는 시도를 무시합니다. 암호화 키를 회전시키고 싶을 때 필요에 따라 이 속성을 변경할 수 있습니다; 지식 소스 정의는 영향을 받지 않을 것입니다. 고객 관리형 키를 사용한 암호화는 무료 검색 서비스에 사용할 수 없으며 2019년 1월 1일 이후 생성된 유료 서비스에만 사용할 수 있습니다.

IndexedOneLakeKnowledgeSource

OneLake 기술 자료에 대한 구성입니다.

속성 필수 형식 Description
indexedOneLakeParameters True

IndexedOneLakeKnowledgeSourceParameters

지식 소스에 대한 매개변수입니다.

kind True string:

indexedOneLake

지식 소스의 유형입니다.

name True

string

참조 자료의 이름입니다.

@odata.etag

string

지식의 원천 ETag.

description

string

선택적 사용자 정의 설명입니다.

encryptionKey

SearchResourceEncryptionKey

Azure Key Vault에서 만드는 암호화 키에 대한 설명입니다. 이 키는 지식 소스 정의에 대해 아무도, 심지어 마이크로소프트도 복호화할 수 없다는 완전한 확신을 원할 때 추가적인 암호화 상태를 제공하는 데 사용됩니다. 지식 소스 정의를 암호화한 후에는 항상 암호화된 상태로 유지됩니다. 검색 서비스는 이 속성을 null로 설정하려는 시도를 무시합니다. 암호화 키를 회전시키고 싶을 때 필요에 따라 이 속성을 변경할 수 있습니다; 지식 소스 정의는 영향을 받지 않을 것입니다. 고객 관리형 키를 사용한 암호화는 무료 검색 서비스에 사용할 수 없으며 2019년 1월 1일 이후 생성된 유료 서비스에만 사용할 수 있습니다.

IndexedSharePointKnowledgeSource

SharePoint 기술 자료에 대한 구성입니다.

속성 필수 형식 Description
indexedSharePointParameters True

IndexedSharePointKnowledgeSourceParameters

지식 소스에 대한 매개변수입니다.

kind True string:

indexedSharePoint

지식 소스의 유형입니다.

name True

string

참조 자료의 이름입니다.

@odata.etag

string

지식의 원천 ETag.

description

string

선택적 사용자 정의 설명입니다.

encryptionKey

SearchResourceEncryptionKey

Azure Key Vault에서 만드는 암호화 키에 대한 설명입니다. 이 키는 지식 소스 정의에 대해 아무도, 심지어 마이크로소프트도 복호화할 수 없다는 완전한 확신을 원할 때 추가적인 암호화 상태를 제공하는 데 사용됩니다. 지식 소스 정의를 암호화한 후에는 항상 암호화된 상태로 유지됩니다. 검색 서비스는 이 속성을 null로 설정하려는 시도를 무시합니다. 암호화 키를 회전시키고 싶을 때 필요에 따라 이 속성을 변경할 수 있습니다; 지식 소스 정의는 영향을 받지 않을 것입니다. 고객 관리형 키를 사용한 암호화는 무료 검색 서비스에 사용할 수 없으며 2019년 1월 1일 이후 생성된 유료 서비스에만 사용할 수 있습니다.

IndexedSqlKnowledgeSource

인덱스화된 SQL 지식 소스 설정.

속성 필수 형식 Description
indexedSqlParameters True

IndexedSqlKnowledgeSourceParameters

SQL 지식 소스의 매개변수입니다.

kind True string:

indexedSql

지식 소스의 유형입니다.

name True

string

참조 자료의 이름입니다.

@odata.etag

string

지식의 원천 ETag.

description

string

선택적 사용자 정의 설명입니다.

encryptionKey

SearchResourceEncryptionKey

Azure Key Vault에서 만드는 암호화 키에 대한 설명입니다. 이 키는 지식 소스 정의에 대해 아무도, 심지어 마이크로소프트도 복호화할 수 없다는 완전한 확신을 원할 때 추가적인 암호화 상태를 제공하는 데 사용됩니다. 지식 소스 정의를 암호화한 후에는 항상 암호화된 상태로 유지됩니다. 검색 서비스는 이 속성을 null로 설정하려는 시도를 무시합니다. 암호화 키를 회전시키고 싶을 때 필요에 따라 이 속성을 변경할 수 있습니다; 지식 소스 정의는 영향을 받지 않을 것입니다. 고객 관리형 키를 사용한 암호화는 무료 검색 서비스에 사용할 수 없으며 2019년 1월 1일 이후 생성된 유료 서비스에만 사용할 수 있습니다.

SearchIndexKnowledgeSource

검색 인덱스를 대상으로 하는 지식 소스입니다.

속성 필수 형식 Description
kind True string:

searchIndex

지식 소스의 유형입니다.

name True

string

참조 자료의 이름입니다.

searchIndexParameters True

SearchIndexKnowledgeSourceParameters

지식 소스에 대한 매개변수입니다.

@odata.etag

string

지식의 원천 ETag.

description

string

선택적 사용자 정의 설명입니다.

encryptionKey

SearchResourceEncryptionKey

Azure Key Vault에서 만드는 암호화 키에 대한 설명입니다. 이 키는 지식 소스 정의에 대해 아무도, 심지어 마이크로소프트도 복호화할 수 없다는 완전한 확신을 원할 때 추가적인 암호화 상태를 제공하는 데 사용됩니다. 지식 소스 정의를 암호화한 후에는 항상 암호화된 상태로 유지됩니다. 검색 서비스는 이 속성을 null로 설정하려는 시도를 무시합니다. 암호화 키를 회전시키고 싶을 때 필요에 따라 이 속성을 변경할 수 있습니다; 지식 소스 정의는 영향을 받지 않을 것입니다. 고객 관리형 키를 사용한 암호화는 무료 검색 서비스에 사용할 수 없으며 2019년 1월 1일 이후 생성된 유료 서비스에만 사용할 수 있습니다.

WebKnowledgeSource

웹 결과를 타겟팅하는 지식 소스.

속성 필수 형식 Description
kind True string:

web

지식 소스의 유형입니다.

name True

string

참조 자료의 이름입니다.

@odata.etag

string

지식의 원천 ETag.

description

string

선택적 사용자 정의 설명입니다.

encryptionKey

SearchResourceEncryptionKey

Azure Key Vault에서 만드는 암호화 키에 대한 설명입니다. 이 키는 지식 소스 정의에 대해 아무도, 심지어 마이크로소프트도 복호화할 수 없다는 완전한 확신을 원할 때 추가적인 암호화 상태를 제공하는 데 사용됩니다. 지식 소스 정의를 암호화한 후에는 항상 암호화된 상태로 유지됩니다. 검색 서비스는 이 속성을 null로 설정하려는 시도를 무시합니다. 암호화 키를 회전시키고 싶을 때 필요에 따라 이 속성을 변경할 수 있습니다; 지식 소스 정의는 영향을 받지 않을 것입니다. 고객 관리형 키를 사용한 암호화는 무료 검색 서비스에 사용할 수 없으며 2019년 1월 1일 이후 생성된 유료 서비스에만 사용할 수 있습니다.

webParameters

WebKnowledgeSourceParameters

웹 지식 소스에 대한 매개 변수입니다.

응답

속성 형식 Description
200 OK KnowledgeSource:

요청이 성공했습니다.

201 Created KnowledgeSource:

요청이 성공했고 결과적으로 새 리소스가 생성되었습니다.

Other Status Codes

ErrorResponse

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

보안

api-key

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

OAuth2Auth

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

범위

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

예제

SearchServiceCreateOrUpdateKnowledgeSource
SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob
SearchServiceCreateOrUpdateKnowledgeSourceFile
SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake
SearchServiceCreateOrUpdateKnowledgeSourceIndexedSharePoint
SearchServiceCreateOrUpdateKnowledgeSourceIndexedSql
SearchServiceCreateOrUpdateKnowledgeSourceWeb

SearchServiceCreateOrUpdateKnowledgeSource

샘플 요청

PUT https://typespecstableexampleservice.search.windows.net/knowledgesources('ks-stable-test')?api-version=2026-10-01






{
  "name": "ks-stable-test",
  "description": "Description of the knowledge source.",
  "kind": "searchIndex",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "stable-test",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ],
    "semanticConfigurationName": "testconfig",
    "baseFilter": "category eq 'news'"
  }
}

샘플 응답

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-stable-test",
  "kind": "searchIndex",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "stable-test",
    "semanticConfigurationName": "testconfig",
    "baseFilter": "category eq 'news'",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ]
  }
}
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-stable-test",
  "kind": "searchIndex",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "stable-test",
    "semanticConfigurationName": "testconfig",
    "baseFilter": "category eq 'news'",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ]
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

샘플 요청

PUT https://typespecstableexampleservice.search.windows.net/knowledgesources('ks-stable-test')?api-version=2026-10-01






{
  "name": "ks-stable-test",
  "description": "Description of the knowledge source.",
  "kind": "azureBlob",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-mini"
        }
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

샘플 응답

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-stable-test",
  "kind": "azureBlob",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "createdResources": {
      "datasource": "ks-stable-test-datasource",
      "indexer": "ks-stable-test-indexer",
      "skillset": "ks-stable-test-skillset",
      "index": "ks-stable-test-index"
    }
  }
}
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-stable-test",
  "kind": "azureBlob",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "createdResources": {
      "datasource": "ks-stable-test-datasource",
      "indexer": "ks-stable-test-indexer",
      "skillset": "ks-stable-test-skillset",
      "index": "ks-stable-test-index"
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceFile

샘플 요청

PUT https://typespecstableexampleservice.search.windows.net/knowledgesources('ks-stable-test')?api-version=2026-10-01






{
  "name": "ks-stable-test",
  "description": "Description of the File knowledge source.",
  "kind": "file",
  "fileParameters": {
    "ingestionParameters": {
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-mini"
        }
      },
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  }
}

샘플 응답

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-stable-test",
  "kind": "file",
  "description": "Description of the File knowledge source.",
  "fileParameters": {
    "ingestionParameters": {
      "contentExtractionMode": "standard",
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-mini"
        }
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "createdResources": {
      "index": "ks-stable-test-index"
    }
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  }
}
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-stable-test",
  "kind": "file",
  "description": "Description of the File knowledge source.",
  "fileParameters": {
    "ingestionParameters": {
      "contentExtractionMode": "standard",
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-mini"
        }
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "createdResources": {
      "index": "ks-stable-test-index"
    }
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake

샘플 요청

PUT https://typespecstableexampleservice.search.windows.net/knowledgesources('ks-stable-test')?api-version=2026-10-01






{
  "name": "ks-stable-test",
  "description": "Description of the OneLake knowledge source.",
  "kind": "indexedOneLake",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-mini"
        }
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

샘플 응답

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-stable-test",
  "kind": "indexedOneLake",
  "description": "Description of the OneLake knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-stable-test",
  "kind": "indexedOneLake",
  "description": "Description of the OneLake knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceIndexedSharePoint

샘플 요청

PUT https://typespecstableexampleservice.search.windows.net/knowledgesources('ks-stable-test')?api-version=2026-10-01






{
  "name": "ks-stable-test",
  "description": "Description of the SharePoint knowledge source.",
  "kind": "indexedSharePoint",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "ingestionParameters": {
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-mini"
        }
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

샘플 응답

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-stable-test",
  "kind": "indexedSharePoint",
  "description": "Description of the SharePoint knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds"
      ],
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-stable-test",
  "kind": "indexedSharePoint",
  "description": "Description of the SharePoint knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds"
      ],
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceIndexedSql

샘플 요청

PUT https://typespecstableexampleservice.search.windows.net/knowledgesources('ks-stable-test')?api-version=2026-10-01






{
  "name": "ks-stable-test",
  "description": "Description of the SQL knowledge source.",
  "kind": "indexedSql",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSqlParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "tableOrView": "dbo.Products",
    "contentColumns": [
      {
        "name": "title",
        "sourceField": "Title",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "description",
        "sourceField": "Description",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "price",
        "sourceField": "Price",
        "searchFieldType": "Edm.Double"
      }
    ],
    "embeddingColumns": [
      {
        "name": "descriptionEmbedding",
        "sourceField": "Description"
      }
    ],
    "ingestionParameters": {
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "contentExtractionMode": "minimal"
    }
  }
}

샘플 응답

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-stable-test",
  "kind": "indexedSql",
  "description": "Description of the SQL knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSqlParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "tableOrView": "dbo.Products",
    "contentColumns": [
      {
        "name": "title",
        "sourceField": "Title",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "description",
        "sourceField": "Description",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "price",
        "sourceField": "Price",
        "searchFieldType": "Edm.Double"
      }
    ],
    "embeddingColumns": [
      {
        "name": "descriptionEmbedding",
        "sourceField": "Description"
      }
    ],
    "ingestionParameters": {
      "contentExtractionMode": "minimal",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      }
    }
  }
}
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-stable-test",
  "kind": "indexedSql",
  "description": "Description of the SQL knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSqlParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "tableOrView": "dbo.Products",
    "contentColumns": [
      {
        "name": "title",
        "sourceField": "Title",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "description",
        "sourceField": "Description",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "price",
        "sourceField": "Price",
        "searchFieldType": "Edm.Double"
      }
    ],
    "embeddingColumns": [
      {
        "name": "descriptionEmbedding",
        "sourceField": "Description"
      }
    ],
    "ingestionParameters": {
      "contentExtractionMode": "minimal",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      }
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceWeb

샘플 요청

PUT https://exampleservice.search.windows.net/knowledgesources('ks-example-index')?api-version=2026-10-01





{
  "webParameters": {
    "domains": {
      "allowedDomains": [
        {
          "address": "example.com",
          "includeSubpages": true
        },
        {
          "address": "another-example.com"
        }
      ],
      "blockedDomains": [
        {
          "address": "blocked.com"
        },
        {
          "address": "spam.com",
          "includeSubpages": true
        }
      ]
    },
    "language": "en",
    "market": "en-US",
    "count": 10,
    "freshness": "Week"
  },
  "name": "ks-example-index",
  "description": "Description of the knowledge source.",
  "kind": "web",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

샘플 응답

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "web",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "webParameters": {
    "domains": {
      "allowedDomains": [
        {
          "address": "example.com",
          "includeSubpages": true
        },
        {
          "address": "another-example.com"
        }
      ],
      "blockedDomains": [
        {
          "address": "blocked.com"
        },
        {
          "address": "spam.com",
          "includeSubpages": true
        }
      ]
    },
    "language": "en",
    "market": "en-US",
    "count": 10,
    "freshness": "Week"
  }
}
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "web",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "webParameters": {
    "domains": {
      "allowedDomains": [
        {
          "address": "example.com",
          "includeSubpages": true
        },
        {
          "address": "another-example.com"
        }
      ],
      "blockedDomains": [
        {
          "address": "blocked.com"
        },
        {
          "address": "spam.com",
          "includeSubpages": true
        }
      ]
    },
    "language": "en",
    "market": "en-US",
    "count": 10,
    "freshness": "Week"
  }
}

정의

속성 Description
Accept

Accept 헤더입니다.

AIServices

AI 서비스의 매개변수.

AzureBlobKnowledgeSource

Azure Blob Storage 지식 원본에 대한 구성입니다.

AzureBlobKnowledgeSourceParameters

Azure Blob Storage 기술 자료에 대한 매개 변수입니다.

AzureOpenAIModelName

호출될 Azure Open AI 모델 이름입니다.

AzureOpenAIVectorizerParameters

Azure OpenAI 리소스에 연결하기 위한 매개 변수를 지정합니다.

ContentColumnMapping

SQL 열을 검색 인덱스 필드에 매핑합니다.

CorsOptions

인덱스에 대한 CORS(원본 간 리소스 공유)를 제어하는 옵션을 정의합니다.

EmbeddingColumnMapping

SQL 열을 벡터 필드에 매핑하여 임베딩합니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보

ErrorDetail

오류 세부 정보입니다.

ErrorResponse

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

FileKnowledgeSource

직접 파일 업로드 및 인덱싱을 지원하는 파일 지식 소스 설정.

FileKnowledgeSourceParameters

파일 지식 소스 매개변수.

IndexedOneLakeKnowledgeSource

OneLake 기술 자료에 대한 구성입니다.

IndexedOneLakeKnowledgeSourceParameters

OneLake 기술 자료에 대한 매개 변수입니다.

IndexedSharePointContainerName

액세스할 SharePoint 라이브러리를 지정합니다.

IndexedSharePointKnowledgeSource

SharePoint 기술 자료에 대한 구성입니다.

IndexedSharePointKnowledgeSourceParameters

SharePoint 지식 소스의 매개변수.

IndexedSqlKnowledgeSource

인덱스화된 SQL 지식 소스 설정.

IndexedSqlKnowledgeSourceParameters

인덱스 SQL 지식 소스의 매개변수.

IndexingSchedule

인덱서 실행 일정을 나타냅니다.

KnowledgeBaseAzureOpenAIModel

쿼리 계획을 수행하는 데 사용되는 Azure OpenAI 리소스를 지정합니다.

KnowledgeBaseModelKind

쿼리 계획에 사용할 AI 모델입니다.

KnowledgeSourceAzureOpenAIVectorizer

쿼리 문자열을 벡터화하는 데 사용되는 Azure OpenAI 리소스를 지정합니다.

KnowledgeSourceIngestionParameters

참조 자료에 대한 모든 일반 수집 설정을 통합합니다.

KnowledgeSourceIngestionPermissionOption

문서 콘텐츠와 함께 인징할 수 있는 권한 유형.

KnowledgeSourceKind

지식 소스의 종류.

KnowledgeSourceNetworkAccessMode

지식 소스 수집을 위한 네트워크 접근 모드를 지정합니다. 디폴트는 '공개'입니다.

Prefer

HTTP PUT 요청의 경우 성공 시 생성/업데이트된 리소스를 반환하도록 서비스에 지시합니다.

SearchIndexerDataNoneIdentity

데이터 원본의 ID 속성을 지웁니다.

SearchIndexerDataUserAssignedIdentity

사용할 데이터 원본의 ID를 지정합니다.

SearchIndexFieldReference

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

SearchIndexKnowledgeSource

검색 인덱스를 대상으로 하는 지식 소스입니다.

SearchIndexKnowledgeSourceParameters

검색 인덱스 지식 원본에 대한 매개 변수입니다.

SearchResourceEncryptionKey

Azure Key Vault의 고객 관리형 암호화 키입니다. 만들고 관리하는 키를 사용하여 인덱스 및 동의어 맵과 같은 미사용 데이터를 암호화하거나 복호화할 수 있습니다.

VectorSearchVectorizerKind

쿼리 시간 동안 사용할 벡터화 방법입니다.

WebKnowledgeSource

웹 결과를 타겟팅하는 지식 소스.

WebKnowledgeSourceDomain

웹 지식 원본 도메인에 대한 구성입니다.

WebKnowledgeSourceDomains

웹 지식 원본에 대한 도메인 허용/차단 구성입니다.

WebKnowledgeSourceParameters

웹 지식 소스에 대한 매개 변수입니다.

Accept

Accept 헤더입니다.

값 Description
application/json;odata.metadata=minimal

AIServices

AI 서비스의 매개변수.

속성 형식 Description
apiKey

string

AI 서비스에 액세스하기 위한 API 키입니다.

uri

string (uri)

AI 서비스 엔드포인트의 URI입니다.

AzureBlobKnowledgeSource

Azure Blob Storage 지식 원본에 대한 구성입니다.

속성 형식 Description
@odata.etag

string

지식의 원천 ETag.

azureBlobParameters

AzureBlobKnowledgeSourceParameters

지식 소스의 유형입니다.

description

string

선택적 사용자 정의 설명입니다.

encryptionKey

SearchResourceEncryptionKey

Azure Key Vault에서 만드는 암호화 키에 대한 설명입니다. 이 키는 지식 소스 정의에 대해 아무도, 심지어 마이크로소프트도 복호화할 수 없다는 완전한 확신을 원할 때 추가적인 암호화 상태를 제공하는 데 사용됩니다. 지식 소스 정의를 암호화한 후에는 항상 암호화된 상태로 유지됩니다. 검색 서비스는 이 속성을 null로 설정하려는 시도를 무시합니다. 암호화 키를 회전시키고 싶을 때 필요에 따라 이 속성을 변경할 수 있습니다; 지식 소스 정의는 영향을 받지 않을 것입니다. 고객 관리형 키를 사용한 암호화는 무료 검색 서비스에 사용할 수 없으며 2019년 1월 1일 이후 생성된 유료 서비스에만 사용할 수 있습니다.

kind string:

azureBlob

지식 소스의 유형입니다.

name

string

참조 자료의 이름입니다.

AzureBlobKnowledgeSourceParameters

Azure Blob Storage 기술 자료에 대한 매개 변수입니다.

속성 형식 Default value Description
connectionString

string

키 기반 연결 문자열 또는 관리 ID를 사용하는 경우 ResourceId 형식입니다.

containerName

string

Blob Storage 컨테이너의 이름입니다.

createdResources

object

지식 소스에서 만든 리소스입니다.

folderPath

string

컨테이너 내의 선택적 폴더 경로입니다.

ingestionParameters

KnowledgeSourceIngestionParameters

모든 일반 수집 설정을 통합합니다.

isADLSGen2

boolean

False

ADLS Gen2 스토리지 계정에 연결하는 경우 true로 설정합니다. 기본값은 false입니다.

AzureOpenAIModelName

호출될 Azure Open AI 모델 이름입니다.

값 Description
text-embedding-ada-002

TextEmbeddingAda002 모델.

text-embedding-3-large

TextEmbedding3Large 모델.

text-embedding-3-small

TextEmbedding3Small 모델.

gpt-5-mini

GPT5미니 모델입니다.

gpt-5-nano

Gpt5Nano 모델입니다.

gpt-5.4

GPT54 모델입니다.

gpt-5.4-mini

GPT54미니 모델입니다.

gpt-5.4-nano

GPT54Nano 모델입니다.

gpt-5.5

GPT55 모델입니다.

gpt-5.6-sol

GPT56Sol 모델입니다.

gpt-5.6-terra

Gpt56Terra 모델입니다.

gpt-5.6-luna

GPT56Luna 모델입니다.

AzureOpenAIVectorizerParameters

Azure OpenAI 리소스에 연결하기 위한 매개 변수를 지정합니다.

속성 형식 Description
apiKey

string

지정된 Azure OpenAI 리소스의 API 키입니다.

authIdentity SearchIndexerDataIdentity:

아웃바운드 연결에 사용되는 사용자 할당 관리 ID입니다.

deploymentId

string

지정된 리소스에 대한 Azure OpenAI 모델 배포의 ID입니다.

modelName

AzureOpenAIModelName

제공된 deploymentId 경로에 배포되는 포함 모델의 이름입니다.

resourceUri

string (uri)

Azure OpenAI 리소스의 리소스 URI입니다.

ContentColumnMapping

SQL 열을 검색 인덱스 필드에 매핑합니다.

속성 형식 Description
name

string

대상 인덱스 필드 이름.

searchFieldType

string

Azure AI 검색 field type (eg., Edm.String, Edm.Int32).

sourceField

string

SQL 열명.

CorsOptions

인덱스에 대한 CORS(원본 간 리소스 공유)를 제어하는 옵션을 정의합니다.

속성 형식 Description
allowedOrigins

string[]

JavaScript 코드에 인덱스에 대한 액세스 권한이 부여되는 원본 목록입니다. {protocol}://{fully-qualified-domain-name}[:{port#}] 형식의 호스트 목록 또는 모든 출처를 허용하는 단일 '*'를 포함할 수 있습니다(권장되지 않음).

maxAgeInSeconds

integer (int64)

브라우저가 CORS 프리플라이트 응답을 캐시해야 하는 기간입니다. 기본값은 5분입니다.

EmbeddingColumnMapping

SQL 열을 벡터 필드에 매핑하여 임베딩합니다.

속성 형식 Description
name

string

검색 인덱스의 대상 벡터 필드 이름.

sourceField

string

임베딩 생성을 위한 입력으로 사용되는 SQL 열.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보

속성 형식 Description
info

추가 정보입니다.

type

string

추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

속성 형식 Description
additionalInfo

ErrorAdditionalInfo[]

오류 추가 정보

code

string

오류 코드입니다.

details

ErrorDetail[]

오류 세부 정보입니다.

message

string

오류 메시지입니다.

target

string

오류 대상.

ErrorResponse

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

속성 형식 Description
error

ErrorDetail

오류 개체입니다.

FileKnowledgeSource

직접 파일 업로드 및 인덱싱을 지원하는 파일 지식 소스 설정.

속성 형식 Description
@odata.etag

string

지식의 원천 ETag.

corsOptions

CorsOptions

파일 지식 소스의 파일 엔드포인트(업로드, 목록, 업데이트, 삭제)에 대한 교차 출처 자원 공유(CORS) 제어 옵션.

description

string

선택적 사용자 정의 설명입니다.

encryptionKey

SearchResourceEncryptionKey

Azure Key Vault에서 만드는 암호화 키에 대한 설명입니다. 이 키는 지식 소스 정의에 대해 아무도, 심지어 마이크로소프트도 복호화할 수 없다는 완전한 확신을 원할 때 추가적인 암호화 상태를 제공하는 데 사용됩니다. 지식 소스 정의를 암호화한 후에는 항상 암호화된 상태로 유지됩니다. 검색 서비스는 이 속성을 null로 설정하려는 시도를 무시합니다. 암호화 키를 회전시키고 싶을 때 필요에 따라 이 속성을 변경할 수 있습니다; 지식 소스 정의는 영향을 받지 않을 것입니다. 고객 관리형 키를 사용한 암호화는 무료 검색 서비스에 사용할 수 없으며 2019년 1월 1일 이후 생성된 유료 서비스에만 사용할 수 있습니다.

fileParameters

FileKnowledgeSourceParameters

파일 지식 소스의 매개변수.

kind string:

file

지식 소스의 유형입니다.

name

string

참조 자료의 이름입니다.

FileKnowledgeSourceParameters

파일 지식 소스 매개변수.

속성 형식 Description
createdResources

object

파일 지식 소스가 생성한 리소스.

ingestionParameters

KnowledgeSourceIngestionParameters

파일 지식 소스의 모든 일반 인제스 설정을 통합하며, 콘텐츠 추출 모드와 선택적 embeddingModel을 포함합니다.

IndexedOneLakeKnowledgeSource

OneLake 기술 자료에 대한 구성입니다.

속성 형식 Description
@odata.etag

string

지식의 원천 ETag.

description

string

선택적 사용자 정의 설명입니다.

encryptionKey

SearchResourceEncryptionKey

Azure Key Vault에서 만드는 암호화 키에 대한 설명입니다. 이 키는 지식 소스 정의에 대해 아무도, 심지어 마이크로소프트도 복호화할 수 없다는 완전한 확신을 원할 때 추가적인 암호화 상태를 제공하는 데 사용됩니다. 지식 소스 정의를 암호화한 후에는 항상 암호화된 상태로 유지됩니다. 검색 서비스는 이 속성을 null로 설정하려는 시도를 무시합니다. 암호화 키를 회전시키고 싶을 때 필요에 따라 이 속성을 변경할 수 있습니다; 지식 소스 정의는 영향을 받지 않을 것입니다. 고객 관리형 키를 사용한 암호화는 무료 검색 서비스에 사용할 수 없으며 2019년 1월 1일 이후 생성된 유료 서비스에만 사용할 수 있습니다.

indexedOneLakeParameters

IndexedOneLakeKnowledgeSourceParameters

지식 소스에 대한 매개변수입니다.

kind string:

indexedOneLake

지식 소스의 유형입니다.

name

string

참조 자료의 이름입니다.

IndexedOneLakeKnowledgeSourceParameters

OneLake 기술 자료에 대한 매개 변수입니다.

속성 형식 Description
createdResources

object

지식 소스에서 만든 리소스입니다.

fabricWorkspaceId

string

OneLake 작업 영역 ID입니다.

ingestionParameters

KnowledgeSourceIngestionParameters

모든 일반 수집 설정을 통합합니다.

lakehouseId

string

어떤 OneLake 호숫가에 접근할 수 있는지 명시합니다.

targetPath

string

OneLakehouse 콘텐츠 필터링을 위한 선택적 OneLakehouse 폴더나 바로가기를 사용할 수 있습니다.

IndexedSharePointContainerName

액세스할 SharePoint 라이브러리를 지정합니다.

값 Description
defaultSiteLibrary

사이트의 기본 문서 라이브러리에서 콘텐츠를 인덱싱합니다.

allSiteLibraries

사이트의 모든 문서 라이브러리에서 콘텐츠를 인덱싱합니다.

useQuery

쿼리를 사용해 SharePoint 콘텐츠를 필터링하세요.

allSiteLists

사이트 내 모든 목록에서 콘텐츠를 색인화하세요.

allSitePages

사이트 내 모든 페이지에서 콘텐츠를 색인화하세요.

allSiteContent

사이트 내 지원되는 모든 라이브러리, 목록 및 페이지에서 콘텐츠를 인덱싱합니다.

IndexedSharePointKnowledgeSource

SharePoint 기술 자료에 대한 구성입니다.

속성 형식 Description
@odata.etag

string

지식의 원천 ETag.

description

string

선택적 사용자 정의 설명입니다.

encryptionKey

SearchResourceEncryptionKey

Azure Key Vault에서 만드는 암호화 키에 대한 설명입니다. 이 키는 지식 소스 정의에 대해 아무도, 심지어 마이크로소프트도 복호화할 수 없다는 완전한 확신을 원할 때 추가적인 암호화 상태를 제공하는 데 사용됩니다. 지식 소스 정의를 암호화한 후에는 항상 암호화된 상태로 유지됩니다. 검색 서비스는 이 속성을 null로 설정하려는 시도를 무시합니다. 암호화 키를 회전시키고 싶을 때 필요에 따라 이 속성을 변경할 수 있습니다; 지식 소스 정의는 영향을 받지 않을 것입니다. 고객 관리형 키를 사용한 암호화는 무료 검색 서비스에 사용할 수 없으며 2019년 1월 1일 이후 생성된 유료 서비스에만 사용할 수 있습니다.

indexedSharePointParameters

IndexedSharePointKnowledgeSourceParameters

지식 소스에 대한 매개변수입니다.

kind string:

indexedSharePoint

지식 소스의 유형입니다.

name

string

참조 자료의 이름입니다.

IndexedSharePointKnowledgeSourceParameters

SharePoint 지식 소스의 매개변수.

속성 형식 Description
connectionString

string

SharePoint 연결 문자열 형식: SharePointOnlineEndpoint=[SharePoint 사이트 URL]; ApplicationId=[Azure AD App ID]; ApplicationSecret=[Azure AD App client secret]; TenantId=[SharePoint 사이트 tenant id]

containerName

IndexedSharePointContainerName

액세스할 SharePoint 라이브러리를 지정합니다.

createdResources

object

지식 소스에서 만든 리소스입니다.

ingestionParameters

KnowledgeSourceIngestionParameters

모든 일반 수집 설정을 통합합니다.

query

string

SharePoint 콘텐츠를 필터링하는 선택적 쿼리입니다.

IndexedSqlKnowledgeSource

인덱스화된 SQL 지식 소스 설정.

속성 형식 Description
@odata.etag

string

지식의 원천 ETag.

description

string

선택적 사용자 정의 설명입니다.

encryptionKey

SearchResourceEncryptionKey

Azure Key Vault에서 만드는 암호화 키에 대한 설명입니다. 이 키는 지식 소스 정의에 대해 아무도, 심지어 마이크로소프트도 복호화할 수 없다는 완전한 확신을 원할 때 추가적인 암호화 상태를 제공하는 데 사용됩니다. 지식 소스 정의를 암호화한 후에는 항상 암호화된 상태로 유지됩니다. 검색 서비스는 이 속성을 null로 설정하려는 시도를 무시합니다. 암호화 키를 회전시키고 싶을 때 필요에 따라 이 속성을 변경할 수 있습니다; 지식 소스 정의는 영향을 받지 않을 것입니다. 고객 관리형 키를 사용한 암호화는 무료 검색 서비스에 사용할 수 없으며 2019년 1월 1일 이후 생성된 유료 서비스에만 사용할 수 있습니다.

indexedSqlParameters

IndexedSqlKnowledgeSourceParameters

SQL 지식 소스의 매개변수입니다.

kind string:

indexedSql

지식 소스의 유형입니다.

name

string

참조 자료의 이름입니다.

IndexedSqlKnowledgeSourceParameters

인덱스 SQL 지식 소스의 매개변수.

속성 형식 Description
connectionString

string

Azure SQL Database 또는 SQL Managed Instance의 연결 문자열입니다.

contentColumns

ContentColumnMapping[]

콘텐츠 필드에 대한 선택적 컬럼 매핑. 만약 이 열을 누락하면 모든 열이 자동 발견됩니다.

createdResources

object

지식 소스에서 만든 리소스입니다.

embeddingColumns

EmbeddingColumnMapping[]

벡터장 삽입을 위한 선택적 열(column) 매핑. 생략하면 벡터장이 생성되지 않습니다.

highWaterMarkColumnName

string

고수표 변경 감지를 위한 선택적 열명 사용. 제공된다면 HighWaterMarkChangeDetectionPolicy를 사용하세요.

ingestionParameters

KnowledgeSourceIngestionParameters

임베딩 모델, 스케줄, 아이덴티티를 포함한 모든 일반 인제트 설정을 통합합니다.

tableOrView

string

색인할 테이블 또는 뷰의 이름. 스키마 자격을 부여할 수 있습니다(예: 'dbo. MyTable').

IndexingSchedule

인덱서 실행 일정을 나타냅니다.

속성 형식 Description
interval

string (duration)

인덱서 실행 사이의 시간 간격입니다.

startTime

string (date-time)

인덱서가 실행을 시작해야 하는 시간입니다.

KnowledgeBaseAzureOpenAIModel

쿼리 계획을 수행하는 데 사용되는 Azure OpenAI 리소스를 지정합니다.

속성 형식 Description
azureOpenAIParameters

AzureOpenAIVectorizerParameters

Azure OpenAI parameters.

kind string:

azureOpenAI

쿼리 계획에 사용할 AI 모델입니다.

KnowledgeBaseModelKind

쿼리 계획에 사용할 AI 모델입니다.

값 Description
azureOpenAI

쿼리 계획에 Azure Open AI 모델을 사용합니다.

KnowledgeSourceAzureOpenAIVectorizer

쿼리 문자열을 벡터화하는 데 사용되는 Azure OpenAI 리소스를 지정합니다.

속성 형식 Description
azureOpenAIParameters

AzureOpenAIVectorizerParameters

Azure OpenAI 포함 벡터화와 관련된 매개 변수를 포함합니다.

kind string:

azureOpenAI

벡터 검색에 사용하도록 구성되는 벡터화 메서드의 이름입니다.

KnowledgeSourceIngestionParameters

참조 자료에 대한 모든 일반 수집 설정을 통합합니다.

속성 형식 Default value Description
aiServices

AIServices

콘텐츠 처리를 위한 선택적 AI 서비스 구성입니다.

chatCompletionModel KnowledgeBaseModel:

KnowledgeBaseAzureOpenAIModel

이미지 언어화 또는 컨텍스트 추출을 위한 선택적 채팅 완료 모델입니다.

contentExtractionMode enum:
  • minimal
  • standard
minimal

선택적 콘텐츠 추출 모드. 기본값은 '최소'입니다.

disableImageVerbalization

boolean

False

이미지 언어화를 사용하지 않도록 설정해야 하는지 여부를 나타냅니다. 기본값은 false입니다.

embeddingModel KnowledgeSourceVectorizer:

KnowledgeSourceAzureOpenAIVectorizer

콘텐츠를 벡터화하기 위한 선택적 벡터화기 구성입니다.

identity SearchIndexerDataIdentity:

이 지식 소스에 사용할 명시적 ID입니다.

ingestionPermissionOptions

KnowledgeSourceIngestionPermissionOption[]

문서 콘텐츠와 함께 수집할 권한 유형의 선택적 목록입니다. 지정된 경우 데이터 원본에 대한 인덱서 권한 옵션을 설정합니다.

ingestionSchedule

IndexingSchedule

데이터 수집에 대한 선택적 일정입니다.

networkAccessMode

KnowledgeSourceNetworkAccessMode

public

선택적으로 네트워크 접속 모드가 제공됩니다. 'private'로 설정하여 사설 네트워크를 통해 데이터 소스와 의존성에 접근할 수 있는 사설 실행 환경에서 인제스팅을 실행합니다. 디폴트는 '공개'입니다. 이것은 생성 시간 설정이며, 지식 소스가 생성된 후에는 변경할 수 없습니다.

KnowledgeSourceIngestionPermissionOption

문서 콘텐츠와 함께 인징할 수 있는 권한 유형.

값 Description
userIds

문서 내용과 함께 명시적인 사용자 식별자를 인징합니다.

groupIds

문서 콘텐츠와 함께 그룹 식별자를 수집합니다.

rbacScope

문서 콘텐츠와 함께 RBAC 범위 정보를 수집합니다.

KnowledgeSourceKind

지식 소스의 종류.

값 Description
searchIndex

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

azureBlob

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

indexedSharePoint

인덱스된 SharePoint에서 데이터를 읽는 지식 소스입니다.

indexedOneLake

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

indexedSql

Azure SQL Database 또는 SQL Managed Instance에서 데이터를 검색 인덱스로 가져오고 인징하는 지식 소스입니다.

web

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

file

직접 파일 업로드와 인덱싱을 지원하는 지식 소스입니다.

KnowledgeSourceNetworkAccessMode

지식 소스 수집을 위한 네트워크 접근 모드를 지정합니다. 디폴트는 '공개'입니다.

값 Description
public

인제스팅은 표준적이고 공개적으로 접근 가능한 실행 환경에서 실행됩니다. 이것이 기본값입니다.

private

인제스팅은 사설 실행 환경에서 실행되므로 사설 네트워크(사설 엔드포인트/공유 사설 링크)를 통해 데이터 소스와 의존성에 도달할 수 있습니다.

Prefer

HTTP PUT 요청의 경우 성공 시 생성/업데이트된 리소스를 반환하도록 서비스에 지시합니다.

값 Description
return=representation

SearchIndexerDataNoneIdentity

데이터 원본의 ID 속성을 지웁니다.

속성 형식 Description
@odata.type string:

#Microsoft.Azure.Search.DataNoneIdentity

ID 유형을 지정하는 URI 조각입니다.

SearchIndexerDataUserAssignedIdentity

사용할 데이터 원본의 ID를 지정합니다.

속성 형식 Description
@odata.type string:

#Microsoft.Azure.Search.DataUserAssignedIdentity

ID 유형을 지정하는 URI 조각입니다.

federatedIdentityClientId

string

다중 테넌트 User-Assigned 관리 신원 지원: 사용자 지정 관리 신원과 연합되도록 구성된 멀티텐턴트 앱의 클라이언트 ID.

userAssignedIdentity

string

일반적으로 검색 서비스에 할당되어야 하는 "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" 형식으로 사용자 할당 관리 ID의 정규화된 Azure 리소스 ID입니다.

SearchIndexFieldReference

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

속성 형식 Description
name

string

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

SearchIndexKnowledgeSource

검색 인덱스를 대상으로 하는 지식 소스입니다.

속성 형식 Description
@odata.etag

string

지식의 원천 ETag.

description

string

선택적 사용자 정의 설명입니다.

encryptionKey

SearchResourceEncryptionKey

Azure Key Vault에서 만드는 암호화 키에 대한 설명입니다. 이 키는 지식 소스 정의에 대해 아무도, 심지어 마이크로소프트도 복호화할 수 없다는 완전한 확신을 원할 때 추가적인 암호화 상태를 제공하는 데 사용됩니다. 지식 소스 정의를 암호화한 후에는 항상 암호화된 상태로 유지됩니다. 검색 서비스는 이 속성을 null로 설정하려는 시도를 무시합니다. 암호화 키를 회전시키고 싶을 때 필요에 따라 이 속성을 변경할 수 있습니다; 지식 소스 정의는 영향을 받지 않을 것입니다. 고객 관리형 키를 사용한 암호화는 무료 검색 서비스에 사용할 수 없으며 2019년 1월 1일 이후 생성된 유료 서비스에만 사용할 수 있습니다.

kind string:

searchIndex

지식 소스의 유형입니다.

name

string

참조 자료의 이름입니다.

searchIndexParameters

SearchIndexKnowledgeSourceParameters

지식 소스에 대한 매개변수입니다.

SearchIndexKnowledgeSourceParameters

검색 인덱스 지식 원본에 대한 매개 변수입니다.

속성 형식 Description
baseFilter

string

검색 시점에 인덱스에 기본 필터 조건이 적용됩니다(예: '상태 eq VA'). 쿼리 시점에 지식 소스 런타임 매개변수를 통해 덮어쓸 수 있습니다.

searchFields

SearchIndexFieldReference[]

검색 인덱스에서 검색할 필드를 제한하는 데 사용됩니다.

searchIndexName

string

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

semanticConfigurationName

string

대상 검색 인덱스에서 기본 구성이 아닌 다른 의미 체계 구성을 지정하는 데 사용됩니다.

sourceDataFields

SearchIndexFieldReference[]

참조된 원본 데이터에 대한 추가 필드를 요청하는 데 사용됩니다.

SearchResourceEncryptionKey

Azure Key Vault의 고객 관리형 암호화 키입니다. 만들고 관리하는 키를 사용하여 인덱스 및 동의어 맵과 같은 미사용 데이터를 암호화하거나 복호화할 수 있습니다.

속성 형식 Description
accessCredentials.applicationId

string

미사용 데이터를 암호화할 때 사용할 Azure Key Vault에 필요한 액세스 권한이 부여된 AAD 애플리케이션 ID입니다. 애플리케이션 ID는 AAD 애플리케이션의 개체 ID와 혼동해서는 안 됩니다.

accessCredentials.applicationSecret

string

지정된 AAD 애플리케이션의 인증 키입니다.

identity SearchIndexerDataIdentity:

이 암호화 키에 사용할 명시적 관리 ID입니다. 지정하지 않고 액세스 자격 증명 속성이 null이면 시스템 할당 관리 ID가 사용됩니다. 리소스 업데이트 시 명시적 ID가 지정되지 않은 경우 변경되지 않은 상태로 유지됩니다. "none"을 지정하면 이 속성의 값이 지워집니다.

keyVaultKeyName

string

미사용 데이터를 암호화하는 데 사용할 Azure Key Vault 키의 이름입니다.

keyVaultKeyVersion

string

미사용 데이터를 암호화하는 데 사용할 Azure Key Vault 키의 버전입니다.

keyVaultUri

string

미사용 데이터를 암호화하는 데 사용할 키를 포함하는 DNS 이름이라고도 하는 Azure Key Vault의 URI입니다. 예제 URI는 https://my-keyvault-name.vault.azure.net수 있습니다.

VectorSearchVectorizerKind

쿼리 시간 동안 사용할 벡터화 방법입니다.

값 Description
azureOpenAI

쿼리 시 Azure OpenAI 리소스를 사용하여 포함을 생성합니다.

customWebApi

쿼리 시 사용자 지정 웹 엔드포인트를 사용하여 포함을 생성합니다.

aiServicesVision

Azure AI Services Vision Vectorize API를 사용하여 쿼리 시 이미지 또는 텍스트 입력에 대한 임베딩을 생성합니다.

aml

쿼리 시 Azure AI Foundry 모델 카탈로그를 통해 배포된 Azure Machine Learning 엔드포인트를 사용하여 포함을 생성합니다.

WebKnowledgeSource

웹 결과를 타겟팅하는 지식 소스.

속성 형식 Description
@odata.etag

string

지식의 원천 ETag.

description

string

선택적 사용자 정의 설명입니다.

encryptionKey

SearchResourceEncryptionKey

Azure Key Vault에서 만드는 암호화 키에 대한 설명입니다. 이 키는 지식 소스 정의에 대해 아무도, 심지어 마이크로소프트도 복호화할 수 없다는 완전한 확신을 원할 때 추가적인 암호화 상태를 제공하는 데 사용됩니다. 지식 소스 정의를 암호화한 후에는 항상 암호화된 상태로 유지됩니다. 검색 서비스는 이 속성을 null로 설정하려는 시도를 무시합니다. 암호화 키를 회전시키고 싶을 때 필요에 따라 이 속성을 변경할 수 있습니다; 지식 소스 정의는 영향을 받지 않을 것입니다. 고객 관리형 키를 사용한 암호화는 무료 검색 서비스에 사용할 수 없으며 2019년 1월 1일 이후 생성된 유료 서비스에만 사용할 수 있습니다.

kind string:

web

지식 소스의 유형입니다.

name

string

참조 자료의 이름입니다.

webParameters

WebKnowledgeSourceParameters

웹 지식 소스에 대한 매개 변수입니다.

WebKnowledgeSourceDomain

웹 지식 원본 도메인에 대한 구성입니다.

속성 형식 Description
address

string

도메인의 주소입니다.

includeSubpages

boolean

이 도메인의 하위 페이지를 포함할지 여부입니다.

WebKnowledgeSourceDomains

웹 지식 원본에 대한 도메인 허용/차단 구성입니다.

속성 형식 Description
allowedDomains

WebKnowledgeSourceDomain[]

웹 결과에 허용되는 도메인들.

blockedDomains

WebKnowledgeSourceDomain[]

웹 결과에서 차단된 도메인들.

WebKnowledgeSourceParameters

웹 지식 소스에 대한 매개 변수입니다.

속성 형식 Description
count

integer (int32)

기본 웹 결과 수. 쿼리 시점에 지식 소스 런타임 매개변수를 통해 덮어쓸 수 있습니다.

domains

WebKnowledgeSourceDomains

웹 결과에 대한 도메인 허용/차단 구성입니다.

freshness

string

웹 결과의 기본 신선도 필터입니다. 쿼리 시점에 지식 소스 런타임 매개변수를 통해 덮어쓸 수 있습니다.

language

string

웹 결과의 기본 언어입니다. 쿼리 시점에 지식 소스 런타임 매개변수를 통해 덮어쓸 수 있습니다.

market

string

웹 결과의 기본 시장입니다. 쿼리 시점에 지식 소스 런타임 매개변수를 통해 덮어쓸 수 있습니다.