Creating and Deploying a Connector

1
curl --request POST  
2
    --url 'https://connector-example.com/search'
3
    --header 'Content-Type: application/json'  
4
    --data '{  
5
    "query": "How do I expense a meal?"  
6
  }'

1
{  
2
  "results": [  
3
  {  
4
    "id": "expense_doc_1",  
5
    "title": "Expense Policies for external travel",  
6
    "text": "You can expense any work-related...",  
7
    "url": "https://internal-site.com/expensing"  
8
    "created_at": "2023-11-25T20:09:31Z",  
9
  },  
10
   {  
11
    "id": "expense_doc_2",  
12
    "title": "Expense Policies for internal travel",  
13
    "text": "You can expense any work-related...",  
14
    "created_at": "2023-11-25T20:09:31Z",  
15
  },...  
16
  ]  
17
}

1
import cohere
2
3
# initialize the Cohere Client with an API Key
4
co = cohere.Client('YOUR_API_KEY')
5
6
created_connector = co.create_connector(
7
            name="Example connector",
8
            url="https://connector-example.com/search",
9
        )

1
{  
2
    "connector": {  
3
   	 "id": "example-connector-kh3g8q",  
4
   	 "organization_id": "00000000-1111-2222-3333-444444444444",  
5
   	 "name": "Example Connector",  
6
   	 "url": "https://connector-example.com/search",  
7
   	 "created_at": "2023-09-21T15:45:39.097677Z",  
8
   	 "updated_at": "2023-09-21T16:12:28.999055Z"  
9
    }  
10
}

1
curl --request POST  
2
    --url 'https://connector-example.com/search'
3
    --header 'Content-Type: application/json'  
4
    --data '{  
5
    "query": "How do I expense a meal?"  
6
  }'

1
import cohere  
2
co = cohere.Client('Your API key')  
3
response = co.chat(  
4
	message="What is the chemical formula for glucose?",  
5
	connectors=[{"id": "example_connector_id"}] # this is from the create step  
6
)

1
{  
2
    "text": "To expense a meal, you will need to follow the guidelines set by the IRS. Firstly, the meal must not be lavish or extravagant. The taxpayer or their employee must be present when food or beverages are consumed. The food or beverages must be provided to a business associate. Most meals are deductible at 50% of the cost. Entertainment expenses are not deductible.",  
3
    "citations": [  
4
   	 {  
5
   		 "start": 47,  
6
   		 "end": 73,  
7
   		 "text": "Expense Policy.",  
8
   		 "document_ids": [  
9
   			 "internal-docs_0"  
10
   		 ]  
11
   	 },   
12
    ],  
13
    "documents": [  
14
   	 {  
15
   		 "id": "internal-docs_0",  
16
   		 "snippet": "Writing off these expenses is a smart move, but how do you go about it?\n\nThe good news is that business meals are 50 percent deductible. This means that every time you take out a client for dinner and drinks, you get to write off half of the bill.\n\nHowever, you can not go around deducting meals indiscriminately. The IRS has guidelines and tests that help you correctly deduct your meals. These include:\n\nConsidering the business context, the meal must not be lavish or extravagant.\n\nThe taxpayer or an employee of the taxpayer is present at the meal.\n\nThe expense must be an ordinary and necessary expense, under the Internal Revenue Code (IRC) Section 162(a), which is incurred or paid to carry on a trade or business.\n\nFood and beverages must be purchased separately from entertainment in the case that the entertainment activity provides food and beverages.",  
17
   		 "title": "Expense Policies",  
18
   		 "url": "https://internal-site.com/expensing"  
19
   	 },  
20
    ],  
21
    "search_results": [  
22
   	 {  
23
   		 "search_query": {  
24
   			 "text": "expense a business meal",  
25
   			 ...  
26
   		 },  
27
   		 "document_ids": [  
28
   			 "internal-docs_0",  
29
                                                 ...  
30
   		 ],  
31
   		 "connector": {  
32
   			 "id": "internal-docs"  
33
   		 }  
34
   	 }  
35
    ],  
36
    "search_queries": [  
37
   	 {  
38
   		 "text": "expense a business meal",  
39
   	 }  
40
    ],  
41
}