-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
21 changed files
with
2,030 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
227 changes: 227 additions & 0 deletions
227
api/dotnet/FoundationaLLM.Vectorization.DataFormats.Office.DOCXTextExtractor.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,227 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <title>Class DOCXTextExtractor | FoundationaLLM </title> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
| <meta name="title" content="Class DOCXTextExtractor | FoundationaLLM "> | ||
|
|
||
| <meta name="description" content="Extracts text from DOCX files."> | ||
| <link rel="icon" href="../../media/favicon.ico"> | ||
| <link rel="stylesheet" href="../../public/docfx.min.css"> | ||
| <link rel="stylesheet" href="../../public/main.css"> | ||
| <meta name="docfx:navrel" content="../../toc.html"> | ||
| <meta name="docfx:tocrel" content="toc.html"> | ||
|
|
||
| <meta name="docfx:rel" content="../../"> | ||
|
|
||
|
|
||
| <meta name="docfx:docurl" content="https://github.com/solliancenet/foundationallm/new/main/apiSpec/new?filename=FoundationaLLM_Vectorization_DataFormats_Office_DOCXTextExtractor.md&value=---%0Auid%3A%20FoundationaLLM.Vectorization.DataFormats.Office.DOCXTextExtractor%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A"> | ||
| <meta name="loc:inThisArticle" content="In this article"> | ||
| <meta name="loc:searchResultsCount" content="{count} results for "{query}""> | ||
| <meta name="loc:searchNoResults" content="No results for "{query}""> | ||
| <meta name="loc:tocFilter" content="Filter by title"> | ||
| <meta name="loc:nextArticle" content="Next"> | ||
| <meta name="loc:prevArticle" content="Previous"> | ||
| <meta name="loc:themeLight" content="Light"> | ||
| <meta name="loc:themeDark" content="Dark"> | ||
| <meta name="loc:themeAuto" content="Auto"> | ||
| <meta name="loc:changeTheme" content="Change theme"> | ||
| <meta name="loc:copy" content="Copy"> | ||
| <meta name="loc:downloadPdf" content="Download PDF"> | ||
| </head> | ||
|
|
||
| <script type="module" src="./../../public/docfx.min.js"></script> | ||
|
|
||
| <script> | ||
| const theme = localStorage.getItem('theme') || 'auto' | ||
| document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme) | ||
| </script> | ||
|
|
||
|
|
||
| <body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference"> | ||
| <header class="bg-body border-bottom"> | ||
| <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> | ||
| <div class="container-xxl flex-nowrap"> | ||
| <a class="navbar-brand" href="../../index.html"> | ||
| <img id="logo" class="svg" src="../../media/fllm-icon.svg" alt="FoundationaLLM"> | ||
| FoundationaLLM | ||
| </a> | ||
| <button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation"> | ||
| <i class="bi bi-three-dots"></i> | ||
| </button> | ||
| <div class="collapse navbar-collapse" id="navpanel"> | ||
| <div id="navbar"> | ||
| <form class="search" role="search" id="search"> | ||
| <i class="bi bi-search"></i> | ||
| <input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search"> | ||
| </form> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </nav> | ||
| </header> | ||
|
|
||
| <main class="container-xxl"> | ||
| <div class="toc-offcanvas"> | ||
| <div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel"> | ||
| <div class="offcanvas-header"> | ||
| <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5> | ||
| <button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button> | ||
| </div> | ||
| <div class="offcanvas-body"> | ||
| <nav class="toc" id="toc"></nav> | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="content"> | ||
| <div class="actionbar"> | ||
| <button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents"> | ||
| <i class="bi bi-list"></i> | ||
| </button> | ||
|
|
||
| <nav id="breadcrumb"></nav> | ||
| </div> | ||
|
|
||
| <article data-uid="FoundationaLLM.Vectorization.DataFormats.Office.DOCXTextExtractor"> | ||
|
|
||
|
|
||
|
|
||
| <h1 id="FoundationaLLM_Vectorization_DataFormats_Office_DOCXTextExtractor" data-uid="FoundationaLLM.Vectorization.DataFormats.Office.DOCXTextExtractor" class="text-break"> | ||
| Class DOCXTextExtractor <a class="header-action link-secondary" title="View source" href="https://github.com/solliancenet/foundationallm/blob/main/src/dotnet/Vectorization/DataFormats/Office/DOCXTextExtractor.cs/#L11"><i class="bi bi-code-slash"></i></a> | ||
| </h1> | ||
|
|
||
| <div class="facts text-secondary"> | ||
| <dl><dt>Namespace</dt><dd><a class="xref" href="FoundationaLLM.html">FoundationaLLM</a>.<a class="xref" href="FoundationaLLM.Vectorization.html">Vectorization</a>.<a class="xref" href="FoundationaLLM.Vectorization.DataFormats.html">DataFormats</a>.<a class="xref" href="FoundationaLLM.Vectorization.DataFormats.Office.html">Office</a></dd></dl> | ||
| <dl><dt>Assembly</dt><dd>FoundationaLLM.Vectorization.dll</dd></dl> | ||
| </div> | ||
|
|
||
| <div class="markdown summary"><p>Extracts text from DOCX files.</p> | ||
| </div> | ||
| <div class="markdown conceptual"></div> | ||
|
|
||
| <div class="codewrapper"> | ||
| <pre><code class="lang-csharp hljs">public class DOCXTextExtractor</code></pre> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <dl class="typelist inheritance"> | ||
| <dt>Inheritance</dt> | ||
| <dd> | ||
| <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div> | ||
| <div><span class="xref">DOCXTextExtractor</span></div> | ||
| </dd> | ||
| </dl> | ||
|
|
||
|
|
||
|
|
||
| <dl class="typelist inheritedMembers"> | ||
| <dt>Inherited Members</dt> | ||
| <dd> | ||
| <div> | ||
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a> | ||
| </div> | ||
| <div> | ||
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a> | ||
| </div> | ||
| <div> | ||
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a> | ||
| </div> | ||
| <div> | ||
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a> | ||
| </div> | ||
| <div> | ||
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a> | ||
| </div> | ||
| <div> | ||
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a> | ||
| </div> | ||
| <div> | ||
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a> | ||
| </div> | ||
| </dd></dl> | ||
|
|
||
| <dl class="typelist extensionMethods"> | ||
| <dt>Extension Methods</dt> | ||
| <dd> | ||
| <div> | ||
| <a class="xref" href="FoundationaLLM.Core.Utils.ObjectExtensions.html#FoundationaLLM_Core_Utils_ObjectExtensions_GetPropertyValues_System_Object_System_Collections_Generic_List_System_String__">ObjectExtensions.GetPropertyValues(object, List<string>)</a> | ||
| </div> | ||
| </dd></dl> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <h2 class="section" id="methods">Methods | ||
| </h2> | ||
|
|
||
|
|
||
| <a id="FoundationaLLM_Vectorization_DataFormats_Office_DOCXTextExtractor_GetText_" data-uid="FoundationaLLM.Vectorization.DataFormats.Office.DOCXTextExtractor.GetText*"></a> | ||
|
|
||
| <h3 id="FoundationaLLM_Vectorization_DataFormats_Office_DOCXTextExtractor_GetText_System_BinaryData_" data-uid="FoundationaLLM.Vectorization.DataFormats.Office.DOCXTextExtractor.GetText(System.BinaryData)"> | ||
| GetText(BinaryData) | ||
| <a class="header-action link-secondary" title="View source" href="https://github.com/solliancenet/foundationallm/blob/main/src/dotnet/Vectorization/DataFormats/Office/DOCXTextExtractor.cs/#L18"><i class="bi bi-code-slash"></i></a> | ||
| </h3> | ||
|
|
||
| <div class="markdown level1 summary"><p>Extracts the text content from a DOCX document.</p> | ||
| </div> | ||
| <div class="markdown level1 conceptual"></div> | ||
|
|
||
| <div class="codewrapper"> | ||
| <pre><code class="lang-csharp hljs">public static string GetText(BinaryData binaryContent)</code></pre> | ||
| </div> | ||
|
|
||
| <h4 class="section">Parameters</h4> | ||
| <dl class="parameters"> | ||
| <dt><code>binaryContent</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.binarydata">BinaryData</a></dt> | ||
| <dd><p>The binary content of the DOCX document.</p> | ||
| </dd> | ||
| </dl> | ||
|
|
||
| <h4 class="section">Returns</h4> | ||
| <dl class="parameters"> | ||
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt> | ||
| <dd><p>The text content of the DOCX document.</p> | ||
| </dd> | ||
| </dl> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| </article> | ||
|
|
||
| <div class="contribution d-print-none"> | ||
| <a href="https://github.com/solliancenet/foundationallm/blob/main/src/dotnet/Vectorization/DataFormats/Office/DOCXTextExtractor.cs/#L11" class="edit-link">Edit this page</a> | ||
| </div> | ||
|
|
||
|
|
||
| </div> | ||
|
|
||
| <div class="affix"> | ||
| <nav id="affix"></nav> | ||
| </div> | ||
| </main> | ||
|
|
||
| <div class="container-xxl search-results" id="search-results"></div> | ||
|
|
||
| <footer class="border-top text-secondary"> | ||
| <div class="container-xxl"> | ||
| <div class="flex-fill"> | ||
| © FoundationaLLM. All rights reserved. | Find out more about FoundationaLLM at <a href="https://foundationallm.ai">foundationallm.ai</a>. | ||
| </div> | ||
| </div> | ||
| </footer> | ||
| </body> | ||
| </html> |
Oops, something went wrong.