Comment on page
Documents
First, find the name of the knowledge that contains the document you wish to retrieve in the knowledge tab of Cortex.
Then, find the name of the documentID you want to retrieve.
Use the knowledgeName and documentID with the
.getDocument function of cortex to retrieve the document. See the Node.js Library for the exact .json return structure.Typescript
Python
try {
const res = await cortex.getDocument('tigers','testing.txt')
const document = res.data.document
console.log(document.text);
} catch (error) {
if (error.response) {
console.log(error.response.status);
console.log(error.response.data);
} else {
console.log(error.message);
}
}
CortexAPI.getDocument('tigers','testing.txt')
Find the knowledgeName of the desired location of the document.
Create an object that follows the createDocument interface to upload.
Typescript
Python
interface createDocument {
timestamp?: number;
tags?: string[];
text?: string | null;
source_url?: string | null;
};
class CreateDocument:
def __init__(
self,
timestamp: Union[int, None] = None,
tags:
List[str] = None,
text: Union[str, None] = None,
source_url: Union[str, None] = None
):
self.timestamp = timestamp
self.tags = tags
self.text = text
self.source_url = source_url
Use the documentID parameter to name the document you want to upload.
Typescript
Python
const test = {
"source_url": "https://www.test.com/",
"text": "test"
}
try {
let output = await cortex.uploadDocument('tigers','test1',test);
console.log(output.data.document);
} catch (error) {
if (error.response) {
console.log(error.response.status);
console.log(error.response.data);
} else {
console.log(error.message);
}
}
test = cortex.CreateDocument()
test.source_url = "https://www.test.com/"
test.text = "test"
CortexAPI = cortex.CortexAPI("sk-...")
CortexAPI.uploadDocument('tigers','test1',test)
Typescript
Python
try {
let output = await cortex.deleteDocument('tigers','test1');
console.log(output.data.document);
} catch (error:any) {
if (error.response) {
console.log(error.response.status);
console.log(error.response.data);
} else {
console.log(error.message);
}
}
CortexAPI.deleteDocument('tigers','test1')
Last modified 4mo ago