Skip to content

Latest commit

 

History

History
226 lines (143 loc) · 6.47 KB

AICustomToolsAPI.md

File metadata and controls

226 lines (143 loc) · 6.47 KB

\AICustomToolsAPI

All URIs are relative to https://dashboard.quantcdn.io

Method HTTP request Description
CreateCustomTool Post /api/v3/organizations/{organisation}/ai/custom-tools Register Custom Edge Function Tool
DeleteCustomTool Delete /api/v3/organizations/{organisation}/ai/custom-tools/{toolName} Delete Custom Tool
ListCustomTools Get /api/v3/organizations/{organisation}/ai/custom-tools List Custom Tools

CreateCustomTool

CreateCustomTool201Response CreateCustomTool(ctx, organisation).CreateCustomToolRequest(createCustomToolRequest).Execute()

Register Custom Edge Function Tool

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	createCustomToolRequest := *openapiclient.NewCreateCustomToolRequest("check_inventory", "Check product inventory levels in warehouse", "https://inventory-api.my-project.quant.cloud", map[string]interface{}(123)) // CreateCustomToolRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AICustomToolsAPI.CreateCustomTool(context.Background(), organisation).CreateCustomToolRequest(createCustomToolRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AICustomToolsAPI.CreateCustomTool``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateCustomTool`: CreateCustomTool201Response
	fmt.Fprintf(os.Stdout, "Response from `AICustomToolsAPI.CreateCustomTool`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation string The organisation ID

Other Parameters

Other parameters are passed through a pointer to a apiCreateCustomToolRequest struct via the builder pattern

Name Type Description Notes

createCustomToolRequest | CreateCustomToolRequest | |

Return type

CreateCustomTool201Response

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteCustomTool

DeleteCustomTool200Response DeleteCustomTool(ctx, organisation, toolName).Execute()

Delete Custom Tool

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID
	toolName := "toolName_example" // string | The tool name to delete

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AICustomToolsAPI.DeleteCustomTool(context.Background(), organisation, toolName).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AICustomToolsAPI.DeleteCustomTool``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteCustomTool`: DeleteCustomTool200Response
	fmt.Fprintf(os.Stdout, "Response from `AICustomToolsAPI.DeleteCustomTool`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation string The organisation ID
toolName string The tool name to delete

Other Parameters

Other parameters are passed through a pointer to a apiDeleteCustomToolRequest struct via the builder pattern

Name Type Description Notes

Return type

DeleteCustomTool200Response

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListCustomTools

ListCustomTools200Response ListCustomTools(ctx, organisation).Execute()

List Custom Tools

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/quantcdn/quant-admin-go"
)

func main() {
	organisation := "organisation_example" // string | The organisation ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AICustomToolsAPI.ListCustomTools(context.Background(), organisation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AICustomToolsAPI.ListCustomTools``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListCustomTools`: ListCustomTools200Response
	fmt.Fprintf(os.Stdout, "Response from `AICustomToolsAPI.ListCustomTools`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
organisation string The organisation ID

Other Parameters

Other parameters are passed through a pointer to a apiListCustomToolsRequest struct via the builder pattern

Name Type Description Notes

Return type

ListCustomTools200Response

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]