SimpleField interface

패키지:

@azure/search-documents

필드의 이름, 데이터 형식 및 검색 동작을 설명하는 인덱스 정의의 필드를 나타냅니다.

속성

analyzerName	필드에 사용할 분석기의 이름입니다. 이 옵션은 검색 가능한 필드에만 사용할 수 있으며 searchAnalyzer 또는 indexAnalyzer와 함께 설정할 수 없습니다. 분석기를 선택한 후에는 필드에 대해 변경할 수 없습니다.
facetable	패싯 쿼리에서 필드를 참조할 수 있도록 설정할지 여부를 나타내는 값입니다. 일반적으로 범주별 적중 횟수를 포함하는 검색 결과 프레젠테이션에 사용됩니다(예: 디지털 카메라를 검색하고 브랜드별, 메가픽셀별, 가격별 적중 항목 보기). Edm.GeographyPoint 또는 Collection(Edm.GeographyPoint) 형식의 필드는 패싯할 수 없습니다. 기본값은 false입니다.
filterable	$filter 쿼리에서 필드를 참조할 수 있도록 설정할지 여부를 나타내는 값입니다. 필터링 가능 항목은 문자열 처리 방식에서 검색 가능한 항목과 다릅니다. 필터링할 수 있는 Edm.String 또는 Collection(Edm.String) 형식의 필드는 단어 분리를 거치지 않으므로 비교는 정확한 일치에만 해당합니다. 예를 들어 이러한 필드 f를 "맑은 날"로 설정하면 $filter=f eq 'sunny'는 일치하는 항목을 찾을 수 없지만 $filter=f eq '맑은 날'입니다. 기본값은 false입니다.
hidden	검색 결과에서 필드를 반환할 수 있는지 여부를 나타내는 값입니다. 필드(예: 여백)를 필터, 정렬 또는 채점 메커니즘으로 사용하지만 최종 사용자에게 필드를 표시하지 않으려면 이 옵션을 사용하지 않도록 설정할 수 있습니다. 이 속성은 키 필드에 대해 false여야 합니다. 이 속성은 기존 필드에서 변경할 수 있습니다. 이 속성을 사용하도록 설정해도 인덱스 스토리지 요구 사항이 증가하지는 않습니다. 기본값은 벡터 필드에 대해 true이고, 그렇지 않으면 false입니다.
indexAnalyzerName	필드에 대한 인덱싱 시간에 사용되는 분석기의 이름입니다. 이 옵션은 검색 가능한 필드에만 사용할 수 있습니다. searchAnalyzer와 함께 설정해야 하며 분석기 옵션과 함께 설정할 수 없습니다. 이 속성은 언어 분석기의 이름으로 설정할 수 없습니다. 언어 분석기가 필요한 경우 대신 분석기 속성을 사용합니다. 분석기를 선택한 후에는 필드에 대해 변경할 수 없습니다.
key	필드가 인덱스의 문서를 고유하게 식별하는지 여부를 나타내는 값입니다. 각 인덱스의 최상위 필드 하나만 키 필드로 선택해야 하며 Edm.String 형식이어야 합니다. 키 필드를 사용하여 문서를 직접 조회하고 특정 문서를 업데이트하거나 삭제할 수 있습니다. 기본값은 false입니다.
name	인덱스 또는 부모 필드의 필드 컬렉션 내에서 고유해야 하는 필드의 이름입니다.
searchable	필드가 전체 텍스트 검색 가능한지 여부를 나타내는 값입니다. 즉, 인덱싱 중에 단어 분리와 같은 분석을 거칩니다. 검색 가능한 필드를 "sunny day"와 같은 값으로 설정하면 내부적으로 개별 토큰 "sunny" 및 "day"로 분할됩니다. 이렇게 하면 이러한 용어를 전체 텍스트로 검색할 수 있습니다. Edm.String 또는 Collection(Edm.String) 형식의 필드는 기본적으로 검색할 수 있습니다. 이 속성은 문자열이 아닌 다른 데이터 형식의 단순 필드에 대해 false여야 합니다. 참고: 검색 가능한 필드는 전체 텍스트 검색을 위해 추가 토큰화된 버전의 필드 값을 수용하기 위해 인덱스의 추가 공간을 사용합니다. 인덱스의 공간을 절약하고 검색에 필드를 포함할 필요가 없는 경우 검색 가능 항목을 false로 설정합니다. 기본값은 false입니다.
searchAnalyzerName	필드에 대한 검색 시간에 사용되는 분석기의 이름입니다. 이 옵션은 검색 가능한 필드에만 사용할 수 있습니다. indexAnalyzerName 함께 설정해야 하며 analyzerName 옵션과 함께 설정할 수 없습니다. 이 속성은 언어 분석기의 이름으로 설정할 수 없습니다. 언어 분석기가 필요한 경우 대신 analyzerName 속성을 사용합니다. 이 분석기는 기존 필드에서 업데이트할 수 있습니다.
sortable	$orderby 식에서 필드를 참조할 수 있도록 설정할지 여부를 나타내는 값입니다. 기본적으로 검색 엔진은 점수를 기준으로 결과를 정렬하지만 대부분의 환경에서 사용자는 문서의 필드를 기준으로 정렬하려고 합니다. 단순 필드는 단일 값인 경우에만 정렬할 수 있습니다(부모 문서의 범위에 단일 값이 있음). 단순 컬렉션 필드는 다중값이므로 정렬할 수 없습니다. 복합 컬렉션의 단순 하위 필드도 다중값이므로 정렬할 수 없습니다. 즉, 직계 부모 필드이든 상위 필드이든 관계없이 복합 컬렉션입니다. 기본값은 false입니다.
stored	필드가 검색 결과에 반환될 디스크에 별도로 유지되는지 여부를 나타내는 변경할 수 없는 값입니다. 스토리지 오버헤드를 절약하기 위해 검색 응답에서 필드 내용을 반환하지 않으려는 경우 이 옵션을 사용하지 않도록 설정할 수 있습니다. 인덱스 생성 중에만 설정할 수 있으며 벡터 필드에 대해서만 설정할 수 있습니다. 기존 필드에 대해 이 속성을 변경하거나 새 필드에 대해 false로 설정할 수 없습니다. 이 속성을 false로 설정하면 'hidden' 속성을 'true'로 설정해야 합니다. 이 속성은 키 필드, 새 필드 및 비벡터 필드의 경우 false이거나 설정되지 않아야 합니다. 이 속성을 사용하지 않도록 설정하면 인덱스 스토리지 요구 사항이 줄어듭니다.
synonymMapNames	이 필드와 연결할 동의어 맵의 이름 목록입니다. 이 옵션은 검색 가능한 필드에만 사용할 수 있습니다. 현재 필드당 하나의 동의어 맵만 지원됩니다. 필드에 동의어 맵을 할당하면 해당 필드를 대상으로 하는 쿼리 용어가 동의어 맵의 규칙을 사용하여 쿼리 시간에 확장됩니다. 이 특성은 기존 필드에서 변경할 수 있습니다.
type	필드의 데이터 형식입니다.
vectorEncodingFormat	필드 내용을 해석하는 인코딩 형식입니다.
vectorSearchDimensions	벡터 필드의 차원입니다.
vectorSearchProfileName	벡터 필드를 검색할 때 사용할 알고리즘 및 벡터라이저를 지정하는 벡터 검색 프로필의 이름입니다.

속성 세부 정보

analyzerName

필드에 사용할 분석기의 이름입니다. 이 옵션은 검색 가능한 필드에만 사용할 수 있으며 searchAnalyzer 또는 indexAnalyzer와 함께 설정할 수 없습니다. 분석기를 선택한 후에는 필드에 대해 변경할 수 없습니다.

analyzerName?: string

속성 값

string

facetable

패싯 쿼리에서 필드를 참조할 수 있도록 설정할지 여부를 나타내는 값입니다. 일반적으로 범주별 적중 횟수를 포함하는 검색 결과 프레젠테이션에 사용됩니다(예: 디지털 카메라를 검색하고 브랜드별, 메가픽셀별, 가격별 적중 항목 보기). Edm.GeographyPoint 또는 Collection(Edm.GeographyPoint) 형식의 필드는 패싯할 수 없습니다. 기본값은 false입니다.

facetable?: boolean

속성 값

boolean

filterable

$filter 쿼리에서 필드를 참조할 수 있도록 설정할지 여부를 나타내는 값입니다. 필터링 가능 항목은 문자열 처리 방식에서 검색 가능한 항목과 다릅니다. 필터링할 수 있는 Edm.String 또는 Collection(Edm.String) 형식의 필드는 단어 분리를 거치지 않으므로 비교는 정확한 일치에만 해당합니다. 예를 들어 이러한 필드 f를 "맑은 날"로 설정하면 $filter=f eq 'sunny'는 일치하는 항목을 찾을 수 없지만 $filter=f eq '맑은 날'입니다. 기본값은 false입니다.

filterable?: boolean

속성 값

boolean

hidden

검색 결과에서 필드를 반환할 수 있는지 여부를 나타내는 값입니다. 필드(예: 여백)를 필터, 정렬 또는 채점 메커니즘으로 사용하지만 최종 사용자에게 필드를 표시하지 않으려면 이 옵션을 사용하지 않도록 설정할 수 있습니다. 이 속성은 키 필드에 대해 false여야 합니다. 이 속성은 기존 필드에서 변경할 수 있습니다. 이 속성을 사용하도록 설정해도 인덱스 스토리지 요구 사항이 증가하지는 않습니다. 기본값은 벡터 필드에 대해 true이고, 그렇지 않으면 false입니다.

hidden?: boolean

속성 값

boolean

indexAnalyzerName

필드에 대한 인덱싱 시간에 사용되는 분석기의 이름입니다. 이 옵션은 검색 가능한 필드에만 사용할 수 있습니다. searchAnalyzer와 함께 설정해야 하며 분석기 옵션과 함께 설정할 수 없습니다. 이 속성은 언어 분석기의 이름으로 설정할 수 없습니다. 언어 분석기가 필요한 경우 대신 분석기 속성을 사용합니다. 분석기를 선택한 후에는 필드에 대해 변경할 수 없습니다.

indexAnalyzerName?: string

속성 값

string

key

필드가 인덱스의 문서를 고유하게 식별하는지 여부를 나타내는 값입니다. 각 인덱스의 최상위 필드 하나만 키 필드로 선택해야 하며 Edm.String 형식이어야 합니다. 키 필드를 사용하여 문서를 직접 조회하고 특정 문서를 업데이트하거나 삭제할 수 있습니다. 기본값은 false입니다.

key?: boolean

속성 값

boolean

name

인덱스 또는 부모 필드의 필드 컬렉션 내에서 고유해야 하는 필드의 이름입니다.

name: string

속성 값

string

searchable

필드가 전체 텍스트 검색 가능한지 여부를 나타내는 값입니다. 즉, 인덱싱 중에 단어 분리와 같은 분석을 거칩니다. 검색 가능한 필드를 "sunny day"와 같은 값으로 설정하면 내부적으로 개별 토큰 "sunny" 및 "day"로 분할됩니다. 이렇게 하면 이러한 용어를 전체 텍스트로 검색할 수 있습니다. Edm.String 또는 Collection(Edm.String) 형식의 필드는 기본적으로 검색할 수 있습니다. 이 속성은 문자열이 아닌 다른 데이터 형식의 단순 필드에 대해 false여야 합니다. 참고: 검색 가능한 필드는 전체 텍스트 검색을 위해 추가 토큰화된 버전의 필드 값을 수용하기 위해 인덱스의 추가 공간을 사용합니다. 인덱스의 공간을 절약하고 검색에 필드를 포함할 필요가 없는 경우 검색 가능 항목을 false로 설정합니다. 기본값은 false입니다.

searchable?: boolean

속성 값

boolean

searchAnalyzerName

필드에 대한 검색 시간에 사용되는 분석기의 이름입니다. 이 옵션은 검색 가능한 필드에만 사용할 수 있습니다. indexAnalyzerName 함께 설정해야 하며 analyzerName 옵션과 함께 설정할 수 없습니다. 이 속성은 언어 분석기의 이름으로 설정할 수 없습니다. 언어 분석기가 필요한 경우 대신 analyzerName 속성을 사용합니다. 이 분석기는 기존 필드에서 업데이트할 수 있습니다.

searchAnalyzerName?: string

속성 값

string

sortable

$orderby 식에서 필드를 참조할 수 있도록 설정할지 여부를 나타내는 값입니다. 기본적으로 검색 엔진은 점수를 기준으로 결과를 정렬하지만 대부분의 환경에서 사용자는 문서의 필드를 기준으로 정렬하려고 합니다. 단순 필드는 단일 값인 경우에만 정렬할 수 있습니다(부모 문서의 범위에 단일 값이 있음). 단순 컬렉션 필드는 다중값이므로 정렬할 수 없습니다. 복합 컬렉션의 단순 하위 필드도 다중값이므로 정렬할 수 없습니다. 즉, 직계 부모 필드이든 상위 필드이든 관계없이 복합 컬렉션입니다. 기본값은 false입니다.

sortable?: boolean

속성 값

boolean

stored

필드가 검색 결과에 반환될 디스크에 별도로 유지되는지 여부를 나타내는 변경할 수 없는 값입니다. 스토리지 오버헤드를 절약하기 위해 검색 응답에서 필드 내용을 반환하지 않으려는 경우 이 옵션을 사용하지 않도록 설정할 수 있습니다. 인덱스 생성 중에만 설정할 수 있으며 벡터 필드에 대해서만 설정할 수 있습니다. 기존 필드에 대해 이 속성을 변경하거나 새 필드에 대해 false로 설정할 수 없습니다. 이 속성을 false로 설정하면 'hidden' 속성을 'true'로 설정해야 합니다. 이 속성은 키 필드, 새 필드 및 비벡터 필드의 경우 false이거나 설정되지 않아야 합니다. 이 속성을 사용하지 않도록 설정하면 인덱스 스토리지 요구 사항이 줄어듭니다.

stored?: boolean

속성 값

boolean

synonymMapNames

이 필드와 연결할 동의어 맵의 이름 목록입니다. 이 옵션은 검색 가능한 필드에만 사용할 수 있습니다. 현재 필드당 하나의 동의어 맵만 지원됩니다. 필드에 동의어 맵을 할당하면 해당 필드를 대상으로 하는 쿼리 용어가 동의어 맵의 규칙을 사용하여 쿼리 시간에 확장됩니다. 이 특성은 기존 필드에서 변경할 수 있습니다.

synonymMapNames?: string[]

속성 값

string[]

type

필드의 데이터 형식입니다.

type: SearchFieldDataType

속성 값

SearchFieldDataType

vectorEncodingFormat

필드 내용을 해석하는 인코딩 형식입니다.

vectorEncodingFormat?: string

속성 값

string

vectorSearchDimensions

벡터 필드의 차원입니다.

vectorSearchDimensions?: number

속성 값

number

vectorSearchProfileName

벡터 필드를 검색할 때 사용할 알고리즘 및 벡터라이저를 지정하는 벡터 검색 프로필의 이름입니다.

vectorSearchProfileName?: string

속성 값

string