openapi.json

{"components":{"responses":{},"schemas":{"Chat completion message":{"description":"A chat message in a conversation.","properties":{"content":{"type":"string"},"role":{"type":"string"}},"required":["content","role"],"title":"Chat completion message","type":"object"},"Chat completion response":{"properties":{"choices":{"items":{"properties":{"message":{"$ref":"#/components/schemas/Chat completion message"}},"type":"object"},"type":"array"},"id":{"type":"string"},"model":{"type":"string"}},"title":"Chat completion response","type":"object"},"Completion":{"description":"A request to complete with the model.","properties":{"model":{"type":"string"},"prompt":{"type":"string"},"stream":{"type":"boolean"}},"required":["model","prompt"],"title":"Completion","type":"object"},"Completion response":{"description":"A completion response from the model.","properties":{"choices":{"items":{"properties":{"text":{"type":"string"}},"required":["message","role"],"type":"object"},"type":"array"},"id":{"type":"string"},"model":{"type":"string"}},"title":"Completion response","type":"object"},"ContentModerationPolicy":{"properties":{"active":{"type":"boolean"},"blocked_content_types":{"items":{"enum":["toxic","obscene","insult","identity_hate","threat","severe_toxic"],"type":"string"},"type":"array"},"id":{"type":"number"},"name":{"type":"string"},"score_threshold":{"type":"number"}},"title":"ContentModerationPolicy","type":"object"},"Create chat completion":{"description":"Creates a model response for the given chat conversation.","properties":{"messages":{"items":{"$ref":"#/components/schemas/Chat completion message"},"type":"array"},"model":{"type":"string"},"stream":{"type":"boolean"}},"required":["messages","model"],"title":"Create chat completion","type":"object"},"DlpPolicy":{"properties":{"active":{"type":"boolean"},"anonymizer":{"properties":{"type":{"enum":["replace"],"type":"string"}},"type":"object"},"entities":{"items":{"enum":["MEDICAL_LICENSE","CREDIT_CARD","US_PASSPORT","PERSON","URL","DATE_TIME","IBAN_CODE","CRYPTO","US_BANK_NUMBER","PHONE_NUMBER","LOCATION","US_DRIVER_LICENSE","US_ITIN","IP_ADDRESS","EMAIL_ADDRESS","US_SSN","NRP"],"type":"string"},"type":"array"},"id":{"type":"number"},"name":{"type":"string"},"response":{"enum":["block","alert","anonymize"],"type":"string"},"score_threshold":{"type":"number"}},"title":"DlpPolicy","type":"object"},"DlpPolicyParams":{"properties":{"dlp_policy":{"$ref":"#/components/schemas/DlpPolicy"}},"title":"DlpPolicyParams","type":"object"},"DlpZsnerPolicy":{"properties":{"active":{"type":"boolean"},"anonymizer":{"properties":{"type":{"enum":["replace"],"type":"string"}},"type":"object"},"entities":{"items":{"properties":{"entity":{"type":"string"}},"type":"object"},"type":"array"},"id":{"type":"number"},"name":{"type":"string"},"response":{"enum":["block","alert","anonymize"],"type":"string"},"score_threshold":{"type":"number"}},"title":"DlpZsnerPolicy","type":"object"},"DlpZsnerPolicyParams":{"properties":{"dlp_zsner_policy":{"$ref":"#/components/schemas/DlpZsnerPolicy"}},"title":"DlpZsnerPolicyParams","type":"object"},"Embedding ":{"description":"A request to embed with the model.","properties":{"input":{"type":"string"},"model":{"type":"string"}},"required":["input","model"],"title":"Embedding ","type":"object"},"Embedding response":{"description":"An embedding response from the model.","items":{"properties":{"embedding":{"items":{"type":"number"},"type":"array"}},"type":"object"},"title":"Embedding response","type":"array"},"ListEndpointResponse":{"items":{"properties":{"name":{"type":"string"}},"type":"object"},"title":"ListEndpointResponse","type":"array"},"ListModelsResponse":{"properties":{"data":{"items":{"properties":{"created":{"type":"number"},"id":{"type":"string"},"object":{"type":"string"},"owned_by":{"type":"string"}},"type":"object"},"type":"array"},"object":{"type":"string"}},"title":"ListModelsResponse","type":"object"},"ShowEndpointResponse":{"properties":{"content_moderation_policies":{"items":{"$ref":"#/components/schemas/ContentModerationPolicy"},"type":"array"},"dlp_policies":{"items":{"$ref":"#/components/schemas/DlpPolicy"},"type":"array"},"dlp_zsner_policies":{"items":{"$ref":"#/components/schemas/DlpZsnerPolicy"},"type":"array"},"name":{"type":"string"}},"title":"ShowEndpointResponse","type":"object"}},"securitySchemes":{"authorization":{"scheme":"bearer","type":"http"}}},"info":{"title":"","version":""},"openapi":"3.0.0","paths":{"/api/v1/endpoints":{"get":{"callbacks":{},"operationId":"DreamcatcherWeb.EndpointController.index","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListEndpointResponse"}}},"description":"List endpoints response"}},"security":[{"authorization":[]}],"summary":"List endpoints","tags":["endpoints"]}},"/api/v1/endpoints/{endpoint_name}/openai/v1/chat/completions":{"post":{"callbacks":{},"operationId":"DreamcatcherWeb.EndpointController.invoke_chat_completions","parameters":[{"description":"Endpoint name","example":"demo-endpoint","in":"path","name":"endpoint_name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Create chat completion"}}},"description":"Chat completion params","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Chat completion response"}}},"description":"Chat completion response"}},"security":[{"authorization":[]}],"summary":"Invoke a chat completion","tags":["endpoints"]}},"/api/v1/endpoints/{endpoint_name}/openai/v1/completions":{"post":{"callbacks":{},"operationId":"DreamcatcherWeb.EndpointController.invoke_completions","parameters":[{"description":"Endpoint name","example":"demo-endpoint","in":"path","name":"endpoint_name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Completion"}}},"description":"Completion params","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Completion response"}}},"description":"Completion response"}},"security":[{"authorization":[]}],"summary":"Invoke a completion","tags":["endpoints"]}},"/api/v1/endpoints/{endpoint_name}/openai/v1/models":{"get":{"callbacks":{},"operationId":"DreamcatcherWeb.EndpointController.models","parameters":[{"description":"Endpoint name","example":"demo-endpoint","in":"path","name":"endpoint_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListModelsResponse"}}},"description":"List models response"}},"security":[{"authorization":[]}],"summary":"Lists upstreams (ie models) for an endpoint","tags":["endpoints"]}},"/api/v1/endpoints/{endpoint_name}/policies/dlp":{"post":{"callbacks":{},"operationId":"DreamcatcherWeb.PresidioPolicyController.create","parameters":[{"description":"Endpoint name","example":"demo-endpoint","in":"path","name":"endpoint_name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DlpPolicyParams"}}},"description":"DLP policy params","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DlpPolicy"}}},"description":"Create DLP policy response"}},"security":[{"authorization":[]}],"summary":"Create a DLP policy","tags":["dlp_policies"]}},"/api/v1/endpoints/{endpoint_name}/policies/dlp/{id}":{"delete":{"callbacks":{},"operationId":"DreamcatcherWeb.PresidioPolicyController.delete","parameters":[{"description":"Endpoint name","example":"demo-endpoint","in":"path","name":"endpoint_name","required":true,"schema":{"type":"string"}},{"description":"DLP Policy ID","example":1,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"OK"}},"security":[{"authorization":[]}],"summary":"Delete a DLP policy","tags":["dlp_policies"]},"get":{"callbacks":{},"operationId":"DreamcatcherWeb.PresidioPolicyController.show","parameters":[{"description":"Endpoint name","example":"demo-endpoint","in":"path","name":"endpoint_name","required":true,"schema":{"type":"string"}},{"description":"DLP Policy ID","example":1,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DlpPolicy"}}},"description":"Show DLP policy response"}},"security":[{"authorization":[]}],"summary":"Get a DLP policy","tags":["dlp_policies"]},"patch":{"callbacks":{},"operationId":"DreamcatcherWeb.PresidioPolicyController.update","parameters":[{"description":"Endpoint name","example":"demo-endpoint","in":"path","name":"endpoint_name","required":true,"schema":{"type":"string"}},{"description":"DLP Policy ID","example":1,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DlpPolicyParams"}}},"description":"DLP policy params","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DlpPolicy"}}},"description":"Update DLP policy response"}},"security":[{"authorization":[]}],"summary":"Update a DLP policy","tags":["dlp_policies"]},"put":{"callbacks":{},"operationId":"DreamcatcherWeb.PresidioPolicyController.update (2)","parameters":[{"description":"Endpoint name","example":"demo-endpoint","in":"path","name":"endpoint_name","required":true,"schema":{"type":"string"}},{"description":"DLP Policy ID","example":1,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DlpPolicyParams"}}},"description":"DLP policy params","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DlpPolicy"}}},"description":"Update DLP policy response"}},"security":[{"authorization":[]}],"summary":"Update a DLP policy","tags":["dlp_policies"]}},"/api/v1/endpoints/{endpoint_name}/policies/dlp/{id}/scan":{"post":{"callbacks":{},"operationId":"DreamcatcherWeb.PresidioPolicyController.scan","parameters":[{"description":"Endpoint name","example":"demo-endpoint","in":"path","name":"endpoint_name","required":true,"schema":{"type":"string"}},{"description":"DLP Policy ID","example":1,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"content":{"type":"string"}},"type":"object"}}},"description":"Content to scan","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"violates_policy":{"type":"boolean"}},"type":"object"}}},"description":"Scan DLP policy response"}},"security":[{"authorization":[]}],"summary":"Scan content with a DLP policy","tags":["dlp_policies"]}},"/api/v1/endpoints/{endpoint_name}/policies/dlp_zsner":{"post":{"callbacks":{},"operationId":"DreamcatcherWeb.ZeroShotNERPolicyController.create","parameters":[{"description":"Endpoint name","example":"demo-endpoint","in":"path","name":"endpoint_name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DlpZsnerPolicyParams"}}},"description":"DLP ZSNER policy params","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DlpZsnerPolicy"}}},"description":"Create DLP ZSNER policy response"}},"security":[{"authorization":[]}],"summary":"Create a DLP ZSNER policy","tags":["dlp_zsner_policies"]}},"/api/v1/endpoints/{endpoint_name}/policies/dlp_zsner/{id}":{"delete":{"callbacks":{},"operationId":"DreamcatcherWeb.ZeroShotNERPolicyController.delete","parameters":[{"description":"Endpoint name","example":"demo-endpoint","in":"path","name":"endpoint_name","required":true,"schema":{"type":"string"}},{"description":"DLP ZSNER Policy ID","example":1,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"OK"}},"security":[{"authorization":[]}],"summary":"Delete a DLP ZSNER policy","tags":["dlp_zsner_policies"]},"get":{"callbacks":{},"operationId":"DreamcatcherWeb.ZeroShotNERPolicyController.show","parameters":[{"description":"Endpoint name","example":"demo-endpoint","in":"path","name":"endpoint_name","required":true,"schema":{"type":"string"}},{"description":"DLP ZSNER Policy ID","example":1,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DlpZsnerPolicy"}}},"description":"Show DLP ZSNER policy response"}},"security":[{"authorization":[]}],"summary":"Get a DLP ZSNER policy","tags":["dlp_zsner_policies"]},"patch":{"callbacks":{},"operationId":"DreamcatcherWeb.ZeroShotNERPolicyController.update","parameters":[{"description":"Endpoint name","example":"demo-endpoint","in":"path","name":"endpoint_name","required":true,"schema":{"type":"string"}},{"description":"DLP ZSNER Policy ID","example":1,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DlpZsnerPolicyParams"}}},"description":"DLP ZSNER policy params","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DlpZsnerPolicy"}}},"description":"Update DLP ZSNER policy response"}},"security":[{"authorization":[]}],"summary":"Update a DLP ZSNER policy","tags":["dlp_zsner_policies"]},"put":{"callbacks":{},"operationId":"DreamcatcherWeb.ZeroShotNERPolicyController.update (2)","parameters":[{"description":"Endpoint name","example":"demo-endpoint","in":"path","name":"endpoint_name","required":true,"schema":{"type":"string"}},{"description":"DLP ZSNER Policy ID","example":1,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DlpZsnerPolicyParams"}}},"description":"DLP ZSNER policy params","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DlpZsnerPolicy"}}},"description":"Update DLP ZSNER policy response"}},"security":[{"authorization":[]}],"summary":"Update a DLP ZSNER policy","tags":["dlp_zsner_policies"]}},"/api/v1/endpoints/{endpoint_name}/policies/dlp_zsner/{id}/scan":{"post":{"callbacks":{},"operationId":"DreamcatcherWeb.ZeroShotNERPolicyController.scan","parameters":[{"description":"Endpoint name","example":"demo-endpoint","in":"path","name":"endpoint_name","required":true,"schema":{"type":"string"}},{"description":"DLP ZSNER Policy ID","example":1,"in":"path","name":"id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"content":{"type":"string"}},"type":"object"}}},"description":"Content to scan","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"violates_policy":{"type":"boolean"}},"type":"object"}}},"description":"Scan DLP ZSNER policy response"}},"security":[{"authorization":[]}],"summary":"Scan content with a DLP ZSNER policy","tags":["dlp_zsner_policies"]}},"/api/v1/endpoints/{id}":{"get":{"callbacks":{},"operationId":"DreamcatcherWeb.EndpointController.show","parameters":[{"description":"Endpoint name","example":"demo-endpoint","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowEndpointResponse"}}},"description":"Show endpoint response"}},"security":[{"authorization":[]}],"summary":"Get an endpoint","tags":["endpoints"]}},"/api/v1/stub/openai/v1/chat/completions":{"post":{"callbacks":{},"operationId":"Stubidity.OpenAI.ChatCompletion.call","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Create chat completion"}}},"description":"Chat completion params","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Chat completion response"}}},"description":"Chat completion response"}},"summary":"Chat completion","tags":["stub_openai"]}},"/api/v1/stub/openai/v1/completions":{"post":{"callbacks":{},"operationId":"Stubidity.OpenAI.Completion.call","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Completion"}}},"description":"Completion params","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Completion response"}}},"description":"Completion response"}},"summary":"Completion","tags":["stub_openai"]}},"/api/v1/stub/openai/v1/embeddings":{"post":{"callbacks":{},"operationId":"Stubidity.OpenAI.Embedding.call","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Embedding "}}},"description":"Embedding params","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Embedding response"}}},"description":"Embedding response"}},"summary":"Embedding","tags":["stub_openai"]}},"/api/v1/stub/openai/v1/engines/{model}":{"post":{"callbacks":{},"operationId":"Stubidity.OpenAI.Embedding.call (2)","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Embedding "}}},"description":"Embedding params","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Embedding response"}}},"description":"Embedding response"}},"summary":"Embedding","tags":["stub_openai"]}}},"security":[],"servers":[{"url":"http://localhost:4000","variables":{}}],"tags":[]}