curl -i -L POST "https://api.box.com/2.0/ai/ask" \
-H "content-type: application/json" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-d '{
"mode": "single_item_qa",
"prompt": "What is the value provided by public APIs based on this document?",
"items": [
{
"type": "file",
"id": "9842787262"
}
],
"dialogue_history": [
{
"prompt": "Make my email about public APIs sound more professional",
"answer": "Here is the first draft of your professional email about public APIs",
"created_at": "2013-12-12T10:53:43-08:00"
}
],
"include_citations": true,
"ai_agent": {
"type": "ai_agent_ask",
"long_text": {
"model": "azure__openai__gpt_4o_mini",
"prompt_template": "It is `{current_date}`, and I have $8000 and want to spend a week in the Azores. What should I see?",
},
"basic_text": {
"model": "azure__openai__gpt_4o_mini",
}
}
}'
await client.ai.createAiAsk({
mode: 'multiple_item_qa' as AiAskModeField,
prompt: 'Which direction sun rises?',
items: [
new AiItemBase({
id: fileToAsk1.id,
type: 'file' as AiItemBaseTypeField,
content: 'Earth goes around the sun',
}),
new AiItemBase({
id: fileToAsk2.id,
type: 'file' as AiItemBaseTypeField,
content: 'Sun rises in the East in the morning',
}),
],
} satisfies AiAsk);
client.ai.create_ai_ask(
CreateAiAskMode.MULTIPLE_ITEM_QA,
"Which direction sun rises?",
[
AiItemBase(
id=file_to_ask_1.id,
type=AiItemBaseTypeField.FILE,
content="Earth goes around the sun",
),
AiItemBase(
id=file_to_ask_2.id,
type=AiItemBaseTypeField.FILE,
content="Sun rises in the East in the morning",
),
],
)
await client.Ai.CreateAiAskAsync(requestBody: new AiAsk(mode: AiAskModeField.MultipleItemQa, prompt: "Which direction sun rises?", items: Array.AsReadOnly(new [] {new AiItemBase(id: fileToAsk1.Id, type: AiItemBaseTypeField.File) { Content = "Earth goes around the sun" },new AiItemBase(id: fileToAsk2.Id, type: AiItemBaseTypeField.File) { Content = "Sun rises in the East in the morning" }})));
BoxAIResponse response = BoxAI.sendAIRequest(
api,
"What is the content of the file?",
Collections.singletonList("123456", BoxAIItem.Type.FILE),
BoxAI.Mode.SINGLE_ITEM_QA
);
BoxAIResponse response = await client.BoxAIManager.SendAIQuestionAsync(
new BoxAIAskRequest
{
Prompt = "What is the name of the file?",
Items = new List<BoxAIAskItem>() { new BoxAIAskItem() { Id = "12345" } },
Mode = AiAskMode.single_item_qa
};
);
Make my email about public APIs sound more professional
dialogue_history.answer
以前にLLMから提供された回答。
Here is a draft of your professional email about public APIs.
dialogue_history.created_at
プロンプトに対する前回の回答が作成された時点のISO日付形式のタイムスタンプ。
2012-12-12T10:53:43-08:00
include_citations
回答で引用情報を返すかどうかを指定します。
true, false
true
items.id
入力データとして指定するBoxファイルID。
112233445566
items.type
指定した入力データのタイプ。現在は、1つのファイルまたは複数のファイルを指定できます。
file
file
items.content
項目のコンテンツ。通常はテキストレプリゼンテーションです。
An application programming interface (API) is a way for two or more computer programs or components to communicate with each other. It is a type of software interface...
curl -i -L POST "https://api.box.com/2.0/ai/ask" \
-H "content-type: application/json" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-d '{
"mode": "single_item_qa",
"items": [
{
"id": "12345678",
"type": "file"
}
],
"prompt": "List the guidelines on creating questions in Box AI for Documents"
}'
レスポンスは次のようになります。
{
"answer": "The guidelines for working with questions in Box AI for Documents are as follows:\n\n1. Box AI pulls information only from the document loaded in preview.\n2. If questions fall outside the scope of the document, Box AI will inform you that it cannot answer.\n3. Be specific when asking questions; use parameters like numbered lists, brevity, tables, and central themes or key points.\n4. Aim to stay within the scope of the document.\n5. Focus on text-based responses only.",
"created_at": "2024-11-04T02:30:09.557-08:00",
"completion_reason": "done"
}
curl -i -L POST "https://api.box.com/2.0/ai/ask" \
-H "content-type: application/json" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-d '{
"mode": "single_item_qa",
"items": [
{
"id": "12345678",
"type": "file",
"content": "This is a document about Box AI For documents. It consists of the functionality summary and guidelines on how to work with Box AI. Additionally, it provides a set of best practices for creating questions."
}
],
"prompt": "List the guidelines on creating questions in Box AI for Documents"
}'
{
"answer": "The document does not provide specific guidelines on working with questions in Box AI for Documents. It only mentions that it includes a set of best practices for creating questions, but the details of those guidelines are not included in the text provided. If you have more information or another document, I can help further!",
"created_at": "2024-11-04T02:31:51.125-08:00",
"completion_reason": "done"
}
curl -i -L POST "https://api.box.com/2.0/ai/ask" \
-H "content-type: application/json" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-d '{
"mode": "multiple_item_qa",
"include_citations": true,
"items": [
{
"id": "12345678",
"type": "file"
}
],
"prompt": "List the guidelines on working with responses in Box AI for Documents"
}'
その結果の回答には、ソースファイルとコンテンツの直接引用が含まれます。
{
"answer": "The guidelines for working with questions in Box AI for Documents are as follows:\n\n1. Box AI pulls information only from the document loaded in preview, and cannot answer questions outside its scope.\n2. Be specific when asking questions; use parameters like numbered lists, brevity, tables, and central themes or key points.\n3. Examples of better phrasing include asking for a numbered list of key points instead of just \"list key points,\" and requesting a succinct outline of important points rather than a general inquiry about the document's purpose.\n4. Stay within the scope of the document and focus on text-based responses only.",
"created_at": "2024-11-04T02:35:00.578-08:00",
"completion_reason": "done",
"citations": [
{
"type": "file",
"id": "12345678",
"name": "Box AI for Documents.docx",
"content": "Guidelines for Box AI questions\nBox AI pulls information only from the document you loaded in preview."
},
{
"type": "file",
"id": "12345678",
"name": "Box AI for Documents.docx",
"content": "If you ask any questions outside of the scope of the document, Box AI informs you that it cannot answer the question with the information provided."
},
{
"type": "file",
"id": "12345678",
"name": "Box AI for Documents.docx",
"content": "As you ask Box AI to analyze your document, consider these suggestions:\n· Be as specific as possible."
},
{
"type": "file",
"id": "12345678",
"name": "Box AI for Documents.docx",
"content": "Box AI for Documents\n\nWhen viewing a document in Box, you can ask Box AI to summarize document content, search key points, and write outline drafts based on your document files."
}
]
}