Skip to main content

​
Creating a Document Manually

What do you need the Logic API to do? Write a description of the task you want to accomplish. In the example of an image analysis document, the description might be: 
"Accept an image as a URL or base64-encoded data and tell me what it is.

Include items like:
- How many people are in it?
- What is the dominant color of the image?
- What's the general mood it invokes?
- What is the gender and or age of the person in the photo?"
To provide the Logic API with context, you can also include examples of input and output.

​
Editing Your Document

document-editor Once you have created a document with AutoDoc or manually, you can edit it to better fit your needs. This guide will walk you through the steps to edit a document in Logic.

​
Step 1: Access the Logic dashboard

Open the Logic dashboard and log in to your account. Select the document you want to edit from the list of documents. If you have just created a document using AutoDoc, it will already be opened in the document editor.

​
Step 2: Edit your document

You can now edit the document to suit your specific use case. Feel free to add, remove, or modify sections as needed. For example, you might include more detail about the image analysis process or add input/output examples.

​
Step 3: Use text formatting

Using the document editor, you can use text formatting to make your document more readable. For example, you can use bullet points to list the items you want the Logic API to include in its analysis. You can also use headings to separate different sections of your document. For example, you might have a section for the input and a section for the output. The text formatting options are available in the toolbar at the top of the document editor. You can use these options to organize your document and make it easier to read.
If you want to learn more about what makes a good document, check out the What Makes a Good Document? section.

​
Finishing Your Document

document-list-hover-menu

​
Step 4: Set a title

The title is something for you to use to refer to your document later, so choose something descriptive. You can edit the title either directly in the document editor at the top or by clicking the pencil icon (✏️) in the document list. 
Image Analysis and Description

​
Step 5: Save your changes

Once you have made your changes, click the Save button to save your document. If you’re already using the document’s API, make sure to publish your changes so that the API reflects the updated document.

​
Step 6: Test it out!

Once you have created your document, you can test it out using automatically generated test cases. This will help you ensure that it behaves as expected and meets your requirements. To learn more about how to test your document, check out the Testing Documents section.
⌘I