azure-docs-sdk-node/docs-ref-autogen/@azure/search-documents/KnowledgeBaseRetrievalRequest.yml at main · MicrosoftDocs/azure-docs-sdk-node · GitHub

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
### YamlMime:TSType
name: KnowledgeBaseRetrievalRequest
uid: '@azure/search-documents.KnowledgeBaseRetrievalRequest'
package: '@azure/search-documents'
summary: The input contract for the retrieval request.
fullName: KnowledgeBaseRetrievalRequest
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: includeActivity
    uid: '@azure/search-documents.KnowledgeBaseRetrievalRequest.includeActivity'
    package: '@azure/search-documents'
    summary: Indicates retrieval results should include activity information.
    fullName: includeActivity
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'includeActivity?: boolean'
      return:
        description: ''
        type: boolean
  - name: intents
    uid: '@azure/search-documents.KnowledgeBaseRetrievalRequest.intents'
    package: '@azure/search-documents'
    summary: A list of intended queries to execute without model query planning.
    fullName: intents
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'intents?: KnowledgeRetrievalIntentUnion[]'
      return:
        description: ''
        type: <xref uid="@azure/search-documents.BaseKnowledgeRetrievalIntent" />[]
  - name: knowledgeSourceParams
    uid: >-
      @azure/search-documents.KnowledgeBaseRetrievalRequest.knowledgeSourceParams
    package: '@azure/search-documents'
    summary: A list of runtime parameters for the knowledge sources.
    fullName: knowledgeSourceParams
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'knowledgeSourceParams?: KnowledgeSourceParamsUnion[]'
      return:
        description: ''
        type: <xref uid="@azure/search-documents.KnowledgeSourceParams" />[]
  - name: maxOutputSizeInTokens
    uid: >-
      @azure/search-documents.KnowledgeBaseRetrievalRequest.maxOutputSizeInTokens
    package: '@azure/search-documents'
    summary: Limits the maximum size of the content in the output.
    fullName: maxOutputSizeInTokens
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'maxOutputSizeInTokens?: number'
      return:
        description: ''
        type: number
  - name: maxRuntimeInSeconds
    uid: '@azure/search-documents.KnowledgeBaseRetrievalRequest.maxRuntimeInSeconds'
    package: '@azure/search-documents'
    summary: The maximum runtime in seconds.
    fullName: maxRuntimeInSeconds
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'maxRuntimeInSeconds?: number'
      return:
        description: ''
        type: number