Resources

class giskard_hub.resources.ConversationsResource(client: SyncClient)

Bases: APIResource

create(*, dataset_id: str, messages: List[ChatMessage], rules: List[str] = NOT_GIVEN, tags: List[str] = NOT_GIVEN, expected_output: str | None = NOT_GIVEN, demo_output: ChatMessage | None = NOT_GIVEN)

delete(conversation_id: str | List[str]) → None

list(dataset_id: str) → List[Conversation]

retrieve(conversation_id: str)

update(conversation_id: str, *, dataset_id: str = NOT_GIVEN, messages: List[ChatMessage] = NOT_GIVEN, rules: List[str] = NOT_GIVEN, tags: List[str] = NOT_GIVEN, expected_output: str | None = NOT_GIVEN, demo_output: ChatMessage | None = NOT_GIVEN) → Conversation

class giskard_hub.resources.DatasetsResource(client: SyncClient)

Bases: APIResource

create(*, name: str, description: str, project_id: str) → Dataset

delete(dataset_id: str | List[str]) → None

list(project_id: str) → List[Dataset]

retrieve(dataset_id: str)

update(dataset_id: str, *, name: str = NOT_GIVEN, description: str = NOT_GIVEN, project_id: str = NOT_GIVEN) → Dataset

class giskard_hub.resources.EvaluationsResource(client: SyncClient)

Bases: APIResource

create(*, model_id: str, dataset_id: str, tags: List[str] = NOT_GIVEN, name: str = NOT_GIVEN)

create_local(*, model: Model, dataset_id: str, tags: List[str] = NOT_GIVEN, name: str = NOT_GIVEN)

delete(execution_id: str | List[str])

list(project_id: str)

list_entries(run_id: str)

retrieve(run_id: str)

update_entry(run_id: str, entry_id: str, *, model_output: ModelOutput = NOT_GIVEN, results: List[EvaluatorResult] = NOT_GIVEN)

class giskard_hub.resources.ModelsResource(client: SyncClient)

Bases: APIResource

chat(model_id: str, messages: List[ChatMessage]) → ModelOutput

create(*, name: str, description: str, url: str, supported_languages: List[str], headers: Dict[str, str] | None = None, project_id: str) → Model

delete(model_id: str | List[str]) → None

list(project_id: str) → List[Model]

retrieve(model_id: str) → Model

update(model_id: str, *, name: str = NOT_GIVEN, description: str = NOT_GIVEN, url: str = NOT_GIVEN, supported_languages: List[str] = NOT_GIVEN, headers: Dict[str, str] = NOT_GIVEN, project_id: str = NOT_GIVEN) → Model

class giskard_hub.resources.ProjectsResource(client: SyncClient)

Bases: APIResource

create(*, name: str, description: str = '')

delete(project_id: str | List[str])

list()

retrieve(project_id: str)

update(project_id: str, *, name: str = NOT_GIVEN, description: str = NOT_GIVEN)