@azure/search-documents 12.2.0 → 12.3.0-alpha.20251031.1

package/dist/commonjs/generated/knowledgeBase/models/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/generated/knowledgeBase/models/index.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAwkBH,kFAAkF;AAClF,IAAY,8BAGX;AAHD,WAAY,8BAA8B;IACxC,uCAAuC;IACvC,yFAAuD,CAAA;AACzD,CAAC,EAHW,8BAA8B,8CAA9B,8BAA8B,QAGzC;AAWD,wFAAwF;AACxF,IAAY,oCAKX;AALD,WAAY,oCAAoC;IAC9C,iCAAiC;IACjC,qDAAa,CAAA;IACb,kCAAkC;IAClC,uDAAe,CAAA;AACjB,CAAC,EALW,oCAAoC,oDAApC,oCAAoC,QAK/C;AAYD,qFAAqF;AACrF,IAAY,iCAGX;AAHD,WAAY,iCAAiC;IAC3C,gDAAgD;IAChD,0DAAqB,CAAA;AACvB,CAAC,EAHW,iCAAiC,iDAAjC,iCAAiC,QAG5C;AAWD,8FAA8F;AAC9F,IAAY,0CAOX;AAPD,WAAY,0CAA0C;IACpD,2FAA2F;IAC3F,iEAAmB,CAAA;IACnB,0CAA0C;IAC1C,yDAAW,CAAA;IACX,2DAA2D;IAC3D,+DAAiB,CAAA;AACnB,CAAC,EAPW,0CAA0C,0DAA1C,0CAA0C,QAOrD;AAaD,qFAAqF;AACrF,IAAY,iCAKX;AALD,WAAY,iCAAiC;IAC3C,qFAAqF;IACrF,sEAAiC,CAAA;IACjC,qDAAqD;IACrD,wEAAmC,CAAA;AACrC,CAAC,EALW,iCAAiC,iDAAjC,iCAAiC,QAK5C;AAYD,4EAA4E;AAC5E,IAAY,wBAaX;AAbD,WAAY,wBAAwB;IAClC,kEAAkE;IAClE,uDAA2B,CAAA;IAC3B,oGAAoG;IACpG,mDAAuB,CAAA;IACvB,2DAA2D;IAC3D,uCAAW,CAAA;IACX,gFAAgF;IAChF,iEAAqC,CAAA;IACrC,4FAA4F;IAC5F,mEAAuC,CAAA;IACvC,yFAAyF;IACzF,6DAAiC,CAAA;AACnC,CAAC,EAbW,wBAAwB,wCAAxB,wBAAwB,QAanC","sourcesContent":["/*\n * Copyright (c) Microsoft Corporation.\n * Licensed under the MIT License.\n *\n * Code generated by Microsoft (R) AutoRest Code Generator.\n * Changes may cause incorrect behavior and will be lost if the code is regenerated.\n */\n\nimport * as coreClient from \"@azure/core-client\";\nimport * as coreHttpCompat from \"@azure/core-http-compat\";\n\nexport type KnowledgeBaseMessageContentUnion =\n  | KnowledgeBaseMessageContent\n  | KnowledgeBaseMessageTextContent\n  | KnowledgeBaseMessageImageContent;\nexport type KnowledgeRetrievalIntentUnion =\n  | KnowledgeRetrievalIntent\n  | KnowledgeRetrievalSemanticIntent;\nexport type KnowledgeRetrievalReasoningEffortUnion =\n  | KnowledgeRetrievalReasoningEffort\n  | KnowledgeRetrievalMinimalReasoningEffort\n  | KnowledgeRetrievalLowReasoningEffort\n  | KnowledgeRetrievalMediumReasoningEffort;\nexport type KnowledgeSourceParamsUnion =\n  | KnowledgeSourceParams\n  | SearchIndexKnowledgeSourceParams\n  | AzureBlobKnowledgeSourceParams\n  | IndexedSharePointKnowledgeSourceParams\n  | IndexedOneLakeKnowledgeSourceParams\n  | WebKnowledgeSourceParams\n  | RemoteSharePointKnowledgeSourceParams;\nexport type KnowledgeBaseActivityRecordUnion =\n  | KnowledgeBaseActivityRecord\n  | KnowledgeBaseRetrievalActivityRecordUnion\n  | KnowledgeBaseModelQueryPlanningActivityRecord\n  | KnowledgeBaseModelAnswerSynthesisActivityRecord\n  | KnowledgeBaseAgenticReasoningActivityRecord;\nexport type KnowledgeBaseReferenceUnion =\n  | KnowledgeBaseReference\n  | KnowledgeBaseSearchIndexReference\n  | KnowledgeBaseAzureBlobReference\n  | KnowledgeBaseIndexedSharePointReference\n  | KnowledgeBaseIndexedOneLakeReference\n  | KnowledgeBaseWebReference\n  | KnowledgeBaseRemoteSharePointReference;\nexport type KnowledgeBaseRetrievalActivityRecordUnion =\n  | KnowledgeBaseRetrievalActivityRecord\n  | KnowledgeBaseSearchIndexActivityRecord\n  | KnowledgeBaseAzureBlobActivityRecord\n  | KnowledgeBaseIndexedSharePointActivityRecord\n  | KnowledgeBaseIndexedOneLakeActivityRecord\n  | KnowledgeBaseWebActivityRecord\n  | KnowledgeBaseRemoteSharePointActivityRecord;\n\n/** The input contract for the retrieval request. */\nexport interface KnowledgeBaseRetrievalRequest {\n  /** A list of chat message style input. */\n  messages?: KnowledgeBaseMessage[];\n  /** A list of intended queries to execute without model query planning. */\n  intents?: KnowledgeRetrievalIntentUnion[];\n  /** The maximum runtime in seconds. */\n  maxRuntimeInSeconds?: number;\n  /** Limits the maximum size of the content in the output. */\n  maxOutputSize?: number;\n  retrievalReasoningEffort?: KnowledgeRetrievalReasoningEffortUnion;\n  /** Indicates retrieval results should include activity information. */\n  includeActivity?: boolean;\n  /** The output configuration for this retrieval. */\n  outputMode?: KnowledgeRetrievalOutputMode;\n  /** A list of runtime parameters for the knowledge sources. */\n  knowledgeSourceParams?: KnowledgeSourceParamsUnion[];\n}\n\n/** The natural language message style object. */\nexport interface KnowledgeBaseMessage {\n  /** The role of the tool response. */\n  role?: string;\n  content: KnowledgeBaseMessageContentUnion[];\n}\n\n/** Specifies the type of the message content. */\nexport interface KnowledgeBaseMessageContent {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type: \"text\" | \"image\";\n}\n\n/** An intended query to execute without model query planning. */\nexport interface KnowledgeRetrievalIntent {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type: \"semantic\";\n}\n\nexport interface KnowledgeRetrievalReasoningEffort {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  kind: \"minimal\" | \"low\" | \"medium\";\n}\n\nexport interface KnowledgeSourceParams {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  kind:\n    | \"searchIndex\"\n    | \"azureBlob\"\n    | \"indexedSharePoint\"\n    | \"indexedOneLake\"\n    | \"web\"\n    | \"remoteSharePoint\";\n  /** The name of the index the params apply to. */\n  knowledgeSourceName: string;\n  /** Indicates whether references should be included for data retrieved from this source. */\n  includeReferences?: boolean;\n  /** Indicates whether references should include the structured data obtained during retrieval in their payload. */\n  includeReferenceSourceData?: boolean;\n  /** Indicates that this knowledge source should bypass source selection and always be queried at retrieval time. */\n  alwaysQuerySource?: boolean;\n  /** The reranker threshold all retrieved documents must meet to be included in the response. */\n  rerankerThreshold?: number;\n}\n\n/** The output contract for the retrieval response. */\nexport interface KnowledgeBaseRetrievalResponse {\n  response?: KnowledgeBaseMessage[];\n  /** The activity records for tracking progress and billing implications. */\n  activity?: KnowledgeBaseActivityRecordUnion[];\n  /** The references for the retrieval data used in the response. */\n  references?: KnowledgeBaseReferenceUnion[];\n}\n\n/** Base type for activity records. */\nexport interface KnowledgeBaseActivityRecord {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type:\n    | \"KnowledgeBaseRetrievalActivityRecord\"\n    | \"searchIndex\"\n    | \"azureBlob\"\n    | \"indexedSharePoint\"\n    | \"indexedOneLake\"\n    | \"web\"\n    | \"remoteSharePoint\"\n    | \"modelQueryPlanning\"\n    | \"modelAnswerSynthesis\"\n    | \"agenticReasoning\";\n  /** The ID of the activity record. */\n  id: number;\n  /** The elapsed time in milliseconds for the retrieval activity. */\n  elapsedMs?: number;\n  /** The error detail explaining why the operation failed. This property is only included when the activity does not succeed. */\n  error?: KnowledgeBaseErrorDetail;\n}\n\n/** The error details. */\nexport interface KnowledgeBaseErrorDetail {\n  /**\n   * The error code.\n   * NOTE: This property will not be serialized. It can only be populated by the server.\n   */\n  readonly code?: string;\n  /**\n   * The error message.\n   * NOTE: This property will not be serialized. It can only be populated by the server.\n   */\n  readonly message?: string;\n  /**\n   * The error target.\n   * NOTE: This property will not be serialized. It can only be populated by the server.\n   */\n  readonly target?: string;\n  /**\n   * The error details.\n   * NOTE: This property will not be serialized. It can only be populated by the server.\n   */\n  readonly details?: KnowledgeBaseErrorDetail[];\n  /**\n   * The error additional info.\n   * NOTE: This property will not be serialized. It can only be populated by the server.\n   */\n  readonly additionalInfo?: KnowledgeBaseErrorAdditionalInfo[];\n}\n\n/** The resource management error additional info. */\nexport interface KnowledgeBaseErrorAdditionalInfo {\n  /**\n   * The additional info type.\n   * NOTE: This property will not be serialized. It can only be populated by the server.\n   */\n  readonly type?: string;\n  /**\n   * The additional info.\n   * NOTE: This property will not be serialized. It can only be populated by the server.\n   */\n  readonly info?: Record<string, unknown>;\n}\n\n/** Base type for references. */\nexport interface KnowledgeBaseReference {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type:\n    | \"searchIndex\"\n    | \"azureBlob\"\n    | \"indexedSharePoint\"\n    | \"indexedOneLake\"\n    | \"web\"\n    | \"remoteSharePoint\";\n  /** The ID of the reference. */\n  id: string;\n  /** The source activity ID for the reference. */\n  activitySource: number;\n  /** Dictionary of <any> */\n  sourceData?: { [propertyName: string]: any };\n  /** The reranker score for the document reference. */\n  rerankerScore?: number;\n}\n\n/** Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */\nexport interface ErrorResponse {\n  /** The error object. */\n  error?: ErrorDetail;\n}\n\n/** The error detail. */\nexport interface ErrorDetail {\n  /**\n   * The error code.\n   * NOTE: This property will not be serialized. It can only be populated by the server.\n   */\n  readonly code?: string;\n  /**\n   * The error message.\n   * NOTE: This property will not be serialized. It can only be populated by the server.\n   */\n  readonly message?: string;\n  /**\n   * The error target.\n   * NOTE: This property will not be serialized. It can only be populated by the server.\n   */\n  readonly target?: string;\n  /**\n   * The error details.\n   * NOTE: This property will not be serialized. It can only be populated by the server.\n   */\n  readonly details?: ErrorDetail[];\n  /**\n   * The error additional info.\n   * NOTE: This property will not be serialized. It can only be populated by the server.\n   */\n  readonly additionalInfo?: ErrorAdditionalInfo[];\n}\n\n/** The resource management error additional info. */\nexport interface ErrorAdditionalInfo {\n  /**\n   * The additional info type.\n   * NOTE: This property will not be serialized. It can only be populated by the server.\n   */\n  readonly type?: string;\n  /**\n   * The additional info.\n   * NOTE: This property will not be serialized. It can only be populated by the server.\n   */\n  readonly info?: Record<string, unknown>;\n}\n\nexport interface KnowledgeBaseMessageImageContentImage {\n  /** The url of the image. */\n  url: string;\n}\n\n/** Represents the arguments the search index retrieval activity was run with. */\nexport interface KnowledgeBaseSearchIndexActivityArguments {\n  /** The search string used to query the search index. */\n  search?: string;\n  /** The filter string. */\n  filter?: string;\n}\n\n/** Represents the arguments the azure blob retrieval activity was run with. */\nexport interface KnowledgeBaseAzureBlobActivityArguments {\n  /** The search string used to query blob contents. */\n  search?: string;\n}\n\n/** Represents the arguments the indexed SharePoint retrieval activity was run with. */\nexport interface KnowledgeBaseIndexedSharePointActivityArguments {\n  /** The search string used to query indexed SharePoint contents. */\n  search?: string;\n}\n\n/** Represents the arguments the indexed OneLake retrieval activity was run with. */\nexport interface KnowledgeBaseIndexedOneLakeActivityArguments {\n  /** The search string used to query indexed OneLake contents. */\n  search?: string;\n}\n\n/** Represents the arguments the web retrieval activity was run with. */\nexport interface KnowledgeBaseWebActivityArguments {\n  /** The search string used to query the web. */\n  search?: string;\n  /** The language for the retrieval activity. */\n  language?: string;\n  /** The market for the retrieval activity. */\n  market?: string;\n  /** The number of web results returned. */\n  count?: number;\n  /** The freshness for the retrieval activity. */\n  freshness?: string;\n}\n\n/** Represents the arguments the remote SharePoint retrieval activity was run with. */\nexport interface KnowledgeBaseRemoteSharePointActivityArguments {\n  /** The search string used to query the remote SharePoint knowledge source. */\n  search?: string;\n  /** The filter expression add-on for the retrieval activity. */\n  filterExpressionAddOn?: string;\n}\n\n/** Information about the sensitivity label applied to a SharePoint document. */\nexport interface SharePointSensitivityLabelInfo {\n  /** The display name for the sensitivity label. */\n  displayName?: string;\n  /** The ID of the sensitivity label. */\n  sensitivityLabelId?: string;\n  /** The tooltip that should be displayed for the label in a UI. */\n  tooltip?: string;\n  /** The priority in which the sensitivity label is applied. */\n  priority?: number;\n  /** The color that the UI should display for the label, if configured. */\n  color?: string;\n  /** Indicates whether the sensitivity label enforces encryption. */\n  isEncrypted?: boolean;\n}\n\n/** Text message type. */\nexport interface KnowledgeBaseMessageTextContent\n  extends KnowledgeBaseMessageContent {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type: \"text\";\n  text: string;\n}\n\n/** Text message type. */\nexport interface KnowledgeBaseMessageImageContent\n  extends KnowledgeBaseMessageContent {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type: \"image\";\n  image: KnowledgeBaseMessageImageContentImage;\n}\n\nexport interface KnowledgeRetrievalSemanticIntent\n  extends KnowledgeRetrievalIntent {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type: \"semantic\";\n  /** The semantic query to execute */\n  search: string;\n}\n\n/** Run knowledge retrieval with minimal reasoning effort. */\nexport interface KnowledgeRetrievalMinimalReasoningEffort\n  extends KnowledgeRetrievalReasoningEffort {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  kind: \"minimal\";\n}\n\n/** Run knowledge retrieval with low reasoning effort. */\nexport interface KnowledgeRetrievalLowReasoningEffort\n  extends KnowledgeRetrievalReasoningEffort {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  kind: \"low\";\n}\n\n/** Run knowledge retrieval with medium reasoning effort. */\nexport interface KnowledgeRetrievalMediumReasoningEffort\n  extends KnowledgeRetrievalReasoningEffort {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  kind: \"medium\";\n}\n\n/** Specifies runtime parameters for a search index knowledge source */\nexport interface SearchIndexKnowledgeSourceParams\n  extends KnowledgeSourceParams {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  kind: \"searchIndex\";\n  /** A filter condition applied to the index (e.g., 'State eq VA'). */\n  filterAddOn?: string;\n}\n\n/** Specifies runtime parameters for a azure blob knowledge source */\nexport interface AzureBlobKnowledgeSourceParams extends KnowledgeSourceParams {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  kind: \"azureBlob\";\n}\n\n/** Specifies runtime parameters for a indexed SharePoint knowledge source */\nexport interface IndexedSharePointKnowledgeSourceParams\n  extends KnowledgeSourceParams {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  kind: \"indexedSharePoint\";\n}\n\n/** Specifies runtime parameters for a indexed OneLake knowledge source */\nexport interface IndexedOneLakeKnowledgeSourceParams\n  extends KnowledgeSourceParams {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  kind: \"indexedOneLake\";\n}\n\n/** Specifies runtime parameters for a web knowledge source */\nexport interface WebKnowledgeSourceParams extends KnowledgeSourceParams {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  kind: \"web\";\n  /** The language of the web results. */\n  language?: string;\n  /** The market of the web results. */\n  market?: string;\n  /** The number of web results to return. */\n  count?: number;\n  /** The freshness of web results. */\n  freshness?: string;\n}\n\n/** Specifies runtime parameters for a remote SharePoint knowledge source */\nexport interface RemoteSharePointKnowledgeSourceParams\n  extends KnowledgeSourceParams {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  kind: \"remoteSharePoint\";\n  /** A filter condition applied to the SharePoint data source. It must be specified in the Keyword Query Language syntax. It will be combined as a conjunction with the filter expression specified in the knowledge source definition. */\n  filterExpressionAddOn?: string;\n}\n\n/** Represents a retrieval activity record. */\nexport interface KnowledgeBaseRetrievalActivityRecord\n  extends KnowledgeBaseActivityRecord {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type:\n    | \"KnowledgeBaseRetrievalActivityRecord\"\n    | \"searchIndex\"\n    | \"azureBlob\"\n    | \"indexedSharePoint\"\n    | \"indexedOneLake\"\n    | \"web\"\n    | \"remoteSharePoint\";\n  /** The knowledge source for the retrieval activity. */\n  knowledgeSourceName?: string;\n  /** The query time for this retrieval activity. */\n  queryTime?: Date;\n  /** The count of documents retrieved that were sufficiently relevant to pass the reranker threshold. */\n  count?: number;\n}\n\n/** Represents an LLM query planning activity record. */\nexport interface KnowledgeBaseModelQueryPlanningActivityRecord\n  extends KnowledgeBaseActivityRecord {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type: \"modelQueryPlanning\";\n  /** The number of input tokens for the LLM query planning activity. */\n  inputTokens?: number;\n  /** The number of output tokens for the LLM query planning activity. */\n  outputTokens?: number;\n}\n\n/** Represents an LLM answer synthesis activity record. */\nexport interface KnowledgeBaseModelAnswerSynthesisActivityRecord\n  extends KnowledgeBaseActivityRecord {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type: \"modelAnswerSynthesis\";\n  /** The number of input tokens for the LLM answer synthesis activity. */\n  inputTokens?: number;\n  /** The number of output tokens for the LLM answer synthesis activity. */\n  outputTokens?: number;\n}\n\n/** Represents an agentic reasoning activity record. */\nexport interface KnowledgeBaseAgenticReasoningActivityRecord\n  extends KnowledgeBaseActivityRecord {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type: \"agenticReasoning\";\n  /** The number of input tokens for agentic reasoning. */\n  reasoningTokens?: number;\n  retrievalReasoningEffort?: KnowledgeRetrievalReasoningEffortUnion;\n}\n\n/** Represents an Azure Search document reference. */\nexport interface KnowledgeBaseSearchIndexReference\n  extends KnowledgeBaseReference {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type: \"searchIndex\";\n  /** The document key for the reference. */\n  docKey?: string;\n}\n\n/** Represents an Azure Blob Storage document reference. */\nexport interface KnowledgeBaseAzureBlobReference\n  extends KnowledgeBaseReference {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type: \"azureBlob\";\n  /** The blob URL for the reference. */\n  blobUrl?: string;\n}\n\n/** Represents an Azure Blob Storage document reference. */\nexport interface KnowledgeBaseIndexedSharePointReference\n  extends KnowledgeBaseReference {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type: \"indexedSharePoint\";\n  /** The document URL for the reference. */\n  docUrl?: string;\n}\n\n/** Represents an Azure Blob Storage document reference. */\nexport interface KnowledgeBaseIndexedOneLakeReference\n  extends KnowledgeBaseReference {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type: \"indexedOneLake\";\n  /** The document URL for the reference. */\n  docUrl?: string;\n}\n\n/** Represents a web document reference. */\nexport interface KnowledgeBaseWebReference extends KnowledgeBaseReference {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type: \"web\";\n  /** The url the reference data originated from. */\n  url?: string;\n  /** The title of the web document. */\n  title?: string;\n}\n\n/** Represents a remote SharePoint document reference. */\nexport interface KnowledgeBaseRemoteSharePointReference\n  extends KnowledgeBaseReference {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type: \"remoteSharePoint\";\n  /** The url the reference data originated from. */\n  webUrl?: string;\n  /** Information about the sensitivity label applied to a SharePoint document. */\n  searchSensitivityLabelInfo?: SharePointSensitivityLabelInfo;\n}\n\n/** Represents a search index retrieval activity record. */\nexport interface KnowledgeBaseSearchIndexActivityRecord\n  extends KnowledgeBaseRetrievalActivityRecord {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type: \"searchIndex\";\n  /** The search index arguments for the retrieval activity. */\n  searchIndexArguments?: KnowledgeBaseSearchIndexActivityArguments;\n}\n\n/** Represents a azure blob retrieval activity record. */\nexport interface KnowledgeBaseAzureBlobActivityRecord\n  extends KnowledgeBaseRetrievalActivityRecord {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type: \"azureBlob\";\n  /** The azure blob arguments for the retrieval activity. */\n  azureBlobArguments?: KnowledgeBaseAzureBlobActivityArguments;\n}\n\n/** Represents a indexed SharePoint retrieval activity record. */\nexport interface KnowledgeBaseIndexedSharePointActivityRecord\n  extends KnowledgeBaseRetrievalActivityRecord {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type: \"indexedSharePoint\";\n  /** The indexed SharePoint arguments for the retrieval activity. */\n  indexedSharePointArguments?: KnowledgeBaseIndexedSharePointActivityArguments;\n}\n\n/** Represents a indexed OneLake retrieval activity record. */\nexport interface KnowledgeBaseIndexedOneLakeActivityRecord\n  extends KnowledgeBaseRetrievalActivityRecord {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type: \"indexedOneLake\";\n  /** The indexed OneLake arguments for the retrieval activity. */\n  indexedOneLakeArguments?: KnowledgeBaseIndexedOneLakeActivityArguments;\n}\n\n/** Represents a web retrieval activity record. */\nexport interface KnowledgeBaseWebActivityRecord\n  extends KnowledgeBaseRetrievalActivityRecord {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type: \"web\";\n  /** The web arguments for the retrieval activity. */\n  webArguments?: KnowledgeBaseWebActivityArguments;\n}\n\n/** Represents a remote SharePoint retrieval activity record. */\nexport interface KnowledgeBaseRemoteSharePointActivityRecord\n  extends KnowledgeBaseRetrievalActivityRecord {\n  /** Polymorphic discriminator, which specifies the different types this object can be */\n  type: \"remoteSharePoint\";\n  /** The remote SharePoint arguments for the retrieval activity. */\n  remoteSharePointArguments?: KnowledgeBaseRemoteSharePointActivityArguments;\n}\n\n/** Known values of {@link ApiVersion20251101Preview} that the service accepts. */\nexport enum KnownApiVersion20251101Preview {\n  /** Api Version '2025-11-01-preview' */\n  TwoThousandTwentyFive1101Preview = \"2025-11-01-preview\",\n}\n\n/**\n * Defines values for ApiVersion20251101Preview. \\\n * {@link KnownApiVersion20251101Preview} can be used interchangeably with ApiVersion20251101Preview,\n *  this enum contains the known values that the service supports.\n * ### Known values supported by the service\n * **2025-11-01-preview**: Api Version '2025-11-01-preview'\n */\nexport type ApiVersion20251101Preview = string;\n\n/** Known values of {@link KnowledgeBaseMessageContentType} that the service accepts. */\nexport enum KnownKnowledgeBaseMessageContentType {\n  /** Text message content kind. */\n  Text = \"text\",\n  /** Image message content kind. */\n  Image = \"image\",\n}\n\n/**\n * Defines values for KnowledgeBaseMessageContentType. \\\n * {@link KnownKnowledgeBaseMessageContentType} can be used interchangeably with KnowledgeBaseMessageContentType,\n *  this enum contains the known values that the service supports.\n * ### Known values supported by the service\n * **text**: Text message content kind. \\\n * **image**: Image message content kind.\n */\nexport type KnowledgeBaseMessageContentType = string;\n\n/** Known values of {@link KnowledgeRetrievalIntentType} that the service accepts. */\nexport enum KnownKnowledgeRetrievalIntentType {\n  /** A natural language semantic query intent. */\n  Semantic = \"semantic\",\n}\n\n/**\n * Defines values for KnowledgeRetrievalIntentType. \\\n * {@link KnownKnowledgeRetrievalIntentType} can be used interchangeably with KnowledgeRetrievalIntentType,\n *  this enum contains the known values that the service supports.\n * ### Known values supported by the service\n * **semantic**: A natural language semantic query intent.\n */\nexport type KnowledgeRetrievalIntentType = string;\n\n/** Known values of {@link KnowledgeRetrievalReasoningEffortKind} that the service accepts. */\nexport enum KnownKnowledgeRetrievalReasoningEffortKind {\n  /** Does not perform any source selections, any query planning, or any iterative search. */\n  Minimal = \"minimal\",\n  /** Use low reasoning during retrieval. */\n  Low = \"low\",\n  /** Use a moderate amount of reasoning during retrieval. */\n  Medium = \"medium\",\n}\n\n/**\n * Defines values for KnowledgeRetrievalReasoningEffortKind. \\\n * {@link KnownKnowledgeRetrievalReasoningEffortKind} can be used interchangeably with KnowledgeRetrievalReasoningEffortKind,\n *  this enum contains the known values that the service supports.\n * ### Known values supported by the service\n * **minimal**: Does not perform any source selections, any query planning, or any iterative search. \\\n * **low**: Use low reasoning during retrieval. \\\n * **medium**: Use a moderate amount of reasoning during retrieval.\n */\nexport type KnowledgeRetrievalReasoningEffortKind = string;\n\n/** Known values of {@link KnowledgeRetrievalOutputMode} that the service accepts. */\nexport enum KnownKnowledgeRetrievalOutputMode {\n  /** Return data from the knowledge sources directly without generative alteration. */\n  ExtractiveData = \"extractiveData\",\n  /** Synthesize an answer for the response payload. */\n  AnswerSynthesis = \"answerSynthesis\",\n}\n\n/**\n * Defines values for KnowledgeRetrievalOutputMode. \\\n * {@link KnownKnowledgeRetrievalOutputMode} can be used interchangeably with KnowledgeRetrievalOutputMode,\n *  this enum contains the known values that the service supports.\n * ### Known values supported by the service\n * **extractiveData**: Return data from the knowledge sources directly without generative alteration. \\\n * **answerSynthesis**: Synthesize an answer for the response payload.\n */\nexport type KnowledgeRetrievalOutputMode = string;\n\n/** Known values of {@link KnowledgeSourceKind} that the service accepts. */\nexport enum KnownKnowledgeSourceKind {\n  /** A knowledge source that retrieves data from a Search Index. */\n  SearchIndex = \"searchIndex\",\n  /** A knowledge source that retrieves and ingests data from Azure Blob Storage to a Search Index. */\n  AzureBlob = \"azureBlob\",\n  /** A knowledge source that retrieves data from the web. */\n  Web = \"web\",\n  /** A knowledge source that retrieves data from a remote SharePoint endpoint. */\n  RemoteSharePoint = \"remoteSharePoint\",\n  /** A knowledge source that retrieves and ingests data from SharePoint to a Search Index. */\n  IndexedSharePoint = \"indexedSharePoint\",\n  /** A knowledge source that retrieves and ingests data from OneLake to a Search Index. */\n  IndexedOneLake = \"indexedOneLake\",\n}\n\n/**\n * Defines values for KnowledgeSourceKind. \\\n * {@link KnownKnowledgeSourceKind} can be used interchangeably with KnowledgeSourceKind,\n *  this enum contains the known values that the service supports.\n * ### Known values supported by the service\n * **searchIndex**: A knowledge source that retrieves data from a Search Index. \\\n * **azureBlob**: A knowledge source that retrieves and ingests data from Azure Blob Storage to a Search Index. \\\n * **web**: A knowledge source that retrieves data from the web. \\\n * **remoteSharePoint**: A knowledge source that retrieves data from a remote SharePoint endpoint. \\\n * **indexedSharePoint**: A knowledge source that retrieves and ingests data from SharePoint to a Search Index. \\\n * **indexedOneLake**: A knowledge source that retrieves and ingests data from OneLake to a Search Index.\n */\nexport type KnowledgeSourceKind = string;\n\n/** Optional parameters. */\nexport interface KnowledgeRetrievalRetrieveOptionalParams\n  extends coreClient.OperationOptions {\n  /** Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents. */\n  xMsQuerySourceAuthorization?: string;\n}\n\n/** Contains response data for the retrieve operation. */\nexport type KnowledgeRetrievalRetrieveResponse = KnowledgeBaseRetrievalResponse;\n\n/** Optional parameters. */\nexport interface SearchClientOptionalParams\n  extends coreHttpCompat.ExtendedServiceClientOptions {\n  /** Overrides client endpoint. */\n  endpoint?: string;\n}\n"]}

package/dist/commonjs/generated/knowledgeBase/models/mappers.d.ts

@@ -0,0 +1,88 @@
+import * as coreClient from "@azure/core-client";
+export declare const KnowledgeBaseRetrievalRequest: coreClient.CompositeMapper;
+export declare const KnowledgeBaseMessage: coreClient.CompositeMapper;
+export declare const KnowledgeBaseMessageContent: coreClient.CompositeMapper;
+export declare const KnowledgeRetrievalIntent: coreClient.CompositeMapper;
+export declare const KnowledgeRetrievalReasoningEffort: coreClient.CompositeMapper;
+export declare const KnowledgeSourceParams: coreClient.CompositeMapper;
+export declare const KnowledgeBaseRetrievalResponse: coreClient.CompositeMapper;
+export declare const KnowledgeBaseActivityRecord: coreClient.CompositeMapper;
+export declare const KnowledgeBaseErrorDetail: coreClient.CompositeMapper;
+export declare const KnowledgeBaseErrorAdditionalInfo: coreClient.CompositeMapper;
+export declare const KnowledgeBaseReference: coreClient.CompositeMapper;
+export declare const ErrorResponse: coreClient.CompositeMapper;
+export declare const ErrorDetail: coreClient.CompositeMapper;
+export declare const ErrorAdditionalInfo: coreClient.CompositeMapper;
+export declare const KnowledgeBaseMessageImageContentImage: coreClient.CompositeMapper;
+export declare const KnowledgeBaseSearchIndexActivityArguments: coreClient.CompositeMapper;
+export declare const KnowledgeBaseAzureBlobActivityArguments: coreClient.CompositeMapper;
+export declare const KnowledgeBaseIndexedSharePointActivityArguments: coreClient.CompositeMapper;
+export declare const KnowledgeBaseIndexedOneLakeActivityArguments: coreClient.CompositeMapper;
+export declare const KnowledgeBaseWebActivityArguments: coreClient.CompositeMapper;
+export declare const KnowledgeBaseRemoteSharePointActivityArguments: coreClient.CompositeMapper;
+export declare const SharePointSensitivityLabelInfo: coreClient.CompositeMapper;
+export declare const KnowledgeBaseMessageTextContent: coreClient.CompositeMapper;
+export declare const KnowledgeBaseMessageImageContent: coreClient.CompositeMapper;
+export declare const KnowledgeRetrievalSemanticIntent: coreClient.CompositeMapper;
+export declare const KnowledgeRetrievalMinimalReasoningEffort: coreClient.CompositeMapper;
+export declare const KnowledgeRetrievalLowReasoningEffort: coreClient.CompositeMapper;
+export declare const KnowledgeRetrievalMediumReasoningEffort: coreClient.CompositeMapper;
+export declare const SearchIndexKnowledgeSourceParams: coreClient.CompositeMapper;
+export declare const AzureBlobKnowledgeSourceParams: coreClient.CompositeMapper;
+export declare const IndexedSharePointKnowledgeSourceParams: coreClient.CompositeMapper;
+export declare const IndexedOneLakeKnowledgeSourceParams: coreClient.CompositeMapper;
+export declare const WebKnowledgeSourceParams: coreClient.CompositeMapper;
+export declare const RemoteSharePointKnowledgeSourceParams: coreClient.CompositeMapper;
+export declare const KnowledgeBaseRetrievalActivityRecord: coreClient.CompositeMapper;
+export declare const KnowledgeBaseModelQueryPlanningActivityRecord: coreClient.CompositeMapper;
+export declare const KnowledgeBaseModelAnswerSynthesisActivityRecord: coreClient.CompositeMapper;
+export declare const KnowledgeBaseAgenticReasoningActivityRecord: coreClient.CompositeMapper;
+export declare const KnowledgeBaseSearchIndexReference: coreClient.CompositeMapper;
+export declare const KnowledgeBaseAzureBlobReference: coreClient.CompositeMapper;
+export declare const KnowledgeBaseIndexedSharePointReference: coreClient.CompositeMapper;
+export declare const KnowledgeBaseIndexedOneLakeReference: coreClient.CompositeMapper;
+export declare const KnowledgeBaseWebReference: coreClient.CompositeMapper;
+export declare const KnowledgeBaseRemoteSharePointReference: coreClient.CompositeMapper;
+export declare const KnowledgeBaseSearchIndexActivityRecord: coreClient.CompositeMapper;
+export declare const KnowledgeBaseAzureBlobActivityRecord: coreClient.CompositeMapper;
+export declare const KnowledgeBaseIndexedSharePointActivityRecord: coreClient.CompositeMapper;
+export declare const KnowledgeBaseIndexedOneLakeActivityRecord: coreClient.CompositeMapper;
+export declare const KnowledgeBaseWebActivityRecord: coreClient.CompositeMapper;
+export declare const KnowledgeBaseRemoteSharePointActivityRecord: coreClient.CompositeMapper;
+export declare let discriminators: {
+    KnowledgeBaseMessageContent: coreClient.CompositeMapper;
+    KnowledgeRetrievalIntent: coreClient.CompositeMapper;
+    KnowledgeRetrievalReasoningEffort: coreClient.CompositeMapper;
+    KnowledgeSourceParams: coreClient.CompositeMapper;
+    KnowledgeBaseActivityRecord: coreClient.CompositeMapper;
+    KnowledgeBaseReference: coreClient.CompositeMapper;
+    "KnowledgeBaseMessageContent.text": coreClient.CompositeMapper;
+    "KnowledgeBaseMessageContent.image": coreClient.CompositeMapper;
+    "KnowledgeRetrievalIntent.semantic": coreClient.CompositeMapper;
+    "KnowledgeRetrievalReasoningEffort.minimal": coreClient.CompositeMapper;
+    "KnowledgeRetrievalReasoningEffort.low": coreClient.CompositeMapper;
+    "KnowledgeRetrievalReasoningEffort.medium": coreClient.CompositeMapper;
+    "KnowledgeSourceParams.searchIndex": coreClient.CompositeMapper;
+    "KnowledgeSourceParams.azureBlob": coreClient.CompositeMapper;
+    "KnowledgeSourceParams.indexedSharePoint": coreClient.CompositeMapper;
+    "KnowledgeSourceParams.indexedOneLake": coreClient.CompositeMapper;
+    "KnowledgeSourceParams.web": coreClient.CompositeMapper;
+    "KnowledgeSourceParams.remoteSharePoint": coreClient.CompositeMapper;
+    "KnowledgeBaseActivityRecord.KnowledgeBaseRetrievalActivityRecord": coreClient.CompositeMapper;
+    "KnowledgeBaseActivityRecord.modelQueryPlanning": coreClient.CompositeMapper;
+    "KnowledgeBaseActivityRecord.modelAnswerSynthesis": coreClient.CompositeMapper;
+    "KnowledgeBaseActivityRecord.agenticReasoning": coreClient.CompositeMapper;
+    "KnowledgeBaseReference.searchIndex": coreClient.CompositeMapper;
+    "KnowledgeBaseReference.azureBlob": coreClient.CompositeMapper;
+    "KnowledgeBaseReference.indexedSharePoint": coreClient.CompositeMapper;
+    "KnowledgeBaseReference.indexedOneLake": coreClient.CompositeMapper;
+    "KnowledgeBaseReference.web": coreClient.CompositeMapper;
+    "KnowledgeBaseReference.remoteSharePoint": coreClient.CompositeMapper;
+    "KnowledgeBaseRetrievalActivityRecord.searchIndex": coreClient.CompositeMapper;
+    "KnowledgeBaseRetrievalActivityRecord.azureBlob": coreClient.CompositeMapper;
+    "KnowledgeBaseRetrievalActivityRecord.indexedSharePoint": coreClient.CompositeMapper;
+    "KnowledgeBaseRetrievalActivityRecord.indexedOneLake": coreClient.CompositeMapper;
+    "KnowledgeBaseRetrievalActivityRecord.web": coreClient.CompositeMapper;
+    "KnowledgeBaseRetrievalActivityRecord.remoteSharePoint": coreClient.CompositeMapper;
+};
+//# sourceMappingURL=mappers.d.ts.map

package/dist/commonjs/generated/knowledgeBase/models/mappers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mappers.d.ts","sourceRoot":"","sources":["../../../../../src/generated/knowledgeBase/models/mappers.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,UAAU,MAAM,oBAAoB,CAAC;AAEjD,eAAO,MAAM,6BAA6B,EAAE,UAAU,CAAC,eA0EtD,CAAC;AAEF,eAAO,MAAM,oBAAoB,EAAE,UAAU,CAAC,eA0B7C,CAAC;AAEF,eAAO,MAAM,2BAA2B,EAAE,UAAU,CAAC,eAmBpD,CAAC;AAEF,eAAO,MAAM,wBAAwB,EAAE,UAAU,CAAC,eAmBjD,CAAC;AAEF,eAAO,MAAM,iCAAiC,EAAE,UAAU,CAAC,eAmB1D,CAAC;AAEF,eAAO,MAAM,qBAAqB,EAAE,UAAU,CAAC,eAkD9C,CAAC;AAEF,eAAO,MAAM,8BAA8B,EAAE,UAAU,CAAC,eA2CvD,CAAC;AAEF,eAAO,MAAM,2BAA2B,EAAE,UAAU,CAAC,eAuCpD,CAAC;AAEF,eAAO,MAAM,wBAAwB,EAAE,UAAU,CAAC,eAsDjD,CAAC;AAEF,eAAO,MAAM,gCAAgC,EAAE,UAAU,CAAC,eAsBzD,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,UAAU,CAAC,eA8C/C,CAAC;AAEF,eAAO,MAAM,aAAa,EAAE,UAAU,CAAC,eActC,CAAC;AAEF,eAAO,MAAM,WAAW,EAAE,UAAU,CAAC,eAsDpC,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,UAAU,CAAC,eAsB5C,CAAC;AAEF,eAAO,MAAM,qCAAqC,EAAE,UAAU,CAAC,eAe5D,CAAC;AAEJ,eAAO,MAAM,yCAAyC,EAAE,UAAU,CAAC,eAoBhE,CAAC;AAEJ,eAAO,MAAM,uCAAuC,EAAE,UAAU,CAAC,eAc9D,CAAC;AAEJ,eAAO,MAAM,+CAA+C,EAAE,UAAU,CAAC,eActE,CAAC;AAEJ,eAAO,MAAM,4CAA4C,EAAE,UAAU,CAAC,eAcnE,CAAC;AAEJ,eAAO,MAAM,iCAAiC,EAAE,UAAU,CAAC,eAqC1D,CAAC;AAEF,eAAO,MAAM,8CAA8C,EAAE,UAAU,CAAC,eAoBrE,CAAC;AAEJ,eAAO,MAAM,8BAA8B,EAAE,UAAU,CAAC,eA2CvD,CAAC;AAEF,eAAO,MAAM,+BAA+B,EAAE,UAAU,CAAC,eAmBxD,CAAC;AAEF,eAAO,MAAM,gCAAgC,EAAE,UAAU,CAAC,eAmBzD,CAAC;AAEF,eAAO,MAAM,gCAAgC,EAAE,UAAU,CAAC,eAmBzD,CAAC;AAEF,eAAO,MAAM,wCAAwC,EAAE,UAAU,CAAC,eAa/D,CAAC;AAEJ,eAAO,MAAM,oCAAoC,EAAE,UAAU,CAAC,eAa3D,CAAC;AAEJ,eAAO,MAAM,uCAAuC,EAAE,UAAU,CAAC,eAa9D,CAAC;AAEJ,eAAO,MAAM,gCAAgC,EAAE,UAAU,CAAC,eAkBzD,CAAC;AAEF,eAAO,MAAM,8BAA8B,EAAE,UAAU,CAAC,eAYvD,CAAC;AAEF,eAAO,MAAM,sCAAsC,EAAE,UAAU,CAAC,eAa7D,CAAC;AAEJ,eAAO,MAAM,mCAAmC,EAAE,UAAU,CAAC,eAY5D,CAAC;AAEF,eAAO,MAAM,wBAAwB,EAAE,UAAU,CAAC,eAoCjD,CAAC;AAEF,eAAO,MAAM,qCAAqC,EAAE,UAAU,CAAC,eAmB5D,CAAC;AAEJ,eAAO,MAAM,oCAAoC,EAAE,UAAU,CAAC,eAiC3D,CAAC;AAEJ,eAAO,MAAM,6CAA6C,EAAE,UAAU,CAAC,eAyBpE,CAAC;AAEJ,eAAO,MAAM,+CAA+C,EAAE,UAAU,CAAC,eAyBtE,CAAC;AAEJ,eAAO,MAAM,2CAA2C,EAAE,UAAU,CAAC,eA0BlE,CAAC;AAEJ,eAAO,MAAM,iCAAiC,EAAE,UAAU,CAAC,eAkB1D,CAAC;AAEF,eAAO,MAAM,+BAA+B,EAAE,UAAU,CAAC,eAkBxD,CAAC;AAEF,eAAO,MAAM,uCAAuC,EAAE,UAAU,CAAC,eAmB9D,CAAC;AAEJ,eAAO,MAAM,oCAAoC,EAAE,UAAU,CAAC,eAmB3D,CAAC;AAEJ,eAAO,MAAM,yBAAyB,EAAE,UAAU,CAAC,eAwBlD,CAAC;AAEF,eAAO,MAAM,sCAAsC,EAAE,UAAU,CAAC,eA0B7D,CAAC;AAEJ,eAAO,MAAM,sCAAsC,EAAE,UAAU,CAAC,eAoB7D,CAAC;AAEJ,eAAO,MAAM,oCAAoC,EAAE,UAAU,CAAC,eAoB3D,CAAC;AAEJ,eAAO,MAAM,4CAA4C,EAAE,UAAU,CAAC,eAoBnE,CAAC;AAEJ,eAAO,MAAM,yCAAyC,EAAE,UAAU,CAAC,eAoBhE,CAAC;AAEJ,eAAO,MAAM,8BAA8B,EAAE,UAAU,CAAC,eAmBvD,CAAC;AAEF,eAAO,MAAM,2CAA2C,EAAE,UAAU,CAAC,eAoBlE,CAAC;AAEJ,eAAO,IAAI,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkDxB,CAAC"}