-
Notifications
You must be signed in to change notification settings - Fork 180
/
DistanceScoringFunction.yml
89 lines (89 loc) · 2.95 KB
/
DistanceScoringFunction.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
### YamlMime:TSType
name: DistanceScoringFunction
uid: '@azure/search-documents.DistanceScoringFunction'
package: '@azure/search-documents'
summary: >-
Defines a function that boosts scores based on distance from a geographic
location.
fullName: DistanceScoringFunction
remarks: ''
isDeprecated: false
type: interface
properties:
- name: parameters
uid: '@azure/search-documents.DistanceScoringFunction.parameters'
package: '@azure/search-documents'
summary: Parameter values for the distance scoring function.
fullName: parameters
remarks: ''
isDeprecated: false
syntax:
content: 'parameters: DistanceScoringParameters'
return:
description: ''
type: <xref uid="@azure/search-documents.DistanceScoringParameters" />
- name: type
uid: '@azure/search-documents.DistanceScoringFunction.type'
package: '@azure/search-documents'
summary: >-
Polymorphic discriminator, which specifies the different types this object
can be
fullName: type
remarks: ''
isDeprecated: false
syntax:
content: 'type: "distance"'
return:
description: ''
type: '"distance"'
inheritedProperties:
- name: boost
uid: '@azure/search-documents.DistanceScoringFunction.boost'
package: '@azure/search-documents'
summary: >-
A multiplier for the raw score. Must be a positive number not equal to
1.0.
fullName: boost
remarks: ''
isDeprecated: false
syntax:
content: 'boost: number'
return:
description: ''
type: number
inheritanceDescription: >-
<b>Inherited From</b>
[BaseScoringFunction.boost](xref:@azure/search-documents.BaseScoringFunction.boost)
- name: fieldName
uid: '@azure/search-documents.DistanceScoringFunction.fieldName'
package: '@azure/search-documents'
summary: The name of the field used as input to the scoring function.
fullName: fieldName
remarks: ''
isDeprecated: false
syntax:
content: 'fieldName: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[BaseScoringFunction.fieldName](xref:@azure/search-documents.BaseScoringFunction.fieldName)
- name: interpolation
uid: '@azure/search-documents.DistanceScoringFunction.interpolation'
package: '@azure/search-documents'
summary: >-
A value indicating how boosting will be interpolated across document
scores; defaults to "Linear".
fullName: interpolation
remarks: ''
isDeprecated: false
syntax:
content: 'interpolation?: ScoringFunctionInterpolation'
return:
description: ''
type: <xref uid="@azure/search-documents.ScoringFunctionInterpolation" />
inheritanceDescription: >-
<b>Inherited From</b>
[BaseScoringFunction.interpolation](xref:@azure/search-documents.BaseScoringFunction.interpolation)
extends: <xref uid="@azure/search-documents.BaseScoringFunction" />